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