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