include/vlc_codec.h

   1 /*****************************************************************************
   2  * vlc_codec.h: Definition of the decoder and encoder structures
   3  *****************************************************************************
   4  * Copyright (C) 1999-2003 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_CODEC_H
  25 #define VLC_CODEC_H 1
  26
  27 #include <vlc_block.h>
  28 #include <vlc_es.h>
  29 #include <vlc_picture.h>
  30 #include <vlc_subpicture.h>
  31
  32 /**
  33  * \defgroup codec Codec
  34  * Decoders and encoders
  35  * @{
  36  * \file
  37  * Decoder and encoder modules interface
  38  *
  39  * \defgroup decoder Decoder
  40  * Audio, video and text decoders
  41  * @{
  42  */
  43
  44 typedef struct decoder_owner_sys_t decoder_owner_sys_t;
  45
  46 /*
  47  * BIG FAT WARNING : the code relies in the first 4 members of filter_t
  48  * and decoder_t to be the same, so if you have anything to add, do it
  49  * at the end of the structure.
  50  */
  51 struct decoder_t
  52 {
  53     VLC_COMMON_MEMBERS
  54
  55     /* Module properties */
  56     module_t *          p_module;
  57     decoder_sys_t *     p_sys;
  58
  59     /* Input format ie from demuxer (XXX: a lot of field could be invalid) */
  60     es_format_t         fmt_in;
  61
  62     /* Output format of decoder/packetizer */
  63     es_format_t         fmt_out;
  64
  65     /* Some decoders only accept packetized data (ie. not truncated) */
  66     bool                b_need_packetized;
  67
  68     /* Tell the decoder if it is allowed to drop frames */
  69     bool                b_pace_control;
  70
  71     /* */
  72     picture_t *         ( * pf_decode_video )( decoder_t *, block_t ** );
  73     block_t *           ( * pf_decode_audio )( decoder_t *, block_t ** );
  74     subpicture_t *      ( * pf_decode_sub)   ( decoder_t *, block_t ** );
  75     block_t *           ( * pf_packetize )   ( decoder_t *, block_t ** );
  76
  77     /* Closed Caption (CEA 608/708) extraction.
  78      * If set, it *may* be called after pf_decode_video/pf_packetize
  79      * returned data. It should return CC for the pictures returned by the
  80      * last pf_packetize/pf_decode_video call only,
  81      * pb_present will be used to known which cc channel are present (but
  82      * globaly, not necessary for the current packet */
  83     block_t *           ( * pf_get_cc )      ( decoder_t *, bool pb_present[4] );
  84
  85     /* Meta data at codec level
  86      *  The decoder owner set it back to NULL once it has retreived what it needs.
  87      *  The decoder owner is responsible of its release except when you overwrite it.
  88      */
  89     vlc_meta_t          *p_description;
  90
  91     /*
  92      * Owner fields
  93      * XXX You MUST not use them directly.
  94      */
  95
  96     /* Video output callbacks
  97      * XXX use decoder_NewPicture */
  98     int             (*pf_vout_format_update)( decoder_t * );
  99     picture_t      *(*pf_vout_buffer_new)( decoder_t * );
 100
 101     /**
 102      * Number of extra (ie in addition to the DPB) picture buffers
 103      * needed for decoding.
 104      */
 105     int             i_extra_picture_buffers;
 106
 107     /* Audio output callbacks */
 108     int             (*pf_aout_format_update)( decoder_t * );
 109
 110     /* SPU output callbacks
 111      * XXX use decoder_NewSubpicture */
 112     subpicture_t   *(*pf_spu_buffer_new)( decoder_t *, const subpicture_updater_t * );
 113
 114     /* Input attachments
 115      * XXX use decoder_GetInputAttachments */
 116     int             (*pf_get_attachments)( decoder_t *p_dec, input_attachment_t ***ppp_attachment, int *pi_attachment );
 117
 118     /* Display date
 119      * XXX use decoder_GetDisplayDate */
 120     mtime_t         (*pf_get_display_date)( decoder_t *, mtime_t );
 121
 122     /* Display rate
 123      * XXX use decoder_GetDisplayRate */
 124     int             (*pf_get_display_rate)( decoder_t * );
 125
 126     /* Private structure for the owner of the decoder */
 127     decoder_owner_sys_t *p_owner;
 128
 129     bool                b_error;
 130 };
 131
 132 /**
 133  * @}
 134  */
 135
 136 /**
 137  * \defgroup encoder Encoder
 138  * Audio, video and text encoders
 139  * @{
 140  */
 141
 142 struct encoder_t
 143 {
 144     VLC_COMMON_MEMBERS
 145
 146     /* Module properties */
 147     module_t *          p_module;
 148     encoder_sys_t *     p_sys;
 149
 150     /* Properties of the input data fed to the encoder */
 151     es_format_t         fmt_in;
 152
 153     /* Properties of the output of the encoder */
 154     es_format_t         fmt_out;
 155
 156     block_t *           ( * pf_encode_video )( encoder_t *, picture_t * );
 157     block_t *           ( * pf_encode_audio )( encoder_t *, block_t * );
 158     block_t *           ( * pf_encode_sub )( encoder_t *, subpicture_t * );
 159
 160     /* Common encoder options */
 161     int i_threads;               /* Number of threads to use during encoding */
 162     int i_iframes;               /* One I frame per i_iframes */
 163     int i_bframes;               /* One B frame per i_bframes */
 164     int i_tolerance;             /* Bitrate tolerance */
 165
 166     /* Encoder config */
 167     config_chain_t *p_cfg;
 168 };
 169
 170 /**
 171  * @}
 172  *
 173  * \ingroup decoder
 174  * @{
 175  */
 176
 177 /**
 178  * This function notifies the video output pipeline of a new video output
 179  * format (fmt_out.video). If there is currently no video output or if the
 180  * video output format has changed, a new video output will be set up.
 181  * @return 0 if the video output is working, -1 if not. */
 182 static inline int decoder_UpdateVideoFormat( decoder_t *dec )
 183 {
 184     if( dec->pf_vout_format_update != NULL )
 185         return dec->pf_vout_format_update( dec );
 186     else
 187         return -1;
 188 }
 189
 190 /**
 191  * This function will return a new picture usable by a decoder as an output
 192  * buffer. You have to release it using picture_Release() or by returning
 193  * it to the caller as a pf_decode_video return value.
 194  */
 195 VLC_API picture_t * decoder_NewPicture( decoder_t * ) VLC_USED;
 196
 197 /**
 198  * This function notifies the audio output pipeline of a new audio output
 199  * format (fmt_out.audio). If there is currently no audio output or if the
 200  * audio output format has changed, a new audio output will be set up.
 201  * @return 0 if the audio output is working, -1 if not. */
 202 static inline int decoder_UpdateAudioFormat( decoder_t *dec )
 203 {
 204     if( dec->pf_aout_format_update != NULL )
 205         return dec->pf_aout_format_update( dec );
 206     else
 207         return -1;
 208 }
 209
 210 /**
 211  * This function will return a new audio buffer usable by a decoder as an
 212  * output buffer. It must be released with block_Release() or returned it to
 213  * the caller as a pf_decode_audio return value.
 214  */
 215 VLC_API block_t * decoder_NewAudioBuffer( decoder_t *, int i_size ) VLC_USED;
 216
 217 /**
 218  * This function will return a new subpicture usable by a decoder as an output
 219  * buffer. You have to release it using subpicture_Delete() or by returning
 220  * it to the caller as a pf_decode_sub return value.
 221  */
 222 VLC_API subpicture_t * decoder_NewSubpicture( decoder_t *, const subpicture_updater_t * ) VLC_USED;
 223
 224 /**
 225  * This function gives all input attachments at once.
 226  *
 227  * You MUST release the returned values
 228  */
 229 VLC_API int decoder_GetInputAttachments( decoder_t *, input_attachment_t ***ppp_attachment, int *pi_attachment );
 230
 231 /**
 232  * This function converts a decoder timestamp into a display date comparable
 233  * to mdate().
 234  * You MUST use it *only* for gathering statistics about speed.
 235  */
 236 VLC_API mtime_t decoder_GetDisplayDate( decoder_t *, mtime_t ) VLC_USED;
 237
 238 /**
 239  * This function returns the current input rate.
 240  * You MUST use it *only* for gathering statistics about speed.
 241  */
 242 VLC_API int decoder_GetDisplayRate( decoder_t * ) VLC_USED;
 243
 244 /** @} */
 245 /** @} */
 246 #endif /* _VLC_CODEC_H */