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