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