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