Sanitize input headers (pass 4).
[vlc.git] / src / input / decoder.h
1 /*****************************************************************************
2  * decoder.h: Input decoder functions
3  *****************************************************************************
4  * Copyright (C) 1998-2008 the VideoLAN team
5  * Copyright (C) 2008 Laurent Aimar
6  * $Id$
7  *
8  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
26 # error This header file can only be included from LibVLC.
27 #endif
28
29 #ifndef _INPUT_DECODER_H
30 #define _INPUT_DECODER_H 1
31
32 #include <vlc_common.h>
33 #include <vlc_codec.h>
34
35 #define BLOCK_FLAG_CORE_FLUSH (1 <<BLOCK_FLAG_CORE_PRIVATE_SHIFT)
36
37 /**
38  * This function changes the pause state.
39  * The date parameter MUST hold the exact date at wich the change has been
40  * done for proper vout/aout pausing.
41  */
42 void input_DecoderChangePause( decoder_t *, bool b_paused, mtime_t i_date );
43
44 /**
45  * This function changes the delay.
46  */
47 void input_DecoderChangeDelay( decoder_t *, mtime_t i_delay );
48
49 /**
50  * This function starts the buffering mode.
51  */
52 void input_DecoderStartBuffering( decoder_t * );
53
54 /**
55  * This function waits for the decoder to have buffered sufficient data.
56  */
57 void input_DecoderWaitBuffering( decoder_t * );
58
59 /**
60  * This function stops the buffering mode.
61  */
62 void input_DecoderStopBuffering( decoder_t * );
63
64 /**
65  * This function returns true if the decoder fifo is empty and false otherwise.
66  */
67 bool input_DecoderIsEmpty( decoder_t * );
68
69 /**
70  * This function activates the request closed caption channel.
71  */
72 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
73
74 /**
75  * This function returns an error if the requested channel does not exist and
76  * set pb_decode to the channel status(active or not) otherwise.
77  */
78 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
79
80 /**
81  * This function set each pb_present entry to true if the corresponding channel
82  * exists or false otherwise.
83  */
84 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
85
86 #endif