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