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