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