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