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