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