src/input/decoder.h

   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$
   7  *
   8  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  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.
  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 Lesser General Public License for more details.
  19  *
  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  *****************************************************************************/
  24
  25 #ifndef LIBVLC_INPUT_DECODER_H
  26 #define LIBVLC_INPUT_DECODER_H 1
  27
  28 #include <vlc_common.h>
  29 #include <vlc_codec.h>
  30
  31 decoder_t *input_DecoderNew( input_thread_t *, es_format_t *, input_clock_t *,
  32                              sout_instance_t * ) VLC_USED;
  33
  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.
  38  */
  39 void input_DecoderChangePause( decoder_t *, bool b_paused, vlc_tick_t i_date );
  40
  41 /**
  42  * Changes the decoder rate.
  43  *
  44  * This function changes rate of the intended playback speed to nominal speed.
  45  * \param dec decoder
  46  * \param rate playback rate (default is 1)
  47  */
  48 void input_DecoderChangeRate( decoder_t *dec, float rate );
  49
  50 /**
  51  * This function changes the delay.
  52  */
  53 void input_DecoderChangeDelay( decoder_t *, vlc_tick_t i_delay );
  54
  55 /**
  56  * This function makes the decoder start waiting for a valid data block from its fifo.
  57  */
  58 void input_DecoderStartWait( decoder_t * );
  59
  60 /**
  61  * This function waits for the decoder to actually receive data.
  62  */
  63 void input_DecoderWait( decoder_t * );
  64
  65 /**
  66  * This function exits the waiting mode of the decoder.
  67  */
  68 void input_DecoderStopWait( decoder_t * );
  69
  70 /**
  71  * This function returns true if the decoder fifo is empty and false otherwise.
  72  */
  73 bool input_DecoderIsEmpty( decoder_t * );
  74
  75 /**
  76  * This function activates the request closed caption channel.
  77  */
  78 int input_DecoderSetCcState( decoder_t *, vlc_fourcc_t, int i_channel, bool b_decode );
  79
  80 /**
  81  * This function returns an error if the requested channel does not exist and
  82  * set pb_decode to the channel status(active or not) otherwise.
  83  */
  84 int input_DecoderGetCcState( decoder_t *, vlc_fourcc_t, int i_channel, bool *pb_decode );
  85
  86 /**
  87  * This function get cc channels descriptions
  88  */
  89 void input_DecoderGetCcDesc( decoder_t *, decoder_cc_desc_t * );
  90
  91 /**
  92  * This function force the display of the next picture and fills the stream
  93  * time consumed.
  94  */
  95 void input_DecoderFrameNext( decoder_t *p_dec, vlc_tick_t *pi_duration );
  96
  97 /**
  98  * This function will return true if the ES format or meta data have changed since
  99  * the last call. In which case, it will do a copy of the current es_format_t if p_fmt
 100  * is not NULL and will do a copy of the current description if pp_meta is non NULL.
 101  * The es_format_t MUST be freed by es_format_Clean and *pp_meta MUST be freed by
 102  * vlc_meta_Delete.
 103  * Otherwise it will return false and will not initialize p_fmt and *pp_meta.
 104  */
 105 bool input_DecoderHasFormatChanged( decoder_t *p_dec, es_format_t *p_fmt, vlc_meta_t **pp_meta );
 106
 107 /**
 108  * This function returns the current size in bytes of the decoder fifo
 109  */
 110 size_t input_DecoderGetFifoSize( decoder_t *p_dec );
 111
 112 /**
 113  * This function returns the objects associated to a decoder
 114  *
 115  * They must be released using vlc_object_release().
 116  */
 117 void input_DecoderGetObjects( decoder_t *, vout_thread_t **, audio_output_t ** );
 118
 119 #endif