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