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