Call ff_find_hwaccel() after calling avcodec_set_dimensions().
[libav.git] / libavcodec / avcodec.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
b78e7197 11 * FFmpeg is distributed in the hope that it will be useful,
04d7f601
DB
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
b78e7197 17 * License along with FFmpeg; if not, write to the Free Software
e5a389a1 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
04d7f601
DB
19 */
20
98790382
SS
21#ifndef AVCODEC_AVCODEC_H
22#define AVCODEC_AVCODEC_H
a96b68b7 23
36df8805 24/**
bad5537e 25 * @file libavcodec/avcodec.h
f5bccd85 26 * external API header
36df8805
MN
27 */
28
c60208e7 29#include <errno.h>
76a448ed 30#include "libavutil/avutil.h"
de6d9b64 31
dd1c8f3e 32#define LIBAVCODEC_VERSION_MAJOR 52
6870aefa 33#define LIBAVCODEC_VERSION_MINOR 41
5aea268d 34#define LIBAVCODEC_VERSION_MICRO 0
e97ac1e6 35
800c289a
MR
36#define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
37 LIBAVCODEC_VERSION_MINOR, \
38 LIBAVCODEC_VERSION_MICRO)
39#define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
40 LIBAVCODEC_VERSION_MINOR, \
41 LIBAVCODEC_VERSION_MICRO)
bb270c08 42#define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
5aa083ee 43
bb270c08 44#define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
ce2749d2 45
8da9266c 46#define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
bb270c08
DB
47#define AV_TIME_BASE 1000000
48#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
9740beff 49
7ebf5927 50/**
6b0cdb6e
NG
51 * Identifies the syntax and semantics of the bitstream.
52 * The principle is roughly:
53 * Two decoders with the same ID can decode the same streams.
54 * Two encoders with the same ID can encode compatible streams.
55 * There may be slight deviations from the principle due to implementation
56 * details.
7ebf5927 57 *
f5bccd85
DB
58 * If you add a codec ID to this list, add it so that
59 * 1. no value of a existing codec ID changes (that would break ABI),
60 * 2. it is as close as possible to similar codecs.
7ebf5927 61 */
de6d9b64 62enum CodecID {
115329f1 63 CODEC_ID_NONE,
ba0dabbf
DB
64
65 /* video codecs */
de6d9b64 66 CODEC_ID_MPEG1VIDEO,
0e373b95 67 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
fb364ada 68 CODEC_ID_MPEG2VIDEO_XVMC,
c6148de2 69 CODEC_ID_H261,
de6d9b64
FB
70 CODEC_ID_H263,
71 CODEC_ID_RV10,
68b94c35 72 CODEC_ID_RV20,
de6d9b64 73 CODEC_ID_MJPEG,
b135d9fb 74 CODEC_ID_MJPEGB,
b1e6b355 75 CODEC_ID_LJPEG,
5e83dec4 76 CODEC_ID_SP5X,
5639729b 77 CODEC_ID_JPEGLS,
bf89e6b1 78 CODEC_ID_MPEG4,
de6d9b64 79 CODEC_ID_RAWVIDEO,
84afee34
MN
80 CODEC_ID_MSMPEG4V1,
81 CODEC_ID_MSMPEG4V2,
82 CODEC_ID_MSMPEG4V3,
e1a9dbff 83 CODEC_ID_WMV1,
b50eef3a 84 CODEC_ID_WMV2,
de6d9b64
FB
85 CODEC_ID_H263P,
86 CODEC_ID_H263I,
d4f5d74a 87 CODEC_ID_FLV1,
be8ffec9 88 CODEC_ID_SVQ1,
8b82a956 89 CODEC_ID_SVQ3,
020fcc94 90 CODEC_ID_DVVIDEO,
11f18faf 91 CODEC_ID_HUFFYUV,
f70f7c6d 92 CODEC_ID_CYUV,
0da71265 93 CODEC_ID_H264,
deabd4fd 94 CODEC_ID_INDEO3,
d86053a4 95 CODEC_ID_VP3,
f44ee2c3 96 CODEC_ID_THEORA,
3d2e8cce 97 CODEC_ID_ASV1,
9b56edf5 98 CODEC_ID_ASV2,
5e20f836 99 CODEC_ID_FFV1,
e2a7bb28 100 CODEC_ID_4XM,
be3564ed 101 CODEC_ID_VCR1,
3aff069b 102 CODEC_ID_CLJR,
c3bf0288 103 CODEC_ID_MDEC,
3ef8be2b
MM
104 CODEC_ID_ROQ,
105 CODEC_ID_INTERPLAY_VIDEO,
9937e686
MM
106 CODEC_ID_XAN_WC3,
107 CODEC_ID_XAN_WC4,
2fdf638b
MM
108 CODEC_ID_RPZA,
109 CODEC_ID_CINEPAK,
110 CODEC_ID_WS_VQA,
111 CODEC_ID_MSRLE,
112 CODEC_ID_MSVIDEO1,
4120a53a 113 CODEC_ID_IDCIN,
1dc1ed99 114 CODEC_ID_8BPS,
11e29a41 115 CODEC_ID_SMC,
42cad81a 116 CODEC_ID_FLIC,
9a4117d5 117 CODEC_ID_TRUEMOTION1,
fafa0b75 118 CODEC_ID_VMDVIDEO,
a273bbfb
RT
119 CODEC_ID_MSZH,
120 CODEC_ID_ZLIB,
070ed1bc 121 CODEC_ID_QTRLE,
791e7b83 122 CODEC_ID_SNOW,
9d53d58e 123 CODEC_ID_TSCC,
d0a0bbd2 124 CODEC_ID_ULTI,
d08d7142 125 CODEC_ID_QDRAW,
ab711b3c 126 CODEC_ID_VIXL,
acfd8f0f 127 CODEC_ID_QPEG,
17179d2d
MN
128 CODEC_ID_XVID,
129 CODEC_ID_PNG,
130 CODEC_ID_PPM,
131 CODEC_ID_PBM,
132 CODEC_ID_PGM,
133 CODEC_ID_PGMYUV,
134 CODEC_ID_PAM,
f37b9768 135 CODEC_ID_FFVHUFF,
3f05305d
MN
136 CODEC_ID_RV30,
137 CODEC_ID_RV40,
10b9c374 138 CODEC_ID_VC1,
21aa398f 139 CODEC_ID_WMV3,
9c7fb608 140 CODEC_ID_LOCO,
a8a15e9d 141 CODEC_ID_WNV1,
589f8220 142 CODEC_ID_AASC,
856dbbff 143 CODEC_ID_INDEO2,
b81f8949 144 CODEC_ID_FRAPS,
64af6168 145 CODEC_ID_TRUEMOTION2,
9fa62f2a 146 CODEC_ID_BMP,
e0f80bd7 147 CODEC_ID_CSCD,
4e114829 148 CODEC_ID_MMVIDEO,
9c8d8e84 149 CODEC_ID_ZMBV,
26376701 150 CODEC_ID_AVS,
348efc18 151 CODEC_ID_SMACKVIDEO,
dfca23e3 152 CODEC_ID_NUV,
fd7b1991 153 CODEC_ID_KMVC,
0919e788 154 CODEC_ID_FLASHSV,
20ffddb9 155 CODEC_ID_CAVS,
f31065f6 156 CODEC_ID_JPEG2000,
eb57c889 157 CODEC_ID_VMNC,
5ce117c3
AJ
158 CODEC_ID_VP5,
159 CODEC_ID_VP6,
160 CODEC_ID_VP6F,
3689cf16 161 CODEC_ID_TARGA,
72450e50 162 CODEC_ID_DSICINVIDEO,
29f86228 163 CODEC_ID_TIERTEXSEQVIDEO,
a991b1fe 164 CODEC_ID_TIFF,
06d392a7 165 CODEC_ID_GIF,
3edeab82 166 CODEC_ID_FFH264,
33a0dd37 167 CODEC_ID_DXA,
52b6bad2 168 CODEC_ID_DNXHD,
efb0c399 169 CODEC_ID_THP,
2d99eed1 170 CODEC_ID_SGI,
9a0ddd09 171 CODEC_ID_C93,
1e6c6759 172 CODEC_ID_BETHSOFTVID,
b46d68c6 173 CODEC_ID_PTX,
1ca779e7 174 CODEC_ID_TXD,
91fc2cf1 175 CODEC_ID_VP6A,
8787d837 176 CODEC_ID_AMV,
66f7679c 177 CODEC_ID_VB,
b4abe1d1 178 CODEC_ID_PCX,
d43df959 179 CODEC_ID_SUNRAST,
800b9c24
BL
180 CODEC_ID_INDEO4,
181 CODEC_ID_INDEO5,
a7129de5 182 CODEC_ID_MIMIC,
975cdc8f 183 CODEC_ID_RL2,
cb21e0a7
JM
184 CODEC_ID_8SVX_EXP,
185 CODEC_ID_8SVX_FIB,
40d26273 186 CODEC_ID_ESCAPE124,
782a58ec 187 CODEC_ID_DIRAC,
b64c096b 188 CODEC_ID_BFI,
495900f7 189 CODEC_ID_CMV,
974e0eee 190 CODEC_ID_MOTIONPIXELS,
cfc78718 191 CODEC_ID_TGV,
42b30357 192 CODEC_ID_TGQ,
d8964f3a 193 CODEC_ID_TQI,
c21fbefb
KS
194 CODEC_ID_AURA,
195 CODEC_ID_AURA2,
97f92143 196 CODEC_ID_V210X,
a1fd2bc3 197 CODEC_ID_TMV,
ca0bb1c4 198 CODEC_ID_V210,
94d3d6a4 199 CODEC_ID_DPX,
c63ea92b 200 CODEC_ID_MAD,
d8b35b85 201 CODEC_ID_FRWU,
0aa6a518 202 CODEC_ID_FLASHSV2,
a96b68b7 203
f5bccd85 204 /* various PCM "codecs" */
17179d2d 205 CODEC_ID_PCM_S16LE= 0x10000,
a96b68b7
FB
206 CODEC_ID_PCM_S16BE,
207 CODEC_ID_PCM_U16LE,
208 CODEC_ID_PCM_U16BE,
209 CODEC_ID_PCM_S8,
210 CODEC_ID_PCM_U8,
211 CODEC_ID_PCM_MULAW,
212 CODEC_ID_PCM_ALAW,
b461b3bc
RD
213 CODEC_ID_PCM_S32LE,
214 CODEC_ID_PCM_S32BE,
215 CODEC_ID_PCM_U32LE,
216 CODEC_ID_PCM_U32BE,
217 CODEC_ID_PCM_S24LE,
218 CODEC_ID_PCM_S24BE,
219 CODEC_ID_PCM_U24LE,
220 CODEC_ID_PCM_U24BE,
221 CODEC_ID_PCM_S24DAUD,
a11c2a2c 222 CODEC_ID_PCM_ZORK,
725d86bf 223 CODEC_ID_PCM_S16LE_PLANAR,
1472b7dd 224 CODEC_ID_PCM_DVD,
aa29709e 225 CODEC_ID_PCM_F32BE,
143a5d6f
PR
226 CODEC_ID_PCM_F32LE,
227 CODEC_ID_PCM_F64BE,
228 CODEC_ID_PCM_F64LE,
5dd3707b 229 CODEC_ID_PCM_BLURAY,
0147f198 230
f5bccd85 231 /* various ADPCM codecs */
17179d2d 232 CODEC_ID_ADPCM_IMA_QT= 0x11000,
0147f198 233 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
234 CODEC_ID_ADPCM_IMA_DK3,
235 CODEC_ID_ADPCM_IMA_DK4,
2fdf638b 236 CODEC_ID_ADPCM_IMA_WS,
7d8379f2 237 CODEC_ID_ADPCM_IMA_SMJPEG,
0147f198 238 CODEC_ID_ADPCM_MS,
e2a7bb28 239 CODEC_ID_ADPCM_4XM,
fc384777
MM
240 CODEC_ID_ADPCM_XA,
241 CODEC_ID_ADPCM_ADX,
7d8379f2 242 CODEC_ID_ADPCM_EA,
e5966052 243 CODEC_ID_ADPCM_G726,
b3bfb299 244 CODEC_ID_ADPCM_CT,
659c3692 245 CODEC_ID_ADPCM_SWF,
2ff4524e 246 CODEC_ID_ADPCM_YAMAHA,
2433f24f
AJ
247 CODEC_ID_ADPCM_SBPRO_4,
248 CODEC_ID_ADPCM_SBPRO_3,
249 CODEC_ID_ADPCM_SBPRO_2,
d1e0d21f 250 CODEC_ID_ADPCM_THP,
3a7f5d07 251 CODEC_ID_ADPCM_IMA_AMV,
e7583962
PR
252 CODEC_ID_ADPCM_EA_R1,
253 CODEC_ID_ADPCM_EA_R3,
254 CODEC_ID_ADPCM_EA_R2,
7bb65d89 255 CODEC_ID_ADPCM_IMA_EA_SEAD,
fac84d3c 256 CODEC_ID_ADPCM_IMA_EA_EACS,
271b4095 257 CODEC_ID_ADPCM_EA_XAS,
861c63a2 258 CODEC_ID_ADPCM_EA_MAXIS_XA,
055dc116 259 CODEC_ID_ADPCM_IMA_ISS,
891f64b3 260
17179d2d
MN
261 /* AMR */
262 CODEC_ID_AMR_NB= 0x12000,
d663a1fd
MN
263 CODEC_ID_AMR_WB,
264
b8414bbd 265 /* RealAudio codecs*/
17179d2d 266 CODEC_ID_RA_144= 0x13000,
b8414bbd 267 CODEC_ID_RA_288,
3ef8be2b
MM
268
269 /* various DPCM codecs */
17179d2d 270 CODEC_ID_ROQ_DPCM= 0x14000,
3ef8be2b 271 CODEC_ID_INTERPLAY_DPCM,
9937e686 272 CODEC_ID_XAN_DPCM,
d08d7142 273 CODEC_ID_SOL_DPCM,
115329f1 274
ba0dabbf 275 /* audio codecs */
17179d2d 276 CODEC_ID_MP2= 0x15000,
0e373b95 277 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
17179d2d 278 CODEC_ID_AAC,
17179d2d
MN
279 CODEC_ID_AC3,
280 CODEC_ID_DTS,
281 CODEC_ID_VORBIS,
282 CODEC_ID_DVAUDIO,
283 CODEC_ID_WMAV1,
284 CODEC_ID_WMAV2,
285 CODEC_ID_MACE3,
286 CODEC_ID_MACE6,
287 CODEC_ID_VMDAUDIO,
288 CODEC_ID_SONIC,
289 CODEC_ID_SONIC_LS,
ac2570a8 290 CODEC_ID_FLAC,
1ede228a 291 CODEC_ID_MP3ADU,
d2a7718d 292 CODEC_ID_MP3ON4,
85ad5695 293 CODEC_ID_SHORTEN,
5df8a0c6 294 CODEC_ID_ALAC,
034eeaa1 295 CODEC_ID_WESTWOOD_SND1,
0e373b95 296 CODEC_ID_GSM, ///< as in Berlin toast format
d9b1c197 297 CODEC_ID_QDM2,
e0f7e329 298 CODEC_ID_COOK,
bf3027c8 299 CODEC_ID_TRUESPEECH,
a24c4a2a 300 CODEC_ID_TTA,
348efc18 301 CODEC_ID_SMACKAUDIO,
6c496518 302 CODEC_ID_QCELP,
730581f3 303 CODEC_ID_WAVPACK,
72450e50 304 CODEC_ID_DSICINAUDIO,
84ed36da 305 CODEC_ID_IMC,
185c7b6b 306 CODEC_ID_MUSEPACK7,
aad512b4 307 CODEC_ID_MLP,
f5bccd85 308 CODEC_ID_GSM_MS, /* as found in WAV */
10e26bc7 309 CODEC_ID_ATRAC3,
8950f828 310 CODEC_ID_VOXWARE,
bf4a1f17 311 CODEC_ID_APE,
636b13c5 312 CODEC_ID_NELLYMOSER,
12877faf 313 CODEC_ID_MUSEPACK8,
cb4ddf77 314 CODEC_ID_SPEEX,
7bb8d51c
BL
315 CODEC_ID_WMAVOICE,
316 CODEC_ID_WMAPRO,
800b9c24 317 CODEC_ID_WMALOSSLESS,
b339f0c6 318 CODEC_ID_ATRAC3P,
2988c93d 319 CODEC_ID_EAC3,
faeedbbb 320 CODEC_ID_SIPR,
7f507b2d 321 CODEC_ID_MP1,
616e899c 322 CODEC_ID_TWINVQ,
9ba4821d 323 CODEC_ID_TRUEHD,
b24bbbb4 324 CODEC_ID_MP4ALS,
223e8df1 325 CODEC_ID_ATRAC1,
115329f1 326
240c1657 327 /* subtitle codecs */
115329f1
DB
328 CODEC_ID_DVD_SUBTITLE= 0x17000,
329 CODEC_ID_DVB_SUBTITLE,
0e373b95 330 CODEC_ID_TEXT, ///< raw UTF-8 text
7e2643ae 331 CODEC_ID_XSUB,
f9a9b350 332 CODEC_ID_SSA,
cc8c2c6a 333 CODEC_ID_MOV_TEXT,
c58b82a2 334 CODEC_ID_HDMV_PGS_SUBTITLE,
e58992e4 335 CODEC_ID_DVB_TELETEXT,
115329f1 336
7ce68923 337 /* other specific kind of codecs (generally used for attachments) */
f8d7c9d3
ES
338 CODEC_ID_TTF= 0x18000,
339
0bef08e5
MN
340 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
341
0e373b95 342 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
f5bccd85 343 * stream (only used by libavformat) */
de6d9b64 344};
dcedf586 345
de6d9b64 346enum CodecType {
4a663d80 347 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
348 CODEC_TYPE_VIDEO,
349 CODEC_TYPE_AUDIO,
985180a1 350 CODEC_TYPE_DATA,
240c1657 351 CODEC_TYPE_SUBTITLE,
f8d7c9d3 352 CODEC_TYPE_ATTACHMENT,
9ff77d17 353 CODEC_TYPE_NB
de6d9b64
FB
354};
355
0e373b95 356/**
0e373b95
MN
357 * all in native-endian format
358 */
a96b68b7 359enum SampleFormat {
9076fee4 360 SAMPLE_FMT_NONE = -1,
1319a77b
AB
361 SAMPLE_FMT_U8, ///< unsigned 8 bits
362 SAMPLE_FMT_S16, ///< signed 16 bits
115329f1 363 SAMPLE_FMT_S32, ///< signed 32 bits
a3a5f4d6 364 SAMPLE_FMT_FLT, ///< float
e06b00f3 365 SAMPLE_FMT_DBL, ///< double
88a07af7 366 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
a96b68b7
FB
367};
368
0d72e7d0 369/* Audio channel masks */
9d9b9d32
370#define CH_FRONT_LEFT 0x00000001
371#define CH_FRONT_RIGHT 0x00000002
372#define CH_FRONT_CENTER 0x00000004
373#define CH_LOW_FREQUENCY 0x00000008
374#define CH_BACK_LEFT 0x00000010
375#define CH_BACK_RIGHT 0x00000020
376#define CH_FRONT_LEFT_OF_CENTER 0x00000040
377#define CH_FRONT_RIGHT_OF_CENTER 0x00000080
378#define CH_BACK_CENTER 0x00000100
379#define CH_SIDE_LEFT 0x00000200
380#define CH_SIDE_RIGHT 0x00000400
381#define CH_TOP_CENTER 0x00000800
382#define CH_TOP_FRONT_LEFT 0x00001000
383#define CH_TOP_FRONT_CENTER 0x00002000
384#define CH_TOP_FRONT_RIGHT 0x00004000
385#define CH_TOP_BACK_LEFT 0x00008000
386#define CH_TOP_BACK_CENTER 0x00010000
387#define CH_TOP_BACK_RIGHT 0x00020000
388#define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
389#define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
0d72e7d0 390
31557166
JR
391/** Channel mask value used for AVCodecContext.request_channel_layout
392 to indicate that the user requests the channel order of the decoder output
393 to be the native codec channel order. */
394#define CH_LAYOUT_NATIVE 0x8000000000000000LL
395
0d72e7d0 396/* Audio channel convenience macros */
9d9b9d32
397#define CH_LAYOUT_MONO (CH_FRONT_CENTER)
398#define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
1b7bc4a2 399#define CH_LAYOUT_2_1 (CH_LAYOUT_STEREO|CH_BACK_CENTER)
9d9b9d32 400#define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
1b7bc4a2
JR
401#define CH_LAYOUT_4POINT0 (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
402#define CH_LAYOUT_2_2 (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
9d9b9d32
403#define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
404#define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
405#define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
8613af0a
JR
406#define CH_LAYOUT_5POINT0_BACK (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
407#define CH_LAYOUT_5POINT1_BACK (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
5dd3707b 408#define CH_LAYOUT_7POINT0 (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
9d9b9d32 409#define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
8613af0a 410#define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_5POINT1_BACK|\
9d9b9d32
411 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
412#define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
0d72e7d0 413
de6d9b64 414/* in bytes */
8170e5fb 415#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
de6d9b64 416
d7425f59 417/**
cf713bb8 418 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
f5bccd85
DB
419 * This is mainly needed because some optimized bitstream readers read
420 * 32 or 64 bit at once and could read over the end.<br>
421 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
422 * MPEG bitstreams could cause overread and segfault.
d7425f59
MN
423 */
424#define FF_INPUT_BUFFER_PADDING_SIZE 8
425
0ecca7a4 426/**
f5bccd85
DB
427 * minimum encoding buffer size
428 * Used to avoid some checks during header writing.
0ecca7a4
MN
429 */
430#define FF_MIN_BUFFER_SIZE 16384
431
47146dfb 432
0e373b95 433/**
bafc102b 434 * motion estimation type.
0e373b95 435 */
e4986da9 436enum Motion_Est_ID {
9b4dd1b8 437 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
e4986da9
J
438 ME_FULL,
439 ME_LOG,
440 ME_PHODS,
9b4dd1b8
MN
441 ME_EPZS, ///< enhanced predictive zonal search
442 ME_X1, ///< reserved for experiments
443 ME_HEX, ///< hexagon based search
444 ME_UMH, ///< uneven multi-hexagon search
445 ME_ITER, ///< iterative search
359bbdab 446 ME_TESA, ///< transformed exhaustive search algorithm
e4986da9
J
447};
448
8c3eba7c 449enum AVDiscard{
f5bccd85
DB
450 /* We leave some space between them for extensions (drop some
451 * keyframes for intra-only or drop just some bidir frames). */
8c3eba7c
MN
452 AVDISCARD_NONE =-16, ///< discard nothing
453 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
454 AVDISCARD_NONREF = 8, ///< discard all non reference
455 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
456 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
457 AVDISCARD_ALL = 48, ///< discard all
458};
459
4ee6a5c1
MN
460enum AVColorPrimaries{
461 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
462 AVCOL_PRI_UNSPECIFIED=2,
463 AVCOL_PRI_BT470M =4,
464 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
465 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
466 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
467 AVCOL_PRI_FILM =8,
468 AVCOL_PRI_NB , ///< Not part of ABI
469};
470
471enum AVColorTransferCharacteristic{
472 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
473 AVCOL_TRC_UNSPECIFIED=2,
474 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
475 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
476 AVCOL_TRC_NB , ///< Not part of ABI
477};
478
479enum AVColorSpace{
480 AVCOL_SPC_RGB =0,
481 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
482 AVCOL_SPC_UNSPECIFIED=2,
483 AVCOL_SPC_FCC =4,
484 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
485 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
486 AVCOL_SPC_SMPTE240M =7,
487 AVCOL_SPC_NB , ///< Not part of ABI
488};
489
490enum AVColorRange{
491 AVCOL_RANGE_UNSPECIFIED=0,
492 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
493 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
494 AVCOL_RANGE_NB , ///< Not part of ABI
495};
496
580a7465
DC
497/**
498 * X X 3 4 X X are luma samples,
499 * 1 2 1-6 are possible chroma positions
500 * X X 5 6 X 0 is undefined/unknown position
501 */
502enum AVChromaLocation{
503 AVCHROMA_LOC_UNSPECIFIED=0,
504 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
505 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
506 AVCHROMA_LOC_TOPLEFT =3, ///< DV
507 AVCHROMA_LOC_TOP =4,
508 AVCHROMA_LOC_BOTTOMLEFT =5,
509 AVCHROMA_LOC_BOTTOM =6,
510 AVCHROMA_LOC_NB , ///< Not part of ABI
511};
512
ce980a95
MN
513typedef struct RcOverride{
514 int start_frame;
515 int end_frame;
f5bccd85 516 int qscale; // If this is 0 then quality_factor will be used instead.
ce980a95
MN
517 float quality_factor;
518} RcOverride;
519
b0ec9efd 520#define FF_MAX_B_FRAMES 16
9dbcbd92 521
a949d72e 522/* encoding support
f5bccd85
DB
523 These flags can be passed in AVCodecContext.flags before initialization.
524 Note: Not everything is supported yet.
a949d72e 525*/
de6d9b64 526
f5bccd85
DB
527#define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
528#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
529#define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
530#define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
531#define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
532#define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
1ba8f5eb
MN
533/**
534 * The parent program guarantees that the input for B-frames containing
f5bccd85 535 * streams is not written to for at least s->max_b_frames+1 frames, if
1ba8f5eb
MN
536 * this is not set the input will be copied.
537 */
8b4c7dbc 538#define CODEC_FLAG_INPUT_PRESERVED 0x0100
273b0cd3
DB
539#define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
540#define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
541#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
542#define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
543#define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
544#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
545#define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
546 location instead of only at frame boundaries. */
f5bccd85
DB
547#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
548#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
549#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
550#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
f5bccd85
DB
551#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
552#define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
21e59552 553/* Fx : Flag for h263+ extra options */
f5bccd85
DB
554#define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
555#define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
556#define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
557#define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
558#define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
332f9ac4
MN
559#define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
560#define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
bb198e19
MN
561#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
562#define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
f5bccd85 563#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
f3eec1cf 564#define CODEC_FLAG_CLOSED_GOP 0x80000000
f5bccd85
DB
565#define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
566#define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
567#define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
568#define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
569#define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
570#define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
d3075ed5 571#define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
58f7833e
RS
572#define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
573#define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
574#define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
f5bccd85
DB
575#define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
576#define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
577#define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
578#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
579#define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
580#define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
581#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
f1618fd9 582#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
6fc5b059 583
21e59552 584/* Unsupported options :
bb270c08
DB
585 * Syntax Arithmetic coding (SAC)
586 * Reference Picture Selection
eafcac6a 587 * Independent Segment Decoding */
21e59552 588/* /Fx */
bf89e6b1
FB
589/* codec capabilities */
590
f5bccd85 591#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
6814a25c
MN
592/**
593 * Codec uses get_buffer() for allocating buffers.
594 * direct rendering method 1
595 */
596#define CODEC_CAP_DR1 0x0002
f5bccd85 597/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
917e06c8 598#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 599#define CODEC_CAP_TRUNCATED 0x0008
f5bccd85 600/* Codec can export data for HW decoding (XvMC). */
5e5c247a 601#define CODEC_CAP_HWACCEL 0x0010
115329f1 602/**
f5bccd85
DB
603 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
604 * If this is not set, the codec is guaranteed to never be fed with NULL data.
934982c4 605 */
6f824977 606#define CODEC_CAP_DELAY 0x0020
cef7cc72
JR
607/**
608 * Codec can be fed a final frame with a smaller size.
609 * This can be used to prevent truncation of the last audio samples.
610 */
611#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
369122dd
NC
612/**
613 * Codec can export data for HW decoding (VDPAU).
614 */
615#define CODEC_CAP_HWACCEL_VDPAU 0x0080
d859bb1d
SS
616/**
617 * Codec can output multiple frames per AVPacket
618 */
619#define CODEC_CAP_SUBFRAMES 0x0100
bf89e6b1 620
f5bccd85 621//The following defines may change, don't expect compatibility if you use them.
8d7ec294 622#define MB_TYPE_INTRA4x4 0x0001
f5bccd85
DB
623#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
624#define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
8d7ec294
WH
625#define MB_TYPE_16x16 0x0008
626#define MB_TYPE_16x8 0x0010
627#define MB_TYPE_8x16 0x0020
628#define MB_TYPE_8x8 0x0040
629#define MB_TYPE_INTERLACED 0x0080
273b0cd3 630#define MB_TYPE_DIRECT2 0x0100 //FIXME
8d7ec294
WH
631#define MB_TYPE_ACPRED 0x0200
632#define MB_TYPE_GMC 0x0400
633#define MB_TYPE_SKIP 0x0800
634#define MB_TYPE_P0L0 0x1000
635#define MB_TYPE_P1L0 0x2000
636#define MB_TYPE_P0L1 0x4000
637#define MB_TYPE_P1L1 0x8000
638#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
639#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
640#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
641#define MB_TYPE_QUANT 0x00010000
642#define MB_TYPE_CBP 0x00020000
643//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
644
fa384dcc
MN
645/**
646 * Pan Scan area.
f5bccd85
DB
647 * This specifies the area which should be displayed.
648 * Note there may be multiple such areas for one frame.
fa384dcc
MN
649 */
650typedef struct AVPanScan{
651 /**
f5bccd85
DB
652 * id
653 * - encoding: Set by user.
654 * - decoding: Set by libavcodec.
fa384dcc
MN
655 */
656 int id;
657
658 /**
659 * width and height in 1/16 pel
f5bccd85
DB
660 * - encoding: Set by user.
661 * - decoding: Set by libavcodec.
fa384dcc
MN
662 */
663 int width;
664 int height;
665
666 /**
f5bccd85
DB
667 * position of the top left corner in 1/16 pel for up to 3 fields/frames
668 * - encoding: Set by user.
669 * - decoding: Set by libavcodec.
fa384dcc
MN
670 */
671 int16_t position[3][2];
672}AVPanScan;
673
492cd3a9 674#define FF_COMMON_FRAME \
b536d0aa
MN
675 /**\
676 * pointer to the picture planes.\
f5bccd85 677 * This might be different from the first allocated byte\
b536d0aa
MN
678 * - encoding: \
679 * - decoding: \
680 */\
1e491e29
MN
681 uint8_t *data[4];\
682 int linesize[4];\
683 /**\
f5bccd85
DB
684 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
685 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
64863965
MN
686 * - encoding: \
687 * - decoding: \
1e491e29
MN
688 */\
689 uint8_t *base[4];\
690 /**\
691 * 1 -> keyframe, 0-> not\
f5bccd85
DB
692 * - encoding: Set by libavcodec.\
693 * - decoding: Set by libavcodec.\
1e491e29
MN
694 */\
695 int key_frame;\
696\
697 /**\
f5bccd85
DB
698 * Picture type of the frame, see ?_TYPE below.\
699 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
700 * - decoding: Set by libavcodec.\
1e491e29
MN
701 */\
702 int pict_type;\
703\
704 /**\
c0df9d75 705 * presentation timestamp in time_base units (time when frame should be shown to user)\
f5bccd85
DB
706 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
707 * - encoding: MUST be set by user.\
708 * - decoding: Set by libavcodec.\
1e491e29 709 */\
be6784dc 710 int64_t pts;\
1e491e29
MN
711\
712 /**\
f5bccd85 713 * picture number in bitstream order\
64863965 714 * - encoding: set by\
f5bccd85 715 * - decoding: Set by libavcodec.\
1e491e29
MN
716 */\
717 int coded_picture_number;\
718 /**\
f5bccd85 719 * picture number in display order\
64863965 720 * - encoding: set by\
f5bccd85 721 * - decoding: Set by libavcodec.\
1e491e29
MN
722 */\
723 int display_picture_number;\
724\
725 /**\
158c7f05 726 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
f5bccd85
DB
727 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
728 * - decoding: Set by libavcodec.\
1e491e29 729 */\
158c7f05 730 int quality; \
1e491e29
MN
731\
732 /**\
733 * buffer age (1->was last buffer and dint change, 2->..., ...).\
f5bccd85 734 * Set to INT_MAX if the buffer has not been used yet.\
64863965 735 * - encoding: unused\
f5bccd85 736 * - decoding: MUST be set by get_buffer().\
1e491e29
MN
737 */\
738 int age;\
739\
740 /**\
741 * is this picture used as reference\
8474f58e
MN
742 * The values for this are the same as the MpegEncContext.picture_structure\
743 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
5fe2a515 744 * Set to 4 for delayed, non-reference frames.\
64863965 745 * - encoding: unused\
f5bccd85 746 * - decoding: Set by libavcodec. (before get_buffer() call)).\
1e491e29
MN
747 */\
748 int reference;\
749\
750 /**\
751 * QP table\
64863965 752 * - encoding: unused\
f5bccd85 753 * - decoding: Set by libavcodec.\
1e491e29
MN
754 */\
755 int8_t *qscale_table;\
756 /**\
757 * QP store stride\
64863965 758 * - encoding: unused\
f5bccd85 759 * - decoding: Set by libavcodec.\
1e491e29
MN
760 */\
761 int qstride;\
762\
763 /**\
f5bccd85 764 * mbskip_table[mb]>=1 if MB didn't change\
1e491e29 765 * stride= mb_width = (width+15)>>4\
64863965 766 * - encoding: unused\
f5bccd85 767 * - decoding: Set by libavcodec.\
1e491e29
MN
768 */\
769 uint8_t *mbskip_table;\
770\
771 /**\
f5bccd85 772 * motion vector table\
61436073
MN
773 * @code\
774 * example:\
775 * int mv_sample_log2= 4 - motion_subsample_log2;\
776 * int mb_width= (width+15)>>4;\
777 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
778 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
779 * @endcode\
f5bccd85
DB
780 * - encoding: Set by user.\
781 * - decoding: Set by libavcodec.\
8d7ec294
WH
782 */\
783 int16_t (*motion_val[2])[2];\
784\
785 /**\
f5bccd85 786 * macroblock type table\
8d7ec294 787 * mb_type_base + mb_width + 2\
f5bccd85
DB
788 * - encoding: Set by user.\
789 * - decoding: Set by libavcodec.\
8d7ec294
WH
790 */\
791 uint32_t *mb_type;\
792\
793 /**\
f0b77c69
MN
794 * log2 of the size of the block which a single vector in motion_val represents: \
795 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
8d7ec294 796 * - encoding: unused\
f5bccd85 797 * - decoding: Set by libavcodec.\
8d7ec294
WH
798 */\
799 uint8_t motion_subsample_log2;\
800\
801 /**\
1e491e29 802 * for some private data of the user\
64863965 803 * - encoding: unused\
f5bccd85 804 * - decoding: Set by user.\
1e491e29
MN
805 */\
806 void *opaque;\
140cb663
MN
807\
808 /**\
809 * error\
f5bccd85 810 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
64863965 811 * - decoding: unused\
140cb663
MN
812 */\
813 uint64_t error[4];\
4e00e76b
MN
814\
815 /**\
f5bccd85
DB
816 * type of the buffer (to keep track of who has to deallocate data[*])\
817 * - encoding: Set by the one who allocates it.\
818 * - decoding: Set by the one who allocates it.\
819 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
4e00e76b
MN
820 */\
821 int type;\
2ec23b6d
MN
822 \
823 /**\
f5bccd85 824 * When decoding, this signals how much the picture must be delayed.\
2ec23b6d 825 * extra_delay = repeat_pict / (2*fps)\
64863965 826 * - encoding: unused\
f5bccd85 827 * - decoding: Set by libavcodec.\
2ec23b6d 828 */\
0426af31
MN
829 int repeat_pict;\
830 \
831 /**\
832 * \
833 */\
834 int qscale_type;\
2744ca9a
RS
835 \
836 /**\
837 * The content of the picture is interlaced.\
f5bccd85
DB
838 * - encoding: Set by user.\
839 * - decoding: Set by libavcodec. (default 0)\
2744ca9a
RS
840 */\
841 int interlaced_frame;\
842 \
843 /**\
f5bccd85
DB
844 * If the content is interlaced, is top field displayed first.\
845 * - encoding: Set by user.\
846 * - decoding: Set by libavcodec.\
2744ca9a 847 */\
9dad924e 848 int top_field_first;\
fa384dcc
MN
849 \
850 /**\
851 * Pan scan.\
f5bccd85
DB
852 * - encoding: Set by user.\
853 * - decoding: Set by libavcodec.\
fa384dcc
MN
854 */\
855 AVPanScan *pan_scan;\
2a2bbcb0
MM
856 \
857 /**\
f5bccd85 858 * Tell user application that palette has changed from previous frame.\
2a2bbcb0 859 * - encoding: ??? (no palette-enabled encoder yet)\
f5bccd85 860 * - decoding: Set by libavcodec. (default 0).\
2a2bbcb0
MM
861 */\
862 int palette_has_changed;\
074c4ca7
RT
863 \
864 /**\
f5bccd85 865 * codec suggestion on buffer type if != 0\
074c4ca7 866 * - encoding: unused\
f5bccd85 867 * - decoding: Set by libavcodec. (before get_buffer() call)).\
074c4ca7
RT
868 */\
869 int buffer_hints;\
8289c6fa
WH
870\
871 /**\
f5bccd85 872 * DCT coefficients\
8289c6fa 873 * - encoding: unused\
f5bccd85 874 * - decoding: Set by libavcodec.\
8289c6fa
WH
875 */\
876 short *dct_coeff;\
a4d36c11
MN
877\
878 /**\
f5bccd85
DB
879 * motion referece frame index\
880 * - encoding: Set by user.\
881 * - decoding: Set by libavcodec.\
a4d36c11 882 */\
79de84f2
MN
883 int8_t *ref_index[2];\
884\
885 /**\
886 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
887 * output in AVFrame.reordered_opaque\
888 * - encoding: unused\
889 * - decoding: Read by user.\
890 */\
891 int64_t reordered_opaque;\
68e5d523
GB
892\
893 /**\
894 * hardware accelerator private data (FFmpeg allocated)\
895 * - encoding: unused\
896 * - decoding: Set by libavcodec\
897 */\
952e2083 898 void *hwaccel_picture_private;\
79de84f2 899
2ec23b6d 900
bb270c08
DB
901#define FF_QSCALE_TYPE_MPEG1 0
902#define FF_QSCALE_TYPE_MPEG2 1
903#define FF_QSCALE_TYPE_H264 2
4e00e76b
MN
904
905#define FF_BUFFER_TYPE_INTERNAL 1
f5bccd85
DB
906#define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
907#define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
908#define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
4e00e76b 909
1e491e29 910
dc85e859
AJ
911#define FF_I_TYPE 1 ///< Intra
912#define FF_P_TYPE 2 ///< Predicted
913#define FF_B_TYPE 3 ///< Bi-dir predicted
914#define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
915#define FF_SI_TYPE 5 ///< Switching Intra
916#define FF_SP_TYPE 6 ///< Switching Predicted
48d533e6 917#define FF_BI_TYPE 7
1e491e29 918
f5bccd85
DB
919#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
920#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
921#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
922#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
074c4ca7 923
18c915ee
TB
924typedef struct AVPacket {
925 /**
7b356d39
RS
926 * Presentation timestamp in AVStream->time_base units; the time at which
927 * the decompressed packet will be presented to the user.
18c915ee
TB
928 * Can be AV_NOPTS_VALUE if it is not stored in the file.
929 * pts MUST be larger or equal to dts as presentation cannot happen before
930 * decompression, unless one wants to view hex dumps. Some formats misuse
931 * the terms dts and pts/cts to mean something different. Such timestamps
932 * must be converted to true pts/dts before they are stored in AVPacket.
933 */
934 int64_t pts;
935 /**
7b356d39
RS
936 * Decompression timestamp in AVStream->time_base units; the time at which
937 * the packet is decompressed.
18c915ee
TB
938 * Can be AV_NOPTS_VALUE if it is not stored in the file.
939 */
940 int64_t dts;
941 uint8_t *data;
942 int size;
943 int stream_index;
944 int flags;
945 /**
7b356d39 946 * Duration of this packet in AVStream->time_base units, 0 if unknown.
18c915ee
TB
947 * Equals next_pts - this_pts in presentation order.
948 */
949 int duration;
950 void (*destruct)(struct AVPacket *);
951 void *priv;
952 int64_t pos; ///< byte position in stream, -1 if unknown
953
954 /**
7b356d39 955 * Time difference in AVStream->time_base units from the pts of this
18c915ee
TB
956 * packet to the point at which the output from the decoder has converged
957 * independent from the availability of previous frames. That is, the
958 * frames are virtually identical no matter if decoding started from
959 * the very first frame or from this keyframe.
960 * Is AV_NOPTS_VALUE if unknown.
961 * This field is not the display duration of the current packet.
962 *
963 * The purpose of this field is to allow seeking in streams that have no
964 * keyframes in the conventional sense. It corresponds to the
965 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
966 * essential for some types of subtitle streams to ensure that all
967 * subtitles are correctly displayed after seeking.
968 */
969 int64_t convergence_duration;
970} AVPacket;
8f3f2e06
RD
971#define AV_PKT_FLAG_KEY 0x0001
972#if LIBAVCODEC_VERSION_MAJOR < 53
973#define PKT_FLAG_KEY AV_PKT_FLAG_KEY
974#endif
18c915ee 975
0da71265
MN
976/**
977 * Audio Video Frame.
ba66ae94
MN
978 * New fields can be added to the end of FF_COMMON_FRAME with minor version
979 * bumps.
8bfb108b 980 * Removal, reordering and changes to existing fields require a major
ba66ae94
MN
981 * version bump. No fields should be added into AVFrame before or after
982 * FF_COMMON_FRAME!
8bfb108b 983 * sizeof(AVFrame) must not be used outside libav*.
0da71265 984 */
492cd3a9
MN
985typedef struct AVFrame {
986 FF_COMMON_FRAME
987} AVFrame;
1e491e29 988
d33c949c 989/**
252f17e2
MN
990 * main external API structure.
991 * New fields can be added to the end with minor version bumps.
8bfb108b 992 * Removal, reordering and changes to existing fields require a major
252f17e2 993 * version bump.
8bfb108b 994 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 995 */
de6d9b64 996typedef struct AVCodecContext {
b71901e6 997 /**
f5bccd85 998 * information on struct for av_log
bc874dae
MB
999 * - set by avcodec_alloc_context
1000 */
d42a814e 1001 const AVClass *av_class;
bc874dae 1002 /**
f5bccd85
DB
1003 * the average bitrate
1004 * - encoding: Set by user; unused for constant quantizer encoding.
1005 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 1006 */
de6d9b64 1007 int bit_rate;
b71901e6
MN
1008
1009 /**
64863965 1010 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 1011 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 1012 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 1013 * - decoding: unused
b71901e6 1014 */
115329f1 1015 int bit_rate_tolerance;
b71901e6
MN
1016
1017 /**
64863965 1018 * CODEC_FLAG_*.
f5bccd85
DB
1019 * - encoding: Set by user.
1020 * - decoding: Set by user.
b71901e6 1021 */
de6d9b64 1022 int flags;
b71901e6
MN
1023
1024 /**
f5bccd85
DB
1025 * Some codecs need additional format info. It is stored here.
1026 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1027 * specific codec MUST set it correctly otherwise stream copy breaks.
1028 * In general use of this field by muxers is not recommanded.
1029 * - encoding: Set by libavcodec.
1030 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
b71901e6
MN
1031 */
1032 int sub_id;
1033
1034 /**
f5bccd85 1035 * Motion estimation algorithm used for video coding.
58f7833e 1036 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
89223ef6 1037 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
64863965
MN
1038 * - encoding: MUST be set by user.
1039 * - decoding: unused
b71901e6
MN
1040 */
1041 int me_method;
1042
1043 /**
f5bccd85
DB
1044 * some codecs need / can use extradata like Huffman tables.
1045 * mjpeg: Huffman tables
b71901e6 1046 * rv10: additional flags
b704e742 1047 * mpeg4: global headers (they can be in the bitstream or here)
f5bccd85
DB
1048 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1049 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1050 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1051 * - encoding: Set/allocated/freed by libavcodec.
1052 * - decoding: Set/allocated/freed by user.
b71901e6 1053 */
58f2a4b0 1054 uint8_t *extradata;
e84c31dc 1055 int extradata_size;
115329f1 1056
b71901e6 1057 /**
f5bccd85
DB
1058 * This is the fundamental unit of time (in seconds) in terms
1059 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
1060 * timebase should be 1/framerate and timestamp increments should be
1061 * identically 1.
f5bccd85
DB
1062 * - encoding: MUST be set by user.
1063 * - decoding: Set by libavcodec.
b71901e6 1064 */
c0df9d75 1065 AVRational time_base;
115329f1 1066
5b28c8c3 1067 /* video only */
14bea432 1068 /**
21adafec 1069 * picture width / height.
115329f1 1070 * - encoding: MUST be set by user.
f5bccd85
DB
1071 * - decoding: Set by libavcodec.
1072 * Note: For compatibility it is possible to set this instead of
1073 * coded_width/height before decoding.
b71901e6 1074 */
de6d9b64 1075 int width, height;
115329f1 1076
e769f053 1077#define FF_ASPECT_EXTENDED 15
b71901e6
MN
1078
1079 /**
f5bccd85
DB
1080 * the number of pictures in a group of pictures, or 0 for intra_only
1081 * - encoding: Set by user.
64863965 1082 * - decoding: unused
b71901e6
MN
1083 */
1084 int gop_size;
1085
1086 /**
f5bccd85
DB
1087 * Pixel format, see PIX_FMT_xxx.
1088 * - encoding: Set by user.
1089 * - decoding: Set by libavcodec.
b71901e6 1090 */
e4eadb4b 1091 enum PixelFormat pix_fmt;
115329f1 1092
bdfcbbed 1093 /**
f5bccd85 1094 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
bdfcbbed 1095 * has to read frames at native frame rate.
f5bccd85
DB
1096 * - encoding: Set by user.
1097 * - decoding: unused
bdfcbbed
MK
1098 */
1099 int rate_emu;
115329f1 1100
b71901e6 1101 /**
f5bccd85
DB
1102 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1103 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 1104 * all codecs can do that. You must check the codec capabilities
f5bccd85 1105 * beforehand.
24b1583a
IK
1106 * The function is also used by hardware acceleration APIs.
1107 * It is called at least once during frame decoding to pass
1108 * the data needed for hardware render.
1109 * In that mode instead of pixel data, AVFrame points to
1110 * a structure specific to the acceleration API. The application
1111 * reads the structure and can change some fields to indicate progress
1112 * or mark state.
64863965 1113 * - encoding: unused
f5bccd85 1114 * - decoding: Set by user.
3bb07d61
MN
1115 * @param height the height of the slice
1116 * @param y the y position of the slice
1117 * @param type 1->top field, 2->bottom field, 3->frame
1118 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 1119 */
bf89e6b1 1120 void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3 1121 const AVFrame *src, int offset[4],
3bb07d61 1122 int y, int type, int height);
bf89e6b1 1123
de6d9b64 1124 /* audio only */
f5bccd85 1125 int sample_rate; ///< samples per second
5fcc4a23 1126 int channels; ///< number of audio channels
a3a5f4d6
MN
1127
1128 /**
f5bccd85
DB
1129 * audio sample format
1130 * - encoding: Set by user.
1131 * - decoding: Set by libavcodec.
a3a5f4d6 1132 */
ce9dd8f5 1133 enum SampleFormat sample_fmt; ///< sample format
de6d9b64 1134
f5bccd85 1135 /* The following data should not be initialized. */
718b27a7 1136 /**
f5bccd85 1137 * Samples per packet, initialized when calling 'init'.
718b27a7
MN
1138 */
1139 int frame_size;
115329f1 1140 int frame_number; ///< audio or video frame number
c0601d70 1141#if LIBAVCODEC_VERSION_MAJOR < 53
f5bccd85 1142 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
c0601d70 1143#endif
115329f1 1144
b71901e6 1145 /**
f5bccd85 1146 * Number of frames the decoded output will be delayed relative to
64863965 1147 * the encoded input.
f5bccd85 1148 * - encoding: Set by libavcodec.
64863965 1149 * - decoding: unused
b71901e6
MN
1150 */
1151 int delay;
115329f1 1152
64863965
MN
1153 /* - encoding parameters */
1154 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
115329f1
DB
1155 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1156
b71901e6 1157 /**
f5bccd85
DB
1158 * minimum quantizer
1159 * - encoding: Set by user.
64863965 1160 * - decoding: unused
b71901e6
MN
1161 */
1162 int qmin;
1163
1164 /**
f5bccd85
DB
1165 * maximum quantizer
1166 * - encoding: Set by user.
64863965 1167 * - decoding: unused
b71901e6
MN
1168 */
1169 int qmax;
1170
1171 /**
f5bccd85
DB
1172 * maximum quantizer difference between frames
1173 * - encoding: Set by user.
64863965 1174 * - decoding: unused
b71901e6
MN
1175 */
1176 int max_qdiff;
1177
1178 /**
f5bccd85
DB
1179 * maximum number of B-frames between non-B-frames
1180 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1181 * - encoding: Set by user.
64863965 1182 * - decoding: unused
b71901e6
MN
1183 */
1184 int max_b_frames;
1185
1186 /**
f5bccd85 1187 * qscale factor between IP and B-frames
662e5411 1188 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1189 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85 1190 * - encoding: Set by user.
64863965 1191 * - decoding: unused
b71901e6
MN
1192 */
1193 float b_quant_factor;
115329f1 1194
b71901e6
MN
1195 /** obsolete FIXME remove */
1196 int rc_strategy;
64b7c5b6
MN
1197#define FF_RC_STRATEGY_XVID 1
1198
8b4c7dbc 1199 int b_frame_strategy;
9dbcbd92 1200
b71901e6 1201 /**
85947156
VS
1202 * hurry up amount
1203 * - encoding: unused
1204 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
f9ec0aa1 1205 * @deprecated Deprecated in favor of skip_idct and skip_frame.
b71901e6
MN
1206 */
1207 int hurry_up;
115329f1 1208
de6d9b64 1209 struct AVCodec *codec;
115329f1 1210
de6d9b64
FB
1211 void *priv_data;
1212
bb628dae 1213 int rtp_payload_size; /* The size of the RTP payload: the coder will */
f5bccd85 1214 /* do its best to deliver a chunk with size */
644d98a4 1215 /* below rtp_payload_size, the chunk will start */
f5bccd85 1216 /* with a start code on some codecs like H.263. */
644d98a4 1217 /* This doesn't take account of any particular */
f5bccd85 1218 /* headers inside the transmitted RTP payload. */
81401c1f 1219
115329f1 1220
f5bccd85
DB
1221 /* The RTP callback: This function is called */
1222 /* every time the encoder has a packet to send. */
1223 /* It depends on the encoder if the data starts */
1224 /* with a Start Code (it should). H.263 does. */
1225 /* mb_nb contains the number of macroblocks */
1226 /* encoded in the RTP payload. */
115329f1 1227 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
81401c1f 1228
098eefe1
MN
1229 /* statistics, used for 2-pass encoding */
1230 int mv_bits;
1231 int header_bits;
1232 int i_tex_bits;
1233 int p_tex_bits;
1234 int i_count;
1235 int p_count;
1236 int skip_count;
b71901e6 1237 int misc_bits;
115329f1 1238
b71901e6 1239 /**
f5bccd85
DB
1240 * number of bits used for the previously encoded frame
1241 * - encoding: Set by libavcodec.
7004ffb3 1242 * - decoding: unused
b71901e6 1243 */
098eefe1 1244 int frame_bits;
7004ffb3 1245
b71901e6 1246 /**
f5bccd85
DB
1247 * Private data of the user, can be used to carry app specific stuff.
1248 * - encoding: Set by user.
1249 * - decoding: Set by user.
b71901e6
MN
1250 */
1251 void *opaque;
1252
de6d9b64 1253 char codec_name[32];
4a663d80
PG
1254 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1255 enum CodecID codec_id; /* see CODEC_ID_xxx */
115329f1 1256
7004ffb3
MN
1257 /**
1258 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85
DB
1259 * This is used to work around some encoder bugs.
1260 * A demuxer should set this to what is stored in the field used to identify the codec.
1261 * If there are multiple such fields in a container then the demuxer should choose the one
1262 * which maximizes the information about the used codec.
1263 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1264 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
47bbf8a7 1265 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
f5bccd85
DB
1266 * first.
1267 * - encoding: Set by user, if not then the default based on codec_id will be used.
1268 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
7004ffb3
MN
1269 */
1270 unsigned int codec_tag;
115329f1 1271
b71901e6 1272 /**
f5bccd85
DB
1273 * Work around bugs in encoders which sometimes cannot be detected automatically.
1274 * - encoding: Set by user
1275 * - decoding: Set by user
b71901e6
MN
1276 */
1277 int workaround_bugs;
64863965 1278#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
1279#define FF_BUG_OLD_MSMPEG4 2
1280#define FF_BUG_XVID_ILACE 4
1281#define FF_BUG_UMP4 8
1282#define FF_BUG_NO_PADDING 16
3116cb14 1283#define FF_BUG_AMV 32
f5bccd85 1284#define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
03e93d35 1285#define FF_BUG_QPEL_CHROMA 64
db794953 1286#define FF_BUG_STD_QPEL 128
36df8805 1287#define FF_BUG_QPEL_CHROMA2 256
c40c3482 1288#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 1289#define FF_BUG_EDGE 1024
b44bdf7e 1290#define FF_BUG_HPEL_CHROMA 2048
4ccde216 1291#define FF_BUG_DC_CLIP 4096
f5bccd85
DB
1292#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1293//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
115329f1 1294
b71901e6 1295 /**
f5bccd85
DB
1296 * luma single coefficient elimination threshold
1297 * - encoding: Set by user.
64863965 1298 * - decoding: unused
b71901e6 1299 */
1f6b6e50 1300 int luma_elim_threshold;
115329f1 1301
b71901e6 1302 /**
f5bccd85
DB
1303 * chroma single coeff elimination threshold
1304 * - encoding: Set by user.
64863965 1305 * - decoding: unused
b71901e6 1306 */
1f6b6e50 1307 int chroma_elim_threshold;
115329f1 1308
b71901e6 1309 /**
f5bccd85
DB
1310 * strictly follow the standard (MPEG4, ...).
1311 * - encoding: Set by user.
5771b2c3
MN
1312 * - decoding: Set by user.
1313 * Setting this to STRICT or higher means the encoder and decoder will
1314 * generally do stupid things. While setting it to inofficial or lower
1315 * will mean the encoder might use things that are not supported by all
1316 * spec compliant decoders. Decoders make no difference between normal,
1317 * inofficial and experimental, that is they always try to decode things
1318 * when they can unless they are explicitly asked to behave stupid
1319 * (=strictly conform to the specs)
b71901e6
MN
1320 */
1321 int strict_std_compliance;
f5bccd85
DB
1322#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1323#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
9cd81798 1324#define FF_COMPLIANCE_NORMAL 0
f5bccd85
DB
1325#define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1326#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
9cd81798 1327
b71901e6 1328 /**
f5bccd85 1329 * qscale offset between IP and B-frames
f5bccd85 1330 * - encoding: Set by user.
64863965 1331 * - decoding: unused
b71901e6
MN
1332 */
1333 float b_quant_offset;
115329f1 1334
b71901e6 1335 /**
047599a4 1336 * Error recognization; higher values will detect more errors but may
f5bccd85 1337 * misdetect some more or less valid parts as errors.
64863965 1338 * - encoding: unused
f5bccd85 1339 * - decoding: Set by user.
b71901e6 1340 */
047599a4 1341 int error_recognition;
1471c6c2 1342#define FF_ER_CAREFUL 1
ce3bcaed
MN
1343#define FF_ER_COMPLIANT 2
1344#define FF_ER_AGGRESSIVE 3
1345#define FF_ER_VERY_AGGRESSIVE 4
115329f1 1346
6b72ac63 1347 /**
f5bccd85
DB
1348 * Called at the beginning of each frame to get a buffer for it.
1349 * If pic.reference is set then the frame will be read later by libavcodec.
2b5296d2 1350 * avcodec_align_dimensions() should be used to find the required width and
f5bccd85 1351 * height, as they normally need to be rounded up to the next multiple of 16.
f1b99cc6
MN
1352 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1353 * avcodec_default_get_buffer() instead of providing buffers allocated by
1354 * some other means.
64863965 1355 * - encoding: unused
f5bccd85 1356 * - decoding: Set by libavcodec., user can override.
b71901e6 1357 */
492cd3a9 1358 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1 1359
b71901e6 1360 /**
69b192ac 1361 * Called to release buffers which were allocated with get_buffer.
f5bccd85
DB
1362 * A released buffer can be reused in get_buffer().
1363 * pic.data[*] must be set to NULL.
64863965 1364 * - encoding: unused
f5bccd85 1365 * - decoding: Set by libavcodec., user can override.
b71901e6 1366 */
492cd3a9 1367 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 1368
b71901e6 1369 /**
eb8a25c8 1370 * Size of the frame reordering buffer in the decoder.
2d7b0560 1371 * For MPEG-2 it is 1 IPB or 0 low delay IP.
f5bccd85
DB
1372 * - encoding: Set by libavcodec.
1373 * - decoding: Set by libavcodec.
b71901e6
MN
1374 */
1375 int has_b_frames;
718b27a7
MN
1376
1377 /**
1378 * number of bytes per packet if constant and known or 0
f5bccd85 1379 * Used by some WAV based audio codecs.
718b27a7
MN
1380 */
1381 int block_align;
115329f1 1382
f5bccd85 1383 int parse_only; /* - decoding only: If true, only parsing is done
917e06c8
FB
1384 (function avcodec_parse_frame()). The frame
1385 data is returned. Only MPEG codecs support this now. */
115329f1 1386
b71901e6 1387 /**
f5bccd85
DB
1388 * 0-> h263 quant 1-> mpeg quant
1389 * - encoding: Set by user.
64863965 1390 * - decoding: unused
b71901e6
MN
1391 */
1392 int mpeg_quant;
115329f1 1393
b71901e6 1394 /**
f5bccd85
DB
1395 * pass1 encoding statistics output buffer
1396 * - encoding: Set by libavcodec.
64863965 1397 * - decoding: unused
b71901e6 1398 */
64863965 1399 char *stats_out;
115329f1 1400
b71901e6 1401 /**
f5bccd85
DB
1402 * pass2 encoding statistics input buffer
1403 * Concatenated stuff from stats_out of pass1 should be placed here.
1404 * - encoding: Allocated/set/freed by user.
64863965 1405 * - decoding: unused
b71901e6
MN
1406 */
1407 char *stats_in;
115329f1 1408
b71901e6 1409 /**
f5bccd85
DB
1410 * ratecontrol qmin qmax limiting method
1411 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1412 * - encoding: Set by user.
64863965 1413 * - decoding: unused
b71901e6 1414 */
ce980a95 1415 float rc_qsquish;
b71901e6 1416
ce980a95
MN
1417 float rc_qmod_amp;
1418 int rc_qmod_freq;
115329f1 1419
b71901e6 1420 /**
f5bccd85
DB
1421 * ratecontrol override, see RcOverride
1422 * - encoding: Allocated/set/freed by user.
64863965 1423 * - decoding: unused
b71901e6 1424 */
ce980a95
MN
1425 RcOverride *rc_override;
1426 int rc_override_count;
115329f1 1427
b71901e6 1428 /**
f5bccd85
DB
1429 * rate control equation
1430 * - encoding: Set by user
64863965 1431 * - decoding: unused
b71901e6 1432 */
6881b8e5 1433 const char *rc_eq;
115329f1 1434
b71901e6 1435 /**
f5bccd85
DB
1436 * maximum bitrate
1437 * - encoding: Set by user.
64863965 1438 * - decoding: unused
b71901e6 1439 */
ce980a95 1440 int rc_max_rate;
115329f1 1441
b71901e6 1442 /**
f5bccd85
DB
1443 * minimum bitrate
1444 * - encoding: Set by user.
64863965 1445 * - decoding: unused
b71901e6 1446 */
ce980a95 1447 int rc_min_rate;
115329f1 1448
b71901e6 1449 /**
f5bccd85
DB
1450 * decoder bitstream buffer size
1451 * - encoding: Set by user.
64863965 1452 * - decoding: unused
b71901e6 1453 */
ce980a95
MN
1454 int rc_buffer_size;
1455 float rc_buffer_aggressivity;
b71901e6
MN
1456
1457 /**
f5bccd85
DB
1458 * qscale factor between P and I-frames
1459 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1460 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1461 * - encoding: Set by user.
64863965 1462 * - decoding: unused
b71901e6
MN
1463 */
1464 float i_quant_factor;
115329f1 1465
b71901e6 1466 /**
f5bccd85
DB
1467 * qscale offset between P and I-frames
1468 * - encoding: Set by user.
64863965 1469 * - decoding: unused
b71901e6
MN
1470 */
1471 float i_quant_offset;
115329f1 1472
b71901e6 1473 /**
f5bccd85
DB
1474 * initial complexity for pass1 ratecontrol
1475 * - encoding: Set by user.
64863965 1476 * - decoding: unused
b71901e6 1477 */
ce980a95 1478 float rc_initial_cplx;
917e06c8 1479
b71901e6 1480 /**
f5bccd85
DB
1481 * DCT algorithm, see FF_DCT_* below
1482 * - encoding: Set by user.
64863965 1483 * - decoding: unused
b71901e6 1484 */
28db7fce 1485 int dct_algo;
c7e07931 1486#define FF_DCT_AUTO 0
28db7fce 1487#define FF_DCT_FASTINT 1
c7e07931
MO
1488#define FF_DCT_INT 2
1489#define FF_DCT_MMX 3
1490#define FF_DCT_MLIB 4
05c4072b 1491#define FF_DCT_ALTIVEC 5
65e4c8c9 1492#define FF_DCT_FAAN 6
115329f1 1493
c5d309f2 1494 /**
f5bccd85
DB
1495 * luminance masking (0-> disabled)
1496 * - encoding: Set by user.
64863965 1497 * - decoding: unused
c5d309f2
MN
1498 */
1499 float lumi_masking;
115329f1 1500
c5d309f2 1501 /**
f5bccd85
DB
1502 * temporary complexity masking (0-> disabled)
1503 * - encoding: Set by user.
64863965 1504 * - decoding: unused
c5d309f2
MN
1505 */
1506 float temporal_cplx_masking;
115329f1 1507
c5d309f2 1508 /**
f5bccd85
DB
1509 * spatial complexity masking (0-> disabled)
1510 * - encoding: Set by user.
64863965 1511 * - decoding: unused
c5d309f2
MN
1512 */
1513 float spatial_cplx_masking;
115329f1 1514
c5d309f2 1515 /**
f5bccd85
DB
1516 * p block masking (0-> disabled)
1517 * - encoding: Set by user.
64863965 1518 * - decoding: unused
c5d309f2
MN
1519 */
1520 float p_masking;
15415af4 1521
5e746b99 1522 /**
f5bccd85
DB
1523 * darkness masking (0-> disabled)
1524 * - encoding: Set by user.
64863965 1525 * - decoding: unused
5e746b99
MN
1526 */
1527 float dark_masking;
115329f1 1528
0c2dd16e 1529 /**
f5bccd85
DB
1530 * IDCT algorithm, see FF_IDCT_* below.
1531 * - encoding: Set by user.
1532 * - decoding: Set by user.
2ad1516a
MN
1533 */
1534 int idct_algo;
273b0cd3
DB
1535#define FF_IDCT_AUTO 0
1536#define FF_IDCT_INT 1
1537#define FF_IDCT_SIMPLE 2
1538#define FF_IDCT_SIMPLEMMX 3
1539#define FF_IDCT_LIBMPEG2MMX 4
1540#define FF_IDCT_PS2 5
1541#define FF_IDCT_MLIB 6
1542#define FF_IDCT_ARM 7
1543#define FF_IDCT_ALTIVEC 8
1544#define FF_IDCT_SH4 9
1545#define FF_IDCT_SIMPLEARM 10
1546#define FF_IDCT_H264 11
1547#define FF_IDCT_VP3 12
1548#define FF_IDCT_IPP 13
1549#define FF_IDCT_XVIDMMX 14
1550#define FF_IDCT_CAVS 15
a0403006 1551#define FF_IDCT_SIMPLEARMV5TE 16
273b0cd3 1552#define FF_IDCT_SIMPLEARMV6 17
d9420d4d 1553#define FF_IDCT_SIMPLEVIS 18
9abc7e0f 1554#define FF_IDCT_WMV2 19
6f08c541 1555#define FF_IDCT_FAAN 20
42b30357 1556#define FF_IDCT_EA 21
7eec4328 1557#define FF_IDCT_SIMPLENEON 22
74c47463 1558#define FF_IDCT_SIMPLEALPHA 23
2ad1516a 1559
144f0625 1560 /**
f5bccd85
DB
1561 * slice count
1562 * - encoding: Set by libavcodec.
1563 * - decoding: Set by user (or 0).
144f0625
MN
1564 */
1565 int slice_count;
1566 /**
f5bccd85
DB
1567 * slice offsets in the frame in bytes
1568 * - encoding: Set/allocated by libavcodec.
1569 * - decoding: Set/allocated by user (or NULL).
144f0625
MN
1570 */
1571 int *slice_offset;
1572
4d2858de 1573 /**
f5bccd85 1574 * error concealment flags
64863965 1575 * - encoding: unused
f5bccd85 1576 * - decoding: Set by user.
4d2858de
MN
1577 */
1578 int error_concealment;
1579#define FF_EC_GUESS_MVS 1
1580#define FF_EC_DEBLOCK 2
1581
6b72ac63 1582 /**
bec89a84 1583 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1584 * CPU features (i.e. MMX, SSE. ...)
bec89a84 1585 *
f5bccd85
DB
1586 * With the FORCE flag you may instead enable given CPU features.
1587 * (Dangerous: Usable in case of misdetection, improper usage however will
1588 * result into program crash.)
bec89a84
ZK
1589 */
1590 unsigned dsp_mask;
f5bccd85 1591#define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
bec89a84 1592 /* lower 16 bits - CPU features */
0cd60abf
MN
1593#define FF_MM_MMX 0x0001 ///< standard MMX
1594#define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
6b434361 1595#if LIBAVCODEC_VERSION_MAJOR < 53
0cd60abf 1596#define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
6b434361
SS
1597#endif
1598#define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
0cd60abf
MN
1599#define FF_MM_SSE 0x0008 ///< SSE functions
1600#define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1601#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1602#define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1603#define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
710441c2
DC
1604#define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1605#define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
0cd60abf 1606#define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
82d1605f 1607#define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
11f18faf
MN
1608
1609 /**
64863965 1610 * bits per sample/pixel from the demuxer (needed for huffyuv).
f5bccd85
DB
1611 * - encoding: Set by libavcodec.
1612 * - decoding: Set by user.
11f18faf 1613 */
46a73068 1614 int bits_per_coded_sample;
115329f1 1615
11f18faf 1616 /**
f5bccd85
DB
1617 * prediction method (needed for huffyuv)
1618 * - encoding: Set by user.
64863965 1619 * - decoding: unused
11f18faf
MN
1620 */
1621 int prediction_method;
1622#define FF_PRED_LEFT 0
1623#define FF_PRED_PLANE 1
1624#define FF_PRED_MEDIAN 2
115329f1 1625
5d3cea3a 1626 /**
f5bccd85 1627 * sample aspect ratio (0 if unknown)
8e5af7a6 1628 * That is the width of a pixel divided by the height of the pixel.
f5bccd85
DB
1629 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1630 * - encoding: Set by user.
1631 * - decoding: Set by libavcodec.
5d3cea3a 1632 */
5ff85f1d 1633 AVRational sample_aspect_ratio;
1e491e29
MN
1634
1635 /**
f5bccd85
DB
1636 * the picture in the bitstream
1637 * - encoding: Set by libavcodec.
1638 * - decoding: Set by libavcodec.
1e491e29 1639 */
492cd3a9 1640 AVFrame *coded_frame;
c8c437bc
MN
1641
1642 /**
f5bccd85
DB
1643 * debug
1644 * - encoding: Set by user.
1645 * - decoding: Set by user.
c8c437bc
MN
1646 */
1647 int debug;
273b0cd3
DB
1648#define FF_DEBUG_PICT_INFO 1
1649#define FF_DEBUG_RC 2
1650#define FF_DEBUG_BITSTREAM 4
1651#define FF_DEBUG_MB_TYPE 8
1652#define FF_DEBUG_QP 16
1653#define FF_DEBUG_MV 32
1654#define FF_DEBUG_DCT_COEFF 0x00000040
1655#define FF_DEBUG_SKIP 0x00000080
1656#define FF_DEBUG_STARTCODE 0x00000100
1657#define FF_DEBUG_PTS 0x00000200
1658#define FF_DEBUG_ER 0x00000400
1659#define FF_DEBUG_MMCO 0x00000800
1660#define FF_DEBUG_BUGS 0x00001000
1661#define FF_DEBUG_VIS_QP 0x00002000
864119b6 1662#define FF_DEBUG_VIS_MB_TYPE 0x00004000
385c820b 1663#define FF_DEBUG_BUFFERS 0x00008000
115329f1 1664
140cb663 1665 /**
f5bccd85
DB
1666 * debug
1667 * - encoding: Set by user.
1668 * - decoding: Set by user.
0c9bbaec
WH
1669 */
1670 int debug_mv;
1671#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1672#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1673#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1674
1675 /**
f5bccd85
DB
1676 * error
1677 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
64863965 1678 * - decoding: unused
140cb663
MN
1679 */
1680 uint64_t error[4];
115329f1 1681
17a70fde 1682 /**
f5bccd85 1683 * minimum MB quantizer
6e0d8c06 1684 * - encoding: unused
64863965 1685 * - decoding: unused
17a70fde
MN
1686 */
1687 int mb_qmin;
1688
1689 /**
f5bccd85 1690 * maximum MB quantizer
6e0d8c06 1691 * - encoding: unused
64863965 1692 * - decoding: unused
17a70fde
MN
1693 */
1694 int mb_qmax;
115329f1 1695
1457ab52 1696 /**
f5bccd85
DB
1697 * motion estimation comparison function
1698 * - encoding: Set by user.
64863965 1699 * - decoding: unused
1457ab52
MN
1700 */
1701 int me_cmp;
1702 /**
f5bccd85
DB
1703 * subpixel motion estimation comparison function
1704 * - encoding: Set by user.
64863965 1705 * - decoding: unused
1457ab52
MN
1706 */
1707 int me_sub_cmp;
1708 /**
f5bccd85
DB
1709 * macroblock comparison function (not supported yet)
1710 * - encoding: Set by user.
64863965 1711 * - decoding: unused
1457ab52
MN
1712 */
1713 int mb_cmp;
622348f9 1714 /**
f5bccd85
DB
1715 * interlaced DCT comparison function
1716 * - encoding: Set by user.
622348f9
MN
1717 * - decoding: unused
1718 */
1719 int ildct_cmp;
273b0cd3
DB
1720#define FF_CMP_SAD 0
1721#define FF_CMP_SSE 1
1722#define FF_CMP_SATD 2
1723#define FF_CMP_DCT 3
1724#define FF_CMP_PSNR 4
1725#define FF_CMP_BIT 5
1726#define FF_CMP_RD 6
1727#define FF_CMP_ZERO 7
1728#define FF_CMP_VSAD 8
1729#define FF_CMP_VSSE 9
1730#define FF_CMP_NSSE 10
1731#define FF_CMP_W53 11
1732#define FF_CMP_W97 12
0fd6aea1 1733#define FF_CMP_DCTMAX 13
27c61ac5 1734#define FF_CMP_DCT264 14
1457ab52 1735#define FF_CMP_CHROMA 256
115329f1 1736
1457ab52 1737 /**
f5bccd85
DB
1738 * ME diamond size & shape
1739 * - encoding: Set by user.
64863965 1740 * - decoding: unused
1457ab52
MN
1741 */
1742 int dia_size;
b07a5980
MN
1743
1744 /**
f5bccd85
DB
1745 * amount of previous MV predictors (2a+1 x 2a+1 square)
1746 * - encoding: Set by user.
64863965 1747 * - decoding: unused
b07a5980
MN
1748 */
1749 int last_predictor_count;
70ac76c0 1750
f5fb6b34 1751 /**
f5bccd85
DB
1752 * prepass for motion estimation
1753 * - encoding: Set by user.
64863965 1754 * - decoding: unused
f5fb6b34
MN
1755 */
1756 int pre_me;
b07a5980 1757
70ac76c0 1758 /**
f5bccd85
DB
1759 * motion estimation prepass comparison function
1760 * - encoding: Set by user.
64863965 1761 * - decoding: unused
70ac76c0
MN
1762 */
1763 int me_pre_cmp;
826f429a 1764
70ac76c0 1765 /**
f5bccd85
DB
1766 * ME prepass diamond size & shape
1767 * - encoding: Set by user.
64863965 1768 * - decoding: unused
70ac76c0
MN
1769 */
1770 int pre_dia_size;
1771
826f429a 1772 /**
f5bccd85
DB
1773 * subpel ME quality
1774 * - encoding: Set by user.
64863965 1775 * - decoding: unused
826f429a
MN
1776 */
1777 int me_subpel_quality;
1778
a33c7159 1779 /**
f5bccd85 1780 * callback to negotiate the pixelFormat
a33c7159 1781 * @param fmt is the list of formats which are supported by the codec,
f5bccd85
DB
1782 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1783 * The first is always the native one.
1784 * @return the chosen format
64863965 1785 * - encoding: unused
f5bccd85 1786 * - decoding: Set by user, if not set the native format will be chosen.
a33c7159 1787 */
494c56d3 1788 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
e2f9490e
FB
1789
1790 /**
f5bccd85
DB
1791 * DTG active format information (additional aspect ratio
1792 * information only used in DVB MPEG-2 transport streams)
1793 * 0 if not set.
115329f1 1794 *
f5bccd85
DB
1795 * - encoding: unused
1796 * - decoding: Set by decoder.
e2f9490e
FB
1797 */
1798 int dtg_active_format;
1799#define FF_DTG_AFD_SAME 8
1800#define FF_DTG_AFD_4_3 9
1801#define FF_DTG_AFD_16_9 10
1802#define FF_DTG_AFD_14_9 11
1803#define FF_DTG_AFD_4_3_SP_14_9 13
1804#define FF_DTG_AFD_16_9_SP_14_9 14
1805#define FF_DTG_AFD_SP_4_3 15
1806
ebbcdc9a 1807 /**
f5bccd85
DB
1808 * maximum motion estimation search range in subpel units
1809 * If 0 then no limit.
115329f1 1810 *
f5bccd85
DB
1811 * - encoding: Set by user.
1812 * - decoding: unused
ebbcdc9a 1813 */
59e0ac8e 1814 int me_range;
ebbcdc9a 1815
65f7062d 1816 /**
f5bccd85
DB
1817 * intra quantizer bias
1818 * - encoding: Set by user.
1984f635
MN
1819 * - decoding: unused
1820 */
1821 int intra_quant_bias;
1822#define FF_DEFAULT_QUANT_BIAS 999999
115329f1 1823
1984f635 1824 /**
f5bccd85
DB
1825 * inter quantizer bias
1826 * - encoding: Set by user.
1984f635
MN
1827 * - decoding: unused
1828 */
1829 int inter_quant_bias;
5cd62665
ZK
1830
1831 /**
f5bccd85
DB
1832 * color table ID
1833 * - encoding: unused
1834 * - decoding: Which clrtable should be used for 8bit RGB images.
1835 * Tables have to be stored somewhere. FIXME
5cd62665
ZK
1836 */
1837 int color_table_id;
115329f1 1838
d90cf87b 1839 /**
f5bccd85
DB
1840 * internal_buffer count
1841 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1842 */
1843 int internal_buffer_count;
115329f1 1844
d90cf87b 1845 /**
f5bccd85
DB
1846 * internal_buffers
1847 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1848 */
1849 void *internal_buffer;
158c7f05
MN
1850
1851#define FF_LAMBDA_SHIFT 7
1852#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1853#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1854#define FF_LAMBDA_MAX (256*128-1)
1855
1856#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce 1857 /**
f5bccd85
DB
1858 * Global quality for codecs which cannot change it per frame.
1859 * This should be proportional to MPEG-1/2/4 qscale.
1860 * - encoding: Set by user.
3d2e8cce
MN
1861 * - decoding: unused
1862 */
1863 int global_quality;
115329f1 1864
bd446bb1
MN
1865#define FF_CODER_TYPE_VLC 0
1866#define FF_CODER_TYPE_AC 1
f87459e4
KN
1867#define FF_CODER_TYPE_RAW 2
1868#define FF_CODER_TYPE_RLE 3
1869#define FF_CODER_TYPE_DEFLATE 4
11e659c2
MN
1870 /**
1871 * coder type
f5bccd85 1872 * - encoding: Set by user.
11e659c2
MN
1873 * - decoding: unused
1874 */
1875 int coder_type;
1876
1877 /**
1878 * context model
f5bccd85 1879 * - encoding: Set by user.
11e659c2
MN
1880 * - decoding: unused
1881 */
1882 int context_model;
5639729b
MN
1883#if 0
1884 /**
1885 *
1886 * - encoding: unused
f5bccd85 1887 * - decoding: Set by user.
5639729b
MN
1888 */
1889 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1890#endif
115329f1 1891
3bb07d61
MN
1892 /**
1893 * slice flags
1894 * - encoding: unused
f5bccd85 1895 * - decoding: Set by user.
3bb07d61
MN
1896 */
1897 int slice_flags;
1898#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1899#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1900#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1901
fb364ada
IK
1902 /**
1903 * XVideo Motion Acceleration
1904 * - encoding: forbidden
1905 * - decoding: set by decoder
1906 */
1907 int xvmc_acceleration;
115329f1 1908
7d1c3fc1
MN
1909 /**
1910 * macroblock decision mode
f5bccd85 1911 * - encoding: Set by user.
7d1c3fc1
MN
1912 * - decoding: unused
1913 */
1914 int mb_decision;
1915#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1916#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
e6dba5df 1917#define FF_MB_DECISION_RD 2 ///< rate distortion
d6eb3c50
MN
1918
1919 /**
1920 * custom intra quantization matrix
f5bccd85
DB
1921 * - encoding: Set by user, can be NULL.
1922 * - decoding: Set by libavcodec.
d6eb3c50
MN
1923 */
1924 uint16_t *intra_matrix;
1925
1926 /**
1927 * custom inter quantization matrix
f5bccd85
DB
1928 * - encoding: Set by user, can be NULL.
1929 * - decoding: Set by libavcodec.
d6eb3c50
MN
1930 */
1931 uint16_t *inter_matrix;
115329f1 1932
541ae140
MN
1933 /**
1934 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85 1935 * This is used to work around some encoder bugs.
541ae140 1936 * - encoding: unused
f5bccd85 1937 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
541ae140
MN
1938 */
1939 unsigned int stream_codec_tag;
05fbd0a2
MN
1940
1941 /**
f5bccd85
DB
1942 * scene change detection threshold
1943 * 0 is default, larger means fewer detected scene changes.
1944 * - encoding: Set by user.
05fbd0a2
MN
1945 * - decoding: unused
1946 */
1947 int scenechange_threshold;
158c7f05
MN
1948
1949 /**
f5bccd85
DB
1950 * minimum Lagrange multipler
1951 * - encoding: Set by user.
158c7f05
MN
1952 * - decoding: unused
1953 */
1954 int lmin;
1955
1956 /**
f5bccd85
DB
1957 * maximum Lagrange multipler
1958 * - encoding: Set by user.
158c7f05
MN
1959 * - decoding: unused
1960 */
1961 int lmax;
2a2bbcb0
MM
1962
1963 /**
f5bccd85 1964 * palette control structure
2a2bbcb0 1965 * - encoding: ??? (no palette-enabled encoder yet)
f5bccd85 1966 * - decoding: Set by user.
2a2bbcb0
MM
1967 */
1968 struct AVPaletteControl *palctrl;
821cb11f
MN
1969
1970 /**
1971 * noise reduction strength
f5bccd85 1972 * - encoding: Set by user.
821cb11f
MN
1973 * - decoding: unused
1974 */
1975 int noise_reduction;
115329f1 1976
074c4ca7 1977 /**
f5bccd85
DB
1978 * Called at the beginning of a frame to get cr buffer for it.
1979 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1980 * libavcodec will pass previous buffer in pic, function should return
e1c2a5a0 1981 * same buffer or new buffer with old frame "painted" into it.
f5bccd85 1982 * If pic.data[0] == NULL must behave like get_buffer().
f1b99cc6
MN
1983 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1984 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1985 * some other means.
074c4ca7 1986 * - encoding: unused
f5bccd85 1987 * - decoding: Set by libavcodec., user can override
074c4ca7 1988 */
e1c2a5a0 1989 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
MN
1990
1991 /**
f5bccd85
DB
1992 * Number of bits which should be loaded into the rc buffer before decoding starts.
1993 * - encoding: Set by user.
ba58dabc
MN
1994 * - decoding: unused
1995 */
1996 int rc_initial_buffer_occupancy;
1997
1998 /**
1999 *
f5bccd85 2000 * - encoding: Set by user.
ba58dabc
MN
2001 * - decoding: unused
2002 */
2003 int inter_threshold;
2004
2005 /**
f5bccd85
DB
2006 * CODEC_FLAG2_*
2007 * - encoding: Set by user.
2008 * - decoding: Set by user.
ba58dabc
MN
2009 */
2010 int flags2;
7ebfc0ea
MN
2011
2012 /**
f5bccd85
DB
2013 * Simulates errors in the bitstream to test error concealment.
2014 * - encoding: Set by user.
2015 * - decoding: unused
7ebfc0ea
MN
2016 */
2017 int error_rate;
115329f1 2018
a1e257b2
MN
2019 /**
2020 * MP3 antialias algorithm, see FF_AA_* below.
2021 * - encoding: unused
f5bccd85 2022 * - decoding: Set by user.
a1e257b2
MN
2023 */
2024 int antialias_algo;
2025#define FF_AA_AUTO 0
2026#define FF_AA_FASTINT 1 //not implemented yet
2027#define FF_AA_INT 2
2028#define FF_AA_FLOAT 3
77ea0d4b 2029 /**
f5bccd85
DB
2030 * quantizer noise shaping
2031 * - encoding: Set by user.
77ea0d4b
MN
2032 * - decoding: unused
2033 */
2034 int quantizer_noise_shaping;
9c3d33d6
MN
2035
2036 /**
f5bccd85 2037 * thread count
eafcac6a 2038 * is used to decide how many independent tasks should be passed to execute()
f5bccd85
DB
2039 * - encoding: Set by user.
2040 * - decoding: Set by user.
9c3d33d6
MN
2041 */
2042 int thread_count;
115329f1 2043
9c3d33d6 2044 /**
f5bccd85
DB
2045 * The codec may call this to execute several independent things.
2046 * It will return only after finishing all tasks.
2047 * The user may replace this with some multithreaded implementation,
2048 * the default implementation will execute the parts serially.
399cec2f 2049 * @param count the number of things to execute
f5bccd85
DB
2050 * - encoding: Set by libavcodec, user can override.
2051 * - decoding: Set by libavcodec, user can override.
9c3d33d6 2052 */
3a84713a 2053 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
115329f1 2054
9c3d33d6 2055 /**
f5bccd85
DB
2056 * thread opaque
2057 * Can be used by execute() to store some per AVCodecContext stuff.
9c3d33d6
MN
2058 * - encoding: set by execute()
2059 * - decoding: set by execute()
2060 */
2061 void *thread_opaque;
a4d36c11
MN
2062
2063 /**
f5bccd85
DB
2064 * Motion estimation threshold below which no motion estimation is
2065 * performed, but instead the user specified motion vectors are used.
115329f1 2066 *
f5bccd85 2067 * - encoding: Set by user.
f20f8a8b 2068 * - decoding: unused
a4d36c11 2069 */
2750b827 2070 int me_threshold;
f20f8a8b
MN
2071
2072 /**
f5bccd85
DB
2073 * Macroblock threshold below which the user specified macroblock types will be used.
2074 * - encoding: Set by user.
f20f8a8b
MN
2075 * - decoding: unused
2076 */
2077 int mb_threshold;
bf266e19
MN
2078
2079 /**
f5bccd85
DB
2080 * precision of the intra DC coefficient - 8
2081 * - encoding: Set by user.
bf266e19
MN
2082 * - decoding: unused
2083 */
2084 int intra_dc_precision;
d4c5d2ad
MN
2085
2086 /**
f5bccd85
DB
2087 * noise vs. sse weight for the nsse comparsion function
2088 * - encoding: Set by user.
d4c5d2ad
MN
2089 * - decoding: unused
2090 */
2091 int nsse_weight;
0dfd33c3
MN
2092
2093 /**
f5bccd85 2094 * Number of macroblock rows at the top which are skipped.
0dfd33c3 2095 * - encoding: unused
f5bccd85 2096 * - decoding: Set by user.
0dfd33c3
MN
2097 */
2098 int skip_top;
2099
2100 /**
f5bccd85 2101 * Number of macroblock rows at the bottom which are skipped.
0dfd33c3 2102 * - encoding: unused
f5bccd85 2103 * - decoding: Set by user.
0dfd33c3
MN
2104 */
2105 int skip_bottom;
baced9f5
MN
2106
2107 /**
2108 * profile
f5bccd85
DB
2109 * - encoding: Set by user.
2110 * - decoding: Set by libavcodec.
baced9f5
MN
2111 */
2112 int profile;
2113#define FF_PROFILE_UNKNOWN -99
4f2c36ac 2114#define FF_PROFILE_AAC_MAIN 0
273b0cd3
DB
2115#define FF_PROFILE_AAC_LOW 1
2116#define FF_PROFILE_AAC_SSR 2
2117#define FF_PROFILE_AAC_LTP 3
baced9f5
MN
2118
2119 /**
2120 * level
f5bccd85
DB
2121 * - encoding: Set by user.
2122 * - decoding: Set by libavcodec.
baced9f5
MN
2123 */
2124 int level;
2125#define FF_LEVEL_UNKNOWN -99
178fcca8
MN
2126
2127 /**
f5bccd85 2128 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
178fcca8 2129 * - encoding: unused
f5bccd85 2130 * - decoding: Set by user.
178fcca8
MN
2131 */
2132 int lowres;
21adafec
MN
2133
2134 /**
f5bccd85
DB
2135 * Bitstream width / height, may be different from width/height if lowres
2136 * or other things are used.
21adafec 2137 * - encoding: unused
f5bccd85 2138 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
21adafec
MN
2139 */
2140 int coded_width, coded_height;
bbf18b21
MN
2141
2142 /**
2143 * frame skip threshold
f5bccd85 2144 * - encoding: Set by user.
bbf18b21
MN
2145 * - decoding: unused
2146 */
2147 int frame_skip_threshold;
2148
2149 /**
2150 * frame skip factor
f5bccd85 2151 * - encoding: Set by user.
bbf18b21
MN
2152 * - decoding: unused
2153 */
2154 int frame_skip_factor;
0fd6aea1
MN
2155
2156 /**
2157 * frame skip exponent
f5bccd85 2158 * - encoding: Set by user.
0fd6aea1
MN
2159 * - decoding: unused
2160 */
2161 int frame_skip_exp;
2162
2163 /**
f5bccd85
DB
2164 * frame skip comparison function
2165 * - encoding: Set by user.
0fd6aea1
MN
2166 * - decoding: unused
2167 */
2168 int frame_skip_cmp;
957c743a
CM
2169
2170 /**
f5bccd85 2171 * Border processing masking, raises the quantizer for mbs on the borders
957c743a 2172 * of the picture.
f5bccd85 2173 * - encoding: Set by user.
957c743a
CM
2174 * - decoding: unused
2175 */
2176 float border_masking;
6e0d8c06
MN
2177
2178 /**
f5bccd85
DB
2179 * minimum MB lagrange multipler
2180 * - encoding: Set by user.
6e0d8c06
MN
2181 * - decoding: unused
2182 */
2183 int mb_lmin;
2184
2185 /**
f5bccd85
DB
2186 * maximum MB lagrange multipler
2187 * - encoding: Set by user.
6e0d8c06
MN
2188 * - decoding: unused
2189 */
2190 int mb_lmax;
09c3e44e
MN
2191
2192 /**
115329f1 2193 *
f5bccd85 2194 * - encoding: Set by user.
09c3e44e
MN
2195 * - decoding: unused
2196 */
2197 int me_penalty_compensation;
8c3eba7c
MN
2198
2199 /**
115329f1 2200 *
8c3eba7c 2201 * - encoding: unused
f5bccd85 2202 * - decoding: Set by user.
8c3eba7c
MN
2203 */
2204 enum AVDiscard skip_loop_filter;
2205
2206 /**
115329f1 2207 *
8c3eba7c 2208 * - encoding: unused
f5bccd85 2209 * - decoding: Set by user.
8c3eba7c
MN
2210 */
2211 enum AVDiscard skip_idct;
2212
2213 /**
115329f1 2214 *
8c3eba7c 2215 * - encoding: unused
f5bccd85 2216 * - decoding: Set by user.
8c3eba7c
MN
2217 */
2218 enum AVDiscard skip_frame;
316a2ec8
MN
2219
2220 /**
2221 *
f5bccd85 2222 * - encoding: Set by user.
316a2ec8
MN
2223 * - decoding: unused
2224 */
2225 int bidir_refine;
e8501c93
MN
2226
2227 /**
2228 *
f5bccd85 2229 * - encoding: Set by user.
e8501c93
MN
2230 * - decoding: unused
2231 */
2232 int brd_scale;
58f7833e
RS
2233
2234 /**
2235 * constant rate factor - quality-based VBR - values ~correspond to qps
f5bccd85 2236 * - encoding: Set by user.
58f7833e
RS
2237 * - decoding: unused
2238 */
9f1c1c99 2239 float crf;
58f7833e
RS
2240
2241 /**
2242 * constant quantization parameter rate control method
f5bccd85 2243 * - encoding: Set by user.
58f7833e
RS
2244 * - decoding: unused
2245 */
2246 int cqp;
2247
2248 /**
f5bccd85
DB
2249 * minimum GOP size
2250 * - encoding: Set by user.
58f7833e
RS
2251 * - decoding: unused
2252 */
2253 int keyint_min;
2254
2255 /**
2256 * number of reference frames
f5bccd85 2257 * - encoding: Set by user.
53d55e9e 2258 * - decoding: Set by lavc.
58f7833e
RS
2259 */
2260 int refs;
2261
2262 /**
2263 * chroma qp offset from luma
f5bccd85 2264 * - encoding: Set by user.
58f7833e
RS
2265 * - decoding: unused
2266 */
2267 int chromaoffset;
2268
2269 /**
f5bccd85
DB
2270 * Influences how often B-frames are used.
2271 * - encoding: Set by user.
58f7833e
RS
2272 * - decoding: unused
2273 */
2274 int bframebias;
2275
2276 /**
2277 * trellis RD quantization
f5bccd85 2278 * - encoding: Set by user.
58f7833e
RS
2279 * - decoding: unused
2280 */
2281 int trellis;
2282
2283 /**
f5bccd85
DB
2284 * Reduce fluctuations in qp (before curve compression).
2285 * - encoding: Set by user.
58f7833e
RS
2286 * - decoding: unused
2287 */
2288 float complexityblur;
2289
2290 /**
2291 * in-loop deblocking filter alphac0 parameter
2292 * alpha is in the range -6...6
f5bccd85 2293 * - encoding: Set by user.
58f7833e
RS
2294 * - decoding: unused
2295 */
2296 int deblockalpha;
2297
2298 /**
2299 * in-loop deblocking filter beta parameter
2300 * beta is in the range -6...6
f5bccd85 2301 * - encoding: Set by user.
58f7833e
RS
2302 * - decoding: unused
2303 */
2304 int deblockbeta;
2305
2306 /**
2307 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
f5bccd85 2308 * - encoding: Set by user.
58f7833e
RS
2309 * - decoding: unused
2310 */
2311 int partitions;
56cc85a0
DB
2312#define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2313#define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2314#define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2315#define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2316#define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
58f7833e
RS
2317
2318 /**
30ab4ded 2319 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
f5bccd85 2320 * - encoding: Set by user.
58f7833e
RS
2321 * - decoding: unused
2322 */
2323 int directpred;
4f59b684 2324
14f0c8e2 2325 /**
02c164c1 2326 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 2327 * - encoding: Set by user.
14f0c8e2
LA
2328 * - decoding: unused
2329 */
2330 int cutoff;
39a64e30
CH
2331
2332 /**
f5bccd85
DB
2333 * Multiplied by qscale for each frame and added to scene_change_score.
2334 * - encoding: Set by user.
39a64e30
CH
2335 * - decoding: unused
2336 */
2337 int scenechange_factor;
1dd509b1
MN
2338
2339 /**
2340 *
f5bccd85
DB
2341 * Note: Value depends upon the compare function used for fullpel ME.
2342 * - encoding: Set by user.
1dd509b1
MN
2343 * - decoding: unused
2344 */
2345 int mv0_threshold;
f9243d34
CH
2346
2347 /**
f5bccd85
DB
2348 * Adjusts sensitivity of b_frame_strategy 1.
2349 * - encoding: Set by user.
f9243d34
CH
2350 * - decoding: unused
2351 */
2352 int b_sensitivity;
a403fc03
JR
2353
2354 /**
f5bccd85 2355 * - encoding: Set by user.
a403fc03
JR
2356 * - decoding: unused
2357 */
2358 int compression_level;
2359#define FF_COMPRESSION_DEFAULT -1
2360
2361 /**
f5bccd85
DB
2362 * Sets whether to use LPC mode - used by FLAC encoder.
2363 * - encoding: Set by user.
2364 * - decoding: unused
a403fc03
JR
2365 */
2366 int use_lpc;
2367
2368 /**
2369 * LPC coefficient precision - used by FLAC encoder
f5bccd85
DB
2370 * - encoding: Set by user.
2371 * - decoding: unused
a403fc03
JR
2372 */
2373 int lpc_coeff_precision;
2374
2375 /**
f5bccd85
DB
2376 * - encoding: Set by user.
2377 * - decoding: unused
a403fc03
JR
2378 */
2379 int min_prediction_order;
2380
2381 /**
f5bccd85
DB
2382 * - encoding: Set by user.
2383 * - decoding: unused
a403fc03
JR
2384 */
2385 int max_prediction_order;
2386
2387 /**
2388 * search method for selecting prediction order
f5bccd85
DB
2389 * - encoding: Set by user.
2390 * - decoding: unused
a403fc03
JR
2391 */
2392 int prediction_order_method;
2393
2394 /**
f5bccd85
DB
2395 * - encoding: Set by user.
2396 * - decoding: unused
a403fc03
JR
2397 */
2398 int min_partition_order;
2399
2400 /**
f5bccd85
DB
2401 * - encoding: Set by user.
2402 * - decoding: unused
a403fc03
JR
2403 */
2404 int max_partition_order;
80d617f5
BC
2405
2406 /**
2407 * GOP timecode frame start number, in non drop frame format
f5bccd85
DB
2408 * - encoding: Set by user.
2409 * - decoding: unused
80d617f5
BC
2410 */
2411 int64_t timecode_frame_start;
b1ec601f 2412
0d72e7d0 2413#if LIBAVCODEC_VERSION_MAJOR < 53
b1ec601f 2414 /**
85947156
VS
2415 * Decoder should decode to this many channels if it can (0 for default)
2416 * - encoding: unused
2417 * - decoding: Set by user.
0d72e7d0 2418 * @deprecated Deprecated in favor of request_channel_layout.
b1ec601f
RD
2419 */
2420 int request_channels;
0d72e7d0 2421#endif
1408352a
JR
2422
2423 /**
2424 * Percentage of dynamic range compression to be applied by the decoder.
2425 * The default value is 1.0, corresponding to full compression.
2426 * - encoding: unused
2427 * - decoding: Set by user.
2428 */
2429 float drc_scale;
79de84f2
MN
2430
2431 /**
2432 * opaque 64bit number (generally a PTS) that will be reordered and
2433 * output in AVFrame.reordered_opaque
2434 * - encoding: unused
2435 * - decoding: Set by user.
2436 */
2437 int64_t reordered_opaque;
312420f3
PR
2438
2439 /**
2440 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2441 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2442 * - encoding: set by user.
2443 * - decoding: set by libavcodec.
2444 */
2445 int bits_per_raw_sample;
0d72e7d0
PR
2446
2447 /**
2448 * Audio channel layout.
2449 * - encoding: set by user.
2450 * - decoding: set by libavcodec.
2451 */
2452 int64_t channel_layout;
2453
2454 /**
2455 * Request decoder to use this channel layout if it can (0 for default)
2456 * - encoding: unused
2457 * - decoding: Set by user.
2458 */
2459 int64_t request_channel_layout;
3bff4d8b
BC
2460
2461 /**
2462 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2463 * - encoding: Set by user.
2464 * - decoding: unused.
2465 */
2466 float rc_max_available_vbv_use;
2467
2468 /**
2469 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2470 * - encoding: Set by user.
2471 * - decoding: unused.
2472 */
2473 float rc_min_vbv_overflow_use;
40e5d31b
GB
2474
2475 /**
2476 * Hardware accelerator in use
2477 * - encoding: unused.
2478 * - decoding: Set by libavcodec
2479 */
2480 struct AVHWAccel *hwaccel;
3797c74b
MN
2481
2482 /**
2483 * For some codecs, the time base is closer to the field rate than the frame rate.
2484 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2485 * if no telecine is used ...
2486 *
2487 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2488 */
2489 int ticks_per_frame;
1aea7018
GB
2490
2491 /**
2492 * Hardware accelerator context.
2493 * For some hardware accelerators, a global context needs to be
2494 * provided by the user. In that case, this holds display-dependent
2495 * data FFmpeg cannot instantiate itself. Please refer to the
2496 * FFmpeg HW accelerator documentation to know how to fill this
2497 * is. e.g. for VA API, this is a struct vaapi_context.
2498 * - encoding: unused
2499 * - decoding: Set by user
2500 */
2501 void *hwaccel_context;
4ee6a5c1
MN
2502
2503 /**
2504 * Chromaticity coordinates of the source primaries.
2505 * - encoding: Set by user
2506 * - decoding: Set by libavcodec
2507 */
2508 enum AVColorPrimaries color_primaries;
2509
2510 /**
2511 * Color Transfer Characteristic.
2512 * - encoding: Set by user
2513 * - decoding: Set by libavcodec
2514 */
2515 enum AVColorTransferCharacteristic color_trc;
2516
2517 /**
2518 * YUV colorspace type.
2519 * - encoding: Set by user
2520 * - decoding: Set by libavcodec
2521 */
2522 enum AVColorSpace colorspace;
2523
2524 /**
2525 * MPEG vs JPEG YUV range.
2526 * - encoding: Set by user
2527 * - decoding: Set by libavcodec
2528 */
2529 enum AVColorRange color_range;
580a7465
DC
2530
2531 /**
2532 * This defines the location of chroma samples.
2533 * - encoding: Set by user
2534 * - decoding: Set by libavcodec
2535 */
8ea08bec 2536 enum AVChromaLocation chroma_sample_location;
8d23a86f
RD
2537
2538 /**
2539 * The codec may call this to execute several independent things.
2540 * It will return only after finishing all tasks.
2541 * The user may replace this with some multithreaded implementation,
2542 * the default implementation will execute the parts serially.
2543 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2544 * @param c context passed also to func
2545 * @param count the number of things to execute
2546 * @param arg2 argument passed unchanged to func
2547 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2548 * @param func function that will be called count times, with jobnr from 0 to count-1.
2549 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2550 * two instances of func executing at the same time will have the same threadnr.
2551 * @return always 0 currently, but code should handle a future improvement where when any call to func
2552 * returns < 0 no further calls to func may be done and < 0 is returned.
2553 * - encoding: Set by libavcodec, user can override.
2554 * - decoding: Set by libavcodec, user can override.
2555 */
2556 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
de6d9b64
FB
2557} AVCodecContext;
2558
64863965
MN
2559/**
2560 * AVCodec.
2561 */
de6d9b64 2562typedef struct AVCodec {
6b0cdb6e
NG
2563 /**
2564 * Name of the codec implementation.
2565 * The name is globally unique among encoders and among decoders (but an
2566 * encoder and a decoder can share the same name).
2567 * This is the primary way to find a codec from the user perspective.
2568 */
18f77016 2569 const char *name;
5d234974 2570 enum CodecType type;
9297ddd3 2571 enum CodecID id;
de6d9b64
FB
2572 int priv_data_size;
2573 int (*init)(AVCodecContext *);
0c1a9eda 2574 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 2575 int (*close)(AVCodecContext *);
7a00bbad 2576 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
a2d11246
MN
2577 /**
2578 * Codec capabilities.
2579 * see CODEC_CAP_*
2580 */
bf89e6b1 2581 int capabilities;
de6d9b64 2582 struct AVCodec *next;
c8cf325a
MN
2583 /**
2584 * Flush buffers.
2585 * Will be called when seeking
2586 */
7a06ff14 2587 void (*flush)(AVCodecContext *);
716e31ea 2588 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
1beb670a 2589 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
fe4bf374 2590 /**
bf7e799c
SS
2591 * Descriptive name for the codec, meant to be more human readable than name.
2592 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
fe4bf374
SS
2593 */
2594 const char *long_name;
3ade5d56 2595 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
88a07af7 2596 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
0d72e7d0 2597 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
de6d9b64
FB
2598} AVCodec;
2599
97d96aaa 2600/**
40e5d31b
GB
2601 * AVHWAccel.
2602 */
2603typedef struct AVHWAccel {
2604 /**
2605 * Name of the hardware accelerated codec.
2606 * The name is globally unique among encoders and among decoders (but an
2607 * encoder and a decoder can share the same name).
2608 */
2609 const char *name;
2610
2611 /**
2612 * Type of codec implemented by the hardware accelerator.
2613 *
2614 * See CODEC_TYPE_xxx
2615 */
2616 enum CodecType type;
2617
2618 /**
2619 * Codec implemented by the hardware accelerator.
2620 *
2621 * See CODEC_ID_xxx
2622 */
2623 enum CodecID id;
2624
2625 /**
2626 * Supported pixel format.
2627 *
2628 * Only hardware accelerated formats are supported here.
2629 */
2630 enum PixelFormat pix_fmt;
2631
2632 /**
2633 * Hardware accelerated codec capabilities.
2634 * see FF_HWACCEL_CODEC_CAP_*
2635 */
2636 int capabilities;
2637
2638 struct AVHWAccel *next;
2639
2640 /**
2641 * Called at the beginning of each frame or field picture.
2642 *
2643 * Meaningful frame information (codec specific) is guaranteed to
2644 * be parsed at this point. This function is mandatory.
2645 *
bf7e799c 2646 * Note that buf can be NULL along with buf_size set to 0.
40e5d31b
GB
2647 * Otherwise, this means the whole frame is available at this point.
2648 *
2649 * @param avctx the codec context
2650 * @param buf the frame data buffer base
2651 * @param buf_size the size of the frame in bytes
2652 * @return zero if successful, a negative value otherwise
2653 */
2654 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2655
2656 /**
2657 * Callback for each slice.
2658 *
2659 * Meaningful slice information (codec specific) is guaranteed to
2660 * be parsed at this point. This function is mandatory.
2661 *
2662 * @param avctx the codec context
2663 * @param buf the slice data buffer base
2664 * @param buf_size the size of the slice in bytes
2665 * @return zero if successful, a negative value otherwise
2666 */
2667 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2668
2669 /**
2670 * Called at the end of each frame or field picture.
2671 *
2672 * The whole picture is parsed at this point and can now be sent
2673 * to the hardware accelerator. This function is mandatory.
2674 *
2675 * @param avctx the codec context
2676 * @return zero if successful, a negative value otherwise
2677 */
2678 int (*end_frame)(AVCodecContext *avctx);
68e5d523
GB
2679
2680 /**
2681 * Size of HW accelerator private data.
2682 *
cd823ff9
GB
2683 * Private data is allocated with av_mallocz() before
2684 * AVCodecContext.get_buffer() and deallocated after
2685 * AVCodecContext.release_buffer().
68e5d523
GB
2686 */
2687 int priv_data_size;
40e5d31b
GB
2688} AVHWAccel;
2689
2690/**
d7425f59
MN
2691 * four components are given, that's all.
2692 * the last component is alpha
2693 */
de6d9b64 2694typedef struct AVPicture {
0c1a9eda 2695 uint8_t *data[4];
cd394651 2696 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
2697} AVPicture;
2698
2bbd8571 2699#if LIBAVCODEC_VERSION_MAJOR < 53
ba118447 2700/**
85947156
VS
2701 * AVPaletteControl
2702 * This structure defines a method for communicating palette changes
2703 * between and demuxer and a decoder.
2704 *
671adb17 2705 * @deprecated Use AVPacket to send palette changes instead.
85947156 2706 * This is totally broken.
ba118447 2707 */
2e99641b 2708#define AVPALETTE_SIZE 1024
432d84c3 2709#define AVPALETTE_COUNT 256
ba118447
MM
2710typedef struct AVPaletteControl {
2711
f5bccd85
DB
2712 /* Demuxer sets this to 1 to indicate the palette has changed;
2713 * decoder resets to 0. */
ba118447
MM
2714 int palette_changed;
2715
2a2bbcb0
MM
2716 /* 4-byte ARGB palette entries, stored in native byte order; note that
2717 * the individual palette components should be on a 8-bit scale; if
f5bccd85
DB
2718 * the palette data comes from an IBM VGA native format, the component
2719 * data is probably 6 bits in size and needs to be scaled. */
2e99641b 2720 unsigned int palette[AVPALETTE_COUNT];
ba118447 2721
18239edf 2722} AVPaletteControl attribute_deprecated;
2bbd8571 2723#endif
ba118447 2724
c66216ed
MN
2725enum AVSubtitleType {
2726 SUBTITLE_NONE,
2727
2728 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2729
2730 /**
2731 * Plain text, the text field must be set by the decoder and is
2732 * authoritative. ass and pict fields may contain approximations.
2733 */
2734 SUBTITLE_TEXT,
2735
2736 /**
2737 * Formatted text, the ass field must be set by the decoder and is
2738 * authoritative. pict and text fields may contain approximations.
2739 */
2740 SUBTITLE_ASS,
2741};
2742
c6ec28b1 2743typedef struct AVSubtitleRect {
ebc466bb
MN
2744 int x; ///< top left corner of pict, undefined when pict is not set
2745 int y; ///< top left corner of pict, undefined when pict is not set
2746 int w; ///< width of pict, undefined when pict is not set
2747 int h; ///< height of pict, undefined when pict is not set
2748 int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651
MN
2749
2750 /**
2751 * data+linesize for the bitmap of this subtitle.
2752 * can be set for text/ass as well once they where rendered
2753 */
2754 AVPicture pict;
f656106f
MN
2755 enum AVSubtitleType type;
2756
2757 char *text; ///< 0 terminated plain UTF-8 text
2758
2759 /**
2760 * 0 terminated ASS/SSA compatible event line.
2761 * The pressentation of this is unaffected by the other values in this
2762 * struct.
2763 */
2764 char *ass;
c6ec28b1
MN
2765} AVSubtitleRect;
2766
2767typedef struct AVSubtitle {
2768 uint16_t format; /* 0 = graphics */
2769 uint32_t start_display_time; /* relative to packet pts, in ms */
2770 uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb 2771 unsigned num_rects;
db4fac64 2772 AVSubtitleRect **rects;
4bbe788a 2773 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
240c1657
FB
2774} AVSubtitle;
2775
cdd8930e
TB
2776/* packet functions */
2777
80d403fc
RD
2778/**
2779 * @deprecated use NULL instead
2780 */
2781attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
cdd8930e
TB
2782
2783/**
2784 * Default packet destructor.
2785 */
2786void av_destruct_packet(AVPacket *pkt);
2787
2788/**
2789 * Initialize optional fields of a packet with default values.
2790 *
2791 * @param pkt packet
2792 */
2793void av_init_packet(AVPacket *pkt);
2794
2795/**
2796 * Allocate the payload of a packet and initialize its fields with
2797 * default values.
2798 *
2799 * @param pkt packet
2800 * @param size wanted payload size
2801 * @return 0 if OK, AVERROR_xxx otherwise
2802 */
2803int av_new_packet(AVPacket *pkt, int size);
2804
2805/**
feb993e5
RD
2806 * Reduce packet size, correctly zeroing padding
2807 *
2808 * @param pkt packet
2809 * @param size new size
2810 */
2811void av_shrink_packet(AVPacket *pkt, int size);
2812
2813/**
cdd8930e
TB
2814 * @warning This is a hack - the packet memory allocation stuff is broken. The
2815 * packet is allocated if it was not really allocated.
2816 */
2817int av_dup_packet(AVPacket *pkt);
2818
2819/**
2820 * Free a packet.
2821 *
2822 * @param pkt packet to free
2823 */
ce1d9c85 2824void av_free_packet(AVPacket *pkt);
240c1657 2825
de6d9b64
FB
2826/* resample.c */
2827
2828struct ReSampleContext;
aaaf1635 2829struct AVResampleContext;
de6d9b64
FB
2830
2831typedef struct ReSampleContext ReSampleContext;
2832
d1e3c6fd
BC
2833#if LIBAVCODEC_VERSION_MAJOR < 53
2834/**
2835 * @deprecated Use av_audio_resample_init() instead.
2836 */
2837attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2838 int output_rate, int input_rate);
2839#endif
2840/**
2841 * Initializes audio resampling context
2842 *
2843 * @param output_channels number of output channels
2844 * @param input_channels number of input channels
2845 * @param output_rate output sample rate
2846 * @param input_rate input sample rate
2847 * @param sample_fmt_out requested output sample format
2848 * @param sample_fmt_in input sample format
2849 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2850 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2851 * @param linear If 1 then the used FIR filter will be linearly interpolated
2852 between the 2 closest, if 0 the closest will be used
2853 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2854 * @return allocated ReSampleContext, NULL if error occured
2855 */
2856ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2857 int output_rate, int input_rate,
2858 enum SampleFormat sample_fmt_out,
2859 enum SampleFormat sample_fmt_in,
2860 int filter_length, int log2_phase_count,
2861 int linear, double cutoff);
2862
de6d9b64
FB
2863int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2864void audio_resample_close(ReSampleContext *s);
2865
3136fcf4
MN
2866
2867/**
2868 * Initializes an audio resampler.
2869 * Note, if either rate is not an integer then simply scale both rates up so they are.
990058bd
MN
2870 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2871 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2872 * @param linear If 1 then the used FIR filter will be linearly interpolated
2873 between the 2 closest, if 0 the closest will be used
2874 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3136fcf4 2875 */
6e225de2 2876struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3136fcf4
MN
2877
2878/**
2879 * resamples.
2880 * @param src an array of unconsumed samples
2881 * @param consumed the number of samples of src which have been consumed are returned here
2882 * @param src_size the number of unconsumed samples available
2883 * @param dst_size the amount of space in samples available in dst
2884 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
2885 * @return the number of samples written in dst or -1 if an error occurred
2886 */
aaaf1635 2887int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3136fcf4
MN
2888
2889
2890/**
2891 * Compensates samplerate/timestamp drift. The compensation is done by changing
2892 * the resampler parameters, so no audible clicks or similar distortions occur
2893 * @param compensation_distance distance in output samples over which the compensation should be performed
2894 * @param sample_delta number of output samples which should be output less
2895 *
2896 * example: av_resample_compensate(c, 10, 500)
2897 * here instead of 510 samples only 500 samples would be output
2898 *
2899 * note, due to rounding the actual compensation might be slightly different,
2900 * especially if the compensation_distance is large and the in_rate used during init is small
2901 */
2d48eddd 2902void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
d88443ae 2903void av_resample_close(struct AVResampleContext *c);
aaaf1635 2904
75917b88
DH
2905/**
2906 * Allocate memory for a picture. Call avpicture_free to free it.
2907 *
f5bccd85
DB
2908 * @param picture the picture to be filled in
2909 * @param pix_fmt the format of the picture
2910 * @param width the width of the picture
2911 * @param height the height of the picture
2912 * @return zero if successful, a negative value if not
75917b88 2913 */
a61ec8e7 2914int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
75917b88 2915
8fc3d25c
PI
2916/**
2917 * Free a picture previously allocated by avpicture_alloc().
2918 *
f5bccd85 2919 * @param picture the AVPicture to be freed
8fc3d25c 2920 */
75917b88
DH
2921void avpicture_free(AVPicture *picture);
2922
392cf77a 2923/**
f5bccd85 2924 * Fill in the AVPicture fields.
392cf77a
PI
2925 * The fields of the given AVPicture are filled in by using the 'ptr' address
2926 * which points to the image data buffer. Depending on the specified picture
2927 * format, one or multiple image data pointers and line sizes will be set.
2928 * If a planar format is specified, several pointers will be set pointing to
2929 * the different picture planes and the line sizes of the different planes
2930 * will be stored in the lines_sizes array.
899a8fa1 2931 * Call with ptr == NULL to get the required size for the ptr buffer.
392cf77a 2932 *
f5bccd85 2933 * @param picture AVPicture whose fields are to be filled in
392cf77a 2934 * @param ptr Buffer which will contain or contains the actual image data
f5bccd85
DB
2935 * @param pix_fmt The format in which the picture data is stored.
2936 * @param width the width of the image in pixels
2937 * @param height the height of the image in pixels
2938 * @return size of the image data in bytes
392cf77a 2939 */
0c1a9eda 2940int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4a30fff6 2941 enum PixelFormat pix_fmt, int width, int height);
a61ec8e7 2942int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
63167088 2943 unsigned char *dest, int dest_size);
392cf77a
PI
2944
2945/**
2946 * Calculate the size in bytes that a picture of the given width and height
2947 * would occupy if stored in the given picture format.
899a8fa1
RD
2948 * Note that this returns the size of a compact representation as generated
2949 * by avpicture_layout, which can be smaller than the size required for e.g.
2950 * avpicture_fill.
392cf77a 2951 *
f5bccd85
DB
2952 * @param pix_fmt the given picture format
2953 * @param width the width of the image
2954 * @param height the height of the image
899a8fa1 2955 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
392cf77a 2956 */
a61ec8e7
SS
2957int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2958void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
2959const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
21adafec 2960void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
d89f692f
SS
2961
2962/**
bf7e799c 2963 * Returns the pixel format corresponding to the name name.
d89f692f 2964 *
bf7e799c 2965 * If there is no pixel format with name name, then looks for a
d89f692f 2966 * pixel format with the name corresponding to the native endian
bf7e799c 2967 * format of name.
d89f692f
SS
2968 * For example in a little-endian system, first looks for "gray16",
2969 * then for "gray16le".
2970 *
bf7e799c 2971 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
d89f692f 2972 */
63167088 2973enum PixelFormat avcodec_get_pix_fmt(const char* name);
d07730dd 2974unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
219b06c6 2975
81299d42
PI
2976#define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2977#define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2978#define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2979#define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2980#define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2981#define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
fab21997 2982
392cf77a 2983/**
81299d42
PI
2984 * Computes what kind of losses will occur when converting from one specific
2985 * pixel format to another.
2986 * When converting from one pixel format to another, information loss may occur.
2987 * For example, when converting from RGB24 to GRAY, the color information will
2988 * be lost. Similarly, other losses occur when converting from some formats to
2989 * other formats. These losses can involve loss of chroma, but also loss of
2990 * resolution, loss of color depth, loss due to the color space conversion, loss
2991 * of the alpha bits or loss due to color quantization.
f5bccd85
DB
2992 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2993 * which will occur when converting from one pixel format to another.
81299d42 2994 *
f5bccd85
DB
2995 * @param[in] dst_pix_fmt destination pixel format
2996 * @param[in] src_pix_fmt source pixel format
81299d42
PI
2997 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2998 * @return Combination of flags informing you what kind of losses will occur.
392cf77a 2999 */
a61ec8e7 3000int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
fab21997 3001 int has_alpha);
392cf77a
PI
3002
3003/**
81299d42
PI
3004 * Finds the best pixel format to convert to given a certain source pixel
3005 * format. When converting from one pixel format to another, information loss
3006 * may occur. For example, when converting from RGB24 to GRAY, the color
3007 * information will be lost. Similarly, other losses occur when converting from
3008 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
f5bccd85
DB
3009 * the given pixel formats should be used to suffer the least amount of loss.
3010 * The pixel formats from which it chooses one, are determined by the
bf7e799c 3011 * pix_fmt_mask parameter.
81299d42
PI
3012 *
3013 * @code
3014 * src_pix_fmt = PIX_FMT_YUV420P;
3015 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3016 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3017 * @endcode
3018 *
f5bccd85
DB
3019 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3020 * @param[in] src_pix_fmt source pixel format
81299d42
PI
3021 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3022 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3023 * @return The best pixel format to convert to or -1 if none was found.
392cf77a 3024 */
a61ec8e7 3025enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
fab21997
FB
3026 int has_alpha, int *loss_ptr);
3027
c3b95b1d
SS
3028
3029/**
3030 * Print in buf the string corresponding to the pixel format with
3031 * number pix_fmt, or an header if pix_fmt is negative.
3032 *
9bd51b9a
PI
3033 * @param[in] buf the buffer where to write the string
3034 * @param[in] buf_size the size of buf
3035 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
c3b95b1d
SS
3036 * a negative value to print the corresponding header.
3037 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3038 */
a61ec8e7 3039void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
c3b95b1d 3040
0469baf1
FB
3041#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3042#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
392cf77a
PI
3043
3044/**
3045 * Tell if an image really has transparent alpha values.
3046 * @return ored mask of FF_ALPHA_xxx constants
3047 */
da64ecc3 3048int img_get_alpha_info(const AVPicture *src,
a61ec8e7 3049 enum PixelFormat pix_fmt, int width, int height);
0469baf1 3050
219b06c6 3051/* deinterlace a picture */
392cf77a 3052/* deinterlace - if not supported return -1 */
da64ecc3 3053int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
a61ec8e7 3054 enum PixelFormat pix_fmt, int width, int height);
de6d9b64
FB
3055
3056/* external high level API */
3057
0334f799
SS
3058/**
3059 * If c is NULL, returns the first registered codec,
c1b02101 3060 * if c is non-NULL, returns the next registered codec after c,
0334f799
SS
3061 * or NULL if c is the last one.
3062 */
55b9e69a 3063AVCodec *av_codec_next(AVCodec *c);
de6d9b64 3064
96afa6be
SS
3065/**
3066 * Returns the LIBAVCODEC_VERSION_INT constant.
3067 */
51a49663 3068unsigned avcodec_version(void);
96afa6be 3069
f9ec0aa1 3070/**
c1736936
DB
3071 * Returns the libavcodec build-time configuration.
3072 */
3073const char * avcodec_configuration(void);
3074
3075/**
3076 * Returns the libavcodec license.
3077 */
3078const char * avcodec_license(void);
3079
3080/**
f9ec0aa1
PI
3081 * Initializes libavcodec.
3082 *
bf7e799c 3083 * @warning This function must be called before any other libavcodec
f9ec0aa1
PI
3084 * function.
3085 */
de6d9b64
FB
3086void avcodec_init(void);
3087
9d385cfe 3088#if LIBAVCODEC_VERSION_MAJOR < 53
d1ca187f 3089/**
85662f49
SS
3090 * @deprecated Deprecated in favor of avcodec_register().
3091 */
3092attribute_deprecated void register_avcodec(AVCodec *codec);
9d385cfe 3093#endif
85662f49
SS
3094
3095/**
bf7e799c 3096 * Register the codec codec and initialize libavcodec.
d1ca187f
SS
3097 *
3098 * @see avcodec_init()
3099 */
85662f49 3100void avcodec_register(AVCodec *codec);
f9ec0aa1
PI
3101
3102/**
645f7879 3103 * Finds a registered encoder with a matching codec ID.
f9ec0aa1 3104 *
f5bccd85 3105 * @param id CodecID of the requested encoder
f9ec0aa1
PI
3106 * @return An encoder if one was found, NULL otherwise.
3107 */
de6d9b64 3108AVCodec *avcodec_find_encoder(enum CodecID id);
f9ec0aa1
PI
3109
3110/**
645f7879 3111 * Finds a registered encoder with the specified name.
f9ec0aa1 3112 *
f5bccd85 3113 * @param name name of the requested encoder
f9ec0aa1
PI
3114 * @return An encoder if one was found, NULL otherwise.
3115 */
98f3b098 3116AVCodec *avcodec_find_encoder_by_name(const char *name);
f9ec0aa1
PI
3117
3118/**
645f7879 3119 * Finds a registered decoder with a matching codec ID.
f9ec0aa1 3120 *
f5bccd85 3121 * @param id CodecID of the requested decoder
f9ec0aa1
PI
3122 * @return A decoder if one was found, NULL otherwise.
3123 */
de6d9b64 3124AVCodec *avcodec_find_decoder(enum CodecID id);
f9ec0aa1
PI
3125
3126/**
645f7879 3127 * Finds a registered decoder with the specified name.
f9ec0aa1 3128 *
f5bccd85 3129 * @param name name of the requested decoder
f9ec0aa1
PI
3130 * @return A decoder if one was found, NULL otherwise.