lavc doxy: fix formatting of AV_PKT_DATA_{PARAM_CHANGE,H263_MB_INFO}
[libav.git] / libavcodec / avcodec.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav 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 *
2912e87a 11 * Libav 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
2912e87a 17 * License along with Libav; 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/**
ba87f080 25 * @file
f5bccd85 26 * external API header
36df8805
MN
27 */
28
c60208e7 29#include <errno.h>
737eb597 30#include "libavutil/samplefmt.h"
76a448ed 31#include "libavutil/avutil.h"
7160bb71 32#include "libavutil/cpu.h"
0b950fe2 33#include "libavutil/dict.h"
abc78a5a 34#include "libavutil/log.h"
d49ea4af 35#include "libavutil/pixfmt.h"
e91709ca 36#include "libavutil/rational.h"
de6d9b64 37
3dd851c4 38#include "libavcodec/version.h"
e97e5a2e
LB
39/**
40 * @defgroup libavc Encoding/Decoding Library
41 * @{
42 *
43 * @defgroup lavc_decoding Decoding
44 * @{
45 * @}
46 *
47 * @defgroup lavc_encoding Encoding
48 * @{
49 * @}
50 *
51 * @defgroup lavc_codec Codecs
52 * @{
53 * @defgroup lavc_codec_native Native Codecs
54 * @{
55 * @}
56 * @defgroup lavc_codec_wrappers External library wrappers
57 * @{
58 * @}
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
60 * @{
61 * @}
62 * @}
63 * @defgroup lavc_internal Internal
64 * @{
65 * @}
66 * @}
67 *
68 */
69
294b3a50
AK
70/**
71 * @defgroup lavc_core Core functions/structures.
72 * @ingroup libavc
73 *
74 * Basic definitions, functions for querying libavcodec capabilities,
75 * allocating core structures, etc.
76 * @{
77 */
eda7c983 78
7ebf5927 79/**
48966b02 80 * Identify the syntax and semantics of the bitstream.
6b0cdb6e
NG
81 * The principle is roughly:
82 * Two decoders with the same ID can decode the same streams.
83 * Two encoders with the same ID can encode compatible streams.
84 * There may be slight deviations from the principle due to implementation
85 * details.
7ebf5927 86 *
f5bccd85
DB
87 * If you add a codec ID to this list, add it so that
88 * 1. no value of a existing codec ID changes (that would break ABI),
89 * 2. it is as close as possible to similar codecs.
7ebf5927 90 */
de6d9b64 91enum CodecID {
115329f1 92 CODEC_ID_NONE,
ba0dabbf
DB
93
94 /* video codecs */
de6d9b64 95 CODEC_ID_MPEG1VIDEO,
0e373b95 96 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
fb364ada 97 CODEC_ID_MPEG2VIDEO_XVMC,
c6148de2 98 CODEC_ID_H261,
de6d9b64
FB
99 CODEC_ID_H263,
100 CODEC_ID_RV10,
68b94c35 101 CODEC_ID_RV20,
de6d9b64 102 CODEC_ID_MJPEG,
b135d9fb 103 CODEC_ID_MJPEGB,
b1e6b355 104 CODEC_ID_LJPEG,
5e83dec4 105 CODEC_ID_SP5X,
5639729b 106 CODEC_ID_JPEGLS,
bf89e6b1 107 CODEC_ID_MPEG4,
de6d9b64 108 CODEC_ID_RAWVIDEO,
84afee34
MN
109 CODEC_ID_MSMPEG4V1,
110 CODEC_ID_MSMPEG4V2,
111 CODEC_ID_MSMPEG4V3,
e1a9dbff 112 CODEC_ID_WMV1,
b50eef3a 113 CODEC_ID_WMV2,
de6d9b64
FB
114 CODEC_ID_H263P,
115 CODEC_ID_H263I,
d4f5d74a 116 CODEC_ID_FLV1,
be8ffec9 117 CODEC_ID_SVQ1,
8b82a956 118 CODEC_ID_SVQ3,
020fcc94 119 CODEC_ID_DVVIDEO,
11f18faf 120 CODEC_ID_HUFFYUV,
f70f7c6d 121 CODEC_ID_CYUV,
0da71265 122 CODEC_ID_H264,
deabd4fd 123 CODEC_ID_INDEO3,
d86053a4 124 CODEC_ID_VP3,
f44ee2c3 125 CODEC_ID_THEORA,
3d2e8cce 126 CODEC_ID_ASV1,
9b56edf5 127 CODEC_ID_ASV2,
5e20f836 128 CODEC_ID_FFV1,
e2a7bb28 129 CODEC_ID_4XM,
be3564ed 130 CODEC_ID_VCR1,
3aff069b 131 CODEC_ID_CLJR,
c3bf0288 132 CODEC_ID_MDEC,
3ef8be2b
MM
133 CODEC_ID_ROQ,
134 CODEC_ID_INTERPLAY_VIDEO,
9937e686
MM
135 CODEC_ID_XAN_WC3,
136 CODEC_ID_XAN_WC4,
2fdf638b
MM
137 CODEC_ID_RPZA,
138 CODEC_ID_CINEPAK,
139 CODEC_ID_WS_VQA,
140 CODEC_ID_MSRLE,
141 CODEC_ID_MSVIDEO1,
4120a53a 142 CODEC_ID_IDCIN,
1dc1ed99 143 CODEC_ID_8BPS,
11e29a41 144 CODEC_ID_SMC,
42cad81a 145 CODEC_ID_FLIC,
9a4117d5 146 CODEC_ID_TRUEMOTION1,
fafa0b75 147 CODEC_ID_VMDVIDEO,
a273bbfb
RT
148 CODEC_ID_MSZH,
149 CODEC_ID_ZLIB,
070ed1bc 150 CODEC_ID_QTRLE,
791e7b83 151 CODEC_ID_SNOW,
9d53d58e 152 CODEC_ID_TSCC,
d0a0bbd2 153 CODEC_ID_ULTI,
d08d7142 154 CODEC_ID_QDRAW,
ab711b3c 155 CODEC_ID_VIXL,
acfd8f0f 156 CODEC_ID_QPEG,
17179d2d
MN
157 CODEC_ID_PNG,
158 CODEC_ID_PPM,
159 CODEC_ID_PBM,
160 CODEC_ID_PGM,
161 CODEC_ID_PGMYUV,
162 CODEC_ID_PAM,
f37b9768 163 CODEC_ID_FFVHUFF,
3f05305d
MN
164 CODEC_ID_RV30,
165 CODEC_ID_RV40,
10b9c374 166 CODEC_ID_VC1,
21aa398f 167 CODEC_ID_WMV3,
9c7fb608 168 CODEC_ID_LOCO,
a8a15e9d 169 CODEC_ID_WNV1,
589f8220 170 CODEC_ID_AASC,
856dbbff 171 CODEC_ID_INDEO2,
b81f8949 172 CODEC_ID_FRAPS,
64af6168 173 CODEC_ID_TRUEMOTION2,
9fa62f2a 174 CODEC_ID_BMP,
e0f80bd7 175 CODEC_ID_CSCD,
4e114829 176 CODEC_ID_MMVIDEO,
9c8d8e84 177 CODEC_ID_ZMBV,
26376701 178 CODEC_ID_AVS,
348efc18 179 CODEC_ID_SMACKVIDEO,
dfca23e3 180 CODEC_ID_NUV,
fd7b1991 181 CODEC_ID_KMVC,
0919e788 182 CODEC_ID_FLASHSV,
20ffddb9 183 CODEC_ID_CAVS,
f31065f6 184 CODEC_ID_JPEG2000,
eb57c889 185 CODEC_ID_VMNC,
5ce117c3
AJ
186 CODEC_ID_VP5,
187 CODEC_ID_VP6,
188 CODEC_ID_VP6F,
3689cf16 189 CODEC_ID_TARGA,
72450e50 190 CODEC_ID_DSICINVIDEO,
29f86228 191 CODEC_ID_TIERTEXSEQVIDEO,
a991b1fe 192 CODEC_ID_TIFF,
06d392a7 193 CODEC_ID_GIF,
33a0dd37 194 CODEC_ID_DXA,
52b6bad2 195 CODEC_ID_DNXHD,
efb0c399 196 CODEC_ID_THP,
2d99eed1 197 CODEC_ID_SGI,
9a0ddd09 198 CODEC_ID_C93,
1e6c6759 199 CODEC_ID_BETHSOFTVID,
b46d68c6 200 CODEC_ID_PTX,
1ca779e7 201 CODEC_ID_TXD,
91fc2cf1 202 CODEC_ID_VP6A,
8787d837 203 CODEC_ID_AMV,
66f7679c 204 CODEC_ID_VB,
b4abe1d1 205 CODEC_ID_PCX,
d43df959 206 CODEC_ID_SUNRAST,
800b9c24
BL
207 CODEC_ID_INDEO4,
208 CODEC_ID_INDEO5,
a7129de5 209 CODEC_ID_MIMIC,
975cdc8f 210 CODEC_ID_RL2,
40d26273 211 CODEC_ID_ESCAPE124,
782a58ec 212 CODEC_ID_DIRAC,
b64c096b 213 CODEC_ID_BFI,
495900f7 214 CODEC_ID_CMV,
974e0eee 215 CODEC_ID_MOTIONPIXELS,
cfc78718 216 CODEC_ID_TGV,
42b30357 217 CODEC_ID_TGQ,
d8964f3a 218 CODEC_ID_TQI,
c21fbefb
KS
219 CODEC_ID_AURA,
220 CODEC_ID_AURA2,
97f92143 221 CODEC_ID_V210X,
a1fd2bc3 222 CODEC_ID_TMV,
ca0bb1c4 223 CODEC_ID_V210,
94d3d6a4 224 CODEC_ID_DPX,
c63ea92b 225 CODEC_ID_MAD,
d8b35b85 226 CODEC_ID_FRWU,
0aa6a518 227 CODEC_ID_FLASHSV2,
a3d995c1 228 CODEC_ID_CDGRAPHICS,
4aaab0a3 229 CODEC_ID_R210,
a1ae40fd 230 CODEC_ID_ANM,
4e5f42dd 231 CODEC_ID_BINKVIDEO,
b9e06ddd
PR
232 CODEC_ID_IFF_ILBM,
233 CODEC_ID_IFF_BYTERUN1,
bf354122 234 CODEC_ID_KGV1,
148bcae9 235 CODEC_ID_YOP,
a98c2dfa 236 CODEC_ID_VP8,
a526d619 237 CODEC_ID_PICTOR,
beaa963c 238 CODEC_ID_ANSI,
40c5ee99
TB
239 CODEC_ID_A64_MULTI,
240 CODEC_ID_A64_MULTI5,
43836928 241 CODEC_ID_R10K,
9d09ebf1 242 CODEC_ID_MXPEG,
d267b339 243 CODEC_ID_LAGARITH,
f5b82f45 244 CODEC_ID_PRORES,
0697440c 245 CODEC_ID_JV,
42315dab 246 CODEC_ID_DFA,
45ecda85
AD
247 CODEC_ID_WMV3IMAGE,
248 CODEC_ID_VC1IMAGE,
0d8506b8 249 CODEC_ID_UTVIDEO,
f545e006 250 CODEC_ID_BMV_VIDEO,
c433a3f9 251 CODEC_ID_VBLE,
19341c58 252 CODEC_ID_DXTORY,
80f6c0bb 253 CODEC_ID_V410,
27ed027b 254 CODEC_ID_XWD,
dc4e5748 255 CODEC_ID_CDXL,
0afd8f12 256 CODEC_ID_XBM,
0e714f88 257 CODEC_ID_ZEROCODEC,
40c5ee99 258
f5bccd85 259 /* various PCM "codecs" */
bca06e77 260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
66760b30 261 CODEC_ID_PCM_S16LE = 0x10000,
a96b68b7
FB
262 CODEC_ID_PCM_S16BE,
263 CODEC_ID_PCM_U16LE,
264 CODEC_ID_PCM_U16BE,
265 CODEC_ID_PCM_S8,
266 CODEC_ID_PCM_U8,
267 CODEC_ID_PCM_MULAW,
268 CODEC_ID_PCM_ALAW,
b461b3bc
RD
269 CODEC_ID_PCM_S32LE,
270 CODEC_ID_PCM_S32BE,
271 CODEC_ID_PCM_U32LE,
272 CODEC_ID_PCM_U32BE,
273 CODEC_ID_PCM_S24LE,
274 CODEC_ID_PCM_S24BE,
275 CODEC_ID_PCM_U24LE,
276 CODEC_ID_PCM_U24BE,
277 CODEC_ID_PCM_S24DAUD,
a11c2a2c 278 CODEC_ID_PCM_ZORK,
725d86bf 279 CODEC_ID_PCM_S16LE_PLANAR,
1472b7dd 280 CODEC_ID_PCM_DVD,
aa29709e 281 CODEC_ID_PCM_F32BE,
143a5d6f
PR
282 CODEC_ID_PCM_F32LE,
283 CODEC_ID_PCM_F64BE,
284 CODEC_ID_PCM_F64LE,
5dd3707b 285 CODEC_ID_PCM_BLURAY,
fbeabfca 286 CODEC_ID_PCM_LXF,
9aa91043 287 CODEC_ID_S302M,
f1f6d361 288 CODEC_ID_PCM_S8_PLANAR,
0147f198 289
f5bccd85 290 /* various ADPCM codecs */
66760b30 291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
0147f198 292 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
2fdf638b 295 CODEC_ID_ADPCM_IMA_WS,
7d8379f2 296 CODEC_ID_ADPCM_IMA_SMJPEG,
0147f198 297 CODEC_ID_ADPCM_MS,
e2a7bb28 298 CODEC_ID_ADPCM_4XM,
fc384777
MM
299 CODEC_ID_ADPCM_XA,
300 CODEC_ID_ADPCM_ADX,
7d8379f2 301 CODEC_ID_ADPCM_EA,
e5966052 302 CODEC_ID_ADPCM_G726,
b3bfb299 303 CODEC_ID_ADPCM_CT,
659c3692 304 CODEC_ID_ADPCM_SWF,
2ff4524e 305 CODEC_ID_ADPCM_YAMAHA,
2433f24f
AJ
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
d1e0d21f 309 CODEC_ID_ADPCM_THP,
3a7f5d07 310 CODEC_ID_ADPCM_IMA_AMV,
e7583962
PR
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
7bb65d89 314 CODEC_ID_ADPCM_IMA_EA_SEAD,
fac84d3c 315 CODEC_ID_ADPCM_IMA_EA_EACS,
271b4095 316 CODEC_ID_ADPCM_EA_XAS,
861c63a2 317 CODEC_ID_ADPCM_EA_MAXIS_XA,
055dc116 318 CODEC_ID_ADPCM_IMA_ISS,
58e37eaf 319 CODEC_ID_ADPCM_G722,
220506d2 320 CODEC_ID_ADPCM_IMA_APC,
891f64b3 321
17179d2d 322 /* AMR */
66760b30 323 CODEC_ID_AMR_NB = 0x12000,
d663a1fd
MN
324 CODEC_ID_AMR_WB,
325
b8414bbd 326 /* RealAudio codecs*/
66760b30 327 CODEC_ID_RA_144 = 0x13000,
b8414bbd 328 CODEC_ID_RA_288,
3ef8be2b
MM
329
330 /* various DPCM codecs */
66760b30 331 CODEC_ID_ROQ_DPCM = 0x14000,
3ef8be2b 332 CODEC_ID_INTERPLAY_DPCM,
9937e686 333 CODEC_ID_XAN_DPCM,
d08d7142 334 CODEC_ID_SOL_DPCM,
115329f1 335
ba0dabbf 336 /* audio codecs */
66760b30 337 CODEC_ID_MP2 = 0x15000,
0e373b95 338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
17179d2d 339 CODEC_ID_AAC,
17179d2d
MN
340 CODEC_ID_AC3,
341 CODEC_ID_DTS,
342 CODEC_ID_VORBIS,
343 CODEC_ID_DVAUDIO,
344 CODEC_ID_WMAV1,
345 CODEC_ID_WMAV2,
346 CODEC_ID_MACE3,
347 CODEC_ID_MACE6,
348 CODEC_ID_VMDAUDIO,
ac2570a8 349 CODEC_ID_FLAC,
1ede228a 350 CODEC_ID_MP3ADU,
d2a7718d 351 CODEC_ID_MP3ON4,
85ad5695 352 CODEC_ID_SHORTEN,
5df8a0c6 353 CODEC_ID_ALAC,
034eeaa1 354 CODEC_ID_WESTWOOD_SND1,
0e373b95 355 CODEC_ID_GSM, ///< as in Berlin toast format
d9b1c197 356 CODEC_ID_QDM2,
e0f7e329 357 CODEC_ID_COOK,
bf3027c8 358 CODEC_ID_TRUESPEECH,
a24c4a2a 359 CODEC_ID_TTA,
348efc18 360 CODEC_ID_SMACKAUDIO,
6c496518 361 CODEC_ID_QCELP,
730581f3 362 CODEC_ID_WAVPACK,
72450e50 363 CODEC_ID_DSICINAUDIO,
84ed36da 364 CODEC_ID_IMC,
185c7b6b 365 CODEC_ID_MUSEPACK7,
aad512b4 366 CODEC_ID_MLP,
f5bccd85 367 CODEC_ID_GSM_MS, /* as found in WAV */
10e26bc7 368 CODEC_ID_ATRAC3,
8950f828 369 CODEC_ID_VOXWARE,
bf4a1f17 370 CODEC_ID_APE,
636b13c5 371 CODEC_ID_NELLYMOSER,
12877faf 372 CODEC_ID_MUSEPACK8,
cb4ddf77 373 CODEC_ID_SPEEX,
7bb8d51c
BL
374 CODEC_ID_WMAVOICE,
375 CODEC_ID_WMAPRO,
800b9c24 376 CODEC_ID_WMALOSSLESS,
b339f0c6 377 CODEC_ID_ATRAC3P,
2988c93d 378 CODEC_ID_EAC3,
faeedbbb 379 CODEC_ID_SIPR,
7f507b2d 380 CODEC_ID_MP1,
616e899c 381 CODEC_ID_TWINVQ,
9ba4821d 382 CODEC_ID_TRUEHD,
b24bbbb4 383 CODEC_ID_MP4ALS,
223e8df1 384 CODEC_ID_ATRAC1,
4e5f42dd
DV
385 CODEC_ID_BINKAUDIO_RDFT,
386 CODEC_ID_BINKAUDIO_DCT,
136e19e1 387 CODEC_ID_AAC_LATM,
ed19fafd 388 CODEC_ID_QDMC,
4ca59d19 389 CODEC_ID_CELT,
463ea05a
DB
390 CODEC_ID_G723_1,
391 CODEC_ID_G729,
19900d60
KS
392 CODEC_ID_8SVX_EXP,
393 CODEC_ID_8SVX_FIB,
f545e006 394 CODEC_ID_BMV_AUDIO,
b8560637 395 CODEC_ID_RALF,
115329f1 396
240c1657 397 /* subtitle codecs */
bca06e77 398 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
66760b30 399 CODEC_ID_DVD_SUBTITLE = 0x17000,
115329f1 400 CODEC_ID_DVB_SUBTITLE,
0e373b95 401 CODEC_ID_TEXT, ///< raw UTF-8 text
7e2643ae 402 CODEC_ID_XSUB,
f9a9b350 403 CODEC_ID_SSA,
cc8c2c6a 404 CODEC_ID_MOV_TEXT,
c58b82a2 405 CODEC_ID_HDMV_PGS_SUBTITLE,
e58992e4 406 CODEC_ID_DVB_TELETEXT,
ba2c508d 407 CODEC_ID_SRT,
115329f1 408
7ce68923 409 /* other specific kind of codecs (generally used for attachments) */
bca06e77 410 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
66760b30 411 CODEC_ID_TTF = 0x18000,
f8d7c9d3 412
66760b30 413 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
0bef08e5 414
66760b30 415 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
f5bccd85 416 * stream (only used by libavformat) */
77b5c82b
AC
417 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
418 * stream (only used by libavformat) */
66760b30 419 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
de6d9b64 420};
dcedf586 421
0eea2129 422#if FF_API_OLD_DECODE_AUDIO
de6d9b64 423/* in bytes */
8170e5fb 424#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
0eea2129 425#endif
de6d9b64 426
d7425f59 427/**
cf713bb8 428 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
171b7b91
AC
429 * This is mainly needed because some optimized bitstream readers read
430 * 32 or 64 bit at once and could read over the end.<br>
f5bccd85
DB
431 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
432 * MPEG bitstreams could cause overread and segfault.
d7425f59 433 */
171b7b91 434#define FF_INPUT_BUFFER_PADDING_SIZE 8
d7425f59 435
0ecca7a4 436/**
f5bccd85
DB
437 * minimum encoding buffer size
438 * Used to avoid some checks during header writing.
0ecca7a4
MN
439 */
440#define FF_MIN_BUFFER_SIZE 16384
441
47146dfb 442
0e373b95 443/**
bafc102b 444 * motion estimation type.
0e373b95 445 */
e4986da9 446enum Motion_Est_ID {
9b4dd1b8 447 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
e4986da9
J
448 ME_FULL,
449 ME_LOG,
450 ME_PHODS,
9b4dd1b8
MN
451 ME_EPZS, ///< enhanced predictive zonal search
452 ME_X1, ///< reserved for experiments
453 ME_HEX, ///< hexagon based search
454 ME_UMH, ///< uneven multi-hexagon search
455 ME_ITER, ///< iterative search
359bbdab 456 ME_TESA, ///< transformed exhaustive search algorithm
e4986da9
J
457};
458
8c3eba7c 459enum AVDiscard{
f5bccd85
DB
460 /* We leave some space between them for extensions (drop some
461 * keyframes for intra-only or drop just some bidir frames). */
8c3eba7c
MN
462 AVDISCARD_NONE =-16, ///< discard nothing
463 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
464 AVDISCARD_NONREF = 8, ///< discard all non reference
465 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
466 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
467 AVDISCARD_ALL = 48, ///< discard all
468};
469
4ee6a5c1
MN
470enum AVColorPrimaries{
471 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
472 AVCOL_PRI_UNSPECIFIED=2,
473 AVCOL_PRI_BT470M =4,
474 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
475 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
476 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
477 AVCOL_PRI_FILM =8,
478 AVCOL_PRI_NB , ///< Not part of ABI
479};
480
481enum AVColorTransferCharacteristic{
482 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
483 AVCOL_TRC_UNSPECIFIED=2,
484 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
485 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
486 AVCOL_TRC_NB , ///< Not part of ABI
487};
488
489enum AVColorSpace{
490 AVCOL_SPC_RGB =0,
491 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
492 AVCOL_SPC_UNSPECIFIED=2,
493 AVCOL_SPC_FCC =4,
494 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
495 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
496 AVCOL_SPC_SMPTE240M =7,
497 AVCOL_SPC_NB , ///< Not part of ABI
498};
499
500enum AVColorRange{
501 AVCOL_RANGE_UNSPECIFIED=0,
502 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
503 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
504 AVCOL_RANGE_NB , ///< Not part of ABI
505};
506
580a7465
DC
507/**
508 * X X 3 4 X X are luma samples,
509 * 1 2 1-6 are possible chroma positions
510 * X X 5 6 X 0 is undefined/unknown position
511 */
512enum AVChromaLocation{
513 AVCHROMA_LOC_UNSPECIFIED=0,
514 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
515 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
516 AVCHROMA_LOC_TOPLEFT =3, ///< DV
517 AVCHROMA_LOC_TOP =4,
518 AVCHROMA_LOC_BOTTOMLEFT =5,
519 AVCHROMA_LOC_BOTTOM =6,
520 AVCHROMA_LOC_NB , ///< Not part of ABI
521};
522
34b47d7c
JR
523enum AVAudioServiceType {
524 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
525 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
526 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
527 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
528 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
529 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
530 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
531 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
532 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
533 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
534};
535
ce980a95
MN
536typedef struct RcOverride{
537 int start_frame;
538 int end_frame;
f5bccd85 539 int qscale; // If this is 0 then quality_factor will be used instead.
ce980a95
MN
540 float quality_factor;
541} RcOverride;
542
b0ec9efd 543#define FF_MAX_B_FRAMES 16
9dbcbd92 544
a949d72e 545/* encoding support
f5bccd85
DB
546 These flags can be passed in AVCodecContext.flags before initialization.
547 Note: Not everything is supported yet.
a949d72e 548*/
de6d9b64 549
f5bccd85
DB
550#define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
551#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
552#define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
553#define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
554#define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
1ba8f5eb
MN
555/**
556 * The parent program guarantees that the input for B-frames containing
f5bccd85 557 * streams is not written to for at least s->max_b_frames+1 frames, if
1ba8f5eb
MN
558 * this is not set the input will be copied.
559 */
8b4c7dbc 560#define CODEC_FLAG_INPUT_PRESERVED 0x0100
273b0cd3
DB
561#define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
562#define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
273b0cd3
DB
563#define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
564#define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
565#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
566#define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
567 location instead of only at frame boundaries. */
f5bccd85
DB
568#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
569#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
570#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
f5bccd85
DB
571#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
572#define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
21e59552 573/* Fx : Flag for h263+ extra options */
f5bccd85 574#define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
332f9ac4 575#define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
bb198e19 576#define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
f3eec1cf 577#define CODEC_FLAG_CLOSED_GOP 0x80000000
f5bccd85 578#define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
f5bccd85
DB
579#define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
580#define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
ed019b8e 581#if FF_API_MPV_GLOBAL_OPTS
af3d804f 582#define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
ff71a383 583#define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
a249f0cc 584#define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
f013cb81 585#define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
ed019b8e 586#endif
f013cb81 587#define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
6fc5b059 588
21e59552 589/* Unsupported options :
bb270c08
DB
590 * Syntax Arithmetic coding (SAC)
591 * Reference Picture Selection
eafcac6a 592 * Independent Segment Decoding */
21e59552 593/* /Fx */
bf89e6b1
FB
594/* codec capabilities */
595
f5bccd85 596#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
6814a25c 597/**
9b489e02
RD
598 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
599 * If not set, it might not use get_buffer() at all or use operations that
600 * assume the buffer was allocated by avcodec_default_get_buffer.
6814a25c
MN
601 */
602#define CODEC_CAP_DR1 0x0002
d7425f59 603#define CODEC_CAP_TRUNCATED 0x0008
f5bccd85 604/* Codec can export data for HW decoding (XvMC). */
5e5c247a 605#define CODEC_CAP_HWACCEL 0x0010
115329f1 606/**
3f6aa85e
JR
607 * Encoder or decoder requires flushing with NULL input at the end in order to
608 * give the complete and correct output.
609 *
610 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
611 * with NULL data. The user can still send NULL data to the public encode
612 * or decode function, but libavcodec will not pass it along to the codec
613 * unless this flag is set.
614 *
615 * Decoders:
616 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
ffeeae92 617 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
3f6aa85e
JR
618 * returns frames.
619 *
620 * Encoders:
621 * The encoder needs to be fed with NULL data at the end of encoding until the
622 * encoder no longer returns data.
b2c75b6e
JR
623 *
624 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
625 * flag also means that the encoder must set the pts and duration for
626 * each output packet. If this flag is not set, the pts and duration will
627 * be determined by libavcodec from the input frame.
934982c4 628 */
6f824977 629#define CODEC_CAP_DELAY 0x0020
cef7cc72
JR
630/**
631 * Codec can be fed a final frame with a smaller size.
632 * This can be used to prevent truncation of the last audio samples.
633 */
634#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
369122dd
NC
635/**
636 * Codec can export data for HW decoding (VDPAU).
637 */
638#define CODEC_CAP_HWACCEL_VDPAU 0x0080
d859bb1d
SS
639/**
640 * Codec can output multiple frames per AVPacket
e9e949cf
MN
641 * Normally demuxers return one frame at a time, demuxers which do not do
642 * are connected to a parser to split what they return into proper frames.
643 * This flag is reserved to the very rare category of codecs which have a
644 * bitstream that cannot be split into frames without timeconsuming
645 * operations like full decoding. Demuxers carring such bitstreams thus
646 * may return multiple frames in a packet. This has many disadvantages like
647 * prohibiting stream copy in many cases thus it should only be considered
648 * as a last resort.
d859bb1d
SS
649 */
650#define CODEC_CAP_SUBFRAMES 0x0100
93ebfeea
JG
651/**
652 * Codec is experimental and is thus avoided in favor of non experimental
653 * encoders
654 */
655#define CODEC_CAP_EXPERIMENTAL 0x0200
62784e37
BL
656/**
657 * Codec should fill in channel configuration and samplerate instead of container
658 */
659#define CODEC_CAP_CHANNEL_CONF 0x0400
16cfc961
SS
660/**
661 * Codec is able to deal with negative linesizes
662 */
663#define CODEC_CAP_NEG_LINESIZES 0x0800
37b00b47
AS
664/**
665 * Codec supports frame-level multithreading.
666 */
667#define CODEC_CAP_FRAME_THREADS 0x1000
94f7451a
RB
668/**
669 * Codec supports slice-based (or partition-based) multithreading.
670 */
671#define CODEC_CAP_SLICE_THREADS 0x2000
fe75dc85
MS
672/**
673 * Codec supports changed parameters at any point.
674 */
675#define CODEC_CAP_PARAM_CHANGE 0x4000
b4d44a45
JG
676/**
677 * Codec supports avctx->thread_count == 0 (auto).
678 */
679#define CODEC_CAP_AUTO_THREADS 0x8000
b2c75b6e
JR
680/**
681 * Audio encoder supports receiving a different number of samples in each call.
682 */
683#define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
bf89e6b1 684
f5bccd85 685//The following defines may change, don't expect compatibility if you use them.
8d7ec294 686#define MB_TYPE_INTRA4x4 0x0001
f5bccd85
DB
687#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
688#define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
8d7ec294
WH
689#define MB_TYPE_16x16 0x0008
690#define MB_TYPE_16x8 0x0010
691#define MB_TYPE_8x16 0x0020
692#define MB_TYPE_8x8 0x0040
693#define MB_TYPE_INTERLACED 0x0080
273b0cd3 694#define MB_TYPE_DIRECT2 0x0100 //FIXME
8d7ec294
WH
695#define MB_TYPE_ACPRED 0x0200
696#define MB_TYPE_GMC 0x0400
697#define MB_TYPE_SKIP 0x0800
698#define MB_TYPE_P0L0 0x1000
699#define MB_TYPE_P1L0 0x2000
700#define MB_TYPE_P0L1 0x4000
701#define MB_TYPE_P1L1 0x8000
702#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
703#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
704#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
705#define MB_TYPE_QUANT 0x00010000
706#define MB_TYPE_CBP 0x00020000
707//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
708
fa384dcc
MN
709/**
710 * Pan Scan area.
f5bccd85
DB
711 * This specifies the area which should be displayed.
712 * Note there may be multiple such areas for one frame.
fa384dcc
MN
713 */
714typedef struct AVPanScan{
715 /**
f5bccd85
DB
716 * id
717 * - encoding: Set by user.
718 * - decoding: Set by libavcodec.
fa384dcc
MN
719 */
720 int id;
721
722 /**
723 * width and height in 1/16 pel
f5bccd85
DB
724 * - encoding: Set by user.
725 * - decoding: Set by libavcodec.
fa384dcc
MN
726 */
727 int width;
728 int height;
729
730 /**
f5bccd85
DB
731 * position of the top left corner in 1/16 pel for up to 3 fields/frames
732 * - encoding: Set by user.
733 * - decoding: Set by libavcodec.
fa384dcc
MN
734 */
735 int16_t position[3][2];
736}AVPanScan;
737
bb270c08
DB
738#define FF_QSCALE_TYPE_MPEG1 0
739#define FF_QSCALE_TYPE_MPEG2 1
740#define FF_QSCALE_TYPE_H264 2
800274f8 741#define FF_QSCALE_TYPE_VP56 3
4e00e76b
MN
742
743#define FF_BUFFER_TYPE_INTERNAL 1
f5bccd85
DB
744#define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
745#define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
746#define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
4e00e76b 747
f5bccd85
DB
748#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
749#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
750#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
751#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
074c4ca7 752
30f3f625
AK
753/**
754 * @defgroup lavc_packet AVPacket
755 *
756 * Types and functions for working with AVPacket.
757 * @{
758 */
4de339e2
KS
759enum AVPacketSideDataType {
760 AV_PKT_DATA_PALETTE,
195c123c 761 AV_PKT_DATA_NEW_EXTRADATA,
30f3f625
AK
762
763 /**
764 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
199ada49 765 * @code
30f3f625
AK
766 * u32le param_flags
767 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
768 * s32le channel_count
769 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
770 * u64le channel_layout
771 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
772 * s32le sample_rate
773 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
774 * s32le width
775 * s32le height
199ada49 776 * @endcode
30f3f625 777 */
fe75dc85 778 AV_PKT_DATA_PARAM_CHANGE,
30f3f625
AK
779
780 /**
781 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
782 * structures with info about macroblocks relevant to splitting the
783 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
784 * That is, it does not necessarily contain info about all macroblocks,
785 * as long as the distance between macroblocks in the info is smaller
786 * than the target payload size.
787 * Each MB info structure is 12 bytes, and is laid out as follows:
199ada49 788 * @code
30f3f625
AK
789 * u32le bit offset from the start of the packet
790 * u8 current quantizer at the start of the macroblock
791 * u8 GOB number
792 * u16le macroblock address within the GOB
793 * u8 horizontal MV predictor
794 * u8 vertical MV predictor
795 * u8 horizontal MV predictor for block number 3
796 * u8 vertical MV predictor for block number 3
199ada49 797 * @endcode
30f3f625 798 */
bdc1220e 799 AV_PKT_DATA_H263_MB_INFO,
4de339e2
KS
800};
801
18c915ee
TB
802typedef struct AVPacket {
803 /**
7b356d39
RS
804 * Presentation timestamp in AVStream->time_base units; the time at which
805 * the decompressed packet will be presented to the user.
18c915ee
TB
806 * Can be AV_NOPTS_VALUE if it is not stored in the file.
807 * pts MUST be larger or equal to dts as presentation cannot happen before
808 * decompression, unless one wants to view hex dumps. Some formats misuse
809 * the terms dts and pts/cts to mean something different. Such timestamps
810 * must be converted to true pts/dts before they are stored in AVPacket.
811 */
812 int64_t pts;
813 /**
7b356d39
RS
814 * Decompression timestamp in AVStream->time_base units; the time at which
815 * the packet is decompressed.
18c915ee
TB
816 * Can be AV_NOPTS_VALUE if it is not stored in the file.
817 */
818 int64_t dts;
819 uint8_t *data;
820 int size;
821 int stream_index;
9d39cbf6
LB
822 /**
823 * A combination of AV_PKT_FLAG values
824 */
18c915ee
TB
825 int flags;
826 /**
4de339e2
KS
827 * Additional packet data that can be provided by the container.
828 * Packet can contain several types of side information.
829 */
830 struct {
831 uint8_t *data;
832 int size;
833 enum AVPacketSideDataType type;
834 } *side_data;
835 int side_data_elems;
836
837 /**
7b356d39 838 * Duration of this packet in AVStream->time_base units, 0 if unknown.
18c915ee
TB
839 * Equals next_pts - this_pts in presentation order.
840 */
841 int duration;
842 void (*destruct)(struct AVPacket *);
843 void *priv;
844 int64_t pos; ///< byte position in stream, -1 if unknown
845
846 /**
7b356d39 847 * Time difference in AVStream->time_base units from the pts of this
18c915ee
TB
848 * packet to the point at which the output from the decoder has converged
849 * independent from the availability of previous frames. That is, the
850 * frames are virtually identical no matter if decoding started from
851 * the very first frame or from this keyframe.
852 * Is AV_NOPTS_VALUE if unknown.
853 * This field is not the display duration of the current packet.
8ee82f40
AJ
854 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
855 * set.
18c915ee
TB
856 *
857 * The purpose of this field is to allow seeking in streams that have no
858 * keyframes in the conventional sense. It corresponds to the
859 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
860 * essential for some types of subtitle streams to ensure that all
861 * subtitles are correctly displayed after seeking.
862 */
863 int64_t convergence_duration;
864} AVPacket;
9d39cbf6
LB
865#define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
866#define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
18c915ee 867
fe75dc85
MS
868enum AVSideDataParamChangeFlags {
869 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
870 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
871 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
872 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
873};
30f3f625
AK
874/**
875 * @}
876 */
fe75dc85
MS
877
878/**
0da71265 879 * Audio Video Frame.
657ccb5a
DB
880 * New fields can be added to the end of AVFRAME with minor version
881 * bumps. Removal, reordering and changes to existing fields require
882 * a major version bump.
8bfb108b 883 * sizeof(AVFrame) must not be used outside libav*.
0da71265 884 */
492cd3a9 885typedef struct AVFrame {
560f773c 886#define AV_NUM_DATA_POINTERS 8
657ccb5a 887 /**
0eea2129 888 * pointer to the picture/channel planes.
657ccb5a 889 * This might be different from the first allocated byte
0eea2129
JR
890 * - encoding: Set by user
891 * - decoding: set by AVCodecContext.get_buffer()
657ccb5a 892 */
560f773c 893 uint8_t *data[AV_NUM_DATA_POINTERS];
0eea2129
JR
894
895 /**
896 * Size, in bytes, of the data for each picture/channel plane.
897 *
898 * For audio, only linesize[0] may be set. For planar audio, each channel
899 * plane must be the same size.
900 *
9814974d 901 * - encoding: Set by user
0eea2129
JR
902 * - decoding: set by AVCodecContext.get_buffer()
903 */
560f773c 904 int linesize[AV_NUM_DATA_POINTERS];
0eea2129 905
657ccb5a 906 /**
1d428004
AK
907 * pointers to the data planes/channels.
908 *
909 * For video, this should simply point to data[].
910 *
911 * For planar audio, each channel has a separate data pointer, and
912 * linesize[0] contains the size of each channel buffer.
913 * For packed audio, there is just one data pointer, and linesize[0]
914 * contains the total size of the buffer for all channels.
915 *
916 * Note: Both data and extended_data will always be set by get_buffer(),
917 * but for planar audio with more channels that can fit in data,
918 * extended_data must be used by the decoder in order to access all
919 * channels.
920 *
921 * encoding: unused
922 * decoding: set by AVCodecContext.get_buffer()
657ccb5a 923 */
1d428004
AK
924 uint8_t **extended_data;
925
926 /**
927 * width and height of the video frame
928 * - encoding: unused
929 * - decoding: Read by user.
930 */
931 int width, height;
932
933 /**
934 * number of audio samples (per channel) described by this frame
935 * - encoding: Set by user
936 * - decoding: Set by libavcodec
937 */
938 int nb_samples;
939
940 /**
941 * format of the frame, -1 if unknown or unset
942 * Values correspond to enum PixelFormat for video frames,
943 * enum AVSampleFormat for audio)
944 * - encoding: unused
945 * - decoding: Read by user.
946 */
947 int format;
948
657ccb5a
DB
949 /**
950 * 1 -> keyframe, 0-> not
951 * - encoding: Set by libavcodec.
952 * - decoding: Set by libavcodec.
953 */
954 int key_frame;
955
956 /**
957 * Picture type of the frame, see ?_TYPE below.
958 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
959 * - decoding: Set by libavcodec.
960 */
961 enum AVPictureType pict_type;
962
963 /**
1d428004
AK
964 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
965 * This isn't used by libavcodec unless the default get/release_buffer() is used.
966 * - encoding:
967 * - decoding:
968 */
969 uint8_t *base[AV_NUM_DATA_POINTERS];
970
971 /**
972 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
973 * - encoding: unused
974 * - decoding: Read by user.
975 */
976 AVRational sample_aspect_ratio;
977
978 /**
657ccb5a
DB
979 * presentation timestamp in time_base units (time when frame should be shown to user)
980 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
981 * - encoding: MUST be set by user.
982 * - decoding: Set by libavcodec.
983 */
984 int64_t pts;
985
986 /**
1d428004
AK
987 * reordered pts from the last AVPacket that has been input into the decoder
988 * - encoding: unused
989 * - decoding: Read by user.
990 */
991 int64_t pkt_pts;
992
993 /**
994 * dts from the last AVPacket that has been input into the decoder
995 * - encoding: unused
996 * - decoding: Read by user.
997 */
998 int64_t pkt_dts;
999
1000 /**
657ccb5a
DB
1001 * picture number in bitstream order
1002 * - encoding: set by
1003 * - decoding: Set by libavcodec.
1004 */
1005 int coded_picture_number;
1006 /**
1007 * picture number in display order
1008 * - encoding: set by
1009 * - decoding: Set by libavcodec.
1010 */
1011 int display_picture_number;
1012
1013 /**
1014 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1015 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1016 * - decoding: Set by libavcodec.
1017 */
1018 int quality;
1019
657ccb5a
DB
1020 /**
1021 * is this picture used as reference
1022 * The values for this are the same as the MpegEncContext.picture_structure
1023 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1024 * Set to 4 for delayed, non-reference frames.
1025 * - encoding: unused
1026 * - decoding: Set by libavcodec. (before get_buffer() call)).
1027 */
1028 int reference;
1029
1030 /**
1031 * QP table
1032 * - encoding: unused
1033 * - decoding: Set by libavcodec.
1034 */
1035 int8_t *qscale_table;
1036 /**
1037 * QP store stride
1038 * - encoding: unused
1039 * - decoding: Set by libavcodec.
1040 */
1041 int qstride;
1042
1043 /**
1d428004
AK
1044 *
1045 */
1046 int qscale_type;
1047
1048 /**
657ccb5a
DB
1049 * mbskip_table[mb]>=1 if MB didn't change
1050 * stride= mb_width = (width+15)>>4
1051 * - encoding: unused
1052 * - decoding: Set by libavcodec.
1053 */
1054 uint8_t *mbskip_table;
1055
1056 /**
1057 * motion vector table
1058 * @code
1059 * example:
1060 * int mv_sample_log2= 4 - motion_subsample_log2;
1061 * int mb_width= (width+15)>>4;
1062 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1063 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1064 * @endcode
1065 * - encoding: Set by user.
1066 * - decoding: Set by libavcodec.
1067 */
1068 int16_t (*motion_val[2])[2];
1069
1070 /**
1071 * macroblock type table
1072 * mb_type_base + mb_width + 2
1073 * - encoding: Set by user.
1074 * - decoding: Set by libavcodec.
1075 */
1076 uint32_t *mb_type;
1077
1078 /**
1d428004 1079 * DCT coefficients
657ccb5a
DB
1080 * - encoding: unused
1081 * - decoding: Set by libavcodec.
1082 */
1d428004
AK
1083 short *dct_coeff;
1084
1085 /**
1086 * motion reference frame index
1087 * the order in which these are stored can depend on the codec.
1088 * - encoding: Set by user.
1089 * - decoding: Set by libavcodec.
1090 */
1091 int8_t *ref_index[2];
657ccb5a
DB
1092
1093 /**
1094 * for some private data of the user
1095 * - encoding: unused
1096 * - decoding: Set by user.
1097 */
1098 void *opaque;
1099
1100 /**
1101 * error
1102 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1103 * - decoding: unused
1104 */
560f773c 1105 uint64_t error[AV_NUM_DATA_POINTERS];
657ccb5a
DB
1106
1107 /**
1108 * type of the buffer (to keep track of who has to deallocate data[*])
1109 * - encoding: Set by the one who allocates it.
1110 * - decoding: Set by the one who allocates it.
1111 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1112 */
1113 int type;
1114
1115 /**
1116 * When decoding, this signals how much the picture must be delayed.
1117 * extra_delay = repeat_pict / (2*fps)
1118 * - encoding: unused
1119 * - decoding: Set by libavcodec.
1120 */
1121 int repeat_pict;
1122
1123 /**
657ccb5a
DB
1124 * The content of the picture is interlaced.
1125 * - encoding: Set by user.
1126 * - decoding: Set by libavcodec. (default 0)
1127 */
1128 int interlaced_frame;
1129
1130 /**
1131 * If the content is interlaced, is top field displayed first.
1132 * - encoding: Set by user.
1133 * - decoding: Set by libavcodec.
1134 */
1135 int top_field_first;
1136
1137 /**
657ccb5a
DB
1138 * Tell user application that palette has changed from previous frame.
1139 * - encoding: ??? (no palette-enabled encoder yet)
1140 * - decoding: Set by libavcodec. (default 0).
1141 */
1142 int palette_has_changed;
1143
1144 /**
1145 * codec suggestion on buffer type if != 0
1146 * - encoding: unused
1147 * - decoding: Set by libavcodec. (before get_buffer() call)).
1148 */
1149 int buffer_hints;
1150
1151 /**
1d428004 1152 * Pan scan.
657ccb5a
DB
1153 * - encoding: Set by user.
1154 * - decoding: Set by libavcodec.
1155 */
1d428004 1156 AVPanScan *pan_scan;
657ccb5a
DB
1157
1158 /**
1159 * reordered opaque 64bit (generally an integer or a double precision float
1160 * PTS but can be anything).
1161 * The user sets AVCodecContext.reordered_opaque to represent the input at
1162 * that time,
1163 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1164 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1165 * @deprecated in favor of pkt_pts
1166 * - encoding: unused
1167 * - decoding: Read by user.
1168 */
1169 int64_t reordered_opaque;
1170
1171 /**
1172 * hardware accelerator private data (Libav-allocated)
1173 * - encoding: unused
1174 * - decoding: Set by libavcodec
1175 */
1176 void *hwaccel_picture_private;
1177
1178 /**
657ccb5a
DB
1179 * the AVCodecContext which ff_thread_get_buffer() was last called on
1180 * - encoding: Set by libavcodec.
1181 * - decoding: Set by libavcodec.
1182 */
1183 struct AVCodecContext *owner;
1184
1185 /**
1186 * used by multithreading to store frame-specific info
1187 * - encoding: Set by libavcodec.
1188 * - decoding: Set by libavcodec.
1189 */
1190 void *thread_opaque;
0eea2129
JR
1191
1192 /**
1d428004
AK
1193 * log2 of the size of the block which a single vector in motion_val represents:
1194 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
8a4a5f6f 1195 * - encoding: unused
1d428004 1196 * - decoding: Set by libavcodec.
8a4a5f6f 1197 */
1d428004 1198 uint8_t motion_subsample_log2;
492cd3a9 1199} AVFrame;
1e491e29 1200
f3a29b75
JR
1201struct AVCodecInternal;
1202
4bf3c8f2
AC
1203enum AVFieldOrder {
1204 AV_FIELD_UNKNOWN,
1205 AV_FIELD_PROGRESSIVE,
1206 AV_FIELD_TT, //< Top coded_first, top displayed first
1207 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1208 AV_FIELD_TB, //< Top coded first, bottom displayed first
1209 AV_FIELD_BT, //< Bottom coded first, top displayed first
1210};
1211
d33c949c 1212/**
252f17e2
MN
1213 * main external API structure.
1214 * New fields can be added to the end with minor version bumps.
8bfb108b 1215 * Removal, reordering and changes to existing fields require a major
252f17e2 1216 * version bump.
8bfb108b 1217 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 1218 */
de6d9b64 1219typedef struct AVCodecContext {
b71901e6 1220 /**
f5bccd85 1221 * information on struct for av_log
488eec10 1222 * - set by avcodec_alloc_context3
bc874dae 1223 */
d42a814e 1224 const AVClass *av_class;
b1edfce0
AK
1225 int log_level_offset;
1226
1227 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1228 struct AVCodec *codec;
1229 char codec_name[32];
1230 enum CodecID codec_id; /* see CODEC_ID_xxx */
1231
1232 /**
1233 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1234 * This is used to work around some encoder bugs.
1235 * A demuxer should set this to what is stored in the field used to identify the codec.
1236 * If there are multiple such fields in a container then the demuxer should choose the one
1237 * which maximizes the information about the used codec.
1238 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1239 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1240 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1241 * first.
1242 * - encoding: Set by user, if not then the default based on codec_id will be used.
1243 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1244 */
1245 unsigned int codec_tag;
1246
1247 /**
1248 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1249 * This is used to work around some encoder bugs.
1250 * - encoding: unused
1251 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1252 */
1253 unsigned int stream_codec_tag;
1254
02beb982 1255#if FF_API_SUB_ID
b1edfce0 1256 /**
02beb982 1257 * @deprecated this field is unused
b1edfce0 1258 */
02beb982
AK
1259 attribute_deprecated int sub_id;
1260#endif
b1edfce0
AK
1261
1262 void *priv_data;
1263
1264 /**
1265 * Private context used for internal data.
1266 *
1267 * Unlike priv_data, this is not codec-specific. It is used in general
1268 * libavcodec functions.
1269 */
1270 struct AVCodecInternal *internal;
1271
1272 /**
1273 * Private data of the user, can be used to carry app specific stuff.
1274 * - encoding: Set by user.
1275 * - decoding: Set by user.
1276 */
1277 void *opaque;
1278
bc874dae 1279 /**
f5bccd85
DB
1280 * the average bitrate
1281 * - encoding: Set by user; unused for constant quantizer encoding.
1282 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 1283 */
de6d9b64 1284 int bit_rate;
b71901e6
MN
1285
1286 /**
64863965 1287 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 1288 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 1289 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 1290 * - decoding: unused
b71901e6 1291 */
115329f1 1292 int bit_rate_tolerance;
b71901e6
MN
1293
1294 /**
b1edfce0
AK
1295 * Global quality for codecs which cannot change it per frame.
1296 * This should be proportional to MPEG-1/2/4 qscale.
f5bccd85 1297 * - encoding: Set by user.
b1edfce0 1298 * - decoding: unused
b71901e6 1299 */
b1edfce0 1300 int global_quality;
b71901e6
MN
1301
1302 /**
b1edfce0
AK
1303 * - encoding: Set by user.
1304 * - decoding: unused
b71901e6 1305 */
b1edfce0
AK
1306 int compression_level;
1307#define FF_COMPRESSION_DEFAULT -1
b71901e6
MN
1308
1309 /**
b1edfce0
AK
1310 * CODEC_FLAG_*.
1311 * - encoding: Set by user.
1312 * - decoding: Set by user.
b71901e6 1313 */
b1edfce0
AK
1314 int flags;
1315
1316 /**
1317 * CODEC_FLAG2_*
1318 * - encoding: Set by user.
1319 * - decoding: Set by user.
1320 */
1321 int flags2;
b71901e6
MN
1322
1323 /**
f5bccd85
DB
1324 * some codecs need / can use extradata like Huffman tables.
1325 * mjpeg: Huffman tables
b71901e6 1326 * rv10: additional flags
b704e742 1327 * mpeg4: global headers (they can be in the bitstream or here)
f5bccd85
DB
1328 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1329 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1330 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1331 * - encoding: Set/allocated/freed by libavcodec.
1332 * - decoding: Set/allocated/freed by user.
b71901e6 1333 */
58f2a4b0 1334 uint8_t *extradata;
e84c31dc 1335 int extradata_size;
115329f1 1336
b71901e6 1337 /**
f5bccd85
DB
1338 * This is the fundamental unit of time (in seconds) in terms
1339 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
1340 * timebase should be 1/framerate and timestamp increments should be
1341 * identically 1.
f5bccd85
DB
1342 * - encoding: MUST be set by user.
1343 * - decoding: Set by libavcodec.
b71901e6 1344 */
c0df9d75 1345 AVRational time_base;
115329f1 1346
b1edfce0
AK
1347 /**
1348 * For some codecs, the time base is closer to the field rate than the frame rate.
1349 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1350 * if no telecine is used ...
1351 *
1352 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1353 */
1354 int ticks_per_frame;
1355
1356 /**
1357 * Encoder delay.
1358 *
1359 * Video:
1360 * Number of frames the decoded output will be delayed relative to the
1361 * encoded input.
1362 *
1363 * Audio:
1364 * Number of "priming" samples added to the beginning of the stream
1365 * during encoding. The decoded output will be delayed by this many
1366 * samples relative to the input to the encoder. Note that this field is
1367 * purely informational and does not directly affect the pts output by
1368 * the encoder, which should always be based on the actual presentation
1369 * time, including any delay.
1370 *
1371 * - encoding: Set by libavcodec.
1372 * - decoding: unused
1373 */
1374 int delay;
1375
1376
5b28c8c3 1377 /* video only */
14bea432 1378 /**
21adafec 1379 * picture width / height.
115329f1 1380 * - encoding: MUST be set by user.
f5bccd85
DB
1381 * - decoding: Set by libavcodec.
1382 * Note: For compatibility it is possible to set this instead of
1383 * coded_width/height before decoding.
b71901e6 1384 */
de6d9b64 1385 int width, height;
115329f1 1386
b1edfce0
AK
1387 /**
1388 * Bitstream width / height, may be different from width/height if lowres enabled.
1389 * - encoding: unused
1390 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1391 */
1392 int coded_width, coded_height;
1393
e769f053 1394#define FF_ASPECT_EXTENDED 15
b71901e6
MN
1395
1396 /**
f5bccd85
DB
1397 * the number of pictures in a group of pictures, or 0 for intra_only
1398 * - encoding: Set by user.
64863965 1399 * - decoding: unused
b71901e6
MN
1400 */
1401 int gop_size;
1402
1403 /**
f5bccd85 1404 * Pixel format, see PIX_FMT_xxx.
c1bdc930
TH
1405 * May be set by the demuxer if known from headers.
1406 * May be overriden by the decoder if it knows better.
f5bccd85 1407 * - encoding: Set by user.
c1bdc930 1408 * - decoding: Set by user if known, overridden by libavcodec if known
b71901e6 1409 */
e4eadb4b 1410 enum PixelFormat pix_fmt;
115329f1 1411
b71901e6 1412 /**
b1edfce0
AK
1413 * Motion estimation algorithm used for video coding.
1414 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1415 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1416 * - encoding: MUST be set by user.
1417 * - decoding: unused
1418 */
1419 int me_method;
1420
1421 /**
f5bccd85
DB
1422 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1423 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 1424 * all codecs can do that. You must check the codec capabilities
f5bccd85 1425 * beforehand.
37b00b47
AS
1426 * When multithreading is used, it may be called from multiple threads
1427 * at the same time; threads might draw different parts of the same AVFrame,
1428 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1429 * in order.
24b1583a
IK
1430 * The function is also used by hardware acceleration APIs.
1431 * It is called at least once during frame decoding to pass
1432 * the data needed for hardware render.
1433 * In that mode instead of pixel data, AVFrame points to
1434 * a structure specific to the acceleration API. The application
1435 * reads the structure and can change some fields to indicate progress
1436 * or mark state.
64863965 1437 * - encoding: unused
f5bccd85 1438 * - decoding: Set by user.
3bb07d61
MN
1439 * @param height the height of the slice
1440 * @param y the y position of the slice
1441 * @param type 1->top field, 2->bottom field, 3->frame
1442 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 1443 */
bf89e6b1 1444 void (*draw_horiz_band)(struct AVCodecContext *s,
560f773c 1445 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
3bb07d61 1446 int y, int type, int height);
bf89e6b1 1447
a3a5f4d6 1448 /**
b1edfce0
AK
1449 * callback to negotiate the pixelFormat
1450 * @param fmt is the list of formats which are supported by the codec,
1451 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1452 * The first is always the native one.
1453 * @return the chosen format
1454 * - encoding: unused
1455 * - decoding: Set by user, if not set the native format will be chosen.
a3a5f4d6 1456 */
b1edfce0 1457 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
de6d9b64 1458
718b27a7 1459 /**
b1edfce0
AK
1460 * maximum number of B-frames between non-B-frames
1461 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1462 * - encoding: Set by user.
1463 * - decoding: unused
718b27a7 1464 */
b1edfce0 1465 int max_b_frames;
115329f1 1466
b71901e6 1467 /**
b1edfce0
AK
1468 * qscale factor between IP and B-frames
1469 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1470 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1471 * - encoding: Set by user.
64863965 1472 * - decoding: unused
b71901e6 1473 */
b1edfce0 1474 float b_quant_factor;
115329f1 1475
b1edfce0
AK
1476 /** obsolete FIXME remove */
1477 int rc_strategy;
1478#define FF_RC_STRATEGY_XVID 1
1479
1480 int b_frame_strategy;
115329f1 1481
63efd83a 1482#if FF_API_MPV_GLOBAL_OPTS
b71901e6 1483 /**
b1edfce0 1484 * luma single coefficient elimination threshold
f5bccd85 1485 * - encoding: Set by user.
64863965 1486 * - decoding: unused
b71901e6 1487 */
63efd83a 1488 attribute_deprecated int luma_elim_threshold;
b71901e6
MN
1489
1490 /**
b1edfce0 1491 * chroma single coeff elimination threshold
f5bccd85 1492 * - encoding: Set by user.
64863965 1493 * - decoding: unused
b71901e6 1494 */
63efd83a
AK
1495 attribute_deprecated int chroma_elim_threshold;
1496#endif
b71901e6
MN
1497
1498 /**
b1edfce0 1499 * qscale offset between IP and B-frames
f5bccd85 1500 * - encoding: Set by user.
64863965 1501 * - decoding: unused
b71901e6 1502 */
b1edfce0 1503 float b_quant_offset;
b71901e6
MN
1504
1505 /**
b1edfce0
AK
1506 * Size of the frame reordering buffer in the decoder.
1507 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1508 * - encoding: Set by libavcodec.
1509 * - decoding: Set by libavcodec.
1510 */
1511 int has_b_frames;
1512
1513 /**
1514 * 0-> h263 quant 1-> mpeg quant
f5bccd85 1515 * - encoding: Set by user.
64863965 1516 * - decoding: unused
b71901e6 1517 */
b1edfce0 1518 int mpeg_quant;
b71901e6
MN
1519
1520 /**
b1edfce0
AK
1521 * qscale factor between P and I-frames
1522 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
662e5411 1523 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85 1524 * - encoding: Set by user.
64863965 1525 * - decoding: unused
b71901e6 1526 */
b1edfce0 1527 float i_quant_factor;
64b7c5b6 1528
b1edfce0
AK
1529 /**
1530 * qscale offset between P and I-frames
1531 * - encoding: Set by user.
1532 * - decoding: unused
1533 */
1534 float i_quant_offset;
9dbcbd92 1535
b1edfce0
AK
1536 /**
1537 * luminance masking (0-> disabled)
1538 * - encoding: Set by user.
1539 * - decoding: unused
1540 */
1541 float lumi_masking;
115329f1 1542
b1edfce0
AK
1543 /**
1544 * temporary complexity masking (0-> disabled)
1545 * - encoding: Set by user.
1546 * - decoding: unused
1547 */
1548 float temporal_cplx_masking;
de6d9b64 1549
b1edfce0
AK
1550 /**
1551 * spatial complexity masking (0-> disabled)
1552 * - encoding: Set by user.
1553 * - decoding: unused
1554 */
1555 float spatial_cplx_masking;
115329f1 1556
b71901e6 1557 /**
b1edfce0 1558 * p block masking (0-> disabled)
f5bccd85 1559 * - encoding: Set by user.
64863965 1560 * - decoding: unused
b71901e6 1561 */
b1edfce0 1562 float p_masking;
115329f1 1563
b71901e6 1564 /**
b1edfce0 1565 * darkness masking (0-> disabled)
f5bccd85 1566 * - encoding: Set by user.
64863965 1567 * - decoding: unused
b71901e6 1568 */
b1edfce0 1569 float dark_masking;
115329f1 1570
b71901e6 1571 /**
b1edfce0
AK
1572 * slice count
1573 * - encoding: Set by libavcodec.
1574 * - decoding: Set by user (or 0).
b71901e6 1575 */
b1edfce0 1576 int slice_count;
b71901e6 1577 /**
b1edfce0 1578 * prediction method (needed for huffyuv)
f5bccd85 1579 * - encoding: Set by user.
64863965 1580 * - decoding: unused
b71901e6 1581 */
b1edfce0
AK
1582 int prediction_method;
1583#define FF_PRED_LEFT 0
1584#define FF_PRED_PLANE 1
1585#define FF_PRED_MEDIAN 2
115329f1 1586
b71901e6 1587 /**
b1edfce0
AK
1588 * slice offsets in the frame in bytes
1589 * - encoding: Set/allocated by libavcodec.
1590 * - decoding: Set/allocated by user (or NULL).
b71901e6 1591 */
b1edfce0 1592 int *slice_offset;
0fd90455 1593
b71901e6 1594 /**
b1edfce0
AK
1595 * sample aspect ratio (0 if unknown)
1596 * That is the width of a pixel divided by the height of the pixel.
1597 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1598 * - encoding: Set by user.
f5bccd85 1599 * - decoding: Set by libavcodec.
b71901e6 1600 */
b1edfce0 1601 AVRational sample_aspect_ratio;
115329f1 1602
b71901e6 1603 /**
b1edfce0 1604 * motion estimation comparison function
f5bccd85 1605 * - encoding: Set by user.
64863965 1606 * - decoding: unused
b71901e6 1607 */
b1edfce0 1608 int me_cmp;
b71901e6 1609 /**
b1edfce0 1610 * subpixel motion estimation comparison function
f5bccd85 1611 * - encoding: Set by user.
64863965 1612 * - decoding: unused
b71901e6 1613 */
b1edfce0 1614 int me_sub_cmp;
b71901e6 1615 /**
b1edfce0 1616 * macroblock comparison function (not supported yet)
f5bccd85 1617 * - encoding: Set by user.
64863965 1618 * - decoding: unused
b71901e6 1619 */
b1edfce0 1620 int mb_cmp;
b71901e6 1621 /**
b1edfce0 1622 * interlaced DCT comparison function
f5bccd85 1623 * - encoding: Set by user.
64863965 1624 * - decoding: unused
b71901e6 1625 */
b1edfce0
AK
1626 int ildct_cmp;
1627#define FF_CMP_SAD 0
1628#define FF_CMP_SSE 1
1629#define FF_CMP_SATD 2
1630#define FF_CMP_DCT 3
1631#define FF_CMP_PSNR 4
1632#define FF_CMP_BIT 5
1633#define FF_CMP_RD 6
1634#define FF_CMP_ZERO 7
1635#define FF_CMP_VSAD 8
1636#define FF_CMP_VSSE 9
1637#define FF_CMP_NSSE 10
1638#define FF_CMP_W53 11
1639#define FF_CMP_W97 12
1640#define FF_CMP_DCTMAX 13
1641#define FF_CMP_DCT264 14
1642#define FF_CMP_CHROMA 256
115329f1 1643
b71901e6 1644 /**
b1edfce0 1645 * ME diamond size & shape
f5bccd85 1646 * - encoding: Set by user.
64863965 1647 * - decoding: unused
b71901e6 1648 */
b1edfce0 1649 int dia_size;
b71901e6
MN
1650
1651 /**
b1edfce0 1652 * amount of previous MV predictors (2a+1 x 2a+1 square)
f5bccd85 1653 * - encoding: Set by user.
64863965 1654 * - decoding: unused
b71901e6 1655 */
b1edfce0 1656 int last_predictor_count;
115329f1 1657
b71901e6 1658 /**
b1edfce0 1659 * prepass for motion estimation
f5bccd85 1660 * - encoding: Set by user.
64863965 1661 * - decoding: unused
b71901e6 1662 */
b1edfce0 1663 int pre_me;
115329f1 1664
b71901e6 1665 /**
b1edfce0 1666 * motion estimation prepass comparison function
f5bccd85 1667 * - encoding: Set by user.
64863965 1668 * - decoding: unused
b71901e6 1669 */
b1edfce0 1670 int me_pre_cmp;
917e06c8 1671
b71901e6 1672 /**
b1edfce0 1673 * ME prepass diamond size & shape
f5bccd85 1674 * - encoding: Set by user.
64863965 1675 * - decoding: unused
b71901e6 1676 */
b1edfce0 1677 int pre_dia_size;
115329f1 1678
c5d309f2 1679 /**
b1edfce0 1680 * subpel ME quality
f5bccd85 1681 * - encoding: Set by user.
64863965 1682 * - decoding: unused
c5d309f2 1683 */
b1edfce0 1684 int me_subpel_quality;
115329f1 1685
c5d309f2 1686 /**
b1edfce0
AK
1687 * DTG active format information (additional aspect ratio
1688 * information only used in DVB MPEG-2 transport streams)
1689 * 0 if not set.
1690 *
1691 * - encoding: unused
1692 * - decoding: Set by decoder.
c5d309f2 1693 */
b1edfce0
AK
1694 int dtg_active_format;
1695#define FF_DTG_AFD_SAME 8
1696#define FF_DTG_AFD_4_3 9
1697#define FF_DTG_AFD_16_9 10
1698#define FF_DTG_AFD_14_9 11
1699#define FF_DTG_AFD_4_3_SP_14_9 13
1700#define FF_DTG_AFD_16_9_SP_14_9 14
1701#define FF_DTG_AFD_SP_4_3 15
115329f1 1702
c5d309f2 1703 /**
b1edfce0
AK
1704 * maximum motion estimation search range in subpel units
1705 * If 0 then no limit.
1706 *
f5bccd85 1707 * - encoding: Set by user.
64863965 1708 * - decoding: unused
c5d309f2 1709 */
b1edfce0 1710 int me_range;
115329f1 1711
c5d309f2 1712 /**
b1edfce0 1713 * intra quantizer bias
f5bccd85 1714 * - encoding: Set by user.
64863965 1715 * - decoding: unused
c5d309f2 1716 */
b1edfce0
AK
1717 int intra_quant_bias;
1718#define FF_DEFAULT_QUANT_BIAS 999999
15415af4 1719
5e746b99 1720 /**
b1edfce0 1721 * inter quantizer bias
f5bccd85 1722 * - encoding: Set by user.
64863965 1723 * - decoding: unused
5e746b99 1724 */
b1edfce0 1725 int inter_quant_bias;
115329f1 1726
4f07f819 1727#if FF_API_COLOR_TABLE_ID
0c2dd16e 1728 /**
b1edfce0
AK
1729 * color table ID
1730 * - encoding: unused
1731 * - decoding: Which clrtable should be used for 8bit RGB images.
1732 * Tables have to be stored somewhere. FIXME
2ad1516a 1733 */
4f07f819
AK
1734 attribute_deprecated int color_table_id;
1735#endif
2ad1516a 1736
144f0625 1737 /**
b1edfce0
AK
1738 * slice flags
1739 * - encoding: unused
1740 * - decoding: Set by user.
144f0625 1741 */
b1edfce0
AK
1742 int slice_flags;
1743#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1744#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1745#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1746
144f0625 1747 /**
b1edfce0
AK
1748 * XVideo Motion Acceleration
1749 * - encoding: forbidden
1750 * - decoding: set by decoder
144f0625 1751 */
b1edfce0 1752 int xvmc_acceleration;
144f0625 1753
4d2858de 1754 /**
b1edfce0
AK
1755 * macroblock decision mode
1756 * - encoding: Set by user.
1757 * - decoding: unused
4d2858de 1758 */
b1edfce0
AK
1759 int mb_decision;
1760#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1761#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1762#define FF_MB_DECISION_RD 2 ///< rate distortion
4d2858de 1763
6b72ac63 1764 /**
b1edfce0
AK
1765 * custom intra quantization matrix
1766 * - encoding: Set by user, can be NULL.
1767 * - decoding: Set by libavcodec.
bec89a84 1768 */
b1edfce0 1769 uint16_t *intra_matrix;
7160bb71 1770
11f18faf 1771 /**
b1edfce0
AK
1772 * custom inter quantization matrix
1773 * - encoding: Set by user, can be NULL.
1774 * - decoding: Set by libavcodec.
11f18faf 1775 */
b1edfce0 1776 uint16_t *inter_matrix;
115329f1 1777
11f18faf 1778 /**
b1edfce0
AK
1779 * scene change detection threshold
1780 * 0 is default, larger means fewer detected scene changes.
f5bccd85 1781 * - encoding: Set by user.
64863965 1782 * - decoding: unused
11f18faf 1783 */
b1edfce0 1784 int scenechange_threshold;
115329f1 1785
5d3cea3a 1786 /**
b1edfce0 1787 * noise reduction strength
f5bccd85 1788 * - encoding: Set by user.
b1edfce0 1789 * - decoding: unused
5d3cea3a 1790 */
b1edfce0 1791 int noise_reduction;
1e491e29 1792
16b7557b 1793#if FF_API_INTER_THRESHOLD
1e491e29 1794 /**
16b7557b 1795 * @deprecated this field is unused
1e491e29 1796 */
16b7557b
AK
1797 attribute_deprecated int inter_threshold;
1798#endif
c8c437bc 1799
23bfcc06 1800#if FF_API_MPV_GLOBAL_OPTS
c8c437bc 1801 /**
23bfcc06 1802 * @deprecated use mpegvideo private options instead
c8c437bc 1803 */
23bfcc06
AK
1804 attribute_deprecated int quantizer_noise_shaping;
1805#endif
115329f1 1806
140cb663 1807 /**
b1edfce0
AK
1808 * Motion estimation threshold below which no motion estimation is
1809 * performed, but instead the user specified motion vectors are used.
1810 *
f5bccd85 1811 * - encoding: Set by user.
b1edfce0 1812 * - decoding: unused
0c9bbaec 1813 */
b1edfce0 1814 int me_threshold;
0c9bbaec
WH
1815
1816 /**
b1edfce0
AK
1817 * Macroblock threshold below which the user specified macroblock types will be used.
1818 * - encoding: Set by user.
64863965 1819 * - decoding: unused
140cb663 1820 */
b1edfce0 1821 int mb_threshold;
115329f1 1822
1457ab52 1823 /**
b1edfce0 1824 * precision of the intra DC coefficient - 8
f5bccd85 1825 * - encoding: Set by user.
64863965 1826 * - decoding: unused
1457ab52 1827 */
b1edfce0
AK
1828 int intra_dc_precision;
1829
1457ab52 1830 /**
b1edfce0
AK
1831 * Number of macroblock rows at the top which are skipped.
1832 * - encoding: unused
1833 * - decoding: Set by user.
1457ab52 1834 */
b1edfce0
AK
1835 int skip_top;
1836
1457ab52 1837 /**
b1edfce0
AK
1838 * Number of macroblock rows at the bottom which are skipped.
1839 * - encoding: unused
1840 * - decoding: Set by user.
1457ab52 1841 */
b1edfce0
AK
1842 int skip_bottom;
1843
622348f9 1844 /**
b1edfce0
AK
1845 * Border processing masking, raises the quantizer for mbs on the borders
1846 * of the picture.
f5bccd85 1847 * - encoding: Set by user.
622348f9
MN
1848 * - decoding: unused
1849 */
b1edfce0 1850 float border_masking;
115329f1 1851
1457ab52 1852 /**
b1edfce0 1853 * minimum MB lagrange multipler
f5bccd85 1854 * - encoding: Set by user.
64863965 1855 * - decoding: unused
1457ab52 1856 */
b1edfce0 1857 int mb_lmin;
b07a5980
MN
1858
1859 /**
b1edfce0 1860 * maximum MB lagrange multipler
f5bccd85 1861 * - encoding: Set by user.
64863965 1862 * - decoding: unused
b07a5980 1863 */
b1edfce0 1864 int mb_lmax;
70ac76c0 1865
f5fb6b34 1866 /**
b1edfce0 1867 *
f5bccd85 1868 * - encoding: Set by user.
64863965 1869 * - decoding: unused
f5fb6b34 1870 */
b1edfce0 1871 int me_penalty_compensation;
b07a5980 1872
70ac76c0 1873 /**
b1edfce0 1874 *
f5bccd85 1875 * - encoding: Set by user.
64863965 1876 * - decoding: unused
70ac76c0 1877 */
b1edfce0 1878 int bidir_refine;
826f429a 1879
70ac76c0 1880 /**
b1edfce0 1881 *
f5bccd85 1882 * - encoding: Set by user.
64863965 1883 * - decoding: unused
70ac76c0 1884 */
b1edfce0 1885 int brd_scale;
70ac76c0 1886
826f429a 1887 /**
b1edfce0 1888 * minimum GOP size
f5bccd85 1889 * - encoding: Set by user.
64863965 1890 * - decoding: unused
826f429a 1891 */
b1edfce0 1892 int keyint_min;
826f429a 1893
a33c7159 1894 /**
b1edfce0
AK
1895 * number of reference frames
1896 * - encoding: Set by user.
1897 * - decoding: Set by lavc.
a33c7159 1898 */
b1edfce0 1899 int refs;
e2f9490e
FB
1900
1901 /**
b1edfce0
AK
1902 * chroma qp offset from luma
1903 * - encoding: Set by user.
1904 * - decoding: unused
e2f9490e 1905 */
b1edfce0 1906 int chromaoffset;
e2f9490e 1907
ebbcdc9a 1908 /**
b1edfce0 1909 * Multiplied by qscale for each frame and added to scene_change_score.
f5bccd85
DB
1910 * - encoding: Set by user.
1911 * - decoding: unused
ebbcdc9a 1912 */
b1edfce0 1913 int scenechange_factor;
ebbcdc9a 1914
65f7062d 1915 /**
b1edfce0
AK
1916 *
1917 * Note: Value depends upon the compare function used for fullpel ME.
f5bccd85 1918 * - encoding: Set by user.
1984f635
MN
1919 * - decoding: unused
1920 */
b1edfce0 1921 int mv0_threshold;
115329f1 1922
1984f635 1923 /**
b1edfce0 1924 * Adjust sensitivity of b_frame_strategy 1.
f5bccd85 1925 * - encoding: Set by user.
1984f635
MN
1926 * - decoding: unused
1927 */
b1edfce0 1928 int b_sensitivity;
5cd62665
ZK
1929
1930 /**
b1edfce0
AK
1931 * Chromaticity coordinates of the source primaries.
1932 * - encoding: Set by user
1933 * - decoding: Set by libavcodec
5cd62665 1934 */
b1edfce0 1935 enum AVColorPrimaries color_primaries;
115329f1 1936
3d2e8cce 1937 /**
b1edfce0
AK
1938 * Color Transfer Characteristic.
1939 * - encoding: Set by user
1940 * - decoding: Set by libavcodec
3d2e8cce 1941 */
b1edfce0 1942 enum AVColorTransferCharacteristic color_trc;
115329f1 1943
11e659c2 1944 /**
b1edfce0
AK
1945 * YUV colorspace type.
1946 * - encoding: Set by user
1947 * - decoding: Set by libavcodec
1948 */
1949 enum AVColorSpace colorspace;
1950
1951 /**
1952 * MPEG vs JPEG YUV range.
1953 * - encoding: Set by user
1954 * - decoding: Set by libavcodec
1955 */
1956 enum AVColorRange color_range;
1957
1958 /**
1959 * This defines the location of chroma samples.
1960 * - encoding: Set by user
1961 * - decoding: Set by libavcodec
1962 */
1963 enum AVChromaLocation chroma_sample_location;
1964
1965 /**
1966 * Number of slices.
1967 * Indicates number of picture subdivisions. Used for parallelized
1968 * decoding.
1969 * - encoding: Set by user
11e659c2
MN
1970 * - decoding: unused
1971 */
b1edfce0
AK
1972 int slices;
1973
1974 /** Field order
1975 * - encoding: set by libavcodec
1976 * - decoding: Set by libavcodec
1977 */
1978 enum AVFieldOrder field_order;
1979
1980 /* audio only */
1981 int sample_rate; ///< samples per second
1982 int channels; ///< number of audio channels
11e659c2
MN
1983
1984 /**
b1edfce0 1985 * audio sample format
f5bccd85 1986 * - encoding: Set by user.
b1edfce0 1987 * - decoding: Set by libavcodec.
11e659c2 1988 */
b1edfce0 1989 enum AVSampleFormat sample_fmt; ///< sample format
115329f1 1990
b1edfce0 1991 /* The following data should not be initialized. */
3bb07d61 1992 /**
b1edfce0 1993 * Samples per packet, initialized when calling 'init'.
3bb07d61 1994 */
b1edfce0 1995 int frame_size;
c179c9e1
AK
1996
1997 /**
1998 * Frame counter, set by libavcodec.
1999 *
2000 * - decoding: total number of frames returned from the decoder so far.
2001 * - encoding: total number of frames passed to the encoder so far.
2002 *
2003 * @note the counter is not incremented if encoding/decoding resulted in
2004 * an error.
2005 */
2006 int frame_number;
3bb07d61 2007
fb364ada 2008 /**
b1edfce0
AK
2009 * number of bytes per packet if constant and known or 0
2010 * Used by some WAV based audio codecs.
fb364ada 2011 */
b1edfce0 2012 int block_align;
115329f1 2013
7d1c3fc1 2014 /**
b1edfce0 2015 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 2016 * - encoding: Set by user.
7d1c3fc1
MN
2017 * - decoding: unused
2018 */
b1edfce0 2019 int cutoff;
d6eb3c50 2020
b1edfce0 2021#if FF_API_REQUEST_CHANNELS
d6eb3c50 2022 /**
b1edfce0
AK
2023 * Decoder should decode to this many channels if it can (0 for default)
2024 * - encoding: unused
2025 * - decoding: Set by user.
2026 * @deprecated Deprecated in favor of request_channel_layout.
d6eb3c50 2027 */
b1edfce0
AK
2028 int request_channels;
2029#endif
d6eb3c50
MN
2030
2031 /**
b1edfce0
AK
2032 * Audio channel layout.
2033 * - encoding: set by user.
2034 * - decoding: set by libavcodec.
d6eb3c50 2035 */
b1edfce0 2036 uint64_t channel_layout;
115329f1 2037
541ae140 2038 /**
b1edfce0 2039 * Request decoder to use this channel layout if it can (0 for default)
541ae140 2040 * - encoding: unused
b1edfce0 2041 * - decoding: Set by user.
541ae140 2042 */
b1edfce0 2043 uint64_t request_channel_layout;
05fbd0a2
MN
2044
2045 /**
b1edfce0 2046 * Type of service that the audio stream conveys.
f5bccd85 2047 * - encoding: Set by user.
b1edfce0 2048 * - decoding: Set by libavcodec.
05fbd0a2 2049 */
b1edfce0 2050 enum AVAudioServiceType audio_service_type;
158c7f05
MN
2051
2052 /**
b1edfce0
AK
2053 * Used to request a sample format from the decoder.
2054 * - encoding: unused.
2055 * - decoding: Set by user.
158c7f05 2056 */
b1edfce0 2057 enum AVSampleFormat request_sample_fmt;
158c7f05
MN
2058
2059 /**
b1edfce0
AK
2060 * Called at the beginning of each frame to get a buffer for it.
2061 *
2062 * The function will set AVFrame.data[], AVFrame.linesize[].
2063 * AVFrame.extended_data[] must also be set, but it should be the same as
2064 * AVFrame.data[] except for planar audio with more channels than can fit
2065 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2066 * many data pointers as it can hold.
2067 *
2068 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2069 * avcodec_default_get_buffer() instead of providing buffers allocated by
2070 * some other means.
2071 *
2072 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2073 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2074 * but if get_buffer() is overridden then alignment considerations should
2075 * be taken into account.
2076 *
2077 * @see avcodec_default_get_buffer()
2078 *
2079 * Video:
2080 *
2081 * If pic.reference is set then the frame will be read later by libavcodec.
2082 * avcodec_align_dimensions2() should be used to find the required width and
2083 * height, as they normally need to be rounded up to the next multiple of 16.
2084 *
2085 * If frame multithreading is used and thread_safe_callbacks is set,
2086 * it may be called from a different thread, but not from more than one at
2087 * once. Does not need to be reentrant.
2088 *
2089 * @see release_buffer(), reget_buffer()
2090 * @see avcodec_align_dimensions2()
2091 *
2092 * Audio:
2093 *
2094 * Decoders request a buffer of a particular size by setting
2095 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2096 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2097 * to a smaller value in the output frame.
2098 *
2099 * Decoders cannot use the buffer after returning from
2100 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2101 * is assumed to be released immediately upon return.
2102 *
2103 * As a convenience, av_samples_get_buffer_size() and
2104 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2105 * functions to find the required data size and to fill data pointers and
2106 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2107 * since all planes must be the same size.
2108 *
2109 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2110 *
2111 * - encoding: unused
2112 * - decoding: Set by libavcodec, user can override.
158c7f05 2113 */
b1edfce0 2114 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2a2bbcb0 2115
821cb11f 2116 /**
b1edfce0
AK
2117 * Called to release buffers which were allocated with get_buffer.
2118 * A released buffer can be reused in get_buffer().
2119 * pic.data[*] must be set to NULL.
2120 * May be called from a different thread if frame multithreading is used,
2121 * but not by more than one thread at once, so does not need to be reentrant.
2122 * - encoding: unused
2123 * - decoding: Set by libavcodec, user can override.
821cb11f 2124 */
b1edfce0 2125 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1 2126
074c4ca7 2127 /**
f5bccd85
DB
2128 * Called at the beginning of a frame to get cr buffer for it.
2129 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2130 * libavcodec will pass previous buffer in pic, function should return
e1c2a5a0 2131 * same buffer or new buffer with old frame "painted" into it.
f5bccd85 2132 * If pic.data[0] == NULL must behave like get_buffer().
f1b99cc6
MN
2133 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2134 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2135 * some other means.
074c4ca7 2136 * - encoding: unused
53128bc3 2137 * - decoding: Set by libavcodec, user can override.
074c4ca7 2138 */
e1c2a5a0 2139 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc 2140
ba58dabc 2141
b1edfce0
AK
2142 /* - encoding parameters */
2143 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2144 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
ba58dabc
MN
2145
2146 /**
b1edfce0 2147 * minimum quantizer
f5bccd85 2148 * - encoding: Set by user.
b1edfce0 2149 * - decoding: unused
ba58dabc 2150 */
b1edfce0 2151 int qmin;
7ebfc0ea
MN
2152
2153 /**
b1edfce0 2154 * maximum quantizer
f5bccd85
DB
2155 * - encoding: Set by user.
2156 * - decoding: unused
7ebfc0ea 2157 */
b1edfce0 2158 int qmax;
115329f1 2159
77ea0d4b 2160 /**
b1edfce0 2161 * maximum quantizer difference between frames
f5bccd85 2162 * - encoding: Set by user.
77ea0d4b
MN
2163 * - decoding: unused
2164 */
b1edfce0 2165 int max_qdiff;
9c3d33d6
MN
2166
2167 /**
b1edfce0
AK
2168 * ratecontrol qmin qmax limiting method
2169 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
f5bccd85 2170 * - encoding: Set by user.
b1edfce0 2171 * - decoding: unused
9c3d33d6 2172 */
b1edfce0 2173 float rc_qsquish;
115329f1 2174
b1edfce0
AK
2175 float rc_qmod_amp;
2176 int rc_qmod_freq;
a4d36c11
MN
2177
2178 /**
b1edfce0 2179 * decoder bitstream buffer size
f5bccd85 2180 * - encoding: Set by user.
f20f8a8b 2181 * - decoding: unused
a4d36c11 2182 */
b1edfce0 2183 int rc_buffer_size;
f20f8a8b
MN
2184
2185 /**
b1edfce0
AK
2186 * ratecontrol override, see RcOverride
2187 * - encoding: Allocated/set/freed by user.
f20f8a8b
MN
2188 * - decoding: unused
2189 */
b1edfce0
AK
2190 int rc_override_count;
2191 RcOverride *rc_override;
bf266e19
MN
2192
2193 /**
b1edfce0
AK
2194 * rate control equation
2195 * - encoding: Set by user
bf266e19
MN
2196 * - decoding: unused
2197 */
b1edfce0 2198 const char *rc_eq;
d4c5d2ad
MN
2199
2200 /**
b1edfce0 2201 * maximum bitrate
f5bccd85 2202 * - encoding: Set by user.
d4c5d2ad
MN
2203 * - decoding: unused
2204 */
b1edfce0 2205 int rc_max_rate;
baced9f5
MN
2206
2207 /**
b1edfce0 2208 * minimum bitrate
f5bccd85 2209 * - encoding: Set by user.
b1edfce0 2210 * - decoding: unused
baced9f5 2211 */
b1edfce0 2212 int rc_min_rate;
0215006a 2213
b1edfce0 2214 float rc_buffer_aggressivity;
c4ab43ff 2215
baced9f5 2216 /**
b1edfce0 2217 * initial complexity for pass1 ratecontrol
f5bccd85 2218 * - encoding: Set by user.
b1edfce0 2219 * - decoding: unused
178fcca8 2220 */
b1edfce0 2221 float rc_initial_cplx;
21adafec
MN
2222
2223 /**
b1edfce0
AK
2224 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2225 * - encoding: Set by user.
2226 * - decoding: unused.
21adafec 2227 */
b1edfce0 2228 float rc_max_available_vbv_use;
bbf18b21
MN
2229
2230 /**
b1edfce0 2231 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
f5bccd85 2232 * - encoding: Set by user.
b1edfce0 2233 * - decoding: unused.
bbf18b21 2234 */
b1edfce0 2235 float rc_min_vbv_overflow_use;
bbf18b21
MN
2236
2237 /**
b1edfce0 2238 * Number of bits which should be loaded into the rc buffer before decoding starts.
f5bccd85 2239 * - encoding: Set by user.
bbf18b21
MN
2240 * - decoding: unused
2241 */
b1edfce0 2242 int rc_initial_buffer_occupancy;
0fd6aea1 2243
b1edfce0
AK
2244#define FF_CODER_TYPE_VLC 0
2245#define FF_CODER_TYPE_AC 1
2246#define FF_CODER_TYPE_RAW 2
2247#define FF_CODER_TYPE_RLE 3
2248#define FF_CODER_TYPE_DEFLATE 4
0fd6aea1 2249 /**
b1edfce0 2250 * coder type
f5bccd85 2251 * - encoding: Set by user.
0fd6aea1
MN
2252 * - decoding: unused
2253 */
b1edfce0 2254 int coder_type;
0fd6aea1
MN
2255
2256 /**
b1edfce0 2257 * context model
f5bccd85 2258 * - encoding: Set by user.
0fd6aea1
MN
2259 * - decoding: unused
2260 */
b1edfce0 2261 int context_model;
957c743a
CM
2262
2263 /**
b1edfce0 2264 * minimum Lagrange multipler
f5bccd85 2265 * - encoding: Set by user.
957c743a
CM
2266 * - decoding: unused
2267 */
b1edfce0 2268 int lmin;
6e0d8c06
MN
2269
2270 /**
b1edfce0 2271 * maximum Lagrange multipler
f5bccd85 2272 * - encoding: Set by user.
6e0d8c06
MN
2273 * - decoding: unused
2274 */
b1edfce0 2275 int lmax;
6e0d8c06
MN
2276
2277 /**
b1edfce0 2278 * frame skip threshold
f5bccd85 2279 * - encoding: Set by user.
6e0d8c06
MN
2280 * - decoding: unused
2281 */
b1edfce0 2282 int frame_skip_threshold;
09c3e44e
MN
2283
2284 /**
b1edfce0 2285 * frame skip factor
f5bccd85 2286 * - encoding: Set by user.
09c3e44e
MN
2287 * - decoding: unused
2288 */
b1edfce0 2289 int frame_skip_factor;
316a2ec8
MN
2290
2291 /**
b1edfce0 2292 * frame skip exponent
f5bccd85 2293 * - encoding: Set by user.
316a2ec8
MN
2294 * - decoding: unused
2295 */
b1edfce0 2296 int frame_skip_exp;
e8501c93
MN
2297
2298 /**
b1edfce0 2299 * frame skip comparison function
f5bccd85 2300 * - encoding: Set by user.
e8501c93
MN
2301 * - decoding: unused
2302 */
b1edfce0 2303 int frame_skip_cmp;
58f7833e 2304
58f7833e 2305 /**
b1edfce0 2306 * trellis RD quantization
f5bccd85 2307 * - encoding: Set by user.
58f7833e
RS
2308 * - decoding: unused
2309 */
b1edfce0 2310 int trellis;
58f7833e
RS
2311
2312 /**
f5bccd85 2313 * - encoding: Set by user.
b1edfce0 2314 * - decoding: unused
58f7833e 2315 */
b1edfce0 2316 int min_prediction_order;
58f7833e
RS
2317
2318 /**
f5bccd85 2319 * - encoding: Set by user.
58f7833e
RS
2320 * - decoding: unused
2321 */
b1edfce0 2322 int max_prediction_order;
58f7833e 2323
58f7833e 2324 /**
b1edfce0 2325 * GOP timecode frame start number, in non drop frame format
f5bccd85 2326 * - encoding: Set by user.
58f7833e
RS
2327 * - decoding: unused
2328 */
b1edfce0
AK
2329 int64_t timecode_frame_start;
2330
2331 /* The RTP callback: This function is called */
2332 /* every time the encoder has a packet to send. */
2333 /* It depends on the encoder if the data starts */
2334 /* with a Start Code (it should). H.263 does. */
2335 /* mb_nb contains the number of macroblocks */
2336 /* encoded in the RTP payload. */
2337 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2338
2339 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2340 /* do its best to deliver a chunk with size */
2341 /* below rtp_payload_size, the chunk will start */
2342 /* with a start code on some codecs like H.263. */
2343 /* This doesn't take account of any particular */
2344 /* headers inside the transmitted RTP payload. */
2345
2346 /* statistics, used for 2-pass encoding */
2347 int mv_bits;
2348 int header_bits;
2349 int i_tex_bits;
2350 int p_tex_bits;
2351 int i_count;
2352 int p_count;
2353 int skip_count;
2354 int misc_bits;
58f7833e 2355
14f0c8e2 2356 /**
b1edfce0
AK
2357 * number of bits used for the previously encoded frame
2358 * - encoding: Set by libavcodec.
14f0c8e2
LA
2359 * - decoding: unused
2360 */
b1edfce0 2361 int frame_bits;
39a64e30
CH
2362
2363 /**
b1edfce0
AK
2364 * pass1 encoding statistics output buffer
2365 * - encoding: Set by libavcodec.
39a64e30
CH
2366 * - decoding: unused
2367 */
b1edfce0 2368 char *stats_out;
1dd509b1
MN
2369
2370 /**
b1edfce0
AK
2371 * pass2 encoding statistics input buffer
2372 * Concatenated stuff from stats_out of pass1 should be placed here.
2373 * - encoding: Allocated/set/freed by user.
1dd509b1
MN
2374 * - decoding: unused
2375 */
b1edfce0 2376 char *stats_in;
f9243d34
CH
2377
2378 /**
b1edfce0
AK
2379 * Work around bugs in encoders which sometimes cannot be detected automatically.
2380 * - encoding: Set by user
2381 * - decoding: Set by user
f9243d34 2382 */
b1edfce0
AK
2383 int workaround_bugs;
2384#define FF_BUG_AUTODETECT 1 ///< autodetection
2385#define FF_BUG_OLD_MSMPEG4 2
2386#define FF_BUG_XVID_ILACE 4
2387#define FF_BUG_UMP4 8
2388#define FF_BUG_NO_PADDING 16
2389#define FF_BUG_AMV 32
2390#define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2391#define FF_BUG_QPEL_CHROMA 64
2392#define FF_BUG_STD_QPEL 128
2393#define FF_BUG_QPEL_CHROMA2 256
2394#define FF_BUG_DIRECT_BLOCKSIZE 512
2395#define FF_BUG_EDGE 1024
2396#define FF_BUG_HPEL_CHROMA 2048
2397#define FF_BUG_DC_CLIP 4096
2398#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2399#define FF_BUG_TRUNCATED 16384
a403fc03
JR
2400
2401 /**
b1edfce0 2402 * strictly follow the standard (MPEG4, ...).
f5bccd85 2403 * - encoding: Set by user.
b1edfce0
AK
2404 * - decoding: Set by user.
2405 * Setting this to STRICT or higher means the encoder and decoder will
2406 * generally do stupid things, whereas setting it to unofficial or lower
2407 * will mean the encoder might produce output that is not supported by all
2408 * spec-compliant decoders. Decoders don't differentiate between normal,
2409 * unofficial and experimental (that is, they always try to decode things
2410 * when they can) unless they are explicitly asked to behave stupidly
2411 * (=strictly conform to the specs)
a403fc03 2412 */
b1edfce0
AK
2413 int strict_std_compliance;
2414#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2415#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2416#define FF_COMPLIANCE_NORMAL 0
2417#define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2418#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
a403fc03 2419
a403fc03 2420 /**
b1edfce0
AK
2421 * error concealment flags
2422 * - encoding: unused
2423 * - decoding: Set by user.
a403fc03 2424 */
b1edfce0
AK
2425 int error_concealment;
2426#define FF_EC_GUESS_MVS 1
2427#define FF_EC_DEBLOCK 2
a403fc03
JR
2428
2429 /**
b1edfce0 2430 * debug
f5bccd85 2431 * - encoding: Set by user.
b1edfce0 2432 * - decoding: Set by user.
a403fc03 2433 */
b1edfce0
AK
2434 int debug;
2435#define FF_DEBUG_PICT_INFO 1
2436#define FF_DEBUG_RC 2
2437#define FF_DEBUG_BITSTREAM 4
2438#define FF_DEBUG_MB_TYPE 8
2439#define FF_DEBUG_QP 16
2440#define FF_DEBUG_MV 32
2441#define FF_DEBUG_DCT_COEFF 0x00000040
2442#define FF_DEBUG_SKIP 0x00000080
2443#define FF_DEBUG_STARTCODE 0x00000100
2444#define FF_DEBUG_PTS 0x00000200
2445#define FF_DEBUG_ER 0x00000400
2446#define FF_DEBUG_MMCO 0x00000800
2447#define FF_DEBUG_BUGS 0x00001000
2448#define FF_DEBUG_VIS_QP 0x00002000
2449#define FF_DEBUG_VIS_MB_TYPE 0x00004000
2450#define FF_DEBUG_BUFFERS 0x00008000
2451#define FF_DEBUG_THREADS 0x00010000
188dea1d 2452
80d617f5 2453 /**
b1edfce0 2454 * debug
f5bccd85 2455 * - encoding: Set by user.
b1edfce0 2456 * - decoding: Set by user.
80d617f5 2457 */
b1edfce0
AK
2458 int debug_mv;
2459#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2460#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2461#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
b1ec601f
RD
2462
2463 /**
b1edfce0 2464 * Error recognition; may misdetect some more or less valid parts as errors.
85947156
VS
2465 * - encoding: unused
2466 * - decoding: Set by user.
b1ec601f 2467 */
b1edfce0
AK
2468 int err_recognition;
2469#define AV_EF_CRCCHECK (1<<0)
2470#define AV_EF_BITSTREAM (1<<1)
2471#define AV_EF_BUFFER (1<<2)
2472#define AV_EF_EXPLODE (1<<3)
1408352a 2473
79de84f2
MN
2474 /**
2475 * opaque 64bit number (generally a PTS) that will be reordered and
2476 * output in AVFrame.reordered_opaque
81c623fa 2477 * @deprecated in favor of pkt_pts
79de84f2
MN
2478 * - encoding: unused
2479 * - decoding: Set by user.
2480 */
2481 int64_t reordered_opaque;
312420f3
PR
2482
2483 /**
b1edfce0
AK
2484 * Hardware accelerator in use
2485 * - encoding: unused.
2486 * - decoding: Set by libavcodec
312420f3 2487 */
b1edfce0 2488 struct AVHWAccel *hwaccel;
0d72e7d0
PR
2489
2490 /**
b1edfce0
AK
2491 * Hardware accelerator context.
2492 * For some hardware accelerators, a global context needs to be
2493 * provided by the user. In that case, this holds display-dependent
2494 * data Libav cannot instantiate itself. Please refer to the
2495 * Libav HW accelerator documentation to know how to fill this
2496 * is. e.g. for VA API, this is a struct vaapi_context.
2497 * - encoding: unused
2498 * - decoding: Set by user
0d72e7d0 2499 */
b1edfce0 2500 void *hwaccel_context;
0d72e7d0
PR
2501
2502 /**
b1edfce0
AK
2503 * error
2504 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2505 * - decoding: unused
0d72e7d0 2506 */
b1edfce0 2507 uint64_t error[AV_NUM_DATA_POINTERS];
3bff4d8b
BC
2508
2509 /**
b1edfce0 2510 * DCT algorithm, see FF_DCT_* below
3bff4d8b 2511 * - encoding: Set by user.
b1edfce0 2512 * - decoding: unused
3bff4d8b 2513 */
b1edfce0
AK
2514 int dct_algo;
2515#define FF_DCT_AUTO 0
2516#define FF_DCT_FASTINT 1
2517#define FF_DCT_INT 2
2518#define FF_DCT_MMX 3
2519#define FF_DCT_ALTIVEC 5
2520#define FF_DCT_FAAN 6
3bff4d8b
BC
2521
2522 /**
b1edfce0 2523 * IDCT algorithm, see FF_IDCT_* below.
3bff4d8b 2524 * - encoding: Set by user.
b1edfce0 2525 * - decoding: Set by user.
3bff4d8b 2526 */
b1edfce0
AK
2527 int idct_algo;
2528#define FF_IDCT_AUTO 0
2529#define FF_IDCT_INT 1
2530#define FF_IDCT_SIMPLE 2
2531#define FF_IDCT_SIMPLEMMX 3
2532#define FF_IDCT_LIBMPEG2MMX 4
2533#define FF_IDCT_MMI 5
2534#define FF_IDCT_ARM 7
2535#define FF_IDCT_ALTIVEC 8
2536#define FF_IDCT_SH4 9
2537#define FF_IDCT_SIMPLEARM 10
2538#define FF_IDCT_H264 11
2539#define FF_IDCT_VP3 12
2540#define FF_IDCT_IPP 13
2541#define FF_IDCT_XVIDMMX 14
2542#define FF_IDCT_CAVS 15
2543#define FF_IDCT_SIMPLEARMV5TE 16
2544#define FF_IDCT_SIMPLEARMV6 17
2545#define FF_IDCT_SIMPLEVIS 18
2546#define FF_IDCT_WMV2 19
2547#define FF_IDCT_FAAN 20
2548#define FF_IDCT_EA 21
2549#define FF_IDCT_SIMPLENEON 22
2550#define FF_IDCT_SIMPLEALPHA 23
2551#define FF_IDCT_BINK 24
40e5d31b
GB
2552
2553 /**
b1edfce0
AK
2554 * dsp_mask could be add used to disable unwanted CPU features
2555 * CPU features (i.e. MMX, SSE. ...)
2556 *
2557 * With the FORCE flag you may instead enable given CPU features.
2558 * (Dangerous: Usable in case of misdetection, improper usage however will
2559 * result into program crash.)
40e5d31b 2560 */
b1edfce0
AK
2561 unsigned dsp_mask;
2562
2563 /**
2564 * bits per sample/pixel from the demuxer (needed for huffyuv).
2565 * - encoding: Set by libavcodec.
2566 * - decoding: Set by user.
2567 */
2568 int bits_per_coded_sample;
2569
2570 /**
2571 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2572 * - encoding: set by user.
2573 * - decoding: set by libavcodec.
2574 */
2575 int bits_per_raw_sample;
3797c74b
MN
2576
2577 /**
b1edfce0
AK
2578 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2579 * - encoding: unused
2580 * - decoding: Set by user.
3797c74b 2581 */
b1edfce0 2582 int lowres;
1aea7018
GB
2583
2584 /**
b1edfce0
AK
2585 * the picture in the bitstream
2586 * - encoding: Set by libavcodec.
2587 * - decoding: Set by libavcodec.
1aea7018 2588 */
b1edfce0 2589 AVFrame *coded_frame;
4ee6a5c1
MN
2590
2591 /**
b1edfce0
AK
2592 * thread count
2593 * is used to decide how many independent tasks should be passed to execute()
2594 * - encoding: Set by user.
2595 * - decoding: Set by user.
4ee6a5c1 2596 */
b1edfce0 2597 int thread_count;
4ee6a5c1
MN
2598
2599 /**
b1edfce0
AK
2600 * Which multithreading methods to use.
2601 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2602 * so clients which cannot provide future frames should not use it.
2603 *
2604 * - encoding: Set by user, otherwise the default is used.
2605 * - decoding: Set by user, otherwise the default is used.
4ee6a5c1 2606 */
b1edfce0
AK
2607 int thread_type;
2608#define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2609#define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
4ee6a5c1
MN
2610
2611 /**
b1edfce0
AK
2612 * Which multithreading methods are in use by the codec.
2613 * - encoding: Set by libavcodec.
2614 * - decoding: Set by libavcodec.
4ee6a5c1 2615 */
b1edfce0 2616 int active_thread_type;
4ee6a5c1
MN
2617
2618 /**
b1edfce0
AK
2619 * Set by the client if its custom get_buffer() callback can be called
2620 * from another thread, which allows faster multithreaded decoding.
2621 * draw_horiz_band() will be called from other threads regardless of this setting.
2622 * Ignored if the default get_buffer() is used.
2623 * - encoding: Set by user.
2624 * - decoding: Set by user.
4ee6a5c1 2625 */
b1edfce0 2626 int thread_safe_callbacks;
580a7465
DC
2627
2628 /**
b1edfce0
AK
2629 * The codec may call this to execute several independent things.
2630 * It will return only after finishing all tasks.
2631 * The user may replace this with some multithreaded implementation,
2632 * the default implementation will execute the parts serially.
2633 * @param count the number of things to execute
2634 * - encoding: Set by libavcodec, user can override.
2635 * - decoding: Set by libavcodec, user can override.
580a7465 2636 */
b1edfce0 2637 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
8d23a86f
RD
2638
2639 /**
2640 * The codec may call this to execute several independent things.
2641 * It will return only after finishing all tasks.
2642 * The user may replace this with some multithreaded implementation,
2643 * the default implementation will execute the parts serially.
2644 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2645 * @param c context passed also to func
2646 * @param count the number of things to execute
2647 * @param arg2 argument passed unchanged to func
2648 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2649 * @param func function that will be called count times, with jobnr from 0 to count-1.
2650 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2651 * two instances of func executing at the same time will have the same threadnr.
2652 * @return always 0 currently, but code should handle a future improvement where when any call to func
2653 * returns < 0 no further calls to func may be done and < 0 is returned.
2654 * - encoding: Set by libavcodec, user can override.
2655 * - decoding: Set by libavcodec, user can override.
2656 */
2657 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
096c87f6 2658
b1edfce0
AK
2659 /**
2660 * thread opaque
2661 * Can be used by execute() to store some per AVCodecContext stuff.
2662 * - encoding: set by execute()
2663 * - decoding: set by execute()
2664 */
2665 void *thread_opaque;
23940f14 2666
2aa72ecc 2667 /**
b1edfce0
AK
2668 * noise vs. sse weight for the nsse comparsion function
2669 * - encoding: Set by user.
2aa72ecc
JZ
2670 * - decoding: unused
2671 */
b1edfce0 2672 int nsse_weight;
cb2c971d
AJ
2673
2674 /**
b1edfce0
AK
2675 * profile
2676 * - encoding: Set by user.
2677 * - decoding: Set by libavcodec.
cb2c971d 2678 */
b1edfce0
AK
2679 int profile;
2680#define FF_PROFILE_UNKNOWN -99
2681#define FF_PROFILE_RESERVED -100
2682
2683#define FF_PROFILE_AAC_MAIN 0
2684#define FF_PROFILE_AAC_LOW 1
2685#define FF_PROFILE_AAC_SSR 2
2686#define FF_PROFILE_AAC_LTP 3
2687
2688#define FF_PROFILE_DTS 20
2689#define FF_PROFILE_DTS_ES 30
2690#define FF_PROFILE_DTS_96_24 40
2691#define FF_PROFILE_DTS_HD_HRA 50
2692#define FF_PROFILE_DTS_HD_MA 60
2693
2694#define FF_PROFILE_MPEG2_422 0
2695#define FF_PROFILE_MPEG2_HIGH 1
2696#define FF_PROFILE_MPEG2_SS 2
2697#define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2698#define FF_PROFILE_MPEG2_MAIN 4
2699#define FF_PROFILE_MPEG2_SIMPLE 5
2700
2701#define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2702#define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2703
2704#define FF_PROFILE_H264_BASELINE 66
2705#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2706#define FF_PROFILE_H264_MAIN 77
2707#define FF_PROFILE_H264_EXTENDED 88
2708#define FF_PROFILE_H264_HIGH 100
2709#define FF_PROFILE_H264_HIGH_10 110
2710#define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2711#define FF_PROFILE_H264_HIGH_422 122
2712#define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2713#define FF_PROFILE_H264_HIGH_444 144
2714#define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2715#define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2716#define FF_PROFILE_H264_CAVLC_444 44
2717
2718#define FF_PROFILE_VC1_SIMPLE 0
2719#define FF_PROFILE_VC1_MAIN 1
2720#define FF_PROFILE_VC1_COMPLEX 2
2721#define FF_PROFILE_VC1_ADVANCED 3
2722
2723#define FF_PROFILE_MPEG4_SIMPLE 0
2724#define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2725#define FF_PROFILE_MPEG4_CORE 2
2726#define FF_PROFILE_MPEG4_MAIN 3
2727#define FF_PROFILE_MPEG4_N_BIT 4
2728#define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2729#define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2730#define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2731#define FF_PROFILE_MPEG4_HYBRID 8
2732#define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2733#define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2734#define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2735#define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2736#define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2737#define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2738#define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
393cbb96
MN
2739
2740 /**
b1edfce0
AK
2741 * level
2742 * - encoding: Set by user.
2743 * - decoding: Set by libavcodec.
393cbb96 2744 */
b1edfce0
AK
2745 int level;
2746#define FF_LEVEL_UNKNOWN -99
37b00b47 2747
37b00b47 2748 /**
37b00b47 2749 *
b1edfce0
AK
2750 * - encoding: unused
2751 * - decoding: Set by user.
37b00b47 2752 */
b1edfce0 2753 enum AVDiscard skip_loop_filter;
37b00b47
AS
2754
2755 /**
b1edfce0
AK
2756 *
2757 * - encoding: unused
2758 * - decoding: Set by user.
37b00b47 2759 */
b1edfce0 2760 enum AVDiscard skip_idct;
37b00b47
AS
2761
2762 /**
b1edfce0
AK
2763 *
2764 * - encoding: unused
37b00b47
AS
2765 * - decoding: Set by user.
2766 */
b1edfce0 2767 enum AVDiscard skip_frame;
55bad0c6
CM
2768
2769 /**
b1edfce0
AK
2770 * Header containing style information for text subtitles.
2771 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2772 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2773 * the Format line following. It shouldn't include any Dialogue line.
2774 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2775 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
55bad0c6 2776 */
b1edfce0
AK
2777 uint8_t *subtitle_header;
2778 int subtitle_header_size;
34b47d7c
JR
2779
2780 /**
b1edfce0 2781 * Simulates errors in the bitstream to test error concealment.
34b47d7c 2782 * - encoding: Set by user.
b1edfce0 2783 * - decoding: unused
64150ff0 2784 */
b1edfce0 2785 int error_rate;
582f2311
DB
2786
2787 /**
b1edfce0
AK
2788 * Current packet as passed into the decoder, to avoid having
2789 * to pass the packet into every function. Currently only valid
2790 * inside lavc and get/release_buffer callbacks.
2791 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
582f2311 2792 * - encoding: unused
582f2311 2793 */
b1edfce0 2794 AVPacket *pkt;
f3a29b75
JR
2795
2796 /**
b1edfce0
AK
2797 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2798 * Used for compliant TS muxing.
2799 * - encoding: Set by libavcodec.
2800 * - decoding: unused.
4bf3c8f2 2801 */
b1edfce0 2802 uint64_t vbv_delay;
de6d9b64
FB
2803} AVCodecContext;
2804
64863965 2805/**
060ec0a8
AH
2806 * AVProfile.
2807 */
2808typedef struct AVProfile {
2809 int profile;
2810 const char *name; ///< short name for the profile
2811} AVProfile;
2812
84626b36
AK
2813typedef struct AVCodecDefault AVCodecDefault;
2814
060ec0a8 2815/**
64863965
MN
2816 * AVCodec.
2817 */
de6d9b64 2818typedef struct AVCodec {
6b0cdb6e
NG
2819 /**
2820 * Name of the codec implementation.
2821 * The name is globally unique among encoders and among decoders (but an
2822 * encoder and a decoder can share the same name).
2823 * This is the primary way to find a codec from the user perspective.
2824 */
18f77016 2825 const char *name;
f5f49a66
AK
2826 /**
2827 * Descriptive name for the codec, meant to be more human readable than name.
2828 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2829 */
2830 const char *long_name;
72415b2a 2831 enum AVMediaType type;
9297ddd3 2832 enum CodecID id;
a2d11246
MN
2833 /**
2834 * Codec capabilities.
2835 * see CODEC_CAP_*
2836 */
bf89e6b1 2837 int capabilities;
716e31ea 2838 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
1beb670a 2839 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3ade5d56 2840 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
5d6e4c16 2841 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
cc276c85 2842 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
0fd0ef79 2843 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
567ad0e3 2844 const AVClass *priv_class; ///< AVClass for the private context
060ec0a8 2845 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
37b00b47 2846
f5f49a66
AK
2847 /*****************************************************************
2848 * No fields below this line are part of the public API. They
2849 * may not be used outside of libavcodec and can be changed and
2850 * removed at will.
2851 * New public fields should be added right above.
2852 *****************************************************************
2853 */
2854 int priv_data_size;
2855 struct AVCodec *next;
37b00b47 2856 /**
21a19b79 2857 * @name Frame-level threading support functions
37b00b47
AS
2858 * @{
2859 */
2860 /**
2861 * If defined, called on thread contexts when they are created.
2862 * If the codec allocates writable tables in init(), re-allocate them here.
2863 * priv_data will be set to a copy of the original.
2864 */
2865 int (*init_thread_copy)(AVCodecContext *);
2866 /**
2867 * Copy necessary context variables from a previous thread context to the current one.
2868 * If not defined, the next thread will start automatically; otherwise, the codec
2869 * must call ff_thread_finish_setup().
2870 *
2871 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2872 */
2873 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2874 /** @} */
84626b36
AK
2875
2876 /**
2877 * Private codec-specific defaults.
2878 */
2879 const AVCodecDefault *defaults;
d97efd7f
AK
2880
2881 /**
2882 * Initialize codec static data, called from avcodec_register().
2883 */
2884 void (*init_static_data)(struct AVCodec *codec);
b2c75b6e 2885
f5f49a66
AK
2886 int (*init)(AVCodecContext *);
2887 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
b2c75b6e
JR
2888 /**
2889 * Encode data to an AVPacket.
2890 *
2891 * @param avctx codec context
2892 * @param avpkt output AVPacket (may contain a user-provided buffer)
2893 * @param[in] frame AVFrame containing the raw data to be encoded
2894 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2895 * non-empty packet was returned in avpkt.
2896 * @return 0 on success, negative error code on failure
2897 */
2898 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2899 int *got_packet_ptr);
f5f49a66
AK
2900 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2901 int (*close)(AVCodecContext *);
2902 /**
2903 * Flush buffers.
2904 * Will be called when seeking
2905 */
2906 void (*flush)(AVCodecContext *);
de6d9b64
FB
2907} AVCodec;
2908
97d96aaa 2909/**
40e5d31b
GB
2910 * AVHWAccel.
2911 */
2912typedef struct AVHWAccel {
2913 /**
2914 * Name of the hardware accelerated codec.
2915 * The name is globally unique among encoders and among decoders (but an
2916 * encoder and a decoder can share the same name).
2917 */
2918 const char *name;
2919
2920 /**
2921 * Type of codec implemented by the hardware accelerator.
2922 *
72415b2a 2923 * See AVMEDIA_TYPE_xxx
40e5d31b 2924 */
72415b2a 2925 enum AVMediaType type;
40e5d31b
GB
2926
2927 /**
2928 * Codec implemented by the hardware accelerator.
2929 *
2930 * See CODEC_ID_xxx
2931 */
2932 enum CodecID id;
2933
2934 /**
2935 * Supported pixel format.
2936 *
2937 * Only hardware accelerated formats are supported here.
2938 */
2939 enum PixelFormat pix_fmt;
2940
2941 /**
2942 * Hardware accelerated codec capabilities.
2943 * see FF_HWACCEL_CODEC_CAP_*
2944 */
2945 int capabilities;
2946
2947 struct AVHWAccel *next;
2948
2949 /**
2950 * Called at the beginning of each frame or field picture.
2951 *
2952 * Meaningful frame information (codec specific) is guaranteed to
2953 * be parsed at this point. This function is mandatory.
2954 *
bf7e799c 2955 * Note that buf can be NULL along with buf_size set to 0.
40e5d31b
GB
2956 * Otherwise, this means the whole frame is available at this point.
2957 *
2958 * @param avctx the codec context
2959 * @param buf the frame data buffer base
2960 * @param buf_size the size of the frame in bytes
2961 * @return zero if successful, a negative value otherwise
2962 */
2963 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2964
2965 /**
2966 * Callback for each slice.
2967 *
2968 * Meaningful slice information (codec specific) is guaranteed to
2969 * be parsed at this point. This function is mandatory.
2970 *
2971 * @param avctx the codec context
2972 * @param buf the slice data buffer base
2973 * @param buf_size the size of the slice in bytes
2974 * @return zero if successful, a negative value otherwise
2975 */
2976 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2977
2978 /**
2979 * Called at the end of each frame or field picture.
2980 *
2981 * The whole picture is parsed at this point and can now be sent
2982 * to the hardware accelerator. This function is mandatory.
2983 *
2984 * @param avctx the codec context
2985 * @return zero if successful, a negative value otherwise
2986 */
2987 int (*end_frame)(AVCodecContext *avctx);
68e5d523
GB
2988
2989 /**
2990 * Size of HW accelerator private data.
2991 *
cd823ff9
GB
2992 * Private data is allocated with av_mallocz() before
2993 * AVCodecContext.get_buffer() and deallocated after
2994 * AVCodecContext.release_buffer().
68e5d523
GB
2995 */
2996 int priv_data_size;
40e5d31b
GB
2997} AVHWAccel;
2998
2999/**
d7425f59
MN
3000 * four components are given, that's all.
3001 * the last component is alpha
3002 */
de6d9b64 3003typedef struct AVPicture {
560f773c
JR
3004 uint8_t *data[AV_NUM_DATA_POINTERS];
3005 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
de6d9b64
FB
3006} AVPicture;
3007
63e4c8a6
AK
3008#define AVPALETTE_SIZE 1024
3009#define AVPALETTE_COUNT 256
ba118447 3010
c66216ed
MN
3011enum AVSubtitleType {
3012 SUBTITLE_NONE,
3013
3014 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3015
3016 /**
3017 * Plain text, the text field must be set by the decoder and is
3018 * authoritative. ass and pict fields may contain approximations.
3019 */
3020 SUBTITLE_TEXT,
3021
3022 /**
3023 * Formatted text, the ass field must be set by the decoder and is
3024 * authoritative. pict and text fields may contain approximations.
3025 */
3026 SUBTITLE_ASS,
3027};
3028
c6ec28b1 3029typedef struct AVSubtitleRect {
ebc466bb
MN
3030 int x; ///< top left corner of pict, undefined when pict is not set
3031 int y; ///< top left corner of pict, undefined when pict is not set
3032 int w; ///< width of pict, undefined when pict is not set
3033 int h; ///< height of pict, undefined when pict is not set
3034 int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651
MN
3035
3036 /**
3037 * data+linesize for the bitmap of this subtitle.
3038 * can be set for text/ass as well once they where rendered
3039 */
3040 AVPicture pict;
f656106f
MN
3041 enum AVSubtitleType type;
3042
3043 char *text; ///< 0 terminated plain UTF-8 text
3044
3045 /**
3046 * 0 terminated ASS/SSA compatible event line.
3047 * The pressentation of this is unaffected by the other values in this
3048 * struct.
3049 */
3050 char *ass;
c6ec28b1
MN
3051} AVSubtitleRect;
3052
3053typedef struct AVSubtitle {
3054 uint16_t format; /* 0 = graphics */
3055 uint32_t start_display_time; /* relative to packet pts, in ms */
3056 uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb 3057 unsigned num_rects;
db4fac64 3058 AVSubtitleRect **rects;
4bbe788a 3059 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
240c1657
FB
3060} AVSubtitle;
3061
294b3a50
AK
3062/**
3063 * If c is NULL, returns the first registered codec,
3064 * if c is non-NULL, returns the next registered codec after c,
3065 * or NULL if c is the last one.
3066 */
3067AVCodec *av_codec_next(AVCodec *c);
3068
3069/**
3070 * Return the LIBAVCODEC_VERSION_INT constant.
3071 */
3072unsigned avcodec_version(void);
3073
3074/**
3075 * Return the libavcodec build-time configuration.
3076 */
3077const char *avcodec_configuration(void);
3078
3079/**
3080 * Return the libavcodec license.
3081 */
3082const char *avcodec_license(void);
3083
3084/**
3085 * Register the codec codec and initialize libavcodec.
3086 *
3087 * @warning either this function or avcodec_register_all() must be called
3088 * before any other libavcodec functions.
3089 *
3090 * @see avcodec_register_all()
3091 */
3092void avcodec_register(AVCodec *codec);
3093
3094/**
3095 * Register all the codecs, parsers and bitstream filters which were enabled at
3096 * configuration time. If you do not call this function you can select exactly
3097 * which formats you want to support, by using the individual registration
3098 * functions.
3099 *
3100 * @see avcodec_register
3101 * @see av_register_codec_parser
3102 * @see av_register_bitstream_filter
3103 */
3104void avcodec_register_all(void);
3105
3106/**
3107 * Allocate an AVCodecContext and set its fields to default values. The
3108 * resulting struct can be deallocated by calling avcodec_close() on it followed
3109 * by av_free().
3110 *
3111 * @param codec if non-NULL, allocate private data and initialize defaults
3112 * for the given codec. It is illegal to then call avcodec_open2()
3113 * with a different codec.
3114 * If NULL, then the codec-specific defaults won't be initialized,
3115 * which may result in suboptimal default settings (this is
3116 * important mainly for encoders, e.g. libx264).
3117 *
3118 * @return An AVCodecContext filled with default values or NULL on failure.
3119 * @see avcodec_get_context_defaults
3120 */
3121AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3122
3123/**
3124 * Set the fields of the given AVCodecContext to default values corresponding
3125 * to the given codec (defaults may be codec-dependent).
3126 *
3127 * Do not call this function if a non-NULL codec has been passed
3128 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3129 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3130 * different codec on this AVCodecContext.
3131 */
3132int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3133
3134/**
3135 * Get the AVClass for AVCodecContext. It can be used in combination with
3136 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3137 *
3138 * @see av_opt_find().
3139 */
3140const AVClass *avcodec_get_class(void);
3141
3142/**
3143 * Copy the settings of the source AVCodecContext into the destination
3144 * AVCodecContext. The resulting destination codec context will be
3145 * unopened, i.e. you are required to call avcodec_open2() before you
3146 * can use this AVCodecContext to decode/encode video/audio data.
3147 *
3148 * @param dest target codec context, should be initialized with
3149 * avcodec_alloc_context3(), but otherwise uninitialized
3150 * @param src source codec context
3151 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3152 */
3153int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3154
3155/**
3156 * Allocate an AVFrame and set its fields to default values. The resulting
3157 * struct can be deallocated by simply calling av_free().
3158 *
3159 * @return An AVFrame filled with default values or NULL on failure.
3160 * @see avcodec_get_frame_defaults
3161 */
3162AVFrame *avcodec_alloc_frame(void);
3163
3164/**
3165 * Set the fields of the given AVFrame to default values.
3166 *
3167 * @param pic The AVFrame of which the fields should be set to default values.
3168 */
3169void avcodec_get_frame_defaults(AVFrame *pic);
3170
3171/**
3172 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3173 * function the context has to be allocated with avcodec_alloc_context3().
3174 *
3175 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3176 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3177 * retrieving a codec.
3178 *
3179 * @warning This function is not thread safe!
3180 *
3181 * @code
3182 * avcodec_register_all();
3183 * av_dict_set(&opts, "b", "2.5M", 0);
3184 * codec = avcodec_find_decoder(CODEC_ID_H264);
3185 * if (!codec)
3186 * exit(1);
3187 *
3188 * context = avcodec_alloc_context3(codec);
3189 *
3190 * if (avcodec_open2(context, codec, opts) < 0)
3191 * exit(1);
3192 * @endcode
3193 *
3194 * @param avctx The context to initialize.
3195 * @param codec The codec to open this context for. If a non-NULL codec has been
3196 * previously passed to avcodec_alloc_context3() or
3197 * avcodec_get_context_defaults3() for this context, then this
3198 * parameter MUST be either NULL or equal to the previously passed
3199 * codec.
3200 * @param options A dictionary filled with AVCodecContext and codec-private options.
3201 * On return this object will be filled with options that were not found.
3202 *
3203 * @return zero on success, a negative value on error
3204 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3205 * av_dict_set(), av_opt_find().
3206 */
3207int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3208
3209/**
3210 * Close a given AVCodecContext and free all the data associated with it
3211 * (but not the AVCodecContext itself).
3212 *
3213 * Calling this function on an AVCodecContext that hasn't been opened will free
3214 * the codec-specific data allocated in avcodec_alloc_context3() /
3215 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3216 * do nothing.
3217 */
3218int avcodec_close(AVCodecContext *avctx);
3219
3220/**
3221 * Free all allocated data in the given subtitle struct.
3222 *
3223 * @param sub AVSubtitle to free.
3224 */
3225void avsubtitle_free(AVSubtitle *sub);
3226
3227/**
3228 * @}
3229 */
3230
30f3f625
AK
3231/**
3232 * @addtogroup lavc_packet
3233 * @{
3234 */
cdd8930e 3235
80d403fc
RD
3236/**
3237 * @deprecated use NULL instead
3238 */
3239attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
cdd8930e
TB
3240
3241/**
3242 * Default packet destructor.
3243 */
3244void av_destruct_packet(AVPacket *pkt);
3245
3246/**
3247 * Initialize optional fields of a packet with default values.
3248 *
3249 * @param pkt packet
3250 */
3251void av_init_packet(AVPacket *pkt);
3252
3253/**
3254 * Allocate the payload of a packet and initialize its fields with
3255 * default values.
3256 *
3257 * @param pkt packet
3258 * @param size wanted payload size
3259 * @return 0 if OK, AVERROR_xxx otherwise
3260 */
3261int av_new_packet(AVPacket *pkt, int size);
3262