Clearer CODEC_CAP_DR1 documentation.
[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 606/**
9b489e02
RD
607 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
608 * If not set, it might not use get_buffer() at all or use operations that
609 * assume the buffer was allocated by avcodec_default_get_buffer.
6814a25c
MN
610 */
611#define CODEC_CAP_DR1 0x0002
f5bccd85 612/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
917e06c8 613#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 614#define CODEC_CAP_TRUNCATED 0x0008
f5bccd85 615/* Codec can export data for HW decoding (XvMC). */
5e5c247a 616#define CODEC_CAP_HWACCEL 0x0010
115329f1 617/**
f5bccd85
DB
618 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
619 * If this is not set, the codec is guaranteed to never be fed with NULL data.
934982c4 620 */
6f824977 621#define CODEC_CAP_DELAY 0x0020
cef7cc72
JR
622/**
623 * Codec can be fed a final frame with a smaller size.
624 * This can be used to prevent truncation of the last audio samples.
625 */
626#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
369122dd
NC
627/**
628 * Codec can export data for HW decoding (VDPAU).
629 */
630#define CODEC_CAP_HWACCEL_VDPAU 0x0080
d859bb1d
SS
631/**
632 * Codec can output multiple frames per AVPacket
e9e949cf
MN
633 * Normally demuxers return one frame at a time, demuxers which do not do
634 * are connected to a parser to split what they return into proper frames.
635 * This flag is reserved to the very rare category of codecs which have a
636 * bitstream that cannot be split into frames without timeconsuming
637 * operations like full decoding. Demuxers carring such bitstreams thus
638 * may return multiple frames in a packet. This has many disadvantages like
639 * prohibiting stream copy in many cases thus it should only be considered
640 * as a last resort.
d859bb1d
SS
641 */
642#define CODEC_CAP_SUBFRAMES 0x0100
bf89e6b1 643
f5bccd85 644//The following defines may change, don't expect compatibility if you use them.
8d7ec294 645#define MB_TYPE_INTRA4x4 0x0001
f5bccd85
DB
646#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
647#define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
8d7ec294
WH
648#define MB_TYPE_16x16 0x0008
649#define MB_TYPE_16x8 0x0010
650#define MB_TYPE_8x16 0x0020
651#define MB_TYPE_8x8 0x0040
652#define MB_TYPE_INTERLACED 0x0080
273b0cd3 653#define MB_TYPE_DIRECT2 0x0100 //FIXME
8d7ec294
WH
654#define MB_TYPE_ACPRED 0x0200
655#define MB_TYPE_GMC 0x0400
656#define MB_TYPE_SKIP 0x0800
657#define MB_TYPE_P0L0 0x1000
658#define MB_TYPE_P1L0 0x2000
659#define MB_TYPE_P0L1 0x4000
660#define MB_TYPE_P1L1 0x8000
661#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
662#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
663#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
664#define MB_TYPE_QUANT 0x00010000
665#define MB_TYPE_CBP 0x00020000
666//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
667
fa384dcc
MN
668/**
669 * Pan Scan area.
f5bccd85
DB
670 * This specifies the area which should be displayed.
671 * Note there may be multiple such areas for one frame.
fa384dcc
MN
672 */
673typedef struct AVPanScan{
674 /**
f5bccd85
DB
675 * id
676 * - encoding: Set by user.
677 * - decoding: Set by libavcodec.
fa384dcc
MN
678 */
679 int id;
680
681 /**
682 * width and height in 1/16 pel
f5bccd85
DB
683 * - encoding: Set by user.
684 * - decoding: Set by libavcodec.
fa384dcc
MN
685 */
686 int width;
687 int height;
688
689 /**
f5bccd85
DB
690 * position of the top left corner in 1/16 pel for up to 3 fields/frames
691 * - encoding: Set by user.
692 * - decoding: Set by libavcodec.
fa384dcc
MN
693 */
694 int16_t position[3][2];
695}AVPanScan;
696
492cd3a9 697#define FF_COMMON_FRAME \
b536d0aa
MN
698 /**\
699 * pointer to the picture planes.\
f5bccd85 700 * This might be different from the first allocated byte\
b536d0aa
MN
701 * - encoding: \
702 * - decoding: \
703 */\
1e491e29
MN
704 uint8_t *data[4];\
705 int linesize[4];\
706 /**\
f5bccd85
DB
707 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
708 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
64863965
MN
709 * - encoding: \
710 * - decoding: \
1e491e29
MN
711 */\
712 uint8_t *base[4];\
713 /**\
714 * 1 -> keyframe, 0-> not\
f5bccd85
DB
715 * - encoding: Set by libavcodec.\
716 * - decoding: Set by libavcodec.\
1e491e29
MN
717 */\
718 int key_frame;\
719\
720 /**\
f5bccd85
DB
721 * Picture type of the frame, see ?_TYPE below.\
722 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
723 * - decoding: Set by libavcodec.\
1e491e29
MN
724 */\
725 int pict_type;\
726\
727 /**\
c0df9d75 728 * presentation timestamp in time_base units (time when frame should be shown to user)\
f5bccd85
DB
729 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
730 * - encoding: MUST be set by user.\
731 * - decoding: Set by libavcodec.\
1e491e29 732 */\
be6784dc 733 int64_t pts;\
1e491e29
MN
734\
735 /**\
f5bccd85 736 * picture number in bitstream order\
64863965 737 * - encoding: set by\
f5bccd85 738 * - decoding: Set by libavcodec.\
1e491e29
MN
739 */\
740 int coded_picture_number;\
741 /**\
f5bccd85 742 * picture number in display order\
64863965 743 * - encoding: set by\
f5bccd85 744 * - decoding: Set by libavcodec.\
1e491e29
MN
745 */\
746 int display_picture_number;\
747\
748 /**\
158c7f05 749 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
f5bccd85
DB
750 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
751 * - decoding: Set by libavcodec.\
1e491e29 752 */\
158c7f05 753 int quality; \
1e491e29
MN
754\
755 /**\
756 * buffer age (1->was last buffer and dint change, 2->..., ...).\
f5bccd85 757 * Set to INT_MAX if the buffer has not been used yet.\
64863965 758 * - encoding: unused\
f5bccd85 759 * - decoding: MUST be set by get_buffer().\
1e491e29
MN
760 */\
761 int age;\
762\
763 /**\
764 * is this picture used as reference\
8474f58e
MN
765 * The values for this are the same as the MpegEncContext.picture_structure\
766 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
5fe2a515 767 * Set to 4 for delayed, non-reference frames.\
64863965 768 * - encoding: unused\
f5bccd85 769 * - decoding: Set by libavcodec. (before get_buffer() call)).\
1e491e29
MN
770 */\
771 int reference;\
772\
773 /**\
774 * QP table\
64863965 775 * - encoding: unused\
f5bccd85 776 * - decoding: Set by libavcodec.\
1e491e29
MN
777 */\
778 int8_t *qscale_table;\
779 /**\
780 * QP store stride\
64863965 781 * - encoding: unused\
f5bccd85 782 * - decoding: Set by libavcodec.\
1e491e29
MN
783 */\
784 int qstride;\
785\
786 /**\
f5bccd85 787 * mbskip_table[mb]>=1 if MB didn't change\
1e491e29 788 * stride= mb_width = (width+15)>>4\
64863965 789 * - encoding: unused\
f5bccd85 790 * - decoding: Set by libavcodec.\
1e491e29
MN
791 */\
792 uint8_t *mbskip_table;\
793\
794 /**\
f5bccd85 795 * motion vector table\
61436073
MN
796 * @code\
797 * example:\
798 * int mv_sample_log2= 4 - motion_subsample_log2;\
799 * int mb_width= (width+15)>>4;\
800 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
801 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
802 * @endcode\
f5bccd85
DB
803 * - encoding: Set by user.\
804 * - decoding: Set by libavcodec.\
8d7ec294
WH
805 */\
806 int16_t (*motion_val[2])[2];\
807\
808 /**\
f5bccd85 809 * macroblock type table\
8d7ec294 810 * mb_type_base + mb_width + 2\
f5bccd85
DB
811 * - encoding: Set by user.\
812 * - decoding: Set by libavcodec.\
8d7ec294
WH
813 */\
814 uint32_t *mb_type;\
815\
816 /**\
f0b77c69
MN
817 * log2 of the size of the block which a single vector in motion_val represents: \
818 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
8d7ec294 819 * - encoding: unused\
f5bccd85 820 * - decoding: Set by libavcodec.\
8d7ec294
WH
821 */\
822 uint8_t motion_subsample_log2;\
823\
824 /**\
1e491e29 825 * for some private data of the user\
64863965 826 * - encoding: unused\
f5bccd85 827 * - decoding: Set by user.\
1e491e29
MN
828 */\
829 void *opaque;\
140cb663
MN
830\
831 /**\
832 * error\
f5bccd85 833 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
64863965 834 * - decoding: unused\
140cb663
MN
835 */\
836 uint64_t error[4];\
4e00e76b
MN
837\
838 /**\
f5bccd85
DB
839 * type of the buffer (to keep track of who has to deallocate data[*])\
840 * - encoding: Set by the one who allocates it.\
841 * - decoding: Set by the one who allocates it.\
842 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
4e00e76b
MN
843 */\
844 int type;\
2ec23b6d
MN
845 \
846 /**\
f5bccd85 847 * When decoding, this signals how much the picture must be delayed.\
2ec23b6d 848 * extra_delay = repeat_pict / (2*fps)\
64863965 849 * - encoding: unused\
f5bccd85 850 * - decoding: Set by libavcodec.\
2ec23b6d 851 */\
0426af31
MN
852 int repeat_pict;\
853 \
854 /**\
855 * \
856 */\
857 int qscale_type;\
2744ca9a
RS
858 \
859 /**\
860 * The content of the picture is interlaced.\
f5bccd85
DB
861 * - encoding: Set by user.\
862 * - decoding: Set by libavcodec. (default 0)\
2744ca9a
RS
863 */\
864 int interlaced_frame;\
865 \
866 /**\
f5bccd85
DB
867 * If the content is interlaced, is top field displayed first.\
868 * - encoding: Set by user.\
869 * - decoding: Set by libavcodec.\
2744ca9a 870 */\
9dad924e 871 int top_field_first;\
fa384dcc
MN
872 \
873 /**\
874 * Pan scan.\
f5bccd85
DB
875 * - encoding: Set by user.\
876 * - decoding: Set by libavcodec.\
fa384dcc
MN
877 */\
878 AVPanScan *pan_scan;\
2a2bbcb0
MM
879 \
880 /**\
f5bccd85 881 * Tell user application that palette has changed from previous frame.\
2a2bbcb0 882 * - encoding: ??? (no palette-enabled encoder yet)\
f5bccd85 883 * - decoding: Set by libavcodec. (default 0).\
2a2bbcb0
MM
884 */\
885 int palette_has_changed;\
074c4ca7
RT
886 \
887 /**\
f5bccd85 888 * codec suggestion on buffer type if != 0\
074c4ca7 889 * - encoding: unused\
f5bccd85 890 * - decoding: Set by libavcodec. (before get_buffer() call)).\
074c4ca7
RT
891 */\
892 int buffer_hints;\
8289c6fa
WH
893\
894 /**\
f5bccd85 895 * DCT coefficients\
8289c6fa 896 * - encoding: unused\
f5bccd85 897 * - decoding: Set by libavcodec.\
8289c6fa
WH
898 */\
899 short *dct_coeff;\
a4d36c11
MN
900\
901 /**\
58184187
BF
902 * motion reference frame index\
903 * the order in which these are stored can depend on the codec.\
f5bccd85
DB
904 * - encoding: Set by user.\
905 * - decoding: Set by libavcodec.\
a4d36c11 906 */\
79de84f2
MN
907 int8_t *ref_index[2];\
908\
909 /**\
910 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
911 * output in AVFrame.reordered_opaque\
912 * - encoding: unused\
913 * - decoding: Read by user.\
914 */\
915 int64_t reordered_opaque;\
68e5d523
GB
916\
917 /**\
918 * hardware accelerator private data (FFmpeg allocated)\
919 * - encoding: unused\
920 * - decoding: Set by libavcodec\
921 */\
952e2083 922 void *hwaccel_picture_private;\
79de84f2 923
2ec23b6d 924
bb270c08
DB
925#define FF_QSCALE_TYPE_MPEG1 0
926#define FF_QSCALE_TYPE_MPEG2 1
927#define FF_QSCALE_TYPE_H264 2
800274f8 928#define FF_QSCALE_TYPE_VP56 3
4e00e76b
MN
929
930#define FF_BUFFER_TYPE_INTERNAL 1
f5bccd85
DB
931#define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
932#define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
933#define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
4e00e76b 934
1e491e29 935
dc85e859
AJ
936#define FF_I_TYPE 1 ///< Intra
937#define FF_P_TYPE 2 ///< Predicted
938#define FF_B_TYPE 3 ///< Bi-dir predicted
939#define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
940#define FF_SI_TYPE 5 ///< Switching Intra
941#define FF_SP_TYPE 6 ///< Switching Predicted
48d533e6 942#define FF_BI_TYPE 7
1e491e29 943
f5bccd85
DB
944#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
945#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
946#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
947#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
074c4ca7 948
18c915ee
TB
949typedef struct AVPacket {
950 /**
7b356d39
RS
951 * Presentation timestamp in AVStream->time_base units; the time at which
952 * the decompressed packet will be presented to the user.
18c915ee
TB
953 * Can be AV_NOPTS_VALUE if it is not stored in the file.
954 * pts MUST be larger or equal to dts as presentation cannot happen before
955 * decompression, unless one wants to view hex dumps. Some formats misuse
956 * the terms dts and pts/cts to mean something different. Such timestamps
957 * must be converted to true pts/dts before they are stored in AVPacket.
958 */
959 int64_t pts;
960 /**
7b356d39
RS
961 * Decompression timestamp in AVStream->time_base units; the time at which
962 * the packet is decompressed.
18c915ee
TB
963 * Can be AV_NOPTS_VALUE if it is not stored in the file.
964 */
965 int64_t dts;
966 uint8_t *data;
967 int size;
968 int stream_index;
969 int flags;
970 /**
7b356d39 971 * Duration of this packet in AVStream->time_base units, 0 if unknown.
18c915ee
TB
972 * Equals next_pts - this_pts in presentation order.
973 */
974 int duration;
975 void (*destruct)(struct AVPacket *);
976 void *priv;
977 int64_t pos; ///< byte position in stream, -1 if unknown
978
979 /**
7b356d39 980 * Time difference in AVStream->time_base units from the pts of this
18c915ee
TB
981 * packet to the point at which the output from the decoder has converged
982 * independent from the availability of previous frames. That is, the
983 * frames are virtually identical no matter if decoding started from
984 * the very first frame or from this keyframe.
985 * Is AV_NOPTS_VALUE if unknown.
986 * This field is not the display duration of the current packet.
987 *
988 * The purpose of this field is to allow seeking in streams that have no
989 * keyframes in the conventional sense. It corresponds to the
990 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
991 * essential for some types of subtitle streams to ensure that all
992 * subtitles are correctly displayed after seeking.
993 */
994 int64_t convergence_duration;
995} AVPacket;
8f3f2e06
RD
996#define AV_PKT_FLAG_KEY 0x0001
997#if LIBAVCODEC_VERSION_MAJOR < 53
998#define PKT_FLAG_KEY AV_PKT_FLAG_KEY
999#endif
18c915ee 1000
0da71265
MN
1001/**
1002 * Audio Video Frame.
ba66ae94
MN
1003 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1004 * bumps.
8bfb108b 1005 * Removal, reordering and changes to existing fields require a major
ba66ae94
MN
1006 * version bump. No fields should be added into AVFrame before or after
1007 * FF_COMMON_FRAME!
8bfb108b 1008 * sizeof(AVFrame) must not be used outside libav*.
0da71265 1009 */
492cd3a9
MN
1010typedef struct AVFrame {
1011 FF_COMMON_FRAME
1012} AVFrame;
1e491e29 1013
d33c949c 1014/**
252f17e2
MN
1015 * main external API structure.
1016 * New fields can be added to the end with minor version bumps.
8bfb108b 1017 * Removal, reordering and changes to existing fields require a major
252f17e2 1018 * version bump.
8bfb108b 1019 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 1020 */
de6d9b64 1021typedef struct AVCodecContext {
b71901e6 1022 /**
f5bccd85 1023 * information on struct for av_log
bc874dae
MB
1024 * - set by avcodec_alloc_context
1025 */
d42a814e 1026 const AVClass *av_class;
bc874dae 1027 /**
f5bccd85
DB
1028 * the average bitrate
1029 * - encoding: Set by user; unused for constant quantizer encoding.
1030 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 1031 */
de6d9b64 1032 int bit_rate;
b71901e6
MN
1033
1034 /**
64863965 1035 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 1036 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 1037 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 1038 * - decoding: unused
b71901e6 1039 */
115329f1 1040 int bit_rate_tolerance;
b71901e6
MN
1041
1042 /**
64863965 1043 * CODEC_FLAG_*.
f5bccd85
DB
1044 * - encoding: Set by user.
1045 * - decoding: Set by user.
b71901e6 1046 */
de6d9b64 1047 int flags;
b71901e6
MN
1048
1049 /**
f5bccd85
DB
1050 * Some codecs need additional format info. It is stored here.
1051 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1052 * specific codec MUST set it correctly otherwise stream copy breaks.
1053 * In general use of this field by muxers is not recommanded.
1054 * - encoding: Set by libavcodec.
1055 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
b71901e6
MN
1056 */
1057 int sub_id;
1058
1059 /**
f5bccd85 1060 * Motion estimation algorithm used for video coding.
58f7833e 1061 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
89223ef6 1062 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
64863965
MN
1063 * - encoding: MUST be set by user.
1064 * - decoding: unused
b71901e6
MN
1065 */
1066 int me_method;
1067
1068 /**
f5bccd85
DB
1069 * some codecs need / can use extradata like Huffman tables.
1070 * mjpeg: Huffman tables
b71901e6 1071 * rv10: additional flags
b704e742 1072 * mpeg4: global headers (they can be in the bitstream or here)
f5bccd85
DB
1073 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1074 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1075 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1076 * - encoding: Set/allocated/freed by libavcodec.
1077 * - decoding: Set/allocated/freed by user.
b71901e6 1078 */
58f2a4b0 1079 uint8_t *extradata;
e84c31dc 1080 int extradata_size;
115329f1 1081
b71901e6 1082 /**
f5bccd85
DB
1083 * This is the fundamental unit of time (in seconds) in terms
1084 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
1085 * timebase should be 1/framerate and timestamp increments should be
1086 * identically 1.
f5bccd85
DB
1087 * - encoding: MUST be set by user.
1088 * - decoding: Set by libavcodec.
b71901e6 1089 */
c0df9d75 1090 AVRational time_base;
115329f1 1091
5b28c8c3 1092 /* video only */
14bea432 1093 /**
21adafec 1094 * picture width / height.
115329f1 1095 * - encoding: MUST be set by user.
f5bccd85
DB
1096 * - decoding: Set by libavcodec.
1097 * Note: For compatibility it is possible to set this instead of
1098 * coded_width/height before decoding.
b71901e6 1099 */
de6d9b64 1100 int width, height;
115329f1 1101
e769f053 1102#define FF_ASPECT_EXTENDED 15
b71901e6
MN
1103
1104 /**
f5bccd85
DB
1105 * the number of pictures in a group of pictures, or 0 for intra_only
1106 * - encoding: Set by user.
64863965 1107 * - decoding: unused
b71901e6
MN
1108 */
1109 int gop_size;
1110
1111 /**
f5bccd85
DB
1112 * Pixel format, see PIX_FMT_xxx.
1113 * - encoding: Set by user.
1114 * - decoding: Set by libavcodec.
b71901e6 1115 */
e4eadb4b 1116 enum PixelFormat pix_fmt;
115329f1 1117
bdfcbbed 1118 /**
f5bccd85 1119 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
bdfcbbed 1120 * has to read frames at native frame rate.
f5bccd85
DB
1121 * - encoding: Set by user.
1122 * - decoding: unused
bdfcbbed
MK
1123 */
1124 int rate_emu;
115329f1 1125
b71901e6 1126 /**
f5bccd85
DB
1127 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1128 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 1129 * all codecs can do that. You must check the codec capabilities
f5bccd85 1130 * beforehand.
24b1583a
IK
1131 * The function is also used by hardware acceleration APIs.
1132 * It is called at least once during frame decoding to pass
1133 * the data needed for hardware render.
1134 * In that mode instead of pixel data, AVFrame points to
1135 * a structure specific to the acceleration API. The application
1136 * reads the structure and can change some fields to indicate progress
1137 * or mark state.
64863965 1138 * - encoding: unused
f5bccd85 1139 * - decoding: Set by user.
3bb07d61
MN
1140 * @param height the height of the slice
1141 * @param y the y position of the slice
1142 * @param type 1->top field, 2->bottom field, 3->frame
1143 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 1144 */
bf89e6b1 1145 void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3 1146 const AVFrame *src, int offset[4],
3bb07d61 1147 int y, int type, int height);
bf89e6b1 1148
de6d9b64 1149 /* audio only */
f5bccd85 1150 int sample_rate; ///< samples per second
5fcc4a23 1151 int channels; ///< number of audio channels
a3a5f4d6
MN
1152
1153 /**
f5bccd85
DB
1154 * audio sample format
1155 * - encoding: Set by user.
1156 * - decoding: Set by libavcodec.
a3a5f4d6 1157 */
ce9dd8f5 1158 enum SampleFormat sample_fmt; ///< sample format
de6d9b64 1159
f5bccd85 1160 /* The following data should not be initialized. */
718b27a7 1161 /**
f5bccd85 1162 * Samples per packet, initialized when calling 'init'.
718b27a7
MN
1163 */
1164 int frame_size;
115329f1 1165 int frame_number; ///< audio or video frame number
c0601d70 1166#if LIBAVCODEC_VERSION_MAJOR < 53
f5bccd85 1167 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
c0601d70 1168#endif
115329f1 1169
b71901e6 1170 /**
f5bccd85 1171 * Number of frames the decoded output will be delayed relative to
64863965 1172 * the encoded input.
f5bccd85 1173 * - encoding: Set by libavcodec.
64863965 1174 * - decoding: unused
b71901e6
MN
1175 */
1176 int delay;
115329f1 1177
64863965
MN
1178 /* - encoding parameters */
1179 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
115329f1
DB
1180 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1181
b71901e6 1182 /**
f5bccd85
DB
1183 * minimum quantizer
1184 * - encoding: Set by user.
64863965 1185 * - decoding: unused
b71901e6
MN
1186 */
1187 int qmin;
1188
1189 /**
f5bccd85
DB
1190 * maximum quantizer
1191 * - encoding: Set by user.
64863965 1192 * - decoding: unused
b71901e6
MN
1193 */
1194 int qmax;
1195
1196 /**
f5bccd85
DB
1197 * maximum quantizer difference between frames
1198 * - encoding: Set by user.
64863965 1199 * - decoding: unused
b71901e6
MN
1200 */
1201 int max_qdiff;
1202
1203 /**
f5bccd85
DB
1204 * maximum number of B-frames between non-B-frames
1205 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1206 * - encoding: Set by user.
64863965 1207 * - decoding: unused
b71901e6
MN
1208 */
1209 int max_b_frames;
1210
1211 /**
f5bccd85 1212 * qscale factor between IP and B-frames
662e5411 1213 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1214 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85 1215 * - encoding: Set by user.
64863965 1216 * - decoding: unused
b71901e6
MN
1217 */
1218 float b_quant_factor;
115329f1 1219
b71901e6
MN
1220 /** obsolete FIXME remove */
1221 int rc_strategy;
64b7c5b6
MN
1222#define FF_RC_STRATEGY_XVID 1
1223
8b4c7dbc 1224 int b_frame_strategy;
9dbcbd92 1225
b71901e6 1226 /**
85947156
VS
1227 * hurry up amount
1228 * - encoding: unused
1229 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
f9ec0aa1 1230 * @deprecated Deprecated in favor of skip_idct and skip_frame.
b71901e6
MN
1231 */
1232 int hurry_up;
115329f1 1233
de6d9b64 1234 struct AVCodec *codec;
115329f1 1235
de6d9b64
FB
1236 void *priv_data;
1237
bb628dae 1238 int rtp_payload_size; /* The size of the RTP payload: the coder will */
f5bccd85 1239 /* do its best to deliver a chunk with size */
644d98a4 1240 /* below rtp_payload_size, the chunk will start */
f5bccd85 1241 /* with a start code on some codecs like H.263. */
644d98a4 1242 /* This doesn't take account of any particular */
f5bccd85 1243 /* headers inside the transmitted RTP payload. */
81401c1f 1244
115329f1 1245
f5bccd85
DB
1246 /* The RTP callback: This function is called */
1247 /* every time the encoder has a packet to send. */
1248 /* It depends on the encoder if the data starts */
1249 /* with a Start Code (it should). H.263 does. */
1250 /* mb_nb contains the number of macroblocks */
1251 /* encoded in the RTP payload. */
115329f1 1252 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
81401c1f 1253
098eefe1
MN
1254 /* statistics, used for 2-pass encoding */
1255 int mv_bits;
1256 int header_bits;
1257 int i_tex_bits;
1258 int p_tex_bits;
1259 int i_count;
1260 int p_count;
1261 int skip_count;
b71901e6 1262 int misc_bits;
115329f1 1263
b71901e6 1264 /**
f5bccd85
DB
1265 * number of bits used for the previously encoded frame
1266 * - encoding: Set by libavcodec.
7004ffb3 1267 * - decoding: unused
b71901e6 1268 */
098eefe1 1269 int frame_bits;
7004ffb3 1270
b71901e6 1271 /**
f5bccd85
DB
1272 * Private data of the user, can be used to carry app specific stuff.
1273 * - encoding: Set by user.
1274 * - decoding: Set by user.
b71901e6
MN
1275 */
1276 void *opaque;
1277
de6d9b64 1278 char codec_name[32];
4a663d80
PG
1279 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1280 enum CodecID codec_id; /* see CODEC_ID_xxx */
115329f1 1281
7004ffb3
MN
1282 /**
1283 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85
DB
1284 * This is used to work around some encoder bugs.
1285 * A demuxer should set this to what is stored in the field used to identify the codec.
1286 * If there are multiple such fields in a container then the demuxer should choose the one
1287 * which maximizes the information about the used codec.
1288 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1289 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
47bbf8a7 1290 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
f5bccd85
DB
1291 * first.
1292 * - encoding: Set by user, if not then the default based on codec_id will be used.
1293 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
7004ffb3
MN
1294 */
1295 unsigned int codec_tag;
115329f1 1296
b71901e6 1297 /**
f5bccd85
DB
1298 * Work around bugs in encoders which sometimes cannot be detected automatically.
1299 * - encoding: Set by user
1300 * - decoding: Set by user
b71901e6
MN
1301 */
1302 int workaround_bugs;
64863965 1303#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
1304#define FF_BUG_OLD_MSMPEG4 2
1305#define FF_BUG_XVID_ILACE 4
1306#define FF_BUG_UMP4 8
1307#define FF_BUG_NO_PADDING 16
3116cb14 1308#define FF_BUG_AMV 32
f5bccd85 1309#define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
03e93d35 1310#define FF_BUG_QPEL_CHROMA 64
db794953 1311#define FF_BUG_STD_QPEL 128
36df8805 1312#define FF_BUG_QPEL_CHROMA2 256
c40c3482 1313#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 1314#define FF_BUG_EDGE 1024
b44bdf7e 1315#define FF_BUG_HPEL_CHROMA 2048
4ccde216 1316#define FF_BUG_DC_CLIP 4096
f5bccd85 1317#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
3566042a 1318#define FF_BUG_TRUNCATED 16384
f5bccd85 1319//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
115329f1 1320
b71901e6 1321 /**
f5bccd85
DB
1322 * luma single coefficient elimination threshold
1323 * - encoding: Set by user.
64863965 1324 * - decoding: unused
b71901e6 1325 */
1f6b6e50 1326 int luma_elim_threshold;
115329f1 1327
b71901e6 1328 /**
f5bccd85
DB
1329 * chroma single coeff elimination threshold
1330 * - encoding: Set by user.
64863965 1331 * - decoding: unused
b71901e6 1332 */
1f6b6e50 1333 int chroma_elim_threshold;
115329f1 1334
b71901e6 1335 /**
f5bccd85
DB
1336 * strictly follow the standard (MPEG4, ...).
1337 * - encoding: Set by user.
5771b2c3
MN
1338 * - decoding: Set by user.
1339 * Setting this to STRICT or higher means the encoder and decoder will
1340 * generally do stupid things. While setting it to inofficial or lower
1341 * will mean the encoder might use things that are not supported by all
1342 * spec compliant decoders. Decoders make no difference between normal,
1343 * inofficial and experimental, that is they always try to decode things
1344 * when they can unless they are explicitly asked to behave stupid
1345 * (=strictly conform to the specs)
b71901e6
MN
1346 */
1347 int strict_std_compliance;
f5bccd85
DB
1348#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1349#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
9cd81798 1350#define FF_COMPLIANCE_NORMAL 0
f5bccd85
DB
1351#define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1352#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
9cd81798 1353
b71901e6 1354 /**
f5bccd85 1355 * qscale offset between IP and B-frames
f5bccd85 1356 * - encoding: Set by user.
64863965 1357 * - decoding: unused
b71901e6
MN
1358 */
1359 float b_quant_offset;
115329f1 1360
b71901e6 1361 /**
047599a4 1362 * Error recognization; higher values will detect more errors but may
f5bccd85 1363 * misdetect some more or less valid parts as errors.
64863965 1364 * - encoding: unused
f5bccd85 1365 * - decoding: Set by user.
b71901e6 1366 */
047599a4 1367 int error_recognition;
1471c6c2 1368#define FF_ER_CAREFUL 1
ce3bcaed
MN
1369#define FF_ER_COMPLIANT 2
1370#define FF_ER_AGGRESSIVE 3
1371#define FF_ER_VERY_AGGRESSIVE 4
115329f1 1372
6b72ac63 1373 /**
f5bccd85
DB
1374 * Called at the beginning of each frame to get a buffer for it.
1375 * If pic.reference is set then the frame will be read later by libavcodec.
eb285cfe 1376 * avcodec_align_dimensions2() should be used to find the required width and
f5bccd85 1377 * height, as they normally need to be rounded up to the next multiple of 16.
f1b99cc6
MN
1378 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1379 * avcodec_default_get_buffer() instead of providing buffers allocated by
1380 * some other means.
64863965 1381 * - encoding: unused
f5bccd85 1382 * - decoding: Set by libavcodec., user can override.
b71901e6 1383 */
492cd3a9 1384 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1 1385
b71901e6 1386 /**
69b192ac 1387 * Called to release buffers which were allocated with get_buffer.
f5bccd85
DB
1388 * A released buffer can be reused in get_buffer().
1389 * pic.data[*] must be set to NULL.
64863965 1390 * - encoding: unused
f5bccd85 1391 * - decoding: Set by libavcodec., user can override.
b71901e6 1392 */
492cd3a9 1393 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 1394
b71901e6 1395 /**
eb8a25c8 1396 * Size of the frame reordering buffer in the decoder.
2d7b0560 1397 * For MPEG-2 it is 1 IPB or 0 low delay IP.
f5bccd85
DB
1398 * - encoding: Set by libavcodec.
1399 * - decoding: Set by libavcodec.
b71901e6
MN
1400 */
1401 int has_b_frames;
718b27a7
MN
1402
1403 /**
1404 * number of bytes per packet if constant and known or 0
f5bccd85 1405 * Used by some WAV based audio codecs.
718b27a7
MN
1406 */
1407 int block_align;
115329f1 1408
f5bccd85 1409 int parse_only; /* - decoding only: If true, only parsing is done
917e06c8
FB
1410 (function avcodec_parse_frame()). The frame
1411 data is returned. Only MPEG codecs support this now. */
115329f1 1412
b71901e6 1413 /**
f5bccd85
DB
1414 * 0-> h263 quant 1-> mpeg quant
1415 * - encoding: Set by user.
64863965 1416 * - decoding: unused
b71901e6
MN
1417 */
1418 int mpeg_quant;
115329f1 1419
b71901e6 1420 /**
f5bccd85
DB
1421 * pass1 encoding statistics output buffer
1422 * - encoding: Set by libavcodec.
64863965 1423 * - decoding: unused
b71901e6 1424 */
64863965 1425 char *stats_out;
115329f1 1426
b71901e6 1427 /**
f5bccd85
DB
1428 * pass2 encoding statistics input buffer
1429 * Concatenated stuff from stats_out of pass1 should be placed here.
1430 * - encoding: Allocated/set/freed by user.
64863965 1431 * - decoding: unused
b71901e6
MN
1432 */
1433 char *stats_in;
115329f1 1434
b71901e6 1435 /**
f5bccd85
DB
1436 * ratecontrol qmin qmax limiting method
1437 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1438 * - encoding: Set by user.
64863965 1439 * - decoding: unused
b71901e6 1440 */
ce980a95 1441 float rc_qsquish;
b71901e6 1442
ce980a95
MN
1443 float rc_qmod_amp;
1444 int rc_qmod_freq;
115329f1 1445
b71901e6 1446 /**
f5bccd85
DB
1447 * ratecontrol override, see RcOverride
1448 * - encoding: Allocated/set/freed by user.
64863965 1449 * - decoding: unused
b71901e6 1450 */
ce980a95
MN
1451 RcOverride *rc_override;
1452 int rc_override_count;
115329f1 1453
b71901e6 1454 /**
f5bccd85
DB
1455 * rate control equation
1456 * - encoding: Set by user
64863965 1457 * - decoding: unused
b71901e6 1458 */
6881b8e5 1459 const char *rc_eq;
115329f1 1460
b71901e6 1461 /**
f5bccd85
DB
1462 * maximum bitrate
1463 * - encoding: Set by user.
64863965 1464 * - decoding: unused
b71901e6 1465 */
ce980a95 1466 int rc_max_rate;
115329f1 1467
b71901e6 1468 /**
f5bccd85
DB
1469 * minimum bitrate
1470 * - encoding: Set by user.
64863965 1471 * - decoding: unused
b71901e6 1472 */
ce980a95 1473 int rc_min_rate;
115329f1 1474
b71901e6 1475 /**
f5bccd85
DB
1476 * decoder bitstream buffer size
1477 * - encoding: Set by user.
64863965 1478 * - decoding: unused
b71901e6 1479 */
ce980a95
MN
1480 int rc_buffer_size;
1481 float rc_buffer_aggressivity;
b71901e6
MN
1482
1483 /**
f5bccd85
DB
1484 * qscale factor between P and I-frames
1485 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1486 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1487 * - encoding: Set by user.
64863965 1488 * - decoding: unused
b71901e6
MN
1489 */
1490 float i_quant_factor;
115329f1 1491
b71901e6 1492 /**
f5bccd85
DB
1493 * qscale offset between P and I-frames
1494 * - encoding: Set by user.
64863965 1495 * - decoding: unused
b71901e6
MN
1496 */
1497 float i_quant_offset;
115329f1 1498
b71901e6 1499 /**
f5bccd85
DB
1500 * initial complexity for pass1 ratecontrol
1501 * - encoding: Set by user.
64863965 1502 * - decoding: unused
b71901e6 1503 */
ce980a95 1504 float rc_initial_cplx;
917e06c8 1505
b71901e6 1506 /**
f5bccd85
DB
1507 * DCT algorithm, see FF_DCT_* below
1508 * - encoding: Set by user.
64863965 1509 * - decoding: unused
b71901e6 1510 */
28db7fce 1511 int dct_algo;
c7e07931 1512#define FF_DCT_AUTO 0
28db7fce 1513#define FF_DCT_FASTINT 1
c7e07931
MO
1514#define FF_DCT_INT 2
1515#define FF_DCT_MMX 3
1516#define FF_DCT_MLIB 4
05c4072b 1517#define FF_DCT_ALTIVEC 5
65e4c8c9 1518#define FF_DCT_FAAN 6
115329f1 1519
c5d309f2 1520 /**
f5bccd85
DB
1521 * luminance masking (0-> disabled)
1522 * - encoding: Set by user.
64863965 1523 * - decoding: unused
c5d309f2
MN
1524 */
1525 float lumi_masking;
115329f1 1526
c5d309f2 1527 /**
f5bccd85
DB
1528 * temporary complexity masking (0-> disabled)
1529 * - encoding: Set by user.
64863965 1530 * - decoding: unused
c5d309f2
MN
1531 */
1532 float temporal_cplx_masking;
115329f1 1533
c5d309f2 1534 /**
f5bccd85
DB
1535 * spatial complexity masking (0-> disabled)
1536 * - encoding: Set by user.
64863965 1537 * - decoding: unused
c5d309f2
MN
1538 */
1539 float spatial_cplx_masking;
115329f1 1540
c5d309f2 1541 /**
f5bccd85
DB
1542 * p block masking (0-> disabled)
1543 * - encoding: Set by user.
64863965 1544 * - decoding: unused
c5d309f2
MN
1545 */
1546 float p_masking;
15415af4 1547
5e746b99 1548 /**
f5bccd85
DB
1549 * darkness masking (0-> disabled)
1550 * - encoding: Set by user.
64863965 1551 * - decoding: unused
5e746b99
MN
1552 */
1553 float dark_masking;
115329f1 1554
0c2dd16e 1555 /**
f5bccd85
DB
1556 * IDCT algorithm, see FF_IDCT_* below.
1557 * - encoding: Set by user.
1558 * - decoding: Set by user.
2ad1516a
MN
1559 */
1560 int idct_algo;
273b0cd3
DB
1561#define FF_IDCT_AUTO 0
1562#define FF_IDCT_INT 1
1563#define FF_IDCT_SIMPLE 2
1564#define FF_IDCT_SIMPLEMMX 3
1565#define FF_IDCT_LIBMPEG2MMX 4
1566#define FF_IDCT_PS2 5
1567#define FF_IDCT_MLIB 6
1568#define FF_IDCT_ARM 7
1569#define FF_IDCT_ALTIVEC 8
1570#define FF_IDCT_SH4 9
1571#define FF_IDCT_SIMPLEARM 10
1572#define FF_IDCT_H264 11
1573#define FF_IDCT_VP3 12
1574#define FF_IDCT_IPP 13
1575#define FF_IDCT_XVIDMMX 14
1576#define FF_IDCT_CAVS 15
a0403006 1577#define FF_IDCT_SIMPLEARMV5TE 16
273b0cd3 1578#define FF_IDCT_SIMPLEARMV6 17
d9420d4d 1579#define FF_IDCT_SIMPLEVIS 18
9abc7e0f 1580#define FF_IDCT_WMV2 19
6f08c541 1581#define FF_IDCT_FAAN 20
42b30357 1582#define FF_IDCT_EA 21
7eec4328 1583#define FF_IDCT_SIMPLENEON 22
74c47463 1584#define FF_IDCT_SIMPLEALPHA 23
342c7dfd 1585#define FF_IDCT_BINK 24
2ad1516a 1586
144f0625 1587 /**
f5bccd85
DB
1588 * slice count
1589 * - encoding: Set by libavcodec.
1590 * - decoding: Set by user (or 0).
144f0625
MN
1591 */
1592 int slice_count;
1593 /**
f5bccd85
DB
1594 * slice offsets in the frame in bytes
1595 * - encoding: Set/allocated by libavcodec.
1596 * - decoding: Set/allocated by user (or NULL).
144f0625
MN
1597 */
1598 int *slice_offset;
1599
4d2858de 1600 /**
f5bccd85 1601 * error concealment flags
64863965 1602 * - encoding: unused
f5bccd85 1603 * - decoding: Set by user.
4d2858de
MN
1604 */
1605 int error_concealment;
1606#define FF_EC_GUESS_MVS 1
1607#define FF_EC_DEBLOCK 2
1608
6b72ac63 1609 /**
bec89a84 1610 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1611 * CPU features (i.e. MMX, SSE. ...)
bec89a84 1612 *
f5bccd85
DB
1613 * With the FORCE flag you may instead enable given CPU features.
1614 * (Dangerous: Usable in case of misdetection, improper usage however will
1615 * result into program crash.)
bec89a84
ZK
1616 */
1617 unsigned dsp_mask;
f5bccd85 1618#define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
bec89a84 1619 /* lower 16 bits - CPU features */
0cd60abf
MN
1620#define FF_MM_MMX 0x0001 ///< standard MMX
1621#define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
6b434361 1622#if LIBAVCODEC_VERSION_MAJOR < 53
0cd60abf 1623#define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
6b434361
SS
1624#endif
1625#define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
0cd60abf
MN
1626#define FF_MM_SSE 0x0008 ///< SSE functions
1627#define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1628#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1629#define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1630#define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
710441c2
DC
1631#define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1632#define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
0cd60abf 1633#define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
82d1605f 1634#define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
11f18faf
MN
1635
1636 /**
64863965 1637 * bits per sample/pixel from the demuxer (needed for huffyuv).
f5bccd85
DB
1638 * - encoding: Set by libavcodec.
1639 * - decoding: Set by user.
11f18faf 1640 */
46a73068 1641 int bits_per_coded_sample;
115329f1 1642
11f18faf 1643 /**
f5bccd85
DB
1644 * prediction method (needed for huffyuv)
1645 * - encoding: Set by user.
64863965 1646 * - decoding: unused
11f18faf
MN
1647 */
1648 int prediction_method;
1649#define FF_PRED_LEFT 0
1650#define FF_PRED_PLANE 1
1651#define FF_PRED_MEDIAN 2
115329f1 1652
5d3cea3a 1653 /**
f5bccd85 1654 * sample aspect ratio (0 if unknown)
8e5af7a6 1655 * That is the width of a pixel divided by the height of the pixel.
f5bccd85
DB
1656 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1657 * - encoding: Set by user.
1658 * - decoding: Set by libavcodec.
5d3cea3a 1659 */
5ff85f1d 1660 AVRational sample_aspect_ratio;
1e491e29
MN
1661
1662 /**
f5bccd85
DB
1663 * the picture in the bitstream
1664 * - encoding: Set by libavcodec.
1665 * - decoding: Set by libavcodec.
1e491e29 1666 */
492cd3a9 1667 AVFrame *coded_frame;
c8c437bc
MN
1668
1669 /**
f5bccd85
DB
1670 * debug
1671 * - encoding: Set by user.
1672 * - decoding: Set by user.
c8c437bc
MN
1673 */
1674 int debug;
273b0cd3
DB
1675#define FF_DEBUG_PICT_INFO 1
1676#define FF_DEBUG_RC 2
1677#define FF_DEBUG_BITSTREAM 4
1678#define FF_DEBUG_MB_TYPE 8
1679#define FF_DEBUG_QP 16
1680#define FF_DEBUG_MV 32
1681#define FF_DEBUG_DCT_COEFF 0x00000040
1682#define FF_DEBUG_SKIP 0x00000080
1683#define FF_DEBUG_STARTCODE 0x00000100
1684#define FF_DEBUG_PTS 0x00000200
1685#define FF_DEBUG_ER 0x00000400
1686#define FF_DEBUG_MMCO 0x00000800
1687#define FF_DEBUG_BUGS 0x00001000
1688#define FF_DEBUG_VIS_QP 0x00002000
864119b6 1689#define FF_DEBUG_VIS_MB_TYPE 0x00004000
385c820b 1690#define FF_DEBUG_BUFFERS 0x00008000
115329f1 1691
140cb663 1692 /**
f5bccd85
DB
1693 * debug
1694 * - encoding: Set by user.
1695 * - decoding: Set by user.
0c9bbaec
WH
1696 */
1697 int debug_mv;
1698#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1699#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1700#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1701
1702 /**
f5bccd85
DB
1703 * error
1704 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
64863965 1705 * - decoding: unused
140cb663
MN
1706 */
1707 uint64_t error[4];
115329f1 1708
17a70fde 1709 /**
f5bccd85 1710 * minimum MB quantizer
6e0d8c06 1711 * - encoding: unused
64863965 1712 * - decoding: unused
17a70fde
MN
1713 */
1714 int mb_qmin;
1715
1716 /**
f5bccd85 1717 * maximum MB quantizer
6e0d8c06 1718 * - encoding: unused
64863965 1719 * - decoding: unused
17a70fde
MN
1720 */
1721 int mb_qmax;
115329f1 1722
1457ab52 1723 /**
f5bccd85
DB
1724 * motion estimation comparison function
1725 * - encoding: Set by user.
64863965 1726 * - decoding: unused
1457ab52
MN
1727 */
1728 int me_cmp;
1729 /**
f5bccd85
DB
1730 * subpixel motion estimation comparison function
1731 * - encoding: Set by user.
64863965 1732 * - decoding: unused
1457ab52
MN
1733 */
1734 int me_sub_cmp;
1735 /**
f5bccd85
DB
1736 * macroblock comparison function (not supported yet)
1737 * - encoding: Set by user.
64863965 1738 * - decoding: unused
1457ab52
MN
1739 */
1740 int mb_cmp;
622348f9 1741 /**
f5bccd85
DB
1742 * interlaced DCT comparison function
1743 * - encoding: Set by user.
622348f9
MN
1744 * - decoding: unused
1745 */
1746 int ildct_cmp;
273b0cd3
DB
1747#define FF_CMP_SAD 0
1748#define FF_CMP_SSE 1
1749#define FF_CMP_SATD 2
1750#define FF_CMP_DCT 3
1751#define FF_CMP_PSNR 4
1752#define FF_CMP_BIT 5
1753#define FF_CMP_RD 6
1754#define FF_CMP_ZERO 7
1755#define FF_CMP_VSAD 8
1756#define FF_CMP_VSSE 9
1757#define FF_CMP_NSSE 10
1758#define FF_CMP_W53 11
1759#define FF_CMP_W97 12
0fd6aea1 1760#define FF_CMP_DCTMAX 13
27c61ac5 1761#define FF_CMP_DCT264 14
1457ab52 1762#define FF_CMP_CHROMA 256
115329f1 1763
1457ab52 1764 /**
f5bccd85
DB
1765 * ME diamond size & shape
1766 * - encoding: Set by user.
64863965 1767 * - decoding: unused
1457ab52
MN
1768 */
1769 int dia_size;
b07a5980
MN
1770
1771 /**
f5bccd85
DB
1772 * amount of previous MV predictors (2a+1 x 2a+1 square)
1773 * - encoding: Set by user.
64863965 1774 * - decoding: unused
b07a5980
MN
1775 */
1776 int last_predictor_count;
70ac76c0 1777
f5fb6b34 1778 /**
f5bccd85
DB
1779 * prepass for motion estimation
1780 * - encoding: Set by user.
64863965 1781 * - decoding: unused
f5fb6b34
MN
1782 */
1783 int pre_me;
b07a5980 1784
70ac76c0 1785 /**
f5bccd85
DB
1786 * motion estimation prepass comparison function
1787 * - encoding: Set by user.
64863965 1788 * - decoding: unused
70ac76c0
MN
1789 */
1790 int me_pre_cmp;
826f429a 1791
70ac76c0 1792 /**
f5bccd85
DB
1793 * ME prepass diamond size & shape
1794 * - encoding: Set by user.
64863965 1795 * - decoding: unused
70ac76c0
MN
1796 */
1797 int pre_dia_size;
1798
826f429a 1799 /**
f5bccd85
DB
1800 * subpel ME quality
1801 * - encoding: Set by user.
64863965 1802 * - decoding: unused
826f429a
MN
1803 */
1804 int me_subpel_quality;
1805
a33c7159 1806 /**
f5bccd85 1807 * callback to negotiate the pixelFormat
a33c7159 1808 * @param fmt is the list of formats which are supported by the codec,
f5bccd85
DB
1809 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1810 * The first is always the native one.
1811 * @return the chosen format
64863965 1812 * - encoding: unused
f5bccd85 1813 * - decoding: Set by user, if not set the native format will be chosen.
a33c7159 1814 */
494c56d3 1815 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
e2f9490e
FB
1816
1817 /**
f5bccd85
DB
1818 * DTG active format information (additional aspect ratio
1819 * information only used in DVB MPEG-2 transport streams)
1820 * 0 if not set.
115329f1 1821 *
f5bccd85
DB
1822 * - encoding: unused
1823 * - decoding: Set by decoder.
e2f9490e
FB
1824 */
1825 int dtg_active_format;
1826#define FF_DTG_AFD_SAME 8
1827#define FF_DTG_AFD_4_3 9
1828#define FF_DTG_AFD_16_9 10
1829#define FF_DTG_AFD_14_9 11
1830#define FF_DTG_AFD_4_3_SP_14_9 13
1831#define FF_DTG_AFD_16_9_SP_14_9 14
1832#define FF_DTG_AFD_SP_4_3 15
1833
ebbcdc9a 1834 /**
f5bccd85
DB
1835 * maximum motion estimation search range in subpel units
1836 * If 0 then no limit.
115329f1 1837 *
f5bccd85
DB
1838 * - encoding: Set by user.
1839 * - decoding: unused
ebbcdc9a 1840 */
59e0ac8e 1841 int me_range;
ebbcdc9a 1842
65f7062d 1843 /**
f5bccd85
DB
1844 * intra quantizer bias
1845 * - encoding: Set by user.
1984f635
MN
1846 * - decoding: unused
1847 */
1848 int intra_quant_bias;
1849#define FF_DEFAULT_QUANT_BIAS 999999
115329f1 1850
1984f635 1851 /**
f5bccd85
DB
1852 * inter quantizer bias
1853 * - encoding: Set by user.
1984f635
MN
1854 * - decoding: unused
1855 */
1856 int inter_quant_bias;
5cd62665
ZK
1857
1858 /**
f5bccd85
DB
1859 * color table ID
1860 * - encoding: unused
1861 * - decoding: Which clrtable should be used for 8bit RGB images.
1862 * Tables have to be stored somewhere. FIXME
5cd62665
ZK
1863 */
1864 int color_table_id;
115329f1 1865
d90cf87b 1866 /**
f5bccd85
DB
1867 * internal_buffer count
1868 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1869 */
1870 int internal_buffer_count;
115329f1 1871
d90cf87b 1872 /**
f5bccd85
DB
1873 * internal_buffers
1874 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1875 */
1876 void *internal_buffer;
158c7f05
MN
1877
1878#define FF_LAMBDA_SHIFT 7
1879#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1880#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1881#define FF_LAMBDA_MAX (256*128-1)
1882
1883#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce 1884 /**
f5bccd85
DB
1885 * Global quality for codecs which cannot change it per frame.
1886 * This should be proportional to MPEG-1/2/4 qscale.
1887 * - encoding: Set by user.
3d2e8cce
MN
1888 * - decoding: unused
1889 */
1890 int global_quality;
115329f1 1891
bd446bb1
MN
1892#define FF_CODER_TYPE_VLC 0
1893#define FF_CODER_TYPE_AC 1
f87459e4
KN
1894#define FF_CODER_TYPE_RAW 2
1895#define FF_CODER_TYPE_RLE 3
1896#define FF_CODER_TYPE_DEFLATE 4
11e659c2
MN
1897 /**
1898 * coder type
f5bccd85 1899 * - encoding: Set by user.
11e659c2
MN
1900 * - decoding: unused
1901 */
1902 int coder_type;
1903
1904 /**
1905 * context model
f5bccd85 1906 * - encoding: Set by user.
11e659c2
MN
1907 * - decoding: unused
1908 */
1909 int context_model;
5639729b
MN
1910#if 0
1911 /**
1912 *
1913 * - encoding: unused
f5bccd85 1914 * - decoding: Set by user.
5639729b
MN
1915 */
1916 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1917#endif
115329f1 1918
3bb07d61
MN
1919 /**
1920 * slice flags
1921 * - encoding: unused
f5bccd85 1922 * - decoding: Set by user.
3bb07d61
MN
1923 */
1924 int slice_flags;
1925#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1926#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1927#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1928
fb364ada
IK
1929 /**
1930 * XVideo Motion Acceleration
1931 * - encoding: forbidden
1932 * - decoding: set by decoder
1933 */
1934 int xvmc_acceleration;
115329f1 1935
7d1c3fc1
MN
1936 /**
1937 * macroblock decision mode
f5bccd85 1938 * - encoding: Set by user.
7d1c3fc1
MN
1939 * - decoding: unused
1940 */
1941 int mb_decision;
1942#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1943#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
e6dba5df 1944#define FF_MB_DECISION_RD 2 ///< rate distortion
d6eb3c50
MN
1945
1946 /**
1947 * custom intra quantization matrix
f5bccd85
DB
1948 * - encoding: Set by user, can be NULL.
1949 * - decoding: Set by libavcodec.
d6eb3c50
MN
1950 */
1951 uint16_t *intra_matrix;
1952
1953 /**
1954 * custom inter quantization matrix
f5bccd85
DB
1955 * - encoding: Set by user, can be NULL.
1956 * - decoding: Set by libavcodec.
d6eb3c50
MN
1957 */
1958 uint16_t *inter_matrix;
115329f1 1959
541ae140
MN
1960 /**
1961 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85 1962 * This is used to work around some encoder bugs.
541ae140 1963 * - encoding: unused
f5bccd85 1964 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
541ae140
MN
1965 */
1966 unsigned int stream_codec_tag;
05fbd0a2
MN
1967
1968 /**
f5bccd85
DB
1969 * scene change detection threshold
1970 * 0 is default, larger means fewer detected scene changes.
1971 * - encoding: Set by user.
05fbd0a2
MN
1972 * - decoding: unused
1973 */
1974 int scenechange_threshold;
158c7f05
MN
1975
1976 /**
f5bccd85
DB
1977 * minimum Lagrange multipler
1978 * - encoding: Set by user.
158c7f05
MN
1979 * - decoding: unused
1980 */
1981 int lmin;
1982
1983 /**
f5bccd85
DB
1984 * maximum Lagrange multipler
1985 * - encoding: Set by user.
158c7f05
MN
1986 * - decoding: unused
1987 */
1988 int lmax;
2a2bbcb0
MM
1989
1990 /**
f5bccd85 1991 * palette control structure
2a2bbcb0 1992 * - encoding: ??? (no palette-enabled encoder yet)
f5bccd85 1993 * - decoding: Set by user.
2a2bbcb0
MM
1994 */
1995 struct AVPaletteControl *palctrl;
821cb11f
MN
1996
1997 /**
1998 * noise reduction strength
f5bccd85 1999 * - encoding: Set by user.
821cb11f
MN
2000 * - decoding: unused
2001 */
2002 int noise_reduction;
115329f1 2003
074c4ca7 2004 /**
f5bccd85
DB
2005 * Called at the beginning of a frame to get cr buffer for it.
2006 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2007 * libavcodec will pass previous buffer in pic, function should return
e1c2a5a0 2008 * same buffer or new buffer with old frame "painted" into it.
f5bccd85 2009 * If pic.data[0] == NULL must behave like get_buffer().
f1b99cc6
MN
2010 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2011 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2012 * some other means.
074c4ca7 2013 * - encoding: unused
f5bccd85 2014 * - decoding: Set by libavcodec., user can override
074c4ca7 2015 */
e1c2a5a0 2016 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
MN
2017
2018 /**
f5bccd85
DB
2019 * Number of bits which should be loaded into the rc buffer before decoding starts.
2020 * - encoding: Set by user.
ba58dabc
MN
2021 * - decoding: unused
2022 */
2023 int rc_initial_buffer_occupancy;
2024
2025 /**
2026 *
f5bccd85 2027 * - encoding: Set by user.
ba58dabc
MN
2028 * - decoding: unused
2029 */
2030 int inter_threshold;
2031
2032 /**
f5bccd85
DB
2033 * CODEC_FLAG2_*
2034 * - encoding: Set by user.
2035 * - decoding: Set by user.
ba58dabc
MN
2036 */
2037 int flags2;
7ebfc0ea
MN
2038
2039 /**
f5bccd85
DB
2040 * Simulates errors in the bitstream to test error concealment.
2041 * - encoding: Set by user.
2042 * - decoding: unused
7ebfc0ea
MN
2043 */
2044 int error_rate;
115329f1 2045
a1e257b2
MN
2046 /**
2047 * MP3 antialias algorithm, see FF_AA_* below.
2048 * - encoding: unused
f5bccd85 2049 * - decoding: Set by user.
a1e257b2
MN
2050 */
2051 int antialias_algo;
2052#define FF_AA_AUTO 0
2053#define FF_AA_FASTINT 1 //not implemented yet
2054#define FF_AA_INT 2
2055#define FF_AA_FLOAT 3
77ea0d4b 2056 /**
f5bccd85
DB
2057 * quantizer noise shaping
2058 * - encoding: Set by user.
77ea0d4b
MN
2059 * - decoding: unused
2060 */
2061 int quantizer_noise_shaping;
9c3d33d6
MN
2062
2063 /**
f5bccd85 2064 * thread count
eafcac6a 2065 * is used to decide how many independent tasks should be passed to execute()
f5bccd85
DB
2066 * - encoding: Set by user.
2067 * - decoding: Set by user.
9c3d33d6
MN
2068 */
2069 int thread_count;
115329f1 2070
9c3d33d6 2071 /**
f5bccd85
DB
2072 * The codec may call this to execute several independent things.
2073 * It will return only after finishing all tasks.
2074 * The user may replace this with some multithreaded implementation,
2075 * the default implementation will execute the parts serially.
399cec2f 2076 * @param count the number of things to execute
f5bccd85
DB
2077 * - encoding: Set by libavcodec, user can override.
2078 * - decoding: Set by libavcodec, user can override.
9c3d33d6 2079 */
3a84713a 2080 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
115329f1 2081
9c3d33d6 2082 /**
f5bccd85
DB
2083 * thread opaque
2084 * Can be used by execute() to store some per AVCodecContext stuff.
9c3d33d6
MN
2085 * - encoding: set by execute()
2086 * - decoding: set by execute()
2087 */
2088 void *thread_opaque;
a4d36c11
MN
2089
2090 /**
f5bccd85
DB
2091 * Motion estimation threshold below which no motion estimation is
2092 * performed, but instead the user specified motion vectors are used.
115329f1 2093 *
f5bccd85 2094 * - encoding: Set by user.
f20f8a8b 2095 * - decoding: unused
a4d36c11 2096 */
2750b827 2097 int me_threshold;
f20f8a8b
MN
2098
2099 /**
f5bccd85
DB
2100 * Macroblock threshold below which the user specified macroblock types will be used.
2101 * - encoding: Set by user.
f20f8a8b
MN
2102 * - decoding: unused
2103 */
2104 int mb_threshold;
bf266e19
MN
2105
2106 /**
f5bccd85
DB
2107 * precision of the intra DC coefficient - 8
2108 * - encoding: Set by user.
bf266e19
MN
2109 * - decoding: unused
2110 */
2111 int intra_dc_precision;
d4c5d2ad
MN
2112
2113 /**
f5bccd85
DB
2114 * noise vs. sse weight for the nsse comparsion function
2115 * - encoding: Set by user.
d4c5d2ad
MN
2116 * - decoding: unused
2117 */
2118 int nsse_weight;
0dfd33c3
MN
2119
2120 /**
f5bccd85 2121 * Number of macroblock rows at the top which are skipped.
0dfd33c3 2122 * - encoding: unused
f5bccd85 2123 * - decoding: Set by user.
0dfd33c3
MN
2124 */
2125 int skip_top;
2126
2127 /**
f5bccd85 2128 * Number of macroblock rows at the bottom which are skipped.
0dfd33c3 2129 * - encoding: unused
f5bccd85 2130 * - decoding: Set by user.
0dfd33c3
MN
2131 */
2132 int skip_bottom;
baced9f5
MN
2133
2134 /**
2135 * profile
f5bccd85
DB
2136 * - encoding: Set by user.
2137 * - decoding: Set by libavcodec.
baced9f5
MN
2138 */
2139 int profile;
2140#define FF_PROFILE_UNKNOWN -99
dd0cd3d2 2141
4f2c36ac 2142#define FF_PROFILE_AAC_MAIN 0
273b0cd3
DB
2143#define FF_PROFILE_AAC_LOW 1
2144#define FF_PROFILE_AAC_SSR 2
2145#define FF_PROFILE_AAC_LTP 3
baced9f5 2146
dd0cd3d2
RC
2147#define FF_PROFILE_H264_BASELINE 66
2148#define FF_PROFILE_H264_MAIN 77
2149#define FF_PROFILE_H264_EXTENDED 88
2150#define FF_PROFILE_H264_HIGH 100
2151#define FF_PROFILE_H264_HIGH_10 110
2152#define FF_PROFILE_H264_HIGH_422 122
2153#define FF_PROFILE_H264_HIGH_444 244
2154#define FF_PROFILE_H264_CAVLC_444 44
2155
baced9f5
MN
2156 /**
2157 * level
f5bccd85
DB
2158 * - encoding: Set by user.
2159 * - decoding: Set by libavcodec.
baced9f5
MN
2160 */
2161 int level;
2162#define FF_LEVEL_UNKNOWN -99
178fcca8
MN
2163
2164 /**
f5bccd85 2165 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
178fcca8 2166 * - encoding: unused
f5bccd85 2167 * - decoding: Set by user.
178fcca8
MN
2168 */
2169 int lowres;
21adafec
MN
2170
2171 /**
f5bccd85
DB
2172 * Bitstream width / height, may be different from width/height if lowres
2173 * or other things are used.
21adafec 2174 * - encoding: unused
f5bccd85 2175 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
21adafec
MN
2176 */
2177 int coded_width, coded_height;
bbf18b21
MN
2178
2179 /**
2180 * frame skip threshold
f5bccd85 2181 * - encoding: Set by user.
bbf18b21
MN
2182 * - decoding: unused
2183 */
2184 int frame_skip_threshold;
2185
2186 /**
2187 * frame skip factor
f5bccd85 2188 * - encoding: Set by user.
bbf18b21
MN
2189 * - decoding: unused
2190 */
2191 int frame_skip_factor;
0fd6aea1
MN
2192
2193 /**
2194 * frame skip exponent
f5bccd85 2195 * - encoding: Set by user.
0fd6aea1
MN
2196 * - decoding: unused
2197 */
2198 int frame_skip_exp;
2199
2200 /**
f5bccd85
DB
2201 * frame skip comparison function
2202 * - encoding: Set by user.
0fd6aea1
MN
2203 * - decoding: unused
2204 */
2205 int frame_skip_cmp;
957c743a
CM
2206
2207 /**
f5bccd85 2208 * Border processing masking, raises the quantizer for mbs on the borders
957c743a 2209 * of the picture.
f5bccd85 2210 * - encoding: Set by user.
957c743a
CM
2211 * - decoding: unused
2212 */
2213 float border_masking;
6e0d8c06
MN
2214
2215 /**
f5bccd85
DB
2216 * minimum MB lagrange multipler
2217 * - encoding: Set by user.
6e0d8c06
MN
2218 * - decoding: unused
2219 */
2220 int mb_lmin;
2221
2222 /**
f5bccd85
DB
2223 * maximum MB lagrange multipler
2224 * - encoding: Set by user.
6e0d8c06
MN
2225 * - decoding: unused
2226 */
2227 int mb_lmax;
09c3e44e
MN
2228
2229 /**
115329f1 2230 *
f5bccd85 2231 * - encoding: Set by user.
09c3e44e
MN
2232 * - decoding: unused
2233 */
2234 int me_penalty_compensation;
8c3eba7c
MN
2235
2236 /**
115329f1 2237 *
8c3eba7c 2238 * - encoding: unused
f5bccd85 2239 * - decoding: Set by user.
8c3eba7c
MN
2240 */
2241 enum AVDiscard skip_loop_filter;
2242
2243 /**
115329f1 2244 *
8c3eba7c 2245 * - encoding: unused
f5bccd85 2246 * - decoding: Set by user.
8c3eba7c
MN
2247 */
2248 enum AVDiscard skip_idct;
2249
2250 /**
115329f1 2251 *
8c3eba7c 2252 * - encoding: unused
f5bccd85 2253 * - decoding: Set by user.
8c3eba7c
MN
2254 */
2255 enum AVDiscard skip_frame;
316a2ec8
MN
2256
2257 /**
2258 *
f5bccd85 2259 * - encoding: Set by user.
316a2ec8
MN
2260 * - decoding: unused
2261 */
2262 int bidir_refine;
e8501c93
MN
2263
2264 /**
2265 *
f5bccd85 2266 * - encoding: Set by user.
e8501c93
MN
2267 * - decoding: unused
2268 */
2269 int brd_scale;
58f7833e
RS
2270
2271 /**
2272 * constant rate factor - quality-based VBR - values ~correspond to qps
f5bccd85 2273 * - encoding: Set by user.
58f7833e
RS
2274 * - decoding: unused
2275 */
9f1c1c99 2276 float crf;
58f7833e
RS
2277
2278 /**
2279 * constant quantization parameter rate control method
f5bccd85 2280 * - encoding: Set by user.
58f7833e
RS
2281 * - decoding: unused
2282 */
2283 int cqp;
2284
2285 /**
f5bccd85
DB
2286 * minimum GOP size
2287 * - encoding: Set by user.
58f7833e
RS
2288 * - decoding: unused
2289 */
2290 int keyint_min;
2291
2292 /**
2293 * number of reference frames
f5bccd85 2294 * - encoding: Set by user.
53d55e9e 2295 * - decoding: Set by lavc.
58f7833e
RS
2296 */
2297 int refs;
2298
2299 /**
2300 * chroma qp offset from luma
f5bccd85 2301 * - encoding: Set by user.
58f7833e
RS
2302 * - decoding: unused
2303 */
2304 int chromaoffset;
2305
2306 /**
f5bccd85
DB
2307 * Influences how often B-frames are used.
2308 * - encoding: Set by user.
58f7833e
RS
2309 * - decoding: unused
2310 */
2311 int bframebias;
2312
2313 /**
2314 * trellis RD quantization
f5bccd85 2315 * - encoding: Set by user.
58f7833e
RS
2316 * - decoding: unused
2317 */
2318 int trellis;
2319
2320 /**
f5bccd85
DB
2321 * Reduce fluctuations in qp (before curve compression).
2322 * - encoding: Set by user.
58f7833e
RS
2323 * - decoding: unused
2324 */
2325 float complexityblur;
2326
2327 /**
2328 * in-loop deblocking filter alphac0 parameter
2329 * alpha is in the range -6...6
f5bccd85 2330 * - encoding: Set by user.
58f7833e
RS
2331 * - decoding: unused
2332 */
2333 int deblockalpha;
2334
2335 /**
2336 * in-loop deblocking filter beta parameter
2337 * beta is in the range -6...6
f5bccd85 2338 * - encoding: Set by user.
58f7833e
RS
2339 * - decoding: unused
2340 */
2341 int deblockbeta;
2342
2343 /**
2344 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
f5bccd85 2345 * - encoding: Set by user.
58f7833e
RS
2346 * - decoding: unused
2347 */
2348 int partitions;
56cc85a0
DB
2349#define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2350#define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2351#define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2352#define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2353#define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
58f7833e
RS
2354
2355 /**
30ab4ded 2356 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
f5bccd85 2357 * - encoding: Set by user.
58f7833e
RS
2358 * - decoding: unused
2359 */
2360 int directpred;
4f59b684 2361
14f0c8e2 2362 /**
02c164c1 2363 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 2364 * - encoding: Set by user.
14f0c8e2
LA
2365 * - decoding: unused
2366 */
2367 int cutoff;
39a64e30
CH
2368
2369 /**
f5bccd85
DB
2370 * Multiplied by qscale for each frame and added to scene_change_score.
2371 * - encoding: Set by user.
39a64e30
CH
2372 * - decoding: unused
2373 */
2374 int scenechange_factor;
1dd509b1
MN
2375
2376 /**
2377 *
f5bccd85
DB
2378 * Note: Value depends upon the compare function used for fullpel ME.
2379 * - encoding: Set by user.
1dd509b1
MN
2380 * - decoding: unused
2381 */
2382 int mv0_threshold;
f9243d34
CH
2383
2384 /**
f5bccd85
DB
2385 * Adjusts sensitivity of b_frame_strategy 1.
2386 * - encoding: Set by user.
f9243d34
CH
2387 * - decoding: unused
2388 */
2389 int b_sensitivity;
a403fc03
JR
2390
2391 /**
f5bccd85 2392 * - encoding: Set by user.
a403fc03
JR
2393 * - decoding: unused
2394 */
2395 int compression_level;
2396#define FF_COMPRESSION_DEFAULT -1
2397
2398 /**
f5bccd85
DB
2399 * Sets whether to use LPC mode - used by FLAC encoder.
2400 * - encoding: Set by user.
2401 * - decoding: unused
a403fc03
JR
2402 */
2403 int use_lpc;
2404
2405 /**
2406 * LPC coefficient precision - used by FLAC encoder
f5bccd85
DB
2407 * - encoding: Set by user.
2408 * - decoding: unused
a403fc03
JR
2409 */
2410 int lpc_coeff_precision;
2411
2412 /**
f5bccd85
DB
2413 * - encoding: Set by user.
2414 * - decoding: unused
a403fc03
JR
2415 */
2416 int min_prediction_order;
2417
2418 /**
f5bccd85
DB
2419 * - encoding: Set by user.
2420 * - decoding: unused
a403fc03
JR
2421 */
2422 int max_prediction_order;
2423
2424 /**
2425 * search method for selecting prediction order
f5bccd85
DB
2426 * - encoding: Set by user.
2427 * - decoding: unused
a403fc03
JR
2428 */
2429 int prediction_order_method;
2430
2431 /**
f5bccd85
DB
2432 * - encoding: Set by user.
2433 * - decoding: unused
a403fc03
JR
2434 */
2435 int min_partition_order;
2436
2437 /**
f5bccd85
DB
2438 * - encoding: Set by user.
2439 * - decoding: unused
a403fc03
JR
2440 */
2441 int max_partition_order;
80d617f5
BC
2442
2443 /**
2444 * GOP timecode frame start number, in non drop frame format
f5bccd85
DB
2445 * - encoding: Set by user.
2446 * - decoding: unused
80d617f5
BC
2447 */
2448 int64_t timecode_frame_start;
b1ec601f 2449
0d72e7d0 2450#if LIBAVCODEC_VERSION_MAJOR < 53
b1ec601f 2451 /**
85947156
VS
2452 * Decoder should decode to this many channels if it can (0 for default)
2453 * - encoding: unused
2454 * - decoding: Set by user.
0d72e7d0 2455 * @deprecated Deprecated in favor of request_channel_layout.
b1ec601f
RD
2456 */
2457 int request_channels;
0d72e7d0 2458#endif
1408352a
JR
2459
2460 /**
2461 * Percentage of dynamic range compression to be applied by the decoder.
2462 * The default value is 1.0, corresponding to full compression.
2463 * - encoding: unused
2464 * - decoding: Set by user.
2465 */
2466 float drc_scale;
79de84f2
MN
2467
2468 /**
2469 * opaque 64bit number (generally a PTS) that will be reordered and
2470 * output in AVFrame.reordered_opaque
2471 * - encoding: unused
2472 * - decoding: Set by user.
2473 */
2474 int64_t reordered_opaque;
312420f3
PR
2475
2476 /**
2477 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2478 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2479 * - encoding: set by user.
2480 * - decoding: set by libavcodec.
2481 */
2482 int bits_per_raw_sample;
0d72e7d0
PR
2483
2484 /**
2485 * Audio channel layout.
2486 * - encoding: set by user.
2487 * - decoding: set by libavcodec.
2488 */
2489 int64_t channel_layout;
2490
2491 /**
2492 * Request decoder to use this channel layout if it can (0 for default)
2493 * - encoding: unused
2494 * - decoding: Set by user.
2495 */
2496 int64_t request_channel_layout;
3bff4d8b
BC
2497
2498 /**
2499 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2500 * - encoding: Set by user.
2501 * - decoding: unused.
2502 */
2503 float rc_max_available_vbv_use;
2504
2505 /**
2506 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2507 * - encoding: Set by user.
2508 * - decoding: unused.
2509 */
2510 float rc_min_vbv_overflow_use;
40e5d31b
GB
2511
2512 /**
2513 * Hardware accelerator in use
2514 * - encoding: unused.
2515 * - decoding: Set by libavcodec
2516 */
2517 struct AVHWAccel *hwaccel;
3797c74b
MN
2518
2519 /**
2520 * For some codecs, the time base is closer to the field rate than the frame rate.
2521 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2522 * if no telecine is used ...
2523 *
2524 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2525 */
2526 int ticks_per_frame;
1aea7018
GB
2527
2528 /**
2529 * Hardware accelerator context.
2530 * For some hardware accelerators, a global context needs to be
2531 * provided by the user. In that case, this holds display-dependent
2532 * data FFmpeg cannot instantiate itself. Please refer to the
2533 * FFmpeg HW accelerator documentation to know how to fill this
2534 * is. e.g. for VA API, this is a struct vaapi_context.
2535 * - encoding: unused
2536 * - decoding: Set by user
2537 */
2538 void *hwaccel_context;
4ee6a5c1
MN
2539
2540 /**
2541 * Chromaticity coordinates of the source primaries.
2542 * - encoding: Set by user
2543 * - decoding: Set by libavcodec
2544 */
2545 enum AVColorPrimaries color_primaries;
2546
2547 /**
2548 * Color Transfer Characteristic.
2549 * - encoding: Set by user
2550 * - decoding: Set by libavcodec
2551 */
2552 enum AVColorTransferCharacteristic color_trc;
2553
2554 /**
2555 * YUV colorspace type.
2556 * - encoding: Set by user
2557 * - decoding: Set by libavcodec
2558 */
2559 enum AVColorSpace colorspace;
2560
2561 /**
2562 * MPEG vs JPEG YUV range.
2563 * - encoding: Set by user
2564 * - decoding: Set by libavcodec
2565 */
2566 enum AVColorRange color_range;
580a7465
DC
2567
2568 /**
2569 * This defines the location of chroma samples.
2570 * - encoding: Set by user
2571 * - decoding: Set by libavcodec
2572 */
8ea08bec 2573 enum AVChromaLocation chroma_sample_location;
8d23a86f
RD
2574
2575 /**
2576 * The codec may call this to execute several independent things.
2577 * It will return only after finishing all tasks.
2578 * The user may replace this with some multithreaded implementation,
2579 * the default implementation will execute the parts serially.
2580 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2581 * @param c context passed also to func
2582 * @param count the number of things to execute
2583 * @param arg2 argument passed unchanged to func
2584 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2585 * @param func function that will be called count times, with jobnr from 0 to count-1.
2586 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2587 * two instances of func executing at the same time will have the same threadnr.
2588 * @return always 0 currently, but code should handle a future improvement where when any call to func
2589 * returns < 0 no further calls to func may be done and < 0 is returned.
2590 * - encoding: Set by libavcodec, user can override.
2591 * - decoding: Set by libavcodec, user can override.
2592 */
2593 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
096c87f6
JGG
2594
2595 /**
2596 * explicit P-frame weighted prediction analysis method
2597 * 0: off
2598 * 1: fast blind weighting (one reference duplicate with -1 offset)
2599 * 2: smart weighting (full fade detection analysis)
2600 * - encoding: Set by user.
2601 * - decoding: unused
2602 */
2603 int weighted_p_pred;
f3b3b489
BC
2604
2605 /**
2606 * AQ mode
2607 * 0: Disabled
2608 * 1: Variance AQ (complexity mask)
2609 * 2: Auto-variance AQ (experimental)
2610 * - encoding: Set by user
2611 * - decoding: unused
2612 */
2613 int aq_mode;
2614
2615 /**
2616 * AQ strength
2617 * Reduces blocking and blurring in flat and textured areas.
2618 * - encoding: Set by user
2619 * - decoding: unused
2620 */
2621 float aq_strength;
2622
2623 /**
2624 * PSY RD
2625 * Strength of psychovisual optimization
2626 * - encoding: Set by user
2627 * - decoding: unused
2628 */
2629 float psy_rd;
2630
2631 /**
2632 * PSY trellis
2633 * Strength of psychovisual optimization
2634 * - encoding: Set by user
2635 * - decoding: unused
2636 */
2637 float psy_trellis;
2638
2639 /**
2640 * RC lookahead
2641 * Number of frames for frametype and ratecontrol lookahead
2642 * - encoding: Set by user
2643 * - decoding: unused
2644 */
2645 int rc_lookahead;
de6d9b64
FB
2646} AVCodecContext;
2647
64863965
MN
2648/**
2649 * AVCodec.
2650 */
de6d9b64 2651typedef struct AVCodec {
6b0cdb6e
NG
2652 /**
2653 * Name of the codec implementation.
2654 * The name is globally unique among encoders and among decoders (but an
2655 * encoder and a decoder can share the same name).
2656 * This is the primary way to find a codec from the user perspective.
2657 */
18f77016 2658 const char *name;
5d234974 2659 enum CodecType type;
9297ddd3 2660 enum CodecID id;
de6d9b64
FB
2661 int priv_data_size;
2662 int (*init)(AVCodecContext *);
0c1a9eda 2663 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 2664 int (*close)(AVCodecContext *);
7a00bbad 2665 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
a2d11246
MN
2666 /**
2667 * Codec capabilities.
2668 * see CODEC_CAP_*
2669 */
bf89e6b1 2670 int capabilities;
de6d9b64 2671 struct AVCodec *next;
c8cf325a
MN
2672 /**
2673 * Flush buffers.
2674 * Will be called when seeking
2675 */
7a06ff14 2676 void (*flush)(AVCodecContext *);
716e31ea 2677 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
1beb670a 2678 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
fe4bf374 2679 /**
bf7e799c
SS
2680 * Descriptive name for the codec, meant to be more human readable than name.
2681 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
fe4bf374
SS
2682 */
2683 const char *long_name;
3ade5d56 2684 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
88a07af7 2685 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
0d72e7d0 2686 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
de6d9b64
FB
2687} AVCodec;
2688
97d96aaa 2689/**
40e5d31b
GB
2690 * AVHWAccel.
2691 */
2692typedef struct AVHWAccel {
2693 /**
2694 * Name of the hardware accelerated codec.
2695 * The name is globally unique among encoders and among decoders (but an
2696 * encoder and a decoder can share the same name).
2697 */
2698 const char *name;
2699
2700 /**
2701 * Type of codec implemented by the hardware accelerator.
2702 *
2703 * See CODEC_TYPE_xxx
2704 */
2705 enum CodecType type;
2706
2707 /**
2708 * Codec implemented by the hardware accelerator.
2709 *
2710 * See CODEC_ID_xxx
2711 */
2712 enum CodecID id;
2713
2714 /**
2715 * Supported pixel format.
2716 *
2717 * Only hardware accelerated formats are supported here.
2718 */
2719 enum PixelFormat pix_fmt;
2720
2721 /**
2722 * Hardware accelerated codec capabilities.
2723 * see FF_HWACCEL_CODEC_CAP_*
2724 */
2725 int capabilities;
2726
2727 struct AVHWAccel *next;
2728
2729 /**
2730 * Called at the beginning of each frame or field picture.
2731 *
2732 * Meaningful frame information (codec specific) is guaranteed to
2733 * be parsed at this point. This function is mandatory.
2734 *
bf7e799c 2735 * Note that buf can be NULL along with buf_size set to 0.
40e5d31b
GB
2736 * Otherwise, this means the whole frame is available at this point.
2737 *
2738 * @param avctx the codec context
2739 * @param buf the frame data buffer base
2740 * @param buf_size the size of the frame in bytes
2741 * @return zero if successful, a negative value otherwise
2742 */
2743 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2744
2745 /**
2746 * Callback for each slice.
2747 *
2748 * Meaningful slice information (codec specific) is guaranteed to
2749 * be parsed at this point. This function is mandatory.
2750 *
2751 * @param avctx the codec context
2752 * @param buf the slice data buffer base
2753 * @param buf_size the size of the slice in bytes
2754 * @return zero if successful, a negative value otherwise
2755 */
2756 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2757
2758 /**
2759 * Called at the end of each frame or field picture.
2760 *
2761 * The whole picture is parsed at this point and can now be sent
2762 * to the hardware accelerator. This function is mandatory.
2763 *
2764 * @param avctx the codec context
2765 * @return zero if successful, a negative value otherwise
2766 */
2767 int (*end_frame)(AVCodecContext *avctx);
68e5d523
GB
2768
2769 /**
2770 * Size of HW accelerator private data.
2771 *
cd823ff9
GB
2772 * Private data is allocated with av_mallocz() before
2773 * AVCodecContext.get_buffer() and deallocated after
2774 * AVCodecContext.release_buffer().
68e5d523
GB
2775 */
2776 int priv_data_size;
40e5d31b
GB
2777} AVHWAccel;
2778
2779/**
d7425f59
MN
2780 * four components are given, that's all.
2781 * the last component is alpha
2782 */
de6d9b64 2783typedef struct AVPicture {
0c1a9eda 2784 uint8_t *data[4];
cd394651 2785 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
2786} AVPicture;
2787
2bbd8571 2788#if LIBAVCODEC_VERSION_MAJOR < 53
ba118447 2789/**
85947156
VS
2790 * AVPaletteControl
2791 * This structure defines a method for communicating palette changes
2792 * between and demuxer and a decoder.
2793 *
671adb17 2794 * @deprecated Use AVPacket to send palette changes instead.
85947156 2795 * This is totally broken.
ba118447 2796 */
2e99641b 2797#define AVPALETTE_SIZE 1024
432d84c3 2798#define AVPALETTE_COUNT 256
ba118447
MM
2799typedef struct AVPaletteControl {
2800
f5bccd85
DB
2801 /* Demuxer sets this to 1 to indicate the palette has changed;
2802 * decoder resets to 0. */
ba118447
MM
2803 int palette_changed;
2804
2a2bbcb0
MM
2805 /* 4-byte ARGB palette entries, stored in native byte order; note that
2806 * the individual palette components should be on a 8-bit scale; if
f5bccd85
DB
2807 * the palette data comes from an IBM VGA native format, the component
2808 * data is probably 6 bits in size and needs to be scaled. */
2e99641b 2809 unsigned int palette[AVPALETTE_COUNT];
ba118447 2810
18239edf 2811} AVPaletteControl attribute_deprecated;
2bbd8571 2812#endif
ba118447 2813
c66216ed
MN
2814enum AVSubtitleType {
2815 SUBTITLE_NONE,
2816
2817 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2818
2819 /**
2820 * Plain text, the text field must be set by the decoder and is
2821 * authoritative. ass and pict fields may contain approximations.
2822 */
2823 SUBTITLE_TEXT,
2824
2825 /**
2826 * Formatted text, the ass field must be set by the decoder and is
2827 * authoritative. pict and text fields may contain approximations.
2828 */
2829 SUBTITLE_ASS,
2830};
2831
c6ec28b1 2832typedef struct AVSubtitleRect {
ebc466bb
MN
2833 int x; ///< top left corner of pict, undefined when pict is not set
2834 int y; ///< top left corner of pict, undefined when pict is not set
2835 int w; ///< width of pict, undefined when pict is not set
2836 int h; ///< height of pict, undefined when pict is not set
2837 int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651
MN
2838
2839 /**
2840 * data+linesize for the bitmap of this subtitle.
2841 * can be set for text/ass as well once they where rendered
2842 */
2843 AVPicture pict;
f656106f
MN
2844 enum AVSubtitleType type;
2845
2846 char *text; ///< 0 terminated plain UTF-8 text
2847
2848 /**
2849 * 0 terminated ASS/SSA compatible event line.
2850 * The pressentation of this is unaffected by the other values in this
2851 * struct.
2852 */
2853 char *ass;
c6ec28b1
MN
2854} AVSubtitleRect;
2855
2856typedef struct AVSubtitle {
2857 uint16_t format; /* 0 = graphics */
2858 uint32_t start_display_time; /* relative to packet pts, in ms */
2859 uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb 2860 unsigned num_rects;
db4fac64 2861 AVSubtitleRect **rects;
4bbe788a 2862 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
240c1657
FB
2863} AVSubtitle;
2864
cdd8930e
TB
2865/* packet functions */
2866
80d403fc
RD
2867/**
2868 * @deprecated use NULL instead
2869 */
2870attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
cdd8930e
TB
2871
2872/**
2873 * Default packet destructor.
2874 */
2875void av_destruct_packet(AVPacket *pkt);
2876
2877/**
2878 * Initialize optional fields of a packet with default values.
2879 *
2880 * @param pkt packet
2881 */
2882void av_init_packet(AVPacket *pkt);
2883
2884/**
2885 * Allocate the payload of a packet and initialize its fields with
2886 * default values.
2887 *
2888 * @param pkt packet
2889 * @param size wanted payload size
2890 * @return 0 if OK, AVERROR_xxx otherwise
2891 */
2892int av_new_packet(AVPacket *pkt, int size);
2893
2894/**
feb993e5
RD
2895 * Reduce packet size, correctly zeroing padding
2896 *
2897 * @param pkt packet
2898 * @param size new size
2899 */
2900void av_shrink_packet(AVPacket *pkt, int size);
2901
2902/**
cdd8930e
TB
2903 * @warning This is a hack - the packet memory allocation stuff is broken. The
2904 * packet is allocated if it was not really allocated.
2905 */
2906int av_dup_packet(AVPacket *pkt);
2907
2908/**
2909 * Free a packet.
2910 *
2911 * @param pkt packet to free
2912 */
ce1d9c85 2913void av_free_packet(AVPacket *pkt);
240c1657 2914
de6d9b64
FB
2915/* resample.c */
2916
2917struct ReSampleContext;
aaaf1635 2918struct AVResampleContext;
de6d9b64
FB
2919
2920typedef struct ReSampleContext ReSampleContext;
2921
d1e3c6fd
BC
2922#if LIBAVCODEC_VERSION_MAJOR < 53
2923/**
2924 * @deprecated Use av_audio_resample_init() instead.
2925 */
2926attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2927 int output_rate, int input_rate);
2928#endif
2929/**
2930 * Initializes audio resampling context
2931 *
2932 * @param output_channels number of output channels
2933 * @param input_channels number of input channels
2934 * @param output_rate output sample rate
2935 * @param input_rate input sample rate
2936 * @param sample_fmt_out requested output sample format
2937 * @param sample_fmt_in input sample format
2938 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2939 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2940 * @param linear If 1 then the used FIR filter will be linearly interpolated
2941 between the 2 closest, if 0 the closest will be used
2942 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2943 * @return allocated ReSampleContext, NULL if error occured
2944 */
2945ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2946 int output_rate, int input_rate,
2947 enum SampleFormat sample_fmt_out,
2948 enum SampleFormat sample_fmt_in,
2949 int filter_length, int log2_phase_count,
2950 int linear, double cutoff);
2951
de6d9b64
FB
2952int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2953void audio_resample_close(ReSampleContext *s);
2954
3136fcf4
MN
2955
2956/**
2957 * Initializes an audio resampler.
2958 * Note, if either rate is not an integer then simply scale both rates up so they are.
990058bd
MN
2959 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2960 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2961 * @param linear If 1 then the used FIR filter will be linearly interpolated
2962 between the 2 closest, if 0 the closest will be used
2963 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3136fcf4 2964 */
6e225de2 2965struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3136fcf4
MN
2966
2967/**
2968 * resamples.
2969 * @param src an array of unconsumed samples
2970 * @param consumed the number of samples of src which have been consumed are returned here
2971 * @param src_size the number of unconsumed samples available
2972 * @param dst_size the amount of space in samples available in dst
2973 * @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.
2974 * @return the number of samples written in dst or -1 if an error occurred
2975 */
aaaf1635 2976int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3136fcf4
MN
2977
2978
2979/**
2980 * Compensates samplerate/timestamp drift. The compensation is done by changing
2981 * the resampler parameters, so no audible clicks or similar distortions occur
2982 * @param compensation_distance distance in output samples over which the compensation should be performed
2983 * @param sample_delta number of output samples which should be output less
2984 *
2985 * example: av_resample_compensate(c, 10, 500)
2986 * here instead of 510 samples only 500 samples would be output
2987 *
2988 * note, due to rounding the actual compensation might be slightly different,
2989 * especially if the compensation_distance is large and the in_rate used during init is small
2990 */
2d48eddd 2991void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
d88443ae 2992void av_resample_close(struct AVResampleContext *c);
aaaf1635 2993
75917b88
DH
2994/**
2995 * Allocate memory for a picture. Call avpicture_free to free it.
2996 *
f5bccd85
DB
2997 * @param picture the picture to be filled in
2998 * @param pix_fmt the format of the picture
2999 * @param width the width of the picture
3000 * @param height the height of the picture
3001 * @return zero if successful, a negative value if not
75917b88 3002 */
a61ec8e7 3003int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
75917b88 3004
8fc3d25c
PI
3005/**
3006 * Free a picture previously allocated by avpicture_alloc().
3007 *
f5bccd85 3008 * @param picture the AVPicture to be freed
8fc3d25c 3009 */
75917b88
DH
3010void avpicture_free(AVPicture *picture);
3011
392cf77a 3012/**
f5bccd85 3013 * Fill in the AVPicture fields.
392cf77a
PI
3014 * The fields of the given AVPicture are filled in by using the 'ptr' address
3015 * which points to the image data buffer. Depending on the specified picture
3016 * format, one or multiple image data pointers and line sizes will be set.
3017 * If a planar format is specified, several pointers will be set pointing to
3018 * the different picture planes and the line sizes of the different planes
3019 * will be stored in the lines_sizes array.
899a8fa1 3020 * Call with ptr == NULL to get the required size for the ptr buffer.
392cf77a 3021 *
f5bccd85 3022 * @param picture AVPicture whose fields are to be filled in
392cf77a 3023 * @param ptr Buffer which will contain or contains the actual image data
f5bccd85
DB
3024 * @param pix_fmt The format in which the picture data is stored.
3025 * @param width the width of the image in pixels
3026 * @param height the height of the image in pixels
3027 * @return size of the image data in bytes
392cf77a 3028 */
0c1a9eda 3029int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4a30fff6 3030 enum PixelFormat pix_fmt, int width, int height);
a61ec8e7 3031int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
63167088 3032 unsigned char *dest, int dest_size);
392cf77a
PI
3033
3034/**
3035 * Calculate the size in bytes that a picture of the given width and height
3036 * would occupy if stored in the given picture format.
899a8fa1
RD
3037 * Note that this returns the size of a compact representation as generated
3038 * by avpicture_layout, which can be smaller than the size required for e.g.
3039 * avpicture_fill.
392cf77a 3040 *
f5bccd85
DB
3041 * @param pix_fmt the given picture format
3042 * @param width the width of the image
3043 * @param height the height of the image
899a8fa1 3044 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
392cf77a 3045 */
a61ec8e7
SS
3046int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3047void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3048const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
21adafec 3049void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
d89f692f 3050
80a07f6e 3051#if LIBAVCODEC_VERSION_MAJOR < 53
d89f692f 3052/**
bf7e799c 3053 * Returns the pixel format corresponding to the name name.
d89f692f 3054 *
bf7e799c 3055 * If there is no pixel format with name name, then looks for a
d89f692f 3056 * pixel format with the name corresponding to the native endian
bf7e799c 3057 * format of name.
d89f692f
SS
3058 * For example in a little-endian system, first looks for "gray16",
3059 * then for "gray16le".
3060 *
bf7e799c 3061 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
80a07f6e
SS
3062 *
3063 * @deprecated Deprecated in favor of av_get_pix_fmt().
d89f692f 3064 */
80a07f6e
SS
3065attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3066#endif
fa4dc9f0
SS
3067
3068/**
3069 * Returns a value representing the fourCC code associated to the
3070 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3071 * found.
3072 */
3073unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
219b06c6 3074
81299d42
PI
3075#define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3076#define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3077#define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3078#define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3079#define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3080#define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
fab21997 3081
392cf77a 3082/**
81299d42
PI
3083 * Computes what kind of losses will occur when converting from one specific
3084 * pixel format to another.
3085 * When converting from one pixel format to another, information loss may occur.
3086 * For example, when converting from RGB24 to GRAY, the color information will
3087 * be lost. Similarly, other losses occur when converting from some formats to
3088 * other formats. These losses can involve loss of chroma, but also loss of
3089 * resolution, loss of color depth, loss due to the color space conversion, loss
3090 * of the alpha bits or loss due to color quantization.
f5bccd85
DB
3091 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3092 * which will occur when converting from one pixel format to another.
81299d42 3093 *
f5bccd85
DB
3094 * @param[in] dst_pix_fmt destination pixel format
3095 * @param[in] src_pix_fmt source pixel format
81299d42
PI
3096 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3097 * @return Combination of flags informing you what kind of losses will occur.
392cf77a 3098 */
a61ec8e7 3099int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
fab21997 3100 int has_alpha);
392cf77a
PI
3101
3102/**
81299d42
PI
3103 * Finds the best pixel format to convert to given a certain source pixel
3104 * format. When converting from one pixel format to another, information loss
3105 * may occur. For example, when converting from RGB24 to GRAY, the color
3106 * information will be lost. Similarly, other losses occur when converting from
3107 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
f5bccd85
DB
3108 * the given pixel formats should be used to suffer the least amount of loss.
3109 * The pixel formats from which it chooses one, are determined by the
bf7e799c 3110 * pix_fmt_mask parameter.
81299d42
PI
3111 *
3112 * @code
3113 * src_pix_fmt = PIX_FMT_YUV420P;
3114 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3115 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3116 * @endcode
3117 *
f5bccd85
DB
3118 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3119 * @param[in] src_pix_fmt source pixel format
81299d42
PI
3120 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3121 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3122 * @return The best pixel format to convert to or -1 if none was found.
392cf77a 3123 */
a61ec8e7 3124enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
fab21997
FB
3125 int has_alpha, int *loss_ptr);
3126
c3b95b1d
SS
3127
3128/**
3129 * Print in buf the string corresponding to the pixel format with
3130 * number pix_fmt, or an header if pix_fmt is negative.
3131 *
9bd51b9a
PI
3132 * @param[in] buf the buffer where to write the string
3133 * @param[in] buf_size the size of buf
3134 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
c3b95b1d
SS
3135 * a negative value to print the corresponding header.
3136 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3137 */
a61ec8e7 3138void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
c3b95b1d 3139
0469baf1
FB
3140#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3141#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
392cf77a
PI
3142
3143/**
3144 * Tell if an image really has transparent alpha values.
3145 * @return ored mask of FF_ALPHA_xxx constants