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