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