Replace more FFmpeg instances by Libav or ffmpeg.
[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
94f7451a
RB
679/**
680 * Codec supports slice-based (or partition-based) multithreading.
681 */
682#define CODEC_CAP_SLICE_THREADS 0x2000
bf89e6b1 683
f5bccd85 684//The following defines may change, don't expect compatibility if you use them.
8d7ec294 685#define MB_TYPE_INTRA4x4 0x0001
f5bccd85
DB
686#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
687#define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
8d7ec294
WH
688#define MB_TYPE_16x16 0x0008
689#define MB_TYPE_16x8 0x0010
690#define MB_TYPE_8x16 0x0020
691#define MB_TYPE_8x8 0x0040
692#define MB_TYPE_INTERLACED 0x0080
273b0cd3 693#define MB_TYPE_DIRECT2 0x0100 //FIXME
8d7ec294
WH
694#define MB_TYPE_ACPRED 0x0200
695#define MB_TYPE_GMC 0x0400
696#define MB_TYPE_SKIP 0x0800
697#define MB_TYPE_P0L0 0x1000
698#define MB_TYPE_P1L0 0x2000
699#define MB_TYPE_P0L1 0x4000
700#define MB_TYPE_P1L1 0x8000
701#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
702#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
703#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
704#define MB_TYPE_QUANT 0x00010000
705#define MB_TYPE_CBP 0x00020000
706//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
707
fa384dcc
MN
708/**
709 * Pan Scan area.
f5bccd85
DB
710 * This specifies the area which should be displayed.
711 * Note there may be multiple such areas for one frame.
fa384dcc
MN
712 */
713typedef struct AVPanScan{
714 /**
f5bccd85
DB
715 * id
716 * - encoding: Set by user.
717 * - decoding: Set by libavcodec.
fa384dcc
MN
718 */
719 int id;
720
721 /**
722 * width and height in 1/16 pel
f5bccd85
DB
723 * - encoding: Set by user.
724 * - decoding: Set by libavcodec.
fa384dcc
MN
725 */
726 int width;
727 int height;
728
729 /**
f5bccd85
DB
730 * position of the top left corner in 1/16 pel for up to 3 fields/frames
731 * - encoding: Set by user.
732 * - decoding: Set by libavcodec.
fa384dcc
MN
733 */
734 int16_t position[3][2];
735}AVPanScan;
736
492cd3a9 737#define FF_COMMON_FRAME \
b536d0aa
MN
738 /**\
739 * pointer to the picture planes.\
f5bccd85 740 * This might be different from the first allocated byte\
b536d0aa
MN
741 * - encoding: \
742 * - decoding: \
743 */\
1e491e29
MN
744 uint8_t *data[4];\
745 int linesize[4];\
746 /**\
f5bccd85
DB
747 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
748 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
64863965
MN
749 * - encoding: \
750 * - decoding: \
1e491e29
MN
751 */\
752 uint8_t *base[4];\
753 /**\
754 * 1 -> keyframe, 0-> not\
f5bccd85
DB
755 * - encoding: Set by libavcodec.\
756 * - decoding: Set by libavcodec.\
1e491e29
MN
757 */\
758 int key_frame;\
759\
760 /**\
f5bccd85
DB
761 * Picture type of the frame, see ?_TYPE below.\
762 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
763 * - decoding: Set by libavcodec.\
1e491e29
MN
764 */\
765 int pict_type;\
766\
767 /**\
c0df9d75 768 * presentation timestamp in time_base units (time when frame should be shown to user)\
f5bccd85
DB
769 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
770 * - encoding: MUST be set by user.\
771 * - decoding: Set by libavcodec.\
1e491e29 772 */\
be6784dc 773 int64_t pts;\
1e491e29
MN
774\
775 /**\
f5bccd85 776 * picture number in bitstream order\
64863965 777 * - encoding: set by\
f5bccd85 778 * - decoding: Set by libavcodec.\
1e491e29
MN
779 */\
780 int coded_picture_number;\
781 /**\
f5bccd85 782 * picture number in display order\
64863965 783 * - encoding: set by\
f5bccd85 784 * - decoding: Set by libavcodec.\
1e491e29
MN
785 */\
786 int display_picture_number;\
787\
788 /**\
158c7f05 789 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
f5bccd85
DB
790 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
791 * - decoding: Set by libavcodec.\
1e491e29 792 */\
158c7f05 793 int quality; \
1e491e29
MN
794\
795 /**\
796 * buffer age (1->was last buffer and dint change, 2->..., ...).\
f5bccd85 797 * Set to INT_MAX if the buffer has not been used yet.\
64863965 798 * - encoding: unused\
f5bccd85 799 * - decoding: MUST be set by get_buffer().\
1e491e29
MN
800 */\
801 int age;\
802\
803 /**\
804 * is this picture used as reference\
8474f58e
MN
805 * The values for this are the same as the MpegEncContext.picture_structure\
806 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
5fe2a515 807 * Set to 4 for delayed, non-reference frames.\
64863965 808 * - encoding: unused\
f5bccd85 809 * - decoding: Set by libavcodec. (before get_buffer() call)).\
1e491e29
MN
810 */\
811 int reference;\
812\
813 /**\
814 * QP table\
64863965 815 * - encoding: unused\
f5bccd85 816 * - decoding: Set by libavcodec.\
1e491e29
MN
817 */\
818 int8_t *qscale_table;\
819 /**\
820 * QP store stride\
64863965 821 * - encoding: unused\
f5bccd85 822 * - decoding: Set by libavcodec.\
1e491e29
MN
823 */\
824 int qstride;\
825\
826 /**\
f5bccd85 827 * mbskip_table[mb]>=1 if MB didn't change\
1e491e29 828 * stride= mb_width = (width+15)>>4\
64863965 829 * - encoding: unused\
f5bccd85 830 * - decoding: Set by libavcodec.\
1e491e29
MN
831 */\
832 uint8_t *mbskip_table;\
833\
834 /**\
f5bccd85 835 * motion vector table\
61436073
MN
836 * @code\
837 * example:\
838 * int mv_sample_log2= 4 - motion_subsample_log2;\
839 * int mb_width= (width+15)>>4;\
840 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
841 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
842 * @endcode\
f5bccd85
DB
843 * - encoding: Set by user.\
844 * - decoding: Set by libavcodec.\
8d7ec294
WH
845 */\
846 int16_t (*motion_val[2])[2];\
847\
848 /**\
f5bccd85 849 * macroblock type table\
8d7ec294 850 * mb_type_base + mb_width + 2\
f5bccd85
DB
851 * - encoding: Set by user.\
852 * - decoding: Set by libavcodec.\
8d7ec294
WH
853 */\
854 uint32_t *mb_type;\
855\
856 /**\
f0b77c69
MN
857 * log2 of the size of the block which a single vector in motion_val represents: \
858 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
8d7ec294 859 * - encoding: unused\
f5bccd85 860 * - decoding: Set by libavcodec.\
8d7ec294
WH
861 */\
862 uint8_t motion_subsample_log2;\
863\
864 /**\
1e491e29 865 * for some private data of the user\
64863965 866 * - encoding: unused\
f5bccd85 867 * - decoding: Set by user.\
1e491e29
MN
868 */\
869 void *opaque;\
140cb663
MN
870\
871 /**\
872 * error\
f5bccd85 873 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
64863965 874 * - decoding: unused\
140cb663
MN
875 */\
876 uint64_t error[4];\
4e00e76b
MN
877\
878 /**\
f5bccd85
DB
879 * type of the buffer (to keep track of who has to deallocate data[*])\
880 * - encoding: Set by the one who allocates it.\
881 * - decoding: Set by the one who allocates it.\
882 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
4e00e76b
MN
883 */\
884 int type;\
2ec23b6d
MN
885 \
886 /**\
f5bccd85 887 * When decoding, this signals how much the picture must be delayed.\
2ec23b6d 888 * extra_delay = repeat_pict / (2*fps)\
64863965 889 * - encoding: unused\
f5bccd85 890 * - decoding: Set by libavcodec.\
2ec23b6d 891 */\
0426af31
MN
892 int repeat_pict;\
893 \
894 /**\
895 * \
896 */\
897 int qscale_type;\
2744ca9a
RS
898 \
899 /**\
900 * The content of the picture is interlaced.\
f5bccd85
DB
901 * - encoding: Set by user.\
902 * - decoding: Set by libavcodec. (default 0)\
2744ca9a
RS
903 */\
904 int interlaced_frame;\
905 \
906 /**\
f5bccd85
DB
907 * If the content is interlaced, is top field displayed first.\
908 * - encoding: Set by user.\
909 * - decoding: Set by libavcodec.\
2744ca9a 910 */\
9dad924e 911 int top_field_first;\
fa384dcc
MN
912 \
913 /**\
914 * Pan scan.\
f5bccd85
DB
915 * - encoding: Set by user.\
916 * - decoding: Set by libavcodec.\
fa384dcc
MN
917 */\
918 AVPanScan *pan_scan;\
2a2bbcb0
MM
919 \
920 /**\
f5bccd85 921 * Tell user application that palette has changed from previous frame.\
2a2bbcb0 922 * - encoding: ??? (no palette-enabled encoder yet)\
f5bccd85 923 * - decoding: Set by libavcodec. (default 0).\
2a2bbcb0
MM
924 */\
925 int palette_has_changed;\
074c4ca7
RT
926 \
927 /**\
f5bccd85 928 * codec suggestion on buffer type if != 0\
074c4ca7 929 * - encoding: unused\
f5bccd85 930 * - decoding: Set by libavcodec. (before get_buffer() call)).\
074c4ca7
RT
931 */\
932 int buffer_hints;\
8289c6fa
WH
933\
934 /**\
f5bccd85 935 * DCT coefficients\
8289c6fa 936 * - encoding: unused\
f5bccd85 937 * - decoding: Set by libavcodec.\
8289c6fa
WH
938 */\
939 short *dct_coeff;\
a4d36c11
MN
940\
941 /**\
58184187
BF
942 * motion reference frame index\
943 * the order in which these are stored can depend on the codec.\
f5bccd85
DB
944 * - encoding: Set by user.\
945 * - decoding: Set by libavcodec.\
a4d36c11 946 */\
79de84f2
MN
947 int8_t *ref_index[2];\
948\
949 /**\
421167b0 950 * reordered opaque 64bit (generally an integer or a double precision float\
e75229fa
MN
951 * PTS but can be anything). \
952 * The user sets AVCodecContext.reordered_opaque to represent the input at\
421167b0
SS
953 * that time,\
954 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
e75229fa 955 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
81c623fa 956 * @deprecated in favor of pkt_pts\
79de84f2
MN
957 * - encoding: unused\
958 * - decoding: Read by user.\
959 */\
960 int64_t reordered_opaque;\
68e5d523
GB
961\
962 /**\
43fb279f 963 * hardware accelerator private data (Libav-allocated)\
68e5d523
GB
964 * - encoding: unused\
965 * - decoding: Set by libavcodec\
966 */\
952e2083 967 void *hwaccel_picture_private;\
393cbb96
MN
968\
969 /**\
970 * reordered pts from the last AVPacket that has been input into the decoder\
971 * - encoding: unused\
972 * - decoding: Read by user.\
973 */\
974 int64_t pkt_pts;\
1919feaf
MN
975\
976 /**\
977 * dts from the last AVPacket that has been input into the decoder\
978 * - encoding: unused\
979 * - decoding: Read by user.\
980 */\
981 int64_t pkt_dts;\
37b00b47
AS
982\
983 /**\
984 * the AVCodecContext which ff_thread_get_buffer() was last called on\
985 * - encoding: Set by libavcodec.\
986 * - decoding: Set by libavcodec.\
987 */\
988 struct AVCodecContext *owner;\
989\
990 /**\
991 * used by multithreading to store frame-specific info\
992 * - encoding: Set by libavcodec.\
993 * - decoding: Set by libavcodec.\
994 */\
2a03e873 995 void *thread_opaque;\
2ec23b6d 996
bb270c08
DB
997#define FF_QSCALE_TYPE_MPEG1 0
998#define FF_QSCALE_TYPE_MPEG2 1
999#define FF_QSCALE_TYPE_H264 2
800274f8 1000#define FF_QSCALE_TYPE_VP56 3
4e00e76b
MN
1001
1002#define FF_BUFFER_TYPE_INTERNAL 1
f5bccd85
DB
1003#define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1004#define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1005#define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
4e00e76b 1006
1e491e29 1007
dc85e859
AJ
1008#define FF_I_TYPE 1 ///< Intra
1009#define FF_P_TYPE 2 ///< Predicted
1010#define FF_B_TYPE 3 ///< Bi-dir predicted
1011#define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
1012#define FF_SI_TYPE 5 ///< Switching Intra
1013#define FF_SP_TYPE 6 ///< Switching Predicted
48d533e6 1014#define FF_BI_TYPE 7
1e491e29 1015
f5bccd85
DB
1016#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1017#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1018#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1019#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
074c4ca7 1020
4de339e2
KS
1021enum AVPacketSideDataType {
1022 AV_PKT_DATA_PALETTE,
1023};
1024
18c915ee
TB
1025typedef struct AVPacket {
1026 /**
7b356d39
RS
1027 * Presentation timestamp in AVStream->time_base units; the time at which
1028 * the decompressed packet will be presented to the user.
18c915ee
TB
1029 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1030 * pts MUST be larger or equal to dts as presentation cannot happen before
1031 * decompression, unless one wants to view hex dumps. Some formats misuse
1032 * the terms dts and pts/cts to mean something different. Such timestamps
1033 * must be converted to true pts/dts before they are stored in AVPacket.
1034 */
1035 int64_t pts;
1036 /**
7b356d39
RS
1037 * Decompression timestamp in AVStream->time_base units; the time at which
1038 * the packet is decompressed.
18c915ee
TB
1039 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1040 */
1041 int64_t dts;
1042 uint8_t *data;
1043 int size;
1044 int stream_index;
1045 int flags;
1046 /**
4de339e2
KS
1047 * Additional packet data that can be provided by the container.
1048 * Packet can contain several types of side information.
1049 */
1050 struct {
1051 uint8_t *data;
1052 int size;
1053 enum AVPacketSideDataType type;
1054 } *side_data;
1055 int side_data_elems;
1056
1057 /**
7b356d39 1058 * Duration of this packet in AVStream->time_base units, 0 if unknown.
18c915ee
TB
1059 * Equals next_pts - this_pts in presentation order.
1060 */
1061 int duration;
1062 void (*destruct)(struct AVPacket *);
1063 void *priv;
1064 int64_t pos; ///< byte position in stream, -1 if unknown
1065
1066 /**
7b356d39 1067 * Time difference in AVStream->time_base units from the pts of this
18c915ee
TB
1068 * packet to the point at which the output from the decoder has converged
1069 * independent from the availability of previous frames. That is, the
1070 * frames are virtually identical no matter if decoding started from
1071 * the very first frame or from this keyframe.
1072 * Is AV_NOPTS_VALUE if unknown.
1073 * This field is not the display duration of the current packet.
8ee82f40
AJ
1074 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1075 * set.
18c915ee
TB
1076 *
1077 * The purpose of this field is to allow seeking in streams that have no
1078 * keyframes in the conventional sense. It corresponds to the
1079 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1080 * essential for some types of subtitle streams to ensure that all
1081 * subtitles are correctly displayed after seeking.
1082 */
1083 int64_t convergence_duration;
1084} AVPacket;
8f3f2e06 1085#define AV_PKT_FLAG_KEY 0x0001
18c915ee 1086
0da71265
MN
1087/**
1088 * Audio Video Frame.
ba66ae94
MN
1089 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1090 * bumps.
8bfb108b 1091 * Removal, reordering and changes to existing fields require a major
ba66ae94
MN
1092 * version bump. No fields should be added into AVFrame before or after
1093 * FF_COMMON_FRAME!
8bfb108b 1094 * sizeof(AVFrame) must not be used outside libav*.
0da71265 1095 */
492cd3a9
MN
1096typedef struct AVFrame {
1097 FF_COMMON_FRAME
1098} AVFrame;
1e491e29 1099
d33c949c 1100/**
252f17e2
MN
1101 * main external API structure.
1102 * New fields can be added to the end with minor version bumps.
8bfb108b 1103 * Removal, reordering and changes to existing fields require a major
252f17e2 1104 * version bump.
8bfb108b 1105 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 1106 */
de6d9b64 1107typedef struct AVCodecContext {
b71901e6 1108 /**
f5bccd85 1109 * information on struct for av_log
bc874dae
MB
1110 * - set by avcodec_alloc_context
1111 */
d42a814e 1112 const AVClass *av_class;
bc874dae 1113 /**
f5bccd85
DB
1114 * the average bitrate
1115 * - encoding: Set by user; unused for constant quantizer encoding.
1116 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 1117 */
de6d9b64 1118 int bit_rate;
b71901e6
MN
1119
1120 /**
64863965 1121 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 1122 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 1123 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 1124 * - decoding: unused
b71901e6 1125 */
115329f1 1126 int bit_rate_tolerance;
b71901e6
MN
1127
1128 /**
64863965 1129 * CODEC_FLAG_*.
f5bccd85
DB
1130 * - encoding: Set by user.
1131 * - decoding: Set by user.
b71901e6 1132 */
de6d9b64 1133 int flags;
b71901e6
MN
1134
1135 /**
f5bccd85
DB
1136 * Some codecs need additional format info. It is stored here.
1137 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1138 * specific codec MUST set it correctly otherwise stream copy breaks.
1139 * In general use of this field by muxers is not recommanded.
1140 * - encoding: Set by libavcodec.
1141 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
b71901e6
MN
1142 */
1143 int sub_id;
1144
1145 /**
f5bccd85 1146 * Motion estimation algorithm used for video coding.
58f7833e 1147 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
89223ef6 1148 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
64863965
MN
1149 * - encoding: MUST be set by user.
1150 * - decoding: unused
b71901e6
MN
1151 */
1152 int me_method;
1153
1154 /**
f5bccd85
DB
1155 * some codecs need / can use extradata like Huffman tables.
1156 * mjpeg: Huffman tables
b71901e6 1157 * rv10: additional flags
b704e742 1158 * mpeg4: global headers (they can be in the bitstream or here)
f5bccd85
DB
1159 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1160 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1161 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1162 * - encoding: Set/allocated/freed by libavcodec.
1163 * - decoding: Set/allocated/freed by user.
b71901e6 1164 */
58f2a4b0 1165 uint8_t *extradata;
e84c31dc 1166 int extradata_size;
115329f1 1167
b71901e6 1168 /**
f5bccd85
DB
1169 * This is the fundamental unit of time (in seconds) in terms
1170 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
1171 * timebase should be 1/framerate and timestamp increments should be
1172 * identically 1.
f5bccd85
DB
1173 * - encoding: MUST be set by user.
1174 * - decoding: Set by libavcodec.
b71901e6 1175 */
c0df9d75 1176 AVRational time_base;
115329f1 1177
5b28c8c3 1178 /* video only */
14bea432 1179 /**
21adafec 1180 * picture width / height.
115329f1 1181 * - encoding: MUST be set by user.
f5bccd85
DB
1182 * - decoding: Set by libavcodec.
1183 * Note: For compatibility it is possible to set this instead of
1184 * coded_width/height before decoding.
b71901e6 1185 */
de6d9b64 1186 int width, height;
115329f1 1187
e769f053 1188#define FF_ASPECT_EXTENDED 15
b71901e6
MN
1189
1190 /**
f5bccd85
DB
1191 * the number of pictures in a group of pictures, or 0 for intra_only
1192 * - encoding: Set by user.
64863965 1193 * - decoding: unused
b71901e6
MN
1194 */
1195 int gop_size;
1196
1197 /**
f5bccd85 1198 * Pixel format, see PIX_FMT_xxx.
c1bdc930
TH
1199 * May be set by the demuxer if known from headers.
1200 * May be overriden by the decoder if it knows better.
f5bccd85 1201 * - encoding: Set by user.
c1bdc930 1202 * - decoding: Set by user if known, overridden by libavcodec if known
b71901e6 1203 */
e4eadb4b 1204 enum PixelFormat pix_fmt;
115329f1 1205
ed5fcd60 1206#if FF_API_RATE_EMU
bdfcbbed 1207 /**
f5bccd85 1208 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
bdfcbbed 1209 * has to read frames at native frame rate.
f5bccd85
DB
1210 * - encoding: Set by user.
1211 * - decoding: unused
bdfcbbed 1212 */
ed5fcd60
AK
1213 attribute_deprecated int rate_emu;
1214#endif
115329f1 1215
b71901e6 1216 /**
f5bccd85
DB
1217 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1218 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 1219 * all codecs can do that. You must check the codec capabilities
f5bccd85 1220 * beforehand.
37b00b47
AS
1221 * When multithreading is used, it may be called from multiple threads
1222 * at the same time; threads might draw different parts of the same AVFrame,
1223 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1224 * in order.
24b1583a
IK
1225 * The function is also used by hardware acceleration APIs.
1226 * It is called at least once during frame decoding to pass
1227 * the data needed for hardware render.
1228 * In that mode instead of pixel data, AVFrame points to
1229 * a structure specific to the acceleration API. The application
1230 * reads the structure and can change some fields to indicate progress
1231 * or mark state.
64863965 1232 * - encoding: unused
f5bccd85 1233 * - decoding: Set by user.
3bb07d61
MN
1234 * @param height the height of the slice
1235 * @param y the y position of the slice
1236 * @param type 1->top field, 2->bottom field, 3->frame
1237 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 1238 */
bf89e6b1 1239 void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3 1240 const AVFrame *src, int offset[4],
3bb07d61 1241 int y, int type, int height);
bf89e6b1 1242
de6d9b64 1243 /* audio only */
f5bccd85 1244 int sample_rate; ///< samples per second
5fcc4a23 1245 int channels; ///< number of audio channels
a3a5f4d6
MN
1246
1247 /**
f5bccd85
DB
1248 * audio sample format
1249 * - encoding: Set by user.
1250 * - decoding: Set by libavcodec.
a3a5f4d6 1251 */
5d6e4c16 1252 enum AVSampleFormat sample_fmt; ///< sample format
de6d9b64 1253
f5bccd85 1254 /* The following data should not be initialized. */
718b27a7 1255 /**
f5bccd85 1256 * Samples per packet, initialized when calling 'init'.
718b27a7
MN
1257 */
1258 int frame_size;
115329f1 1259 int frame_number; ///< audio or video frame number
115329f1 1260
b71901e6 1261 /**
f5bccd85 1262 * Number of frames the decoded output will be delayed relative to
64863965 1263 * the encoded input.
f5bccd85 1264 * - encoding: Set by libavcodec.
64863965 1265 * - decoding: unused
b71901e6
MN
1266 */
1267 int delay;
115329f1 1268
64863965
MN
1269 /* - encoding parameters */
1270 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
115329f1
DB
1271 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1272
b71901e6 1273 /**
f5bccd85
DB
1274 * minimum quantizer
1275 * - encoding: Set by user.
64863965 1276 * - decoding: unused
b71901e6
MN
1277 */
1278 int qmin;
1279
1280 /**
f5bccd85
DB
1281 * maximum quantizer
1282 * - encoding: Set by user.
64863965 1283 * - decoding: unused
b71901e6
MN
1284 */
1285 int qmax;
1286
1287 /**
f5bccd85
DB
1288 * maximum quantizer difference between frames
1289 * - encoding: Set by user.
64863965 1290 * - decoding: unused
b71901e6
MN
1291 */
1292 int max_qdiff;
1293
1294 /**
f5bccd85
DB
1295 * maximum number of B-frames between non-B-frames
1296 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1297 * - encoding: Set by user.
64863965 1298 * - decoding: unused
b71901e6
MN
1299 */
1300 int max_b_frames;
1301
1302 /**
f5bccd85 1303 * qscale factor between IP and B-frames
662e5411 1304 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1305 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85 1306 * - encoding: Set by user.
64863965 1307 * - decoding: unused
b71901e6
MN
1308 */
1309 float b_quant_factor;
115329f1 1310
b71901e6
MN
1311 /** obsolete FIXME remove */
1312 int rc_strategy;
64b7c5b6
MN
1313#define FF_RC_STRATEGY_XVID 1
1314
8b4c7dbc 1315 int b_frame_strategy;
9dbcbd92 1316
8ed2ae09 1317#if FF_API_HURRY_UP
b71901e6 1318 /**
85947156
VS
1319 * hurry up amount
1320 * - encoding: unused
1321 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
f9ec0aa1 1322 * @deprecated Deprecated in favor of skip_idct and skip_frame.
b71901e6 1323 */
8ed2ae09
AK
1324 attribute_deprecated int hurry_up;
1325#endif
115329f1 1326
de6d9b64 1327 struct AVCodec *codec;
115329f1 1328
de6d9b64
FB
1329 void *priv_data;
1330
bb628dae 1331 int rtp_payload_size; /* The size of the RTP payload: the coder will */
f5bccd85 1332 /* do its best to deliver a chunk with size */
644d98a4 1333 /* below rtp_payload_size, the chunk will start */
f5bccd85 1334 /* with a start code on some codecs like H.263. */
644d98a4 1335 /* This doesn't take account of any particular */
f5bccd85 1336 /* headers inside the transmitted RTP payload. */
81401c1f 1337
115329f1 1338
f5bccd85
DB
1339 /* The RTP callback: This function is called */
1340 /* every time the encoder has a packet to send. */
1341 /* It depends on the encoder if the data starts */
1342 /* with a Start Code (it should). H.263 does. */
1343 /* mb_nb contains the number of macroblocks */
1344 /* encoded in the RTP payload. */
115329f1 1345 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
81401c1f 1346
098eefe1
MN
1347 /* statistics, used for 2-pass encoding */
1348 int mv_bits;
1349 int header_bits;
1350 int i_tex_bits;
1351 int p_tex_bits;
1352 int i_count;
1353 int p_count;
1354 int skip_count;
b71901e6 1355 int misc_bits;
115329f1 1356
b71901e6 1357 /**
f5bccd85
DB
1358 * number of bits used for the previously encoded frame
1359 * - encoding: Set by libavcodec.
7004ffb3 1360 * - decoding: unused
b71901e6 1361 */
098eefe1 1362 int frame_bits;
7004ffb3 1363
b71901e6 1364 /**
f5bccd85
DB
1365 * Private data of the user, can be used to carry app specific stuff.
1366 * - encoding: Set by user.
1367 * - decoding: Set by user.
b71901e6
MN
1368 */
1369 void *opaque;
1370
de6d9b64 1371 char codec_name[32];
72415b2a 1372 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
4a663d80 1373 enum CodecID codec_id; /* see CODEC_ID_xxx */
115329f1 1374
7004ffb3
MN
1375 /**
1376 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85
DB
1377 * This is used to work around some encoder bugs.
1378 * A demuxer should set this to what is stored in the field used to identify the codec.
1379 * If there are multiple such fields in a container then the demuxer should choose the one
1380 * which maximizes the information about the used codec.
1381 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1382 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
47bbf8a7 1383 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
f5bccd85
DB
1384 * first.
1385 * - encoding: Set by user, if not then the default based on codec_id will be used.
1386 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
7004ffb3
MN
1387 */
1388 unsigned int codec_tag;
115329f1 1389
b71901e6 1390 /**
f5bccd85
DB
1391 * Work around bugs in encoders which sometimes cannot be detected automatically.
1392 * - encoding: Set by user
1393 * - decoding: Set by user
b71901e6
MN
1394 */
1395 int workaround_bugs;
64863965 1396#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
1397#define FF_BUG_OLD_MSMPEG4 2
1398#define FF_BUG_XVID_ILACE 4
1399#define FF_BUG_UMP4 8
1400#define FF_BUG_NO_PADDING 16
3116cb14 1401#define FF_BUG_AMV 32
f5bccd85 1402#define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
03e93d35 1403#define FF_BUG_QPEL_CHROMA 64
db794953 1404#define FF_BUG_STD_QPEL 128
36df8805 1405#define FF_BUG_QPEL_CHROMA2 256
c40c3482 1406#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 1407#define FF_BUG_EDGE 1024
b44bdf7e 1408#define FF_BUG_HPEL_CHROMA 2048
4ccde216 1409#define FF_BUG_DC_CLIP 4096
f5bccd85 1410#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
3566042a 1411#define FF_BUG_TRUNCATED 16384
f5bccd85 1412//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
115329f1 1413
b71901e6 1414 /**
f5bccd85
DB
1415 * luma single coefficient elimination threshold
1416 * - encoding: Set by user.
64863965 1417 * - decoding: unused
b71901e6 1418 */
1f6b6e50 1419 int luma_elim_threshold;
115329f1 1420
b71901e6 1421 /**
f5bccd85
DB
1422 * chroma single coeff elimination threshold
1423 * - encoding: Set by user.
64863965 1424 * - decoding: unused
b71901e6 1425 */
1f6b6e50 1426 int chroma_elim_threshold;
115329f1 1427
b71901e6 1428 /**
f5bccd85
DB
1429 * strictly follow the standard (MPEG4, ...).
1430 * - encoding: Set by user.
5771b2c3
MN
1431 * - decoding: Set by user.
1432 * Setting this to STRICT or higher means the encoder and decoder will
2d525ef4 1433 * generally do stupid things, whereas setting it to unofficial or lower
538c0e13
RB
1434 * will mean the encoder might produce output that is not supported by all
1435 * spec-compliant decoders. Decoders don't differentiate between normal,
2d525ef4 1436 * unofficial and experimental (that is, they always try to decode things
538c0e13 1437 * when they can) unless they are explicitly asked to behave stupidly
5771b2c3 1438 * (=strictly conform to the specs)
b71901e6
MN
1439 */
1440 int strict_std_compliance;
538c0e13 1441#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
f5bccd85 1442#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
9cd81798 1443#define FF_COMPLIANCE_NORMAL 0
2d525ef4 1444#define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
f5bccd85 1445#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
9cd81798 1446
b71901e6 1447 /**
f5bccd85 1448 * qscale offset between IP and B-frames
f5bccd85 1449 * - encoding: Set by user.
64863965 1450 * - decoding: unused
b71901e6
MN
1451 */
1452 float b_quant_offset;
115329f1 1453
b71901e6 1454 /**
047599a4 1455 * Error recognization; higher values will detect more errors but may
f5bccd85 1456 * misdetect some more or less valid parts as errors.
64863965 1457 * - encoding: unused
f5bccd85 1458 * - decoding: Set by user.
b71901e6 1459 */
047599a4 1460 int error_recognition;
1471c6c2 1461#define FF_ER_CAREFUL 1
ce3bcaed
MN
1462#define FF_ER_COMPLIANT 2
1463#define FF_ER_AGGRESSIVE 3
1464#define FF_ER_VERY_AGGRESSIVE 4
115329f1 1465
6b72ac63 1466 /**
f5bccd85
DB
1467 * Called at the beginning of each frame to get a buffer for it.
1468 * If pic.reference is set then the frame will be read later by libavcodec.
eb285cfe 1469 * avcodec_align_dimensions2() should be used to find the required width and
f5bccd85 1470 * height, as they normally need to be rounded up to the next multiple of 16.
f1b99cc6
MN
1471 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1472 * avcodec_default_get_buffer() instead of providing buffers allocated by
1473 * some other means.
37b00b47
AS
1474 * If frame multithreading is used and thread_safe_callbacks is set,
1475 * it may be called from a different thread, but not from more than one at once.
1476 * Does not need to be reentrant.
64863965 1477 * - encoding: unused
53128bc3 1478 * - decoding: Set by libavcodec, user can override.
b71901e6 1479 */
492cd3a9 1480 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1 1481
b71901e6 1482 /**
69b192ac 1483 * Called to release buffers which were allocated with get_buffer.
f5bccd85
DB
1484 * A released buffer can be reused in get_buffer().
1485 * pic.data[*] must be set to NULL.
37b00b47
AS
1486 * May be called from a different thread if frame multithreading is used,
1487 * but not by more than one thread at once, so does not need to be reentrant.
64863965 1488 * - encoding: unused
53128bc3 1489 * - decoding: Set by libavcodec, user can override.
b71901e6 1490 */
492cd3a9 1491 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 1492
b71901e6 1493 /**
eb8a25c8 1494 * Size of the frame reordering buffer in the decoder.
2d7b0560 1495 * For MPEG-2 it is 1 IPB or 0 low delay IP.
f5bccd85
DB
1496 * - encoding: Set by libavcodec.
1497 * - decoding: Set by libavcodec.
b71901e6
MN
1498 */
1499 int has_b_frames;
718b27a7
MN
1500
1501 /**
1502 * number of bytes per packet if constant and known or 0
f5bccd85 1503 * Used by some WAV based audio codecs.
718b27a7
MN
1504 */
1505 int block_align;
115329f1 1506
f5bccd85 1507 int parse_only; /* - decoding only: If true, only parsing is done
917e06c8
FB
1508 (function avcodec_parse_frame()). The frame
1509 data is returned. Only MPEG codecs support this now. */
115329f1 1510
b71901e6 1511 /**
f5bccd85
DB
1512 * 0-> h263 quant 1-> mpeg quant
1513 * - encoding: Set by user.
64863965 1514 * - decoding: unused
b71901e6
MN
1515 */
1516 int mpeg_quant;
115329f1 1517
b71901e6 1518 /**
f5bccd85
DB
1519 * pass1 encoding statistics output buffer
1520 * - encoding: Set by libavcodec.
64863965 1521 * - decoding: unused
b71901e6 1522 */
64863965 1523 char *stats_out;
115329f1 1524
b71901e6 1525 /**
f5bccd85
DB
1526 * pass2 encoding statistics input buffer
1527 * Concatenated stuff from stats_out of pass1 should be placed here.
1528 * - encoding: Allocated/set/freed by user.
64863965 1529 * - decoding: unused
b71901e6
MN
1530 */
1531 char *stats_in;
115329f1 1532
b71901e6 1533 /**
f5bccd85
DB
1534 * ratecontrol qmin qmax limiting method
1535 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1536 * - encoding: Set by user.
64863965 1537 * - decoding: unused
b71901e6 1538 */
ce980a95 1539 float rc_qsquish;
b71901e6 1540
ce980a95
MN
1541 float rc_qmod_amp;
1542 int rc_qmod_freq;
115329f1 1543
b71901e6 1544 /**
f5bccd85
DB
1545 * ratecontrol override, see RcOverride
1546 * - encoding: Allocated/set/freed by user.
64863965 1547 * - decoding: unused
b71901e6 1548 */
ce980a95
MN
1549 RcOverride *rc_override;
1550 int rc_override_count;
115329f1 1551
b71901e6 1552 /**
f5bccd85
DB
1553 * rate control equation
1554 * - encoding: Set by user
64863965 1555 * - decoding: unused
b71901e6 1556 */
6881b8e5 1557 const char *rc_eq;
115329f1 1558
b71901e6 1559 /**
f5bccd85
DB
1560 * maximum bitrate
1561 * - encoding: Set by user.
64863965 1562 * - decoding: unused
b71901e6 1563 */
ce980a95 1564 int rc_max_rate;
115329f1 1565
b71901e6 1566 /**
f5bccd85
DB
1567 * minimum bitrate
1568 * - encoding: Set by user.
64863965 1569 * - decoding: unused
b71901e6 1570 */
ce980a95 1571 int rc_min_rate;
115329f1 1572
b71901e6 1573 /**
f5bccd85
DB
1574 * decoder bitstream buffer size
1575 * - encoding: Set by user.
64863965 1576 * - decoding: unused
b71901e6 1577 */
ce980a95
MN
1578 int rc_buffer_size;
1579 float rc_buffer_aggressivity;
b71901e6
MN
1580
1581 /**
f5bccd85
DB
1582 * qscale factor between P and I-frames
1583 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1584 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1585 * - encoding: Set by user.
64863965 1586 * - decoding: unused
b71901e6
MN
1587 */
1588 float i_quant_factor;
115329f1 1589
b71901e6 1590 /**
f5bccd85
DB
1591 * qscale offset between P and I-frames
1592 * - encoding: Set by user.
64863965 1593 * - decoding: unused
b71901e6
MN
1594 */
1595 float i_quant_offset;
115329f1 1596
b71901e6 1597 /**
f5bccd85
DB
1598 * initial complexity for pass1 ratecontrol
1599 * - encoding: Set by user.
64863965 1600 * - decoding: unused
b71901e6 1601 */
ce980a95 1602 float rc_initial_cplx;
917e06c8 1603
b71901e6 1604 /**
f5bccd85
DB
1605 * DCT algorithm, see FF_DCT_* below
1606 * - encoding: Set by user.
64863965 1607 * - decoding: unused
b71901e6 1608 */
28db7fce 1609 int dct_algo;
c7e07931 1610#define FF_DCT_AUTO 0
28db7fce 1611#define FF_DCT_FASTINT 1
c7e07931
MO
1612#define FF_DCT_INT 2
1613#define FF_DCT_MMX 3
1614#define FF_DCT_MLIB 4
05c4072b 1615#define FF_DCT_ALTIVEC 5
65e4c8c9 1616#define FF_DCT_FAAN 6
115329f1 1617
c5d309f2 1618 /**
f5bccd85
DB
1619 * luminance masking (0-> disabled)
1620 * - encoding: Set by user.
64863965 1621 * - decoding: unused
c5d309f2
MN
1622 */
1623 float lumi_masking;
115329f1 1624
c5d309f2 1625 /**
f5bccd85
DB
1626 * temporary complexity masking (0-> disabled)
1627 * - encoding: Set by user.
64863965 1628 * - decoding: unused
c5d309f2
MN
1629 */
1630 float temporal_cplx_masking;
115329f1 1631
c5d309f2 1632 /**
f5bccd85
DB
1633 * spatial complexity masking (0-> disabled)
1634 * - encoding: Set by user.
64863965 1635 * - decoding: unused
c5d309f2
MN
1636 */
1637 float spatial_cplx_masking;
115329f1 1638
c5d309f2 1639 /**
f5bccd85
DB
1640 * p block masking (0-> disabled)
1641 * - encoding: Set by user.
64863965 1642 * - decoding: unused
c5d309f2
MN
1643 */
1644 float p_masking;
15415af4 1645
5e746b99 1646 /**
f5bccd85
DB
1647 * darkness masking (0-> disabled)
1648 * - encoding: Set by user.
64863965 1649 * - decoding: unused
5e746b99
MN
1650 */
1651 float dark_masking;
115329f1 1652
0c2dd16e 1653 /**
f5bccd85
DB
1654 * IDCT algorithm, see FF_IDCT_* below.
1655 * - encoding: Set by user.
1656 * - decoding: Set by user.
2ad1516a
MN
1657 */
1658 int idct_algo;
273b0cd3
DB
1659#define FF_IDCT_AUTO 0
1660#define FF_IDCT_INT 1
1661#define FF_IDCT_SIMPLE 2
1662#define FF_IDCT_SIMPLEMMX 3
1663#define FF_IDCT_LIBMPEG2MMX 4
1664#define FF_IDCT_PS2 5
1665#define FF_IDCT_MLIB 6
1666#define FF_IDCT_ARM 7
1667#define FF_IDCT_ALTIVEC 8
1668#define FF_IDCT_SH4 9
1669#define FF_IDCT_SIMPLEARM 10
1670#define FF_IDCT_H264 11
1671#define FF_IDCT_VP3 12
1672#define FF_IDCT_IPP 13
1673#define FF_IDCT_XVIDMMX 14
1674#define FF_IDCT_CAVS 15
a0403006 1675#define FF_IDCT_SIMPLEARMV5TE 16
273b0cd3 1676#define FF_IDCT_SIMPLEARMV6 17
d9420d4d 1677#define FF_IDCT_SIMPLEVIS 18
9abc7e0f 1678#define FF_IDCT_WMV2 19
6f08c541 1679#define FF_IDCT_FAAN 20
42b30357 1680#define FF_IDCT_EA 21
7eec4328 1681#define FF_IDCT_SIMPLENEON 22
74c47463 1682#define FF_IDCT_SIMPLEALPHA 23
342c7dfd 1683#define FF_IDCT_BINK 24
2ad1516a 1684
144f0625 1685 /**
f5bccd85
DB
1686 * slice count
1687 * - encoding: Set by libavcodec.
1688 * - decoding: Set by user (or 0).
144f0625
MN
1689 */
1690 int slice_count;
1691 /**
f5bccd85
DB
1692 * slice offsets in the frame in bytes
1693 * - encoding: Set/allocated by libavcodec.
1694 * - decoding: Set/allocated by user (or NULL).
144f0625
MN
1695 */
1696 int *slice_offset;
1697
4d2858de 1698 /**
f5bccd85 1699 * error concealment flags
64863965 1700 * - encoding: unused
f5bccd85 1701 * - decoding: Set by user.
4d2858de
MN
1702 */
1703 int error_concealment;
1704#define FF_EC_GUESS_MVS 1
1705#define FF_EC_DEBLOCK 2
1706
6b72ac63 1707 /**
bec89a84 1708 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1709 * CPU features (i.e. MMX, SSE. ...)
bec89a84 1710 *
f5bccd85
DB
1711 * With the FORCE flag you may instead enable given CPU features.
1712 * (Dangerous: Usable in case of misdetection, improper usage however will
1713 * result into program crash.)
bec89a84
ZK
1714 */
1715 unsigned dsp_mask;
7160bb71 1716
11f18faf 1717 /**
64863965 1718 * bits per sample/pixel from the demuxer (needed for huffyuv).
f5bccd85
DB
1719 * - encoding: Set by libavcodec.
1720 * - decoding: Set by user.
11f18faf 1721 */
46a73068 1722 int bits_per_coded_sample;
115329f1 1723
11f18faf 1724 /**
f5bccd85
DB
1725 * prediction method (needed for huffyuv)
1726 * - encoding: Set by user.
64863965 1727 * - decoding: unused
11f18faf
MN
1728 */
1729 int prediction_method;
1730#define FF_PRED_LEFT 0
1731#define FF_PRED_PLANE 1
1732#define FF_PRED_MEDIAN 2
115329f1 1733
5d3cea3a 1734 /**
f5bccd85 1735 * sample aspect ratio (0 if unknown)
8e5af7a6 1736 * That is the width of a pixel divided by the height of the pixel.
f5bccd85
DB
1737 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1738 * - encoding: Set by user.
1739 * - decoding: Set by libavcodec.
5d3cea3a 1740 */
5ff85f1d 1741 AVRational sample_aspect_ratio;
1e491e29
MN
1742
1743 /**
f5bccd85
DB
1744 * the picture in the bitstream
1745 * - encoding: Set by libavcodec.
1746 * - decoding: Set by libavcodec.
1e491e29 1747 */
492cd3a9 1748 AVFrame *coded_frame;
c8c437bc
MN
1749
1750 /**
f5bccd85
DB
1751 * debug
1752 * - encoding: Set by user.
1753 * - decoding: Set by user.
c8c437bc
MN
1754 */
1755 int debug;
273b0cd3
DB
1756#define FF_DEBUG_PICT_INFO 1
1757#define FF_DEBUG_RC 2
1758#define FF_DEBUG_BITSTREAM 4
1759#define FF_DEBUG_MB_TYPE 8
1760#define FF_DEBUG_QP 16
1761#define FF_DEBUG_MV 32
1762#define FF_DEBUG_DCT_COEFF 0x00000040
1763#define FF_DEBUG_SKIP 0x00000080
1764#define FF_DEBUG_STARTCODE 0x00000100
1765#define FF_DEBUG_PTS 0x00000200
1766#define FF_DEBUG_ER 0x00000400
1767#define FF_DEBUG_MMCO 0x00000800
1768#define FF_DEBUG_BUGS 0x00001000
1769#define FF_DEBUG_VIS_QP 0x00002000
864119b6 1770#define FF_DEBUG_VIS_MB_TYPE 0x00004000
385c820b 1771#define FF_DEBUG_BUFFERS 0x00008000
37b00b47 1772#define FF_DEBUG_THREADS 0x00010000
115329f1 1773
140cb663 1774 /**
f5bccd85
DB
1775 * debug
1776 * - encoding: Set by user.
1777 * - decoding: Set by user.
0c9bbaec
WH
1778 */
1779 int debug_mv;
1780#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1781#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1782#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1783
1784 /**
f5bccd85
DB
1785 * error
1786 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
64863965 1787 * - decoding: unused
140cb663
MN
1788 */
1789 uint64_t error[4];
115329f1 1790
4a49d2d5 1791#if FF_API_MB_Q
17a70fde 1792 /**
f5bccd85 1793 * minimum MB quantizer
6e0d8c06 1794 * - encoding: unused
64863965 1795 * - decoding: unused
17a70fde 1796 */
4a49d2d5 1797 attribute_deprecated int mb_qmin;
17a70fde
MN
1798
1799 /**
f5bccd85 1800 * maximum MB quantizer
6e0d8c06 1801 * - encoding: unused
64863965 1802 * - decoding: unused
17a70fde 1803 */
4a49d2d5
AK
1804 attribute_deprecated int mb_qmax;
1805#endif
115329f1 1806
1457ab52 1807 /**
f5bccd85
DB
1808 * motion estimation comparison function
1809 * - encoding: Set by user.
64863965 1810 * - decoding: unused
1457ab52
MN
1811 */
1812 int me_cmp;
1813 /**
f5bccd85
DB
1814 * subpixel motion estimation comparison function
1815 * - encoding: Set by user.
64863965 1816 * - decoding: unused
1457ab52
MN
1817 */
1818 int me_sub_cmp;
1819 /**
f5bccd85
DB
1820 * macroblock comparison function (not supported yet)
1821 * - encoding: Set by user.
64863965 1822 * - decoding: unused
1457ab52
MN
1823 */
1824 int mb_cmp;
622348f9 1825 /**
f5bccd85
DB
1826 * interlaced DCT comparison function
1827 * - encoding: Set by user.
622348f9
MN
1828 * - decoding: unused
1829 */
1830 int ildct_cmp;
273b0cd3
DB
1831#define FF_CMP_SAD 0
1832#define FF_CMP_SSE 1
1833#define FF_CMP_SATD 2
1834#define FF_CMP_DCT 3
1835#define FF_CMP_PSNR 4
1836#define FF_CMP_BIT 5
1837#define FF_CMP_RD 6
1838#define FF_CMP_ZERO 7
1839#define FF_CMP_VSAD 8
1840#define FF_CMP_VSSE 9
1841#define FF_CMP_NSSE 10
1842#define FF_CMP_W53 11
1843#define FF_CMP_W97 12
0fd6aea1 1844#define FF_CMP_DCTMAX 13
27c61ac5 1845#define FF_CMP_DCT264 14
1457ab52 1846#define FF_CMP_CHROMA 256
115329f1 1847
1457ab52 1848 /**
f5bccd85
DB
1849 * ME diamond size & shape
1850 * - encoding: Set by user.
64863965 1851 * - decoding: unused
1457ab52
MN
1852 */
1853 int dia_size;
b07a5980
MN
1854
1855 /**
f5bccd85
DB
1856 * amount of previous MV predictors (2a+1 x 2a+1 square)
1857 * - encoding: Set by user.
64863965 1858 * - decoding: unused
b07a5980
MN
1859 */
1860 int last_predictor_count;
70ac76c0 1861
f5fb6b34 1862 /**
f5bccd85
DB
1863 * prepass for motion estimation
1864 * - encoding: Set by user.
64863965 1865 * - decoding: unused
f5fb6b34
MN
1866 */
1867 int pre_me;
b07a5980 1868
70ac76c0 1869 /**
f5bccd85
DB
1870 * motion estimation prepass comparison function
1871 * - encoding: Set by user.
64863965 1872 * - decoding: unused
70ac76c0
MN
1873 */
1874 int me_pre_cmp;
826f429a 1875
70ac76c0 1876 /**
f5bccd85
DB
1877 * ME prepass diamond size & shape
1878 * - encoding: Set by user.
64863965 1879 * - decoding: unused
70ac76c0
MN
1880 */
1881 int pre_dia_size;
1882
826f429a 1883 /**
f5bccd85
DB
1884 * subpel ME quality
1885 * - encoding: Set by user.
64863965 1886 * - decoding: unused
826f429a
MN
1887 */
1888 int me_subpel_quality;
1889
a33c7159 1890 /**
f5bccd85 1891 * callback to negotiate the pixelFormat
a33c7159 1892 * @param fmt is the list of formats which are supported by the codec,
f5bccd85
DB
1893 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1894 * The first is always the native one.
1895 * @return the chosen format
64863965 1896 * - encoding: unused
f5bccd85 1897 * - decoding: Set by user, if not set the native format will be chosen.
a33c7159 1898 */
494c56d3 1899 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
e2f9490e
FB
1900
1901 /**
f5bccd85
DB
1902 * DTG active format information (additional aspect ratio
1903 * information only used in DVB MPEG-2 transport streams)
1904 * 0 if not set.
115329f1 1905 *
f5bccd85
DB
1906 * - encoding: unused
1907 * - decoding: Set by decoder.
e2f9490e
FB
1908 */
1909 int dtg_active_format;
1910#define FF_DTG_AFD_SAME 8
1911#define FF_DTG_AFD_4_3 9
1912#define FF_DTG_AFD_16_9 10
1913#define FF_DTG_AFD_14_9 11
1914#define FF_DTG_AFD_4_3_SP_14_9 13
1915#define FF_DTG_AFD_16_9_SP_14_9 14
1916#define FF_DTG_AFD_SP_4_3 15
1917
ebbcdc9a 1918 /**
f5bccd85
DB
1919 * maximum motion estimation search range in subpel units
1920 * If 0 then no limit.
115329f1 1921 *
f5bccd85
DB
1922 * - encoding: Set by user.
1923 * - decoding: unused
ebbcdc9a 1924 */
59e0ac8e 1925 int me_range;
ebbcdc9a 1926
65f7062d 1927 /**
f5bccd85
DB
1928 * intra quantizer bias
1929 * - encoding: Set by user.
1984f635
MN
1930 * - decoding: unused
1931 */
1932 int intra_quant_bias;
1933#define FF_DEFAULT_QUANT_BIAS 999999
115329f1 1934
1984f635 1935 /**
f5bccd85
DB
1936 * inter quantizer bias
1937 * - encoding: Set by user.
1984f635
MN
1938 * - decoding: unused
1939 */
1940 int inter_quant_bias;
5cd62665
ZK
1941
1942 /**
f5bccd85
DB
1943 * color table ID
1944 * - encoding: unused
1945 * - decoding: Which clrtable should be used for 8bit RGB images.
1946 * Tables have to be stored somewhere. FIXME
5cd62665
ZK
1947 */
1948 int color_table_id;
115329f1 1949
d90cf87b 1950 /**
f5bccd85
DB
1951 * internal_buffer count
1952 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1953 */
1954 int internal_buffer_count;
115329f1 1955
d90cf87b 1956 /**
f5bccd85
DB
1957 * internal_buffers
1958 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1959 */
1960 void *internal_buffer;
158c7f05 1961
3d2e8cce 1962 /**
f5bccd85
DB
1963 * Global quality for codecs which cannot change it per frame.
1964 * This should be proportional to MPEG-1/2/4 qscale.
1965 * - encoding: Set by user.
3d2e8cce
MN
1966 * - decoding: unused
1967 */
1968 int global_quality;
115329f1 1969
bd446bb1
MN
1970#define FF_CODER_TYPE_VLC 0
1971#define FF_CODER_TYPE_AC 1
f87459e4
KN
1972#define FF_CODER_TYPE_RAW 2
1973#define FF_CODER_TYPE_RLE 3
1974#define FF_CODER_TYPE_DEFLATE 4
11e659c2
MN
1975 /**
1976 * coder type
f5bccd85 1977 * - encoding: Set by user.
11e659c2
MN
1978 * - decoding: unused
1979 */
1980 int coder_type;
1981
1982 /**
1983 * context model
f5bccd85 1984 * - encoding: Set by user.
11e659c2
MN
1985 * - decoding: unused
1986 */
1987 int context_model;
5639729b
MN
1988#if 0
1989 /**
1990 *
1991 * - encoding: unused
f5bccd85 1992 * - decoding: Set by user.
5639729b
MN
1993 */
1994 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1995#endif
115329f1 1996
3bb07d61
MN
1997 /**
1998 * slice flags
1999 * - encoding: unused
f5bccd85 2000 * - decoding: Set by user.
3bb07d61
MN
2001 */
2002 int slice_flags;
2003#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2004#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2005#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2006
fb364ada
IK
2007 /**
2008 * XVideo Motion Acceleration
2009 * - encoding: forbidden
2010 * - decoding: set by decoder
2011 */
2012 int xvmc_acceleration;
115329f1 2013
7d1c3fc1
MN
2014 /**
2015 * macroblock decision mode
f5bccd85 2016 * - encoding: Set by user.
7d1c3fc1
MN
2017 * - decoding: unused
2018 */
2019 int mb_decision;
2020#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2021#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
e6dba5df 2022#define FF_MB_DECISION_RD 2 ///< rate distortion
d6eb3c50
MN
2023
2024 /**
2025 * custom intra quantization matrix
f5bccd85
DB
2026 * - encoding: Set by user, can be NULL.
2027 * - decoding: Set by libavcodec.
d6eb3c50
MN
2028 */
2029 uint16_t *intra_matrix;
2030
2031 /**
2032 * custom inter quantization matrix
f5bccd85
DB
2033 * - encoding: Set by user, can be NULL.
2034 * - decoding: Set by libavcodec.
d6eb3c50
MN
2035 */
2036 uint16_t *inter_matrix;
115329f1 2037
541ae140
MN
2038 /**
2039 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85 2040 * This is used to work around some encoder bugs.
541ae140 2041 * - encoding: unused
f5bccd85 2042 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
541ae140
MN
2043 */
2044 unsigned int stream_codec_tag;
05fbd0a2
MN
2045
2046 /**
f5bccd85
DB
2047 * scene change detection threshold
2048 * 0 is default, larger means fewer detected scene changes.
2049 * - encoding: Set by user.
05fbd0a2
MN
2050 * - decoding: unused
2051 */
2052 int scenechange_threshold;
158c7f05
MN
2053
2054 /**
f5bccd85
DB
2055 * minimum Lagrange multipler
2056 * - encoding: Set by user.
158c7f05
MN
2057 * - decoding: unused
2058 */
2059 int lmin;
2060
2061 /**
f5bccd85
DB
2062 * maximum Lagrange multipler
2063 * - encoding: Set by user.
158c7f05
MN
2064 * - decoding: unused
2065 */
2066 int lmax;
2a2bbcb0 2067
eda7c983 2068#if FF_API_PALETTE_CONTROL
2a2bbcb0 2069 /**
f5bccd85 2070 * palette control structure
2a2bbcb0 2071 * - encoding: ??? (no palette-enabled encoder yet)
f5bccd85 2072 * - decoding: Set by user.
2a2bbcb0
MM
2073 */
2074 struct AVPaletteControl *palctrl;
eda7c983 2075#endif
821cb11f
MN
2076
2077 /**
2078 * noise reduction strength
f5bccd85 2079 * - encoding: Set by user.
821cb11f
MN
2080 * - decoding: unused
2081 */
2082 int noise_reduction;
115329f1 2083
074c4ca7 2084 /**
f5bccd85
DB
2085 * Called at the beginning of a frame to get cr buffer for it.
2086 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2087 * libavcodec will pass previous buffer in pic, function should return
e1c2a5a0 2088 * same buffer or new buffer with old frame "painted" into it.
f5bccd85 2089 * If pic.data[0] == NULL must behave like get_buffer().
f1b99cc6
MN
2090 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2091 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2092 * some other means.
074c4ca7 2093 * - encoding: unused
53128bc3 2094 * - decoding: Set by libavcodec, user can override.
074c4ca7 2095 */
e1c2a5a0 2096 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
MN
2097
2098 /**
f5bccd85
DB
2099 * Number of bits which should be loaded into the rc buffer before decoding starts.
2100 * - encoding: Set by user.
ba58dabc
MN
2101 * - decoding: unused
2102 */
2103 int rc_initial_buffer_occupancy;
2104
2105 /**
2106 *
f5bccd85 2107 * - encoding: Set by user.
ba58dabc
MN
2108 * - decoding: unused
2109 */
2110 int inter_threshold;
2111
2112 /**
f5bccd85
DB
2113 * CODEC_FLAG2_*
2114 * - encoding: Set by user.
2115 * - decoding: Set by user.
ba58dabc
MN
2116 */
2117 int flags2;
7ebfc0ea
MN
2118
2119 /**
f5bccd85
DB
2120 * Simulates errors in the bitstream to test error concealment.
2121 * - encoding: Set by user.
2122 * - decoding: unused
7ebfc0ea
MN
2123 */
2124 int error_rate;
115329f1 2125
4e3945fd 2126#if FF_API_ANTIALIAS_ALGO
a1e257b2
MN
2127 /**
2128 * MP3 antialias algorithm, see FF_AA_* below.
2129 * - encoding: unused
f5bccd85 2130 * - decoding: Set by user.
a1e257b2 2131 */
4e3945fd 2132 attribute_deprecated int antialias_algo;
a1e257b2
MN
2133#define FF_AA_AUTO 0
2134#define FF_AA_FASTINT 1 //not implemented yet
2135#define FF_AA_INT 2
2136#define FF_AA_FLOAT 3
4e3945fd
AK
2137#endif
2138
77ea0d4b 2139 /**
f5bccd85
DB
2140 * quantizer noise shaping
2141 * - encoding: Set by user.
77ea0d4b
MN
2142 * - decoding: unused
2143 */
2144 int quantizer_noise_shaping;
9c3d33d6
MN
2145
2146 /**
f5bccd85 2147 * thread count
eafcac6a 2148 * is used to decide how many independent tasks should be passed to execute()
f5bccd85
DB
2149 * - encoding: Set by user.
2150 * - decoding: Set by user.
9c3d33d6
MN
2151 */
2152 int thread_count;
115329f1 2153
9c3d33d6 2154 /**
f5bccd85
DB
2155 * The codec may call this to execute several independent things.
2156 * It will return only after finishing all tasks.
2157 * The user may replace this with some multithreaded implementation,
2158 * the default implementation will execute the parts serially.
399cec2f 2159 * @param count the number of things to execute
f5bccd85
DB
2160 * - encoding: Set by libavcodec, user can override.
2161 * - decoding: Set by libavcodec, user can override.
9c3d33d6 2162 */
3a84713a 2163 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
115329f1 2164
9c3d33d6 2165 /**
f5bccd85
DB
2166 * thread opaque
2167 * Can be used by execute() to store some per AVCodecContext stuff.
9c3d33d6
MN
2168 * - encoding: set by execute()
2169 * - decoding: set by execute()
2170 */
2171 void *thread_opaque;
a4d36c11
MN
2172
2173 /**
f5bccd85
DB
2174 * Motion estimation threshold below which no motion estimation is
2175 * performed, but instead the user specified motion vectors are used.
115329f1 2176 *
f5bccd85 2177 * - encoding: Set by user.
f20f8a8b 2178 * - decoding: unused
a4d36c11 2179 */
2750b827 2180 int me_threshold;
f20f8a8b
MN
2181
2182 /**
f5bccd85
DB
2183 * Macroblock threshold below which the user specified macroblock types will be used.
2184 * - encoding: Set by user.
f20f8a8b
MN
2185 * - decoding: unused
2186 */
2187 int mb_threshold;
bf266e19
MN
2188
2189 /**
f5bccd85
DB
2190 * precision of the intra DC coefficient - 8
2191 * - encoding: Set by user.
bf266e19
MN
2192 * - decoding: unused
2193 */
2194 int intra_dc_precision;
d4c5d2ad
MN
2195
2196 /**
f5bccd85
DB
2197 * noise vs. sse weight for the nsse comparsion function
2198 * - encoding: Set by user.
d4c5d2ad
MN
2199 * - decoding: unused
2200 */
2201 int nsse_weight;
0dfd33c3
MN
2202
2203 /**
f5bccd85 2204 * Number of macroblock rows at the top which are skipped.
0dfd33c3 2205 * - encoding: unused
f5bccd85 2206 * - decoding: Set by user.
0dfd33c3
MN
2207 */
2208 int skip_top;
2209
2210 /**
f5bccd85 2211 * Number of macroblock rows at the bottom which are skipped.
0dfd33c3 2212 * - encoding: unused
f5bccd85 2213 * - decoding: Set by user.
0dfd33c3
MN
2214 */
2215 int skip_bottom;
baced9f5
MN
2216
2217 /**
2218 * profile
f5bccd85
DB
2219 * - encoding: Set by user.
2220 * - decoding: Set by libavcodec.
baced9f5
MN
2221 */
2222 int profile;
2223#define FF_PROFILE_UNKNOWN -99
aecd0a44 2224#define FF_PROFILE_RESERVED -100
dd0cd3d2 2225
4f2c36ac 2226#define FF_PROFILE_AAC_MAIN 0
273b0cd3
DB
2227#define FF_PROFILE_AAC_LOW 1
2228#define FF_PROFILE_AAC_SSR 2
2229#define FF_PROFILE_AAC_LTP 3
baced9f5 2230
f5a2d285
AH
2231#define FF_PROFILE_DTS 20
2232#define FF_PROFILE_DTS_ES 30
2233#define FF_PROFILE_DTS_96_24 40
2234#define FF_PROFILE_DTS_HD_HRA 50
2235#define FF_PROFILE_DTS_HD_MA 60
2236
aecd0a44
BL
2237#define FF_PROFILE_MPEG2_422 0
2238#define FF_PROFILE_MPEG2_HIGH 1
2239#define FF_PROFILE_MPEG2_SS 2
2240#define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2241#define FF_PROFILE_MPEG2_MAIN 4
2242#define FF_PROFILE_MPEG2_SIMPLE 5
2243
fe9a3fbe
JG
2244#define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2245#define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2246
2247#define FF_PROFILE_H264_BASELINE 66
2248#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2249#define FF_PROFILE_H264_MAIN 77
2250#define FF_PROFILE_H264_EXTENDED 88
2251#define FF_PROFILE_H264_HIGH 100
2252#define FF_PROFILE_H264_HIGH_10 110
2253#define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2254#define FF_PROFILE_H264_HIGH_422 122
2255#define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
440b6169 2256#define FF_PROFILE_H264_HIGH_444 144
fe9a3fbe
JG
2257#define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2258#define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2259#define FF_PROFILE_H264_CAVLC_444 44
dd0cd3d2 2260
0215006a
HL
2261#define FF_PROFILE_VC1_SIMPLE 0
2262#define FF_PROFILE_VC1_MAIN 1
2263#define FF_PROFILE_VC1_COMPLEX 2
2264#define FF_PROFILE_VC1_ADVANCED 3
2265
baced9f5
MN
2266 /**
2267 * level
f5bccd85
DB
2268 * - encoding: Set by user.
2269 * - decoding: Set by libavcodec.
baced9f5
MN
2270 */
2271 int level;
2272#define FF_LEVEL_UNKNOWN -99
178fcca8
MN
2273
2274 /**
f5bccd85 2275 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
178fcca8 2276 * - encoding: unused
f5bccd85 2277 * - decoding: Set by user.
178fcca8
MN
2278 */
2279 int lowres;
21adafec
MN
2280
2281 /**
f5bccd85
DB
2282 * Bitstream width / height, may be different from width/height if lowres
2283 * or other things are used.
21adafec 2284 * - encoding: unused
f5bccd85 2285 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
21adafec
MN
2286 */
2287 int coded_width, coded_height;
bbf18b21
MN
2288
2289 /**
2290 * frame skip threshold
f5bccd85 2291 * - encoding: Set by user.
bbf18b21
MN
2292 * - decoding: unused
2293 */
2294 int frame_skip_threshold;
2295
2296 /**
2297 * frame skip factor
f5bccd85 2298 * - encoding: Set by user.
bbf18b21
MN
2299 * - decoding: unused
2300 */
2301 int frame_skip_factor;
0fd6aea1
MN
2302
2303 /**
2304 * frame skip exponent
f5bccd85 2305 * - encoding: Set by user.
0fd6aea1
MN
2306 * - decoding: unused
2307 */
2308 int frame_skip_exp;
2309
2310 /**
f5bccd85
DB
2311 * frame skip comparison function
2312 * - encoding: Set by user.
0fd6aea1
MN
2313 * - decoding: unused
2314 */
2315 int frame_skip_cmp;
957c743a
CM
2316
2317 /**
f5bccd85 2318 * Border processing masking, raises the quantizer for mbs on the borders
957c743a 2319 * of the picture.
f5bccd85 2320 * - encoding: Set by user.
957c743a
CM
2321 * - decoding: unused
2322 */
2323 float border_masking;
6e0d8c06
MN
2324
2325 /**
f5bccd85
DB
2326 * minimum MB lagrange multipler
2327 * - encoding: Set by user.
6e0d8c06
MN
2328 * - decoding: unused
2329 */
2330 int mb_lmin;
2331
2332 /**
f5bccd85
DB
2333 * maximum MB lagrange multipler
2334 * - encoding: Set by user.
6e0d8c06
MN
2335 * - decoding: unused
2336 */
2337 int mb_lmax;
09c3e44e
MN
2338
2339 /**
115329f1 2340 *
f5bccd85 2341 * - encoding: Set by user.
09c3e44e
MN
2342 * - decoding: unused
2343 */
2344 int me_penalty_compensation;
8c3eba7c
MN
2345
2346 /**
115329f1 2347 *
8c3eba7c 2348 * - encoding: unused
f5bccd85 2349 * - decoding: Set by user.
8c3eba7c
MN
2350 */
2351 enum AVDiscard skip_loop_filter;
2352
2353 /**
115329f1 2354 *
8c3eba7c 2355 * - encoding: unused
f5bccd85 2356 * - decoding: Set by user.
8c3eba7c
MN
2357 */
2358 enum AVDiscard skip_idct;
2359
2360 /**
115329f1 2361 *
8c3eba7c 2362 * - encoding: unused
f5bccd85 2363 * - decoding: Set by user.
8c3eba7c
MN
2364 */
2365 enum AVDiscard skip_frame;
316a2ec8
MN
2366
2367 /**
2368 *
f5bccd85 2369 * - encoding: Set by user.
316a2ec8
MN
2370 * - decoding: unused
2371 */
2372 int bidir_refine;
e8501c93
MN
2373
2374 /**
2375 *
f5bccd85 2376 * - encoding: Set by user.
e8501c93
MN
2377 * - decoding: unused
2378 */
2379 int brd_scale;
58f7833e
RS
2380
2381 /**
2382 * constant rate factor - quality-based VBR - values ~correspond to qps
f5bccd85 2383 * - encoding: Set by user.
58f7833e
RS
2384 * - decoding: unused
2385 */
9f1c1c99 2386 float crf;
58f7833e
RS
2387
2388 /**
2389 * constant quantization parameter rate control method
f5bccd85 2390 * - encoding: Set by user.
58f7833e
RS
2391 * - decoding: unused
2392 */
2393 int cqp;
2394
2395 /**
f5bccd85
DB
2396 * minimum GOP size
2397 * - encoding: Set by user.
58f7833e
RS
2398 * - decoding: unused
2399 */
2400 int keyint_min;
2401
2402 /**
2403 * number of reference frames
f5bccd85 2404 * - encoding: Set by user.
53d55e9e 2405 * - decoding: Set by lavc.
58f7833e
RS
2406 */
2407 int refs;
2408
2409 /**
2410 * chroma qp offset from luma
f5bccd85 2411 * - encoding: Set by user.
58f7833e
RS
2412 * - decoding: unused
2413 */
2414 int chromaoffset;
2415
2416 /**
f5bccd85
DB
2417 * Influences how often B-frames are used.
2418 * - encoding: Set by user.
58f7833e
RS
2419 * - decoding: unused
2420 */
2421 int bframebias;
2422
2423 /**
2424 * trellis RD quantization
f5bccd85 2425 * - encoding: Set by user.
58f7833e
RS
2426 * - decoding: unused
2427 */
2428 int trellis;
2429
2430 /**
f5bccd85
DB
2431 * Reduce fluctuations in qp (before curve compression).
2432 * - encoding: Set by user.
58f7833e
RS
2433 * - decoding: unused
2434 */
2435 float complexityblur;
2436
2437 /**
2438 * in-loop deblocking filter alphac0 parameter
2439 * alpha is in the range -6...6
f5bccd85 2440 * - encoding: Set by user.
58f7833e
RS
2441 * - decoding: unused
2442 */
2443 int deblockalpha;
2444
2445 /**
2446 * in-loop deblocking filter beta parameter
2447 * beta is in the range -6...6
f5bccd85 2448 * - encoding: Set by user.
58f7833e
RS
2449 * - decoding: unused
2450 */
2451 int deblockbeta;
2452
2453 /**
2454 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
f5bccd85 2455 * - encoding: Set by user.
58f7833e
RS
2456 * - decoding: unused
2457 */
2458 int partitions;
56cc85a0
DB
2459#define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2460#define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2461#define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2462#define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2463#define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
58f7833e
RS
2464
2465 /**
30ab4ded 2466 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
f5bccd85 2467 * - encoding: Set by user.
58f7833e
RS
2468 * - decoding: unused
2469 */
2470 int directpred;
4f59b684 2471
14f0c8e2 2472 /**
02c164c1 2473 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 2474 * - encoding: Set by user.
14f0c8e2
LA
2475 * - decoding: unused
2476 */
2477 int cutoff;
39a64e30
CH
2478
2479 /**
f5bccd85
DB
2480 * Multiplied by qscale for each frame and added to scene_change_score.
2481 * - encoding: Set by user.
39a64e30
CH
2482 * - decoding: unused
2483 */
2484 int scenechange_factor;
1dd509b1
MN
2485
2486 /**
2487 *
f5bccd85
DB
2488 * Note: Value depends upon the compare function used for fullpel ME.
2489 * - encoding: Set by user.
1dd509b1
MN
2490 * - decoding: unused
2491 */
2492 int mv0_threshold;
f9243d34
CH
2493
2494 /**
f5bccd85
DB
2495 * Adjusts sensitivity of b_frame_strategy 1.
2496 * - encoding: Set by user.
f9243d34
CH
2497 * - decoding: unused
2498 */
2499 int b_sensitivity;
a403fc03
JR
2500
2501 /**
f5bccd85 2502 * - encoding: Set by user.
a403fc03
JR
2503 * - decoding: unused
2504 */
2505 int compression_level;
2506#define FF_COMPRESSION_DEFAULT -1
2507
a403fc03
JR
2508 /**
2509 * LPC coefficient precision - used by FLAC encoder
f5bccd85
DB
2510 * - encoding: Set by user.
2511 * - decoding: unused
a403fc03
JR
2512 */
2513 int lpc_coeff_precision;
2514
2515 /**
f5bccd85
DB
2516 * - encoding: Set by user.
2517 * - decoding: unused
a403fc03
JR
2518 */
2519 int min_prediction_order;
2520
2521 /**
f5bccd85
DB
2522 * - encoding: Set by user.
2523 * - decoding: unused
a403fc03
JR
2524 */
2525 int max_prediction_order;
2526
2527 /**
2528 * search method for selecting prediction order
f5bccd85
DB
2529 * - encoding: Set by user.
2530 * - decoding: unused
a403fc03
JR
2531 */
2532 int prediction_order_method;
2533
2534 /**
f5bccd85
DB
2535 * - encoding: Set by user.
2536 * - decoding: unused
a403fc03
JR
2537 */
2538 int min_partition_order;
2539
2540 /**
f5bccd85
DB
2541 * - encoding: Set by user.
2542 * - decoding: unused
a403fc03
JR
2543 */
2544 int max_partition_order;
80d617f5
BC
2545
2546 /**
2547 * GOP timecode frame start number, in non drop frame format
f5bccd85
DB
2548 * - encoding: Set by user.
2549 * - decoding: unused
80d617f5
BC
2550 */
2551 int64_t timecode_frame_start;
b1ec601f 2552
9f5ddd1e 2553#if FF_API_REQUEST_CHANNELS
b1ec601f 2554 /**
85947156
VS
2555 * Decoder should decode to this many channels if it can (0 for default)
2556 * - encoding: unused
2557 * - decoding: Set by user.
0d72e7d0 2558 * @deprecated Deprecated in favor of request_channel_layout.
b1ec601f
RD
2559 */
2560 int request_channels;
0d72e7d0 2561#endif
1408352a
JR
2562
2563 /**
2564 * Percentage of dynamic range compression to be applied by the decoder.
2565 * The default value is 1.0, corresponding to full compression.
2566 * - encoding: unused
2567 * - decoding: Set by user.
2568 */
2569 float drc_scale;
79de84f2
MN
2570
2571 /**
2572 * opaque 64bit number (generally a PTS) that will be reordered and
2573 * output in AVFrame.reordered_opaque
81c623fa 2574 * @deprecated in favor of pkt_pts
79de84f2
MN
2575 * - encoding: unused
2576 * - decoding: Set by user.
2577 */
2578 int64_t reordered_opaque;
312420f3
PR
2579
2580 /**
2581 * Bits per sample/pixel of internal libavcodec pixel/sample format.
5d6e4c16 2582 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
312420f3
PR
2583 * - encoding: set by user.
2584 * - decoding: set by libavcodec.
2585 */
2586 int bits_per_raw_sample;
0d72e7d0
PR
2587
2588 /**
2589 * Audio channel layout.
2590 * - encoding: set by user.
2591 * - decoding: set by libavcodec.
2592 */
2593 int64_t channel_layout;
2594
2595 /**
2596 * Request decoder to use this channel layout if it can (0 for default)
2597 * - encoding: unused
2598 * - decoding: Set by user.
2599 */
2600 int64_t request_channel_layout;
3bff4d8b
BC
2601
2602 /**
2603 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2604 * - encoding: Set by user.
2605 * - decoding: unused.
2606 */
2607 float rc_max_available_vbv_use;
2608
2609 /**
2610 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2611 * - encoding: Set by user.
2612 * - decoding: unused.
2613 */
2614 float rc_min_vbv_overflow_use;
40e5d31b
GB
2615
2616 /**
2617 * Hardware accelerator in use
2618 * - encoding: unused.
2619 * - decoding: Set by libavcodec
2620 */
2621 struct AVHWAccel *hwaccel;
3797c74b
MN
2622
2623 /**
2624 * For some codecs, the time base is closer to the field rate than the frame rate.
2625 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2626 * if no telecine is used ...
2627 *
2628 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2629 */
2630 int ticks_per_frame;
1aea7018
GB
2631
2632 /**
2633 * Hardware accelerator context.
2634 * For some hardware accelerators, a global context needs to be
2635 * provided by the user. In that case, this holds display-dependent
43fb279f
DB
2636 * data Libav cannot instantiate itself. Please refer to the
2637 * Libav HW accelerator documentation to know how to fill this
1aea7018
GB
2638 * is. e.g. for VA API, this is a struct vaapi_context.
2639 * - encoding: unused
2640 * - decoding: Set by user
2641 */
2642 void *hwaccel_context;
4ee6a5c1
MN
2643
2644 /**
2645 * Chromaticity coordinates of the source primaries.
2646 * - encoding: Set by user
2647 * - decoding: Set by libavcodec
2648 */
2649 enum AVColorPrimaries color_primaries;
2650
2651 /**
2652 * Color Transfer Characteristic.
2653 * - encoding: Set by user
2654 * - decoding: Set by libavcodec
2655 */
2656 enum AVColorTransferCharacteristic color_trc;
2657
2658 /**
2659 * YUV colorspace type.
2660 * - encoding: Set by user
2661 * - decoding: Set by libavcodec
2662 */
2663 enum AVColorSpace colorspace;
2664
2665 /**
2666 * MPEG vs JPEG YUV range.
2667 * - encoding: Set by user
2668 * - decoding: Set by libavcodec
2669 */
2670 enum AVColorRange color_range;
580a7465
DC
2671
2672 /**
2673 * This defines the location of chroma samples.
2674 * - encoding: Set by user
2675 * - decoding: Set by libavcodec
2676 */
8ea08bec 2677 enum AVChromaLocation chroma_sample_location;
8d23a86f
RD
2678
2679 /**
2680 * The codec may call this to execute several independent things.
2681 * It will return only after finishing all tasks.
2682 * The user may replace this with some multithreaded implementation,
2683 * the default implementation will execute the parts serially.
2684 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2685 * @param c context passed also to func
2686 * @param count the number of things to execute
2687 * @param arg2 argument passed unchanged to func
2688 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2689 * @param func function that will be called count times, with jobnr from 0 to count-1.
2690 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2691 * two instances of func executing at the same time will have the same threadnr.
2692 * @return always 0 currently, but code should handle a future improvement where when any call to func
2693 * returns < 0 no further calls to func may be done and < 0 is returned.
2694 * - encoding: Set by libavcodec, user can override.
2695 * - decoding: Set by libavcodec, user can override.
2696 */
2697 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
096c87f6
JGG
2698
2699 /**
2700 * explicit P-frame weighted prediction analysis method
2701 * 0: off
2702 * 1: fast blind weighting (one reference duplicate with -1 offset)
2703 * 2: smart weighting (full fade detection analysis)
2704 * - encoding: Set by user.
2705 * - decoding: unused
2706 */
2707 int weighted_p_pred;
f3b3b489
BC
2708
2709 /**
2710 * AQ mode
2711 * 0: Disabled
2712 * 1: Variance AQ (complexity mask)
2713 * 2: Auto-variance AQ (experimental)
2714 * - encoding: Set by user
2715 * - decoding: unused
2716 */
2717 int aq_mode;
2718
2719 /**
2720 * AQ strength
2721 * Reduces blocking and blurring in flat and textured areas.
2722 * - encoding: Set by user
2723 * - decoding: unused
2724 */
2725 float aq_strength;
2726
2727 /**
2728 * PSY RD
2729 * Strength of psychovisual optimization
2730 * - encoding: Set by user
2731 * - decoding: unused
2732 */
2733 float psy_rd;
2734
2735 /**
2736 * PSY trellis
2737 * Strength of psychovisual optimization
2738 * - encoding: Set by user
2739 * - decoding: unused
2740 */
2741 float psy_trellis;
2742
2743 /**
2744 * RC lookahead
2745 * Number of frames for frametype and ratecontrol lookahead
2746 * - encoding: Set by user
2747 * - decoding: unused
2748 */
2749 int rc_lookahead;
e8c7fca9
JGG
2750
2751 /**
2752 * Constant rate factor maximum
2753 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2754 * than crf_max, even if doing so would violate VBV restrictions.
2755 * - encoding: Set by user.
2756 * - decoding: unused
2757 */
2758 float crf_max;
fecd7b45
SS
2759
2760 int log_level_offset;
23940f14
JR
2761
2762 /**
2763 * Determines which LPC analysis algorithm to use.
2764 * - encoding: Set by user
2765 * - decoding: unused
2766 */
2767 enum AVLPCType lpc_type;
2768
2769 /**
2770 * Number of passes to use for Cholesky factorization during LPC analysis
2771 * - encoding: Set by user
2772 * - decoding: unused
2773 */
2774 int lpc_passes;
2aa72ecc
JZ
2775
2776 /**
2777 * Number of slices.
2778 * Indicates number of picture subdivisions. Used for parallelized
2779 * decoding.
2780 * - encoding: Set by user
2781 * - decoding: unused
2782 */
2783 int slices;
cb2c971d
AJ
2784
2785 /**
2786 * Header containing style information for text subtitles.
2787 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2788 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2789 * the Format line following. It shouldn't include any Dialogue line.
2790 * - encoding: Set/allocated/freed by user (before avcodec_open())
2791 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2792 */
2793 uint8_t *subtitle_header;
2794 int subtitle_header_size;
393cbb96
MN
2795
2796 /**
2797 * Current packet as passed into the decoder, to avoid having
2798 * to pass the packet into every function. Currently only valid
2799 * inside lavc and get/release_buffer callbacks.
2800 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2801 * - encoding: unused
2802 */
2803 AVPacket *pkt;
37b00b47
AS
2804
2805 /**
2806 * Whether this is a copy of the context which had init() called on it.
2807 * This is used by multithreading - shared tables and picture pointers
2808 * should be freed from the original context only.
2809 * - encoding: Set by libavcodec.
2810 * - decoding: Set by libavcodec.
2811 */
2812 int is_copy;
2813
2814 /**
2815 * Which multithreading methods to use.
2816 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2817 * so clients which cannot provide future frames should not use it.
2818 *
2819 * - encoding: Set by user, otherwise the default is used.
2820 * - decoding: Set by user, otherwise the default is used.
2821 */
2822 int thread_type;
2823#define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2824#define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2825
2826 /**
2827 * Which multithreading methods are in use by the codec.
2828 * - encoding: Set by libavcodec.
2829 * - decoding: Set by libavcodec.
2830 */
2831 int active_thread_type;
2832
2833 /**
2834 * Set by the client if its custom get_buffer() callback can be called
2835 * from another thread, which allows faster multithreaded decoding.
2836 * draw_horiz_band() will be called from other threads regardless of this setting.
2837 * Ignored if the default get_buffer() is used.
2838 * - encoding: Set by user.
2839 * - decoding: Set by user.
2840 */
2841 int thread_safe_callbacks;
55bad0c6
CM
2842
2843 /**
2844 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2845 * Used for compliant TS muxing.
2846 * - encoding: Set by libavcodec.
2847 * - decoding: unused.
2848 */
2849 uint64_t vbv_delay;
34b47d7c
JR
2850
2851 /**
2852 * Type of service that the audio stream conveys.
2853 * - encoding: Set by user.
2854 * - decoding: Set by libavcodec.
2855 */
2856 enum AVAudioServiceType audio_service_type;
de6d9b64
FB
2857} AVCodecContext;
2858
64863965 2859/**
060ec0a8
AH
2860 * AVProfile.
2861 */
2862typedef struct AVProfile {
2863 int profile;
2864 const char *name; ///< short name for the profile
2865} AVProfile;
2866
2867/**
64863965
MN
2868 * AVCodec.
2869 */
de6d9b64 2870typedef struct AVCodec {
6b0cdb6e
NG
2871 /**
2872 * Name of the codec implementation.
2873 * The name is globally unique among encoders and among decoders (but an
2874 * encoder and a decoder can share the same name).
2875 * This is the primary way to find a codec from the user perspective.
2876 */
18f77016 2877 const char *name;
72415b2a 2878 enum AVMediaType type;
9297ddd3 2879 enum CodecID id;
de6d9b64
FB
2880 int priv_data_size;
2881 int (*init)(AVCodecContext *);
0c1a9eda 2882 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 2883 int (*close)(AVCodecContext *);
7a00bbad 2884 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
a2d11246
MN
2885 /**
2886 * Codec capabilities.
2887 * see CODEC_CAP_*
2888 */
bf89e6b1 2889 int capabilities;
de6d9b64 2890 struct AVCodec *next;
c8cf325a
MN
2891 /**
2892 * Flush buffers.
2893 * Will be called when seeking
2894 */
7a06ff14 2895 void (*flush)(AVCodecContext *);
716e31ea 2896 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
1beb670a 2897 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
fe4bf374 2898 /**
bf7e799c
SS
2899 * Descriptive name for the codec, meant to be more human readable than name.
2900 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
fe4bf374
SS
2901 */
2902 const char *long_name;
3ade5d56 2903 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
5d6e4c16 2904 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
0d72e7d0 2905 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
0fd0ef79 2906 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
567ad0e3 2907 const AVClass *priv_class; ///< AVClass for the private context
060ec0a8 2908 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
37b00b47
AS
2909
2910 /**
2911 * @defgroup framethreading Frame-level threading support functions.
2912 * @{
2913 */
2914 /**
2915 * If defined, called on thread contexts when they are created.
2916 * If the codec allocates writable tables in init(), re-allocate them here.
2917 * priv_data will be set to a copy of the original.
2918 */
2919 int (*init_thread_copy)(AVCodecContext *);
2920 /**
2921 * Copy necessary context variables from a previous thread context to the current one.
2922 * If not defined, the next thread will start automatically; otherwise, the codec
2923 * must call ff_thread_finish_setup().
2924 *
2925 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2926 */
2927 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2928 /** @} */
de6d9b64
FB
2929} AVCodec;
2930
97d96aaa 2931/**
40e5d31b
GB
2932 * AVHWAccel.
2933 */
2934typedef struct AVHWAccel {
2935 /**
2936 * Name of the hardware accelerated codec.
2937 * The name is globally unique among encoders and among decoders (but an
2938 * encoder and a decoder can share the same name).
2939 */
2940 const char *name;
2941
2942 /**
2943 * Type of codec implemented by the hardware accelerator.
2944 *
72415b2a 2945 * See AVMEDIA_TYPE_xxx
40e5d31b 2946 */
72415b2a 2947 enum AVMediaType type;
40e5d31b
GB
2948
2949 /**
2950 * Codec implemented by the hardware accelerator.
2951 *
2952 * See CODEC_ID_xxx
2953 */
2954 enum CodecID id;
2955
2956 /**
2957 * Supported pixel format.
2958 *
2959 * Only hardware accelerated formats are supported here.
2960 */
2961 enum PixelFormat pix_fmt;
2962
2963 /**
2964 * Hardware accelerated codec capabilities.
2965 * see FF_HWACCEL_CODEC_CAP_*
2966 */
2967 int capabilities;
2968
2969 struct AVHWAccel *next;
2970
2971 /**
2972 * Called at the beginning of each frame or field picture.
2973 *
2974 * Meaningful frame information (codec specific) is guaranteed to
2975 * be parsed at this point. This function is mandatory.
2976 *
bf7e799c 2977 * Note that buf can be NULL along with buf_size set to 0.
40e5d31b
GB
2978 * Otherwise, this means the whole frame is available at this point.
2979 *
2980 * @param avctx the codec context
2981 * @param buf the frame data buffer base
2982 * @param buf_size the size of the frame in bytes
2983 * @return zero if successful, a negative value otherwise
2984 */
2985 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2986
2987 /**
2988 * Callback for each slice.
2989 *
2990 * Meaningful slice information (codec specific) is guaranteed to
2991 * be parsed at this point. This function is mandatory.
2992 *
2993 * @param avctx the codec context
2994 * @param buf the slice data buffer base
2995 * @param buf_size the size of the slice in bytes
2996 * @return zero if successful, a negative value otherwise
2997 */
2998 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2999
3000 /**
3001 * Called at the end of each frame or field picture.
3002 *
3003 * The whole picture is parsed at this point and can now be sent
3004 * to the hardware accelerator. This function is mandatory.
3005 *
3006 * @param avctx the codec context
3007 * @return zero if successful, a negative value otherwise
3008 */
3009 int (*end_frame)(AVCodecContext *avctx);
68e5d523
GB
3010
3011 /**
3012 * Size of HW accelerator private data.
3013 *
cd823ff9
GB
3014 * Private data is allocated with av_mallocz() before
3015 * AVCodecContext.get_buffer() and deallocated after
3016 * AVCodecContext.release_buffer().
68e5d523
GB
3017 */
3018 int priv_data_size;
40e5d31b
GB
3019} AVHWAccel;
3020
3021/**
d7425f59
MN
3022 * four components are given, that's all.
3023 * the last component is alpha
3024 */
de6d9b64 3025typedef struct AVPicture {
0c1a9eda 3026 uint8_t *data[4];
cd394651 3027 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
3028} AVPicture;
3029
eda7c983 3030#if FF_API_PALETTE_CONTROL
ba118447 3031/**
85947156
VS
3032 * AVPaletteControl
3033 * This structure defines a method for communicating palette changes
3034 * between and demuxer and a decoder.
3035 *
671adb17 3036 * @deprecated Use AVPacket to send palette changes instead.
85947156 3037 * This is totally broken.
ba118447 3038 */
2e99641b 3039#define AVPALETTE_SIZE 1024
432d84c3 3040#define AVPALETTE_COUNT 256
ba118447
MM
3041typedef struct AVPaletteControl {
3042
f5bccd85
DB
3043 /* Demuxer sets this to 1 to indicate the palette has changed;
3044 * decoder resets to 0. */
ba118447
MM
3045 int palette_changed;
3046
2a2bbcb0
MM
3047 /* 4-byte ARGB palette entries, stored in native byte order; note that
3048 * the individual palette components should be on a 8-bit scale; if
f5bccd85
DB
3049 * the palette data comes from an IBM VGA native format, the component
3050 * data is probably 6 bits in size and needs to be scaled. */
2e99641b 3051 unsigned int palette[AVPALETTE_COUNT];
ba118447 3052
18239edf 3053} AVPaletteControl attribute_deprecated;
2bbd8571 3054#endif
ba118447 3055
c66216ed
MN
3056enum AVSubtitleType {
3057 SUBTITLE_NONE,
3058
3059 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3060
3061 /**
3062 * Plain text, the text field must be set by the decoder and is
3063 * authoritative. ass and pict fields may contain approximations.
3064 */
3065 SUBTITLE_TEXT,
3066
3067 /**
3068 * Formatted text, the ass field must be set by the decoder and is
3069 * authoritative. pict and text fields may contain approximations.
3070 */
3071 SUBTITLE_ASS,
3072};
3073
c6ec28b1 3074typedef struct AVSubtitleRect {
ebc466bb
MN
3075 int x; ///< top left corner of pict, undefined when pict is not set
3076 int y; ///< top left corner of pict, undefined when pict is not set
3077 int w; ///< width of pict, undefined when pict is not set
3078 int h; ///< height of pict, undefined when pict is not set
3079 int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651
MN
3080
3081 /**
3082 * data+linesize for the bitmap of this subtitle.
3083 * can be set for text/ass as well once they where rendered
3084 */
3085 AVPicture pict;
f656106f
MN
3086 enum AVSubtitleType type;
3087
3088 char *text; ///< 0 terminated plain UTF-8 text
3089
3090 /**
3091 * 0 terminated ASS/SSA compatible event line.
3092 * The pressentation of this is unaffected by the other values in this
3093 * struct.
3094 */
3095 char *ass;
c6ec28b1
MN
3096} AVSubtitleRect;
3097
3098typedef struct AVSubtitle {
3099 uint16_t format; /* 0 = graphics */
3100 uint32_t start_display_time; /* relative to packet pts, in ms */
3101 uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb 3102 unsigned num_rects;
db4fac64 3103 AVSubtitleRect **rects;
4bbe788a 3104 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
240c1657
FB
3105} AVSubtitle;
3106
cdd8930e
TB
3107/* packet functions */
3108
80d403fc
RD
3109/**
3110 * @deprecated use NULL instead
3111 */
3112attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
cdd8930e
TB
3113
3114/**
3115 * Default packet destructor.
3116 */
3117void av_destruct_packet(AVPacket *pkt);
3118
3119/**
3120 * Initialize optional fields of a packet with default values.
3121 *
3122 * @param pkt packet
3123 */
3124void av_init_packet(AVPacket *pkt);
3125
3126/**
3127 * Allocate the payload of a packet and initialize its fields with
3128 * default values.
3129 *
3130 * @param pkt packet
3131 * @param size wanted payload size
3132 * @return 0 if OK, AVERROR_xxx otherwise
3133 */
3134int av_new_packet(AVPacket *pkt, int size);
3135
3136/**
feb993e5
RD
3137 * Reduce packet size, correctly zeroing padding
3138 *
3139 * @param pkt packet
3140 * @param size new size
3141 */
3142void av_shrink_packet(AVPacket *pkt, int size);
3143
3144/**
a08d918e
RD
3145 * Increase packet size, correctly zeroing padding
3146 *
3147 * @param pkt packet
3148 * @param grow_by number of bytes by which to increase the size of the packet
3149 */
3150int av_grow_packet(AVPacket *pkt, int grow_by);
3151
3152/**
cdd8930e
TB
3153 * @warning This is a hack - the packet memory allocation stuff is broken. The
3154 * packet is allocated if it was not really allocated.
3155 */
3156int av_dup_packet(AVPacket *pkt);
3157
3158/**
3159 * Free a packet.
3160 *
3161 * @param pkt packet to free
3162 */
ce1d9c85 3163void av_free_packet(AVPacket *pkt);
240c1657 3164
4de339e2
KS
3165/**
3166 * Allocate new information of a packet.
3167 *
3168 * @param pkt packet
3169 * @param type side information type
3170 * @param size side information size
3171 * @return pointer to fresh allocated data or NULL otherwise
3172 */
3173uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3174 int size);
3175
3176/**
3177 * Get side information from packet.
3178 *
3179 * @param pkt packet
3180 * @param type desired side information type
3181 * @param size pointer for side information size to store (optional)
3182 * @return pointer to data if present or NULL otherwise
<