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