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