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