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