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