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