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