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