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