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