audiotrack: simplify native rate handling
[vlc.git] / src / input / decoder.h
blob226ecde86236ff5acd113faef6242c28bee664e1
1 /*****************************************************************************
2 * decoder.h: Input decoder functions
3 *****************************************************************************
4 * Copyright (C) 1998-2008 VLC authors and VideoLAN
5 * Copyright (C) 2008 Laurent Aimar
6 * $Id$
8 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #ifndef LIBVLC_INPUT_DECODER_H
26 #define LIBVLC_INPUT_DECODER_H 1
28 #include <vlc_common.h>
29 #include <vlc_codec.h>
31 decoder_t *input_DecoderNew( input_thread_t *, es_format_t *, input_clock_t *,
32 sout_instance_t * ) VLC_USED;
34 /**
35 * This function changes the pause state.
36 * The date parameter MUST hold the exact date at which the change has been
37 * done for proper vout/aout pausing.
39 void input_DecoderChangePause( decoder_t *, bool b_paused, mtime_t i_date );
41 /**
42 * This function changes the delay.
44 void input_DecoderChangeDelay( decoder_t *, mtime_t i_delay );
46 /**
47 * This function makes the decoder start waiting for a valid data block from its fifo.
49 void input_DecoderStartWait( decoder_t * );
51 /**
52 * This function waits for the decoder to actually receive data.
54 void input_DecoderWait( decoder_t * );
56 /**
57 * This function exits the waiting mode of the decoder.
59 void input_DecoderStopWait( decoder_t * );
61 /**
62 * This function returns true if the decoder fifo is empty and false otherwise.
64 bool input_DecoderIsEmpty( decoder_t * );
66 /**
67 * This function activates the request closed caption channel.
69 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
71 /**
72 * This function returns an error if the requested channel does not exist and
73 * set pb_decode to the channel status(active or not) otherwise.
75 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
77 /**
78 * This function set each pb_present entry to true if the corresponding channel
79 * exists or false otherwise.
81 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
83 /**
84 * This function force the display of the next picture and fills the stream
85 * time consumed.
87 void input_DecoderFrameNext( decoder_t *p_dec, mtime_t *pi_duration );
89 /**
90 * This function will return true if the ES format or meta data have changed since
91 * the last call. In which case, it will do a copy of the current es_format_t if p_fmt
92 * is not NULL and will do a copy of the current description if pp_meta is non NULL.
93 * The es_format_t MUST be freed by es_format_Clean and *pp_meta MUST be freed by
94 * vlc_meta_Delete.
95 * Otherwise it will return false and will not initialize p_fmt and *pp_meta.
97 bool input_DecoderHasFormatChanged( decoder_t *p_dec, es_format_t *p_fmt, vlc_meta_t **pp_meta );
99 /**
100 * This function returns the current size in bytes of the decoder fifo
102 size_t input_DecoderGetFifoSize( decoder_t *p_dec );
105 * This function returns the objects associated to a decoder
107 * They must be released using vlc_object_release().
109 void input_DecoderGetObjects( decoder_t *, vout_thread_t **, audio_output_t ** );
111 #endif