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