decoder.h 3.45 KB
Newer Older
1
/*****************************************************************************
2
 * decoder.h: Input decoder functions
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 *****************************************************************************
 * Copyright (C) 1998-2008 the VideoLAN team
 * Copyright (C) 2008 Laurent Aimar
 * $Id$
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
# error This header file can only be included from LibVLC.
#endif

#ifndef _INPUT_DECODER_H
#define _INPUT_DECODER_H 1

#include <vlc_common.h>
#include <vlc_codec.h>

#define BLOCK_FLAG_CORE_FLUSH (1 <<BLOCK_FLAG_CORE_PRIVATE_SHIFT)

/**
38 39 40 41 42 43
 * This function changes the pause state.
 * The date parameter MUST hold the exact date at wich the change has been
 * done for proper vout/aout pausing.
 */
void input_DecoderChangePause( decoder_t *, bool b_paused, mtime_t i_date );

44 45 46 47 48
/**
 * This function changes the delay.
 */
void input_DecoderChangeDelay( decoder_t *, mtime_t i_delay );

49
/**
Laurent Aimar's avatar
Laurent Aimar committed
50
 * This function starts the buffering mode.
51
 */
Laurent Aimar's avatar
Laurent Aimar committed
52 53
void input_DecoderStartBuffering( decoder_t * );

54 55 56 57 58
/**
 * This function waits for the decoder to have buffered sufficient data.
 */
void input_DecoderWaitBuffering( decoder_t * );

Laurent Aimar's avatar
Laurent Aimar committed
59 60 61 62
/**
 * This function stops the buffering mode.
 */
void input_DecoderStopBuffering( decoder_t * );
63 64 65 66

/**
 * This function returns true if the decoder fifo is empty and false otherwise.
 */
67
bool input_DecoderIsEmpty( decoder_t * );
68 69 70 71

/**
 * This function activates the request closed caption channel.
 */
72 73
int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );

74 75 76 77
/**
 * This function returns an error if the requested channel does not exist and
 * set pb_decode to the channel status(active or not) otherwise.
 */
78
int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
79 80 81 82 83

/**
 * This function set each pb_present entry to true if the corresponding channel
 * exists or false otherwise.
 */
84
void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
85

86 87 88 89 90 91
/**
 * This function force the display of the next picture and fills the stream
 * time consumed.
 */
void input_DecoderFrameNext( decoder_t *p_dec, mtime_t *pi_duration );

92
/**
Laurent Aimar's avatar
Laurent Aimar committed
93 94 95 96 97 98
 * This function will return true if the ES format or meta data have changed since
 * the last call. In which case, it will do a copy of the current es_format_t if p_fmt
 * is not NULL and will do a copy of the current description if pp_meta is non NULL.
 * The es_format_t MUST be freed by es_format_Clean and *pp_meta MUST be freed by
 * vlc_meta_Delete.
 * Otherwise it will return false and will not initialize p_fmt and *pp_meta.
99
 */
Laurent Aimar's avatar
Laurent Aimar committed
100
bool input_DecoderHasFormatChanged( decoder_t *p_dec, es_format_t *p_fmt, vlc_meta_t **pp_meta );
101

102
#endif