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