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