1 /*****************************************************************************
2 * vlc_codec.h: Definition of the decoder and encoder structures
3 *****************************************************************************
4 * Copyright (C) 1999-2003 VLC authors and VideoLAN
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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 *****************************************************************************/
27 #include <vlc_block.h>
29 #include <vlc_picture.h>
30 #include <vlc_subpicture.h>
34 * This file defines the structure and types used by decoders and encoders
37 typedef struct decoder_owner_sys_t decoder_owner_sys_t;
40 * \defgroup decoder Decoder
42 * The structure describing a decoder
48 * BIG FAT WARNING : the code relies in the first 4 members of filter_t
49 * and decoder_t to be the same, so if you have anything to add, do it
50 * at the end of the structure.
56 /* Module properties */
58 decoder_sys_t * p_sys;
60 /* Input format ie from demuxer (XXX: a lot of field could be invalid) */
63 /* Output format of decoder/packetizer */
66 /* Some decoders only accept packetized data (ie. not truncated) */
67 bool b_need_packetized;
69 /* Tell the decoder if it is allowed to drop frames */
73 picture_t * ( * pf_decode_video )( decoder_t *, block_t ** );
74 block_t * ( * pf_decode_audio )( decoder_t *, block_t ** );
75 subpicture_t * ( * pf_decode_sub) ( decoder_t *, block_t ** );
76 block_t * ( * pf_packetize ) ( decoder_t *, block_t ** );
78 /* Closed Caption (CEA 608/708) extraction.
79 * If set, it *may* be called after pf_decode_video/pf_packetize
80 * returned data. It should return CC for the pictures returned by the
81 * last pf_packetize/pf_decode_video call only,
82 * pb_present will be used to known which cc channel are present (but
83 * globaly, not necessary for the current packet */
84 block_t * ( * pf_get_cc ) ( decoder_t *, bool pb_present[4] );
86 /* Meta data at codec level
87 * The decoder owner set it back to NULL once it has retreived what it needs.
88 * The decoder owner is responsible of its release except when you overwrite it.
90 vlc_meta_t *p_description;
94 * XXX You MUST not use them directly.
97 /* Video output callbacks
98 * XXX use decoder_NewPicture/decoder_DeletePicture
99 * and decoder_LinkPicture/decoder_UnlinkPicture */
100 int (*pf_vout_format_update)( decoder_t * );
101 picture_t *(*pf_vout_buffer_new)( decoder_t * );
102 void (*pf_vout_buffer_del)( decoder_t *, picture_t * );
103 void (*pf_picture_link) ( decoder_t *, picture_t * );
104 void (*pf_picture_unlink) ( decoder_t *, picture_t * );
107 * Number of extra (ie in addition to the DPB) picture buffers
108 * needed for decoding.
110 int i_extra_picture_buffers;
112 /* Audio output callbacks */
113 int (*pf_aout_format_update)( decoder_t * );
115 /* SPU output callbacks
116 * XXX use decoder_NewSubpicture and decoder_DeleteSubpicture */
117 subpicture_t *(*pf_spu_buffer_new)( decoder_t *, const subpicture_updater_t * );
118 void (*pf_spu_buffer_del)( decoder_t *, subpicture_t * );
121 * XXX use decoder_GetInputAttachments */
122 int (*pf_get_attachments)( decoder_t *p_dec, input_attachment_t ***ppp_attachment, int *pi_attachment );
125 * XXX use decoder_GetDisplayDate */
126 mtime_t (*pf_get_display_date)( decoder_t *, mtime_t );
129 * XXX use decoder_GetDisplayRate */
130 int (*pf_get_display_rate)( decoder_t * );
132 /* Private structure for the owner of the decoder */
133 decoder_owner_sys_t *p_owner;
143 * \defgroup encoder Encoder
145 * The structure describing a Encoder
154 /* Module properties */
156 encoder_sys_t * p_sys;
158 /* Properties of the input data fed to the encoder */
161 /* Properties of the output of the encoder */
164 block_t * ( * pf_encode_video )( encoder_t *, picture_t * );
165 block_t * ( * pf_encode_audio )( encoder_t *, block_t * );
166 block_t * ( * pf_encode_sub )( encoder_t *, subpicture_t * );
168 /* Common encoder options */
169 int i_threads; /* Number of threads to use during encoding */
170 int i_iframes; /* One I frame per i_iframes */
171 int i_bframes; /* One B frame per i_bframes */
172 int i_tolerance; /* Bitrate tolerance */
175 config_chain_t *p_cfg;
184 * This function notifies the video output pipeline of a new video output
185 * format (fmt_out.video). If there is currently no video output or if the
186 * video output format has changed, a new audio video will be set up.
187 * @return 0 if the video output is working, -1 if not. */
188 static inline int decoder_UpdateVideoFormat( decoder_t *dec )
190 if( dec->pf_vout_format_update != NULL )
191 return dec->pf_vout_format_update( dec );
197 * This function will return a new picture usable by a decoder as an output
198 * buffer. You have to release it using decoder_DeletePicture or by returning
199 * it to the caller as a pf_decode_video return value.
201 VLC_API picture_t * decoder_NewPicture( decoder_t * ) VLC_USED;
204 * This function will release a picture create by decoder_NewPicture.
206 VLC_API void decoder_DeletePicture( decoder_t *, picture_t *p_picture );
209 * This function will increase the picture reference count.
210 * (picture_Hold is not usable.)
212 VLC_API void decoder_LinkPicture( decoder_t *, picture_t * );
215 * This function will decrease the picture reference count.
216 * (picture_Release is not usable.)
218 VLC_API void decoder_UnlinkPicture( decoder_t *, picture_t * );
221 * This function notifies the audio output pipeline of a new audio output
222 * format (fmt_out.audio). If there is currently no audio output or if the
223 * audio output format has changed, a new audio output will be set up.
224 * @return 0 if the audio output is working, -1 if not. */
225 static inline int decoder_UpdateAudioFormat( decoder_t *dec )
227 if( dec->pf_aout_format_update != NULL )
228 return dec->pf_aout_format_update( dec );
234 * This function will return a new audio buffer usable by a decoder as an
235 * output buffer. You have to release it using decoder_DeleteAudioBuffer
236 * or by returning it to the caller as a pf_decode_audio return value.
238 VLC_API block_t * decoder_NewAudioBuffer( decoder_t *, int i_size ) VLC_USED;
241 * This function will return a new subpicture usable by a decoder as an output
242 * buffer. You have to release it using decoder_DeleteSubpicture or by returning
243 * it to the caller as a pf_decode_sub return value.
245 VLC_API subpicture_t * decoder_NewSubpicture( decoder_t *, const subpicture_updater_t * ) VLC_USED;
248 * This function will release a subpicture created by decoder_NewSubicture.
250 VLC_API void decoder_DeleteSubpicture( decoder_t *, subpicture_t *p_subpicture );
253 * This function gives all input attachments at once.
255 * You MUST release the returned values
257 VLC_API int decoder_GetInputAttachments( decoder_t *, input_attachment_t ***ppp_attachment, int *pi_attachment );
260 * This function converts a decoder timestamp into a display date comparable
262 * You MUST use it *only* for gathering statistics about speed.
264 VLC_API mtime_t decoder_GetDisplayDate( decoder_t *, mtime_t ) VLC_USED;
267 * This function returns the current input rate.
268 * You MUST use it *only* for gathering statistics about speed.
270 VLC_API int decoder_GetDisplayRate( decoder_t * ) VLC_USED;
272 #endif /* _VLC_CODEC_H */