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