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