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