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