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