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