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