git.sesse.net Git - vlc/blob - 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 #define BLOCK_FLAG_CORE_FLUSH (1 <<BLOCK_FLAG_CORE_PRIVATE_SHIFT)
  32
  33 decoder_t *input_DecoderNew( input_thread_t *, es_format_t *, input_clock_t *,
  34                              sout_instance_t * ) VLC_USED;
  35
  36 /**
  37  * This function changes the pause state.
  38  * The date parameter MUST hold the exact date at wich the change has been
  39  * done for proper vout/aout pausing.
  40  */
  41 void input_DecoderChangePause( decoder_t *, bool b_paused, mtime_t i_date );
  42
  43 /**
  44  * This function changes the delay.
  45  */
  46 void input_DecoderChangeDelay( decoder_t *, mtime_t i_delay );
  47
  48 /**
  49  * This function makes the decoder start waiting for a valid data block from its fifo.
  50  */
  51 void input_DecoderStartWait( decoder_t * );
  52
  53 /**
  54  * This function waits for the decoder to actually receive data.
  55  */
  56 void input_DecoderWait( decoder_t * );
  57
  58 /**
  59  * This function exits the waiting mode of the decoder.
  60  */
  61 void input_DecoderStopWait( decoder_t * );
  62
  63 /**
  64  * This function returns true if the decoder fifo is empty and false otherwise.
  65  */
  66 bool input_DecoderIsEmpty( decoder_t * );
  67
  68 /**
  69  * This function activates the request closed caption channel.
  70  */
  71 int input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
  72
  73 /**
  74  * This function returns an error if the requested channel does not exist and
  75  * set pb_decode to the channel status(active or not) otherwise.
  76  */
  77 int input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
  78
  79 /**
  80  * This function set each pb_present entry to true if the corresponding channel
  81  * exists or false otherwise.
  82  */
  83 void input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
  84
  85 /**
  86  * This function force the display of the next picture and fills the stream
  87  * time consumed.
  88  */
  89 void input_DecoderFrameNext( decoder_t *p_dec, mtime_t *pi_duration );
  90
  91 /**
  92  * This function will return true if the ES format or meta data have changed since
  93  * the last call. In which case, it will do a copy of the current es_format_t if p_fmt
  94  * is not NULL and will do a copy of the current description if pp_meta is non NULL.
  95  * The es_format_t MUST be freed by es_format_Clean and *pp_meta MUST be freed by
  96  * vlc_meta_Delete.
  97  * Otherwise it will return false and will not initialize p_fmt and *pp_meta.
  98  */
  99 bool input_DecoderHasFormatChanged( decoder_t *p_dec, es_format_t *p_fmt, vlc_meta_t **pp_meta );
 100
 101 /**
 102  * This function returns the current size in bytes of the decoder fifo
 103  */
 104 size_t input_DecoderGetFifoSize( decoder_t *p_dec );
 105
 106 /**
 107  * This function returns the objects associated to a decoder
 108  *
 109  * They must be released using vlc_object_release().
 110  */
 111 void input_DecoderGetObjects( decoder_t *, vout_thread_t **, audio_output_t ** );
 112
 113 #endif