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