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 */
99 int (*pf_vout_format_update
)( decoder_t
* );
100 picture_t
*(*pf_vout_buffer_new
)( decoder_t
* );
103 * Number of extra (ie in addition to the DPB) picture buffers
104 * needed for decoding.
106 int i_extra_picture_buffers
;
108 /* Audio output callbacks */
109 int (*pf_aout_format_update
)( decoder_t
* );
111 /* SPU output callbacks
112 * XXX use decoder_NewSubpicture */
113 subpicture_t
*(*pf_spu_buffer_new
)( decoder_t
*, const subpicture_updater_t
* );
116 * XXX use decoder_GetInputAttachments */
117 int (*pf_get_attachments
)( decoder_t
*p_dec
, input_attachment_t
***ppp_attachment
, int *pi_attachment
);
120 * XXX use decoder_GetDisplayDate */
121 mtime_t (*pf_get_display_date
)( decoder_t
*, mtime_t
);
124 * XXX use decoder_GetDisplayRate */
125 int (*pf_get_display_rate
)( decoder_t
* );
127 /* Private structure for the owner of the decoder */
128 decoder_owner_sys_t
*p_owner
;
138 * \defgroup encoder Encoder
140 * The structure describing a Encoder
149 /* Module properties */
151 encoder_sys_t
* p_sys
;
153 /* Properties of the input data fed to the encoder */
156 /* Properties of the output of the encoder */
159 block_t
* ( * pf_encode_video
)( encoder_t
*, picture_t
* );
160 block_t
* ( * pf_encode_audio
)( encoder_t
*, block_t
* );
161 block_t
* ( * pf_encode_sub
)( encoder_t
*, subpicture_t
* );
163 /* Common encoder options */
164 int i_threads
; /* Number of threads to use during encoding */
165 int i_iframes
; /* One I frame per i_iframes */
166 int i_bframes
; /* One B frame per i_bframes */
167 int i_tolerance
; /* Bitrate tolerance */
170 config_chain_t
*p_cfg
;
179 * This function notifies the video output pipeline of a new video output
180 * format (fmt_out.video). If there is currently no video output or if the
181 * video output format has changed, a new video output will be set up.
182 * @return 0 if the video output is working, -1 if not. */
183 static inline int decoder_UpdateVideoFormat( decoder_t
*dec
)
185 if( dec
->pf_vout_format_update
!= NULL
)
186 return dec
->pf_vout_format_update( dec
);
192 * This function will return a new picture usable by a decoder as an output
193 * buffer. You have to release it using picture_Release() or by returning
194 * it to the caller as a pf_decode_video return value.
196 VLC_API picture_t
* decoder_NewPicture( decoder_t
* ) VLC_USED
;
199 * This function notifies the audio output pipeline of a new audio output
200 * format (fmt_out.audio). If there is currently no audio output or if the
201 * audio output format has changed, a new audio output will be set up.
202 * @return 0 if the audio output is working, -1 if not. */
203 static inline int decoder_UpdateAudioFormat( decoder_t
*dec
)
205 if( dec
->pf_aout_format_update
!= NULL
)
206 return dec
->pf_aout_format_update( dec
);
212 * This function will return a new audio buffer usable by a decoder as an
213 * output buffer. It must be released with block_Release() or returned it to
214 * the caller as a pf_decode_audio return value.
216 VLC_API block_t
* decoder_NewAudioBuffer( decoder_t
*, int i_size
) VLC_USED
;
219 * This function will return a new subpicture usable by a decoder as an output
220 * buffer. You have to release it using subpicture_Delete() or by returning
221 * it to the caller as a pf_decode_sub return value.
223 VLC_API subpicture_t
* decoder_NewSubpicture( decoder_t
*, const subpicture_updater_t
* ) VLC_USED
;
226 * This function gives all input attachments at once.
228 * You MUST release the returned values
230 VLC_API
int decoder_GetInputAttachments( decoder_t
*, input_attachment_t
***ppp_attachment
, int *pi_attachment
);
233 * This function converts a decoder timestamp into a display date comparable
235 * You MUST use it *only* for gathering statistics about speed.
237 VLC_API mtime_t
decoder_GetDisplayDate( decoder_t
*, mtime_t
) VLC_USED
;
240 * This function returns the current input rate.
241 * You MUST use it *only* for gathering statistics about speed.
243 VLC_API
int decoder_GetDisplayRate( decoder_t
* ) VLC_USED
;
245 #endif /* _VLC_CODEC_H */