Added codec id for QCELP.
[libav.git] / libavcodec / avcodec.h
CommitLineData
a96b68b7
FB
1#ifndef AVCODEC_H
2#define AVCODEC_H
3
36df8805
MN
4/**
5 * @file avcodec.h
d33c949c 6 * external api header.
36df8805
MN
7 */
8
9
02d697aa
ZK
10#ifdef __cplusplus
11extern "C" {
12#endif
13
c11c2bc2 14#include "avutil.h"
4b813d5c 15#include <sys/types.h> /* size_t */
de6d9b64 16
bb270c08 17#define AV_STRINGIFY(s) AV_TOSTRING(s)
7b7d86f1 18#define AV_TOSTRING(s) #s
5aa083ee 19
9c050969 20#define LIBAVCODEC_VERSION_INT ((51<<16)+(11<<8)+0)
64db55ae 21#define LIBAVCODEC_VERSION 51.11.0
bb270c08 22#define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
5aa083ee 23
bb270c08 24#define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
ce2749d2 25
bb270c08
DB
26#define AV_NOPTS_VALUE int64_t_C(0x8000000000000000)
27#define AV_TIME_BASE 1000000
28#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
9740beff 29
de6d9b64 30enum CodecID {
115329f1 31 CODEC_ID_NONE,
de6d9b64 32 CODEC_ID_MPEG1VIDEO,
dcedf586 33 CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
fb364ada 34 CODEC_ID_MPEG2VIDEO_XVMC,
c6148de2 35 CODEC_ID_H261,
de6d9b64
FB
36 CODEC_ID_H263,
37 CODEC_ID_RV10,
68b94c35 38 CODEC_ID_RV20,
de6d9b64 39 CODEC_ID_MJPEG,
b135d9fb 40 CODEC_ID_MJPEGB,
b1e6b355 41 CODEC_ID_LJPEG,
5e83dec4 42 CODEC_ID_SP5X,
5639729b 43 CODEC_ID_JPEGLS,
bf89e6b1 44 CODEC_ID_MPEG4,
de6d9b64 45 CODEC_ID_RAWVIDEO,
84afee34
MN
46 CODEC_ID_MSMPEG4V1,
47 CODEC_ID_MSMPEG4V2,
48 CODEC_ID_MSMPEG4V3,
e1a9dbff 49 CODEC_ID_WMV1,
b50eef3a 50 CODEC_ID_WMV2,
de6d9b64
FB
51 CODEC_ID_H263P,
52 CODEC_ID_H263I,
d4f5d74a 53 CODEC_ID_FLV1,
be8ffec9 54 CODEC_ID_SVQ1,
8b82a956 55 CODEC_ID_SVQ3,
020fcc94 56 CODEC_ID_DVVIDEO,
11f18faf 57 CODEC_ID_HUFFYUV,
f70f7c6d 58 CODEC_ID_CYUV,
0da71265 59 CODEC_ID_H264,
deabd4fd 60 CODEC_ID_INDEO3,
d86053a4 61 CODEC_ID_VP3,
f44ee2c3 62 CODEC_ID_THEORA,
3d2e8cce 63 CODEC_ID_ASV1,
9b56edf5 64 CODEC_ID_ASV2,
5e20f836 65 CODEC_ID_FFV1,
e2a7bb28 66 CODEC_ID_4XM,
be3564ed 67 CODEC_ID_VCR1,
3aff069b 68 CODEC_ID_CLJR,
c3bf0288 69 CODEC_ID_MDEC,
3ef8be2b
MM
70 CODEC_ID_ROQ,
71 CODEC_ID_INTERPLAY_VIDEO,
9937e686
MM
72 CODEC_ID_XAN_WC3,
73 CODEC_ID_XAN_WC4,
2fdf638b
MM
74 CODEC_ID_RPZA,
75 CODEC_ID_CINEPAK,
76 CODEC_ID_WS_VQA,
77 CODEC_ID_MSRLE,
78 CODEC_ID_MSVIDEO1,
4120a53a 79 CODEC_ID_IDCIN,
1dc1ed99 80 CODEC_ID_8BPS,
11e29a41 81 CODEC_ID_SMC,
42cad81a 82 CODEC_ID_FLIC,
9a4117d5 83 CODEC_ID_TRUEMOTION1,
fafa0b75 84 CODEC_ID_VMDVIDEO,
a273bbfb
RT
85 CODEC_ID_MSZH,
86 CODEC_ID_ZLIB,
070ed1bc 87 CODEC_ID_QTRLE,
791e7b83 88 CODEC_ID_SNOW,
9d53d58e 89 CODEC_ID_TSCC,
d0a0bbd2 90 CODEC_ID_ULTI,
d08d7142 91 CODEC_ID_QDRAW,
ab711b3c 92 CODEC_ID_VIXL,
acfd8f0f 93 CODEC_ID_QPEG,
17179d2d
MN
94 CODEC_ID_XVID,
95 CODEC_ID_PNG,
96 CODEC_ID_PPM,
97 CODEC_ID_PBM,
98 CODEC_ID_PGM,
99 CODEC_ID_PGMYUV,
100 CODEC_ID_PAM,
f37b9768 101 CODEC_ID_FFVHUFF,
3f05305d
MN
102 CODEC_ID_RV30,
103 CODEC_ID_RV40,
10b9c374 104 CODEC_ID_VC1,
21aa398f 105 CODEC_ID_WMV3,
9c7fb608 106 CODEC_ID_LOCO,
a8a15e9d 107 CODEC_ID_WNV1,
589f8220 108 CODEC_ID_AASC,
856dbbff 109 CODEC_ID_INDEO2,
b81f8949 110 CODEC_ID_FRAPS,
64af6168 111 CODEC_ID_TRUEMOTION2,
9fa62f2a 112 CODEC_ID_BMP,
e0f80bd7 113 CODEC_ID_CSCD,
4e114829 114 CODEC_ID_MMVIDEO,
9c8d8e84 115 CODEC_ID_ZMBV,
26376701 116 CODEC_ID_AVS,
348efc18 117 CODEC_ID_SMACKVIDEO,
dfca23e3 118 CODEC_ID_NUV,
fd7b1991 119 CODEC_ID_KMVC,
0919e788 120 CODEC_ID_FLASHSV,
20ffddb9 121 CODEC_ID_CAVS,
a96b68b7
FB
122
123 /* various pcm "codecs" */
17179d2d 124 CODEC_ID_PCM_S16LE= 0x10000,
a96b68b7
FB
125 CODEC_ID_PCM_S16BE,
126 CODEC_ID_PCM_U16LE,
127 CODEC_ID_PCM_U16BE,
128 CODEC_ID_PCM_S8,
129 CODEC_ID_PCM_U8,
130 CODEC_ID_PCM_MULAW,
131 CODEC_ID_PCM_ALAW,
b461b3bc
RD
132 CODEC_ID_PCM_S32LE,
133 CODEC_ID_PCM_S32BE,
134 CODEC_ID_PCM_U32LE,
135 CODEC_ID_PCM_U32BE,
136 CODEC_ID_PCM_S24LE,
137 CODEC_ID_PCM_S24BE,
138 CODEC_ID_PCM_U24LE,
139 CODEC_ID_PCM_U24BE,
140 CODEC_ID_PCM_S24DAUD,
0147f198
FR
141
142 /* various adpcm codecs */
17179d2d 143 CODEC_ID_ADPCM_IMA_QT= 0x11000,
0147f198 144 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
145 CODEC_ID_ADPCM_IMA_DK3,
146 CODEC_ID_ADPCM_IMA_DK4,
2fdf638b 147 CODEC_ID_ADPCM_IMA_WS,
7d8379f2 148 CODEC_ID_ADPCM_IMA_SMJPEG,
0147f198 149 CODEC_ID_ADPCM_MS,
e2a7bb28 150 CODEC_ID_ADPCM_4XM,
fc384777
MM
151 CODEC_ID_ADPCM_XA,
152 CODEC_ID_ADPCM_ADX,
7d8379f2 153 CODEC_ID_ADPCM_EA,
e5966052 154 CODEC_ID_ADPCM_G726,
b3bfb299 155 CODEC_ID_ADPCM_CT,
659c3692 156 CODEC_ID_ADPCM_SWF,
2ff4524e 157 CODEC_ID_ADPCM_YAMAHA,
2433f24f
AJ
158 CODEC_ID_ADPCM_SBPRO_4,
159 CODEC_ID_ADPCM_SBPRO_3,
160 CODEC_ID_ADPCM_SBPRO_2,
891f64b3 161
17179d2d
MN
162 /* AMR */
163 CODEC_ID_AMR_NB= 0x12000,
d663a1fd
MN
164 CODEC_ID_AMR_WB,
165
b8414bbd 166 /* RealAudio codecs*/
17179d2d 167 CODEC_ID_RA_144= 0x13000,
b8414bbd 168 CODEC_ID_RA_288,
3ef8be2b
MM
169
170 /* various DPCM codecs */
17179d2d 171 CODEC_ID_ROQ_DPCM= 0x14000,
3ef8be2b 172 CODEC_ID_INTERPLAY_DPCM,
9937e686 173 CODEC_ID_XAN_DPCM,
d08d7142 174 CODEC_ID_SOL_DPCM,
115329f1 175
17179d2d
MN
176 CODEC_ID_MP2= 0x15000,
177 CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
178 CODEC_ID_AAC,
179 CODEC_ID_MPEG4AAC,
180 CODEC_ID_AC3,
181 CODEC_ID_DTS,
182 CODEC_ID_VORBIS,
183 CODEC_ID_DVAUDIO,
184 CODEC_ID_WMAV1,
185 CODEC_ID_WMAV2,
186 CODEC_ID_MACE3,
187 CODEC_ID_MACE6,
188 CODEC_ID_VMDAUDIO,
189 CODEC_ID_SONIC,
190 CODEC_ID_SONIC_LS,
ac2570a8 191 CODEC_ID_FLAC,
1ede228a 192 CODEC_ID_MP3ADU,
d2a7718d 193 CODEC_ID_MP3ON4,
85ad5695 194 CODEC_ID_SHORTEN,
5df8a0c6 195 CODEC_ID_ALAC,
034eeaa1 196 CODEC_ID_WESTWOOD_SND1,
115329f1 197 CODEC_ID_GSM,
d9b1c197 198 CODEC_ID_QDM2,
e0f7e329 199 CODEC_ID_COOK,
bf3027c8 200 CODEC_ID_TRUESPEECH,
a24c4a2a 201 CODEC_ID_TTA,
348efc18 202 CODEC_ID_SMACKAUDIO,
6c496518 203 CODEC_ID_QCELP,
115329f1 204
240c1657 205 /* subtitle codecs */
115329f1
DB
206 CODEC_ID_DVD_SUBTITLE= 0x17000,
207 CODEC_ID_DVB_SUBTITLE,
208
17179d2d 209 CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
985180a1 210 stream (only used by libavformat) */
de6d9b64 211};
dcedf586
FB
212
213/* CODEC_ID_MP3LAME is absolete */
214#define CODEC_ID_MP3LAME CODEC_ID_MP3
de6d9b64
FB
215
216enum CodecType {
4a663d80 217 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
218 CODEC_TYPE_VIDEO,
219 CODEC_TYPE_AUDIO,
985180a1 220 CODEC_TYPE_DATA,
240c1657 221 CODEC_TYPE_SUBTITLE,
de6d9b64
FB
222};
223
a96b68b7 224/* currently unused, may be used if 24/32 bits samples ever supported */
1319a77b 225/* all in native endian */
a96b68b7 226enum SampleFormat {
9076fee4 227 SAMPLE_FMT_NONE = -1,
1319a77b
AB
228 SAMPLE_FMT_U8, ///< unsigned 8 bits
229 SAMPLE_FMT_S16, ///< signed 16 bits
230 SAMPLE_FMT_S24, ///< signed 24 bits
115329f1 231 SAMPLE_FMT_S32, ///< signed 32 bits
a3a5f4d6 232 SAMPLE_FMT_FLT, ///< float
a96b68b7
FB
233};
234
de6d9b64 235/* in bytes */
8170e5fb 236#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
de6d9b64 237
d7425f59 238/**
cf713bb8 239 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
115329f1 240 * this is mainly needed because some optimized bitstream readers read
cf713bb8
MN
241 * 32 or 64 bit at once and could read over the end<br>
242 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
243 * MPEG bitstreams could cause overread and segfault
d7425f59
MN
244 */
245#define FF_INPUT_BUFFER_PADDING_SIZE 8
246
0ecca7a4
MN
247/**
248 * minimum encoding buffer size.
249 * used to avoid some checks during header writing
250 */
251#define FF_MIN_BUFFER_SIZE 16384
252
e4986da9
J
253/* motion estimation type, EPZS by default */
254enum Motion_Est_ID {
101bea5f 255 ME_ZERO = 1,
e4986da9
J
256 ME_FULL,
257 ME_LOG,
258 ME_PHODS,
259 ME_EPZS,
51d6a3cf
MN
260 ME_X1,
261 ME_HEX,
262 ME_UMH,
263 ME_ITER,
e4986da9
J
264};
265
8c3eba7c
MN
266enum AVDiscard{
267//we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
268 AVDISCARD_NONE =-16, ///< discard nothing
269 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
270 AVDISCARD_NONREF = 8, ///< discard all non reference
271 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
272 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
273 AVDISCARD_ALL = 48, ///< discard all
274};
275
ce980a95
MN
276typedef struct RcOverride{
277 int start_frame;
278 int end_frame;
279 int qscale; // if this is 0 then quality_factor will be used instead
280 float quality_factor;
281} RcOverride;
282
b0ec9efd 283#define FF_MAX_B_FRAMES 16
9dbcbd92 284
a949d72e 285/* encoding support
115329f1 286 these flags can be passed in AVCodecContext.flags before initing
bb628dae 287 Note: not everything is supported yet.
a949d72e 288*/
de6d9b64 289
115329f1 290#define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
dba019da 291#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / Advanced prediction for H263
115329f1
DB
292#define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
293#define CODEC_FLAG_GMC 0x0020 ///< use GMC
294#define CODEC_FLAG_MV0 0x0040 ///< always try a MB with MV=<0,0>
295#define CODEC_FLAG_PART 0x0080 ///< use data partitioning
296/* parent program gurantees that the input for b-frame containing streams is not written to
9dbcbd92 297 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 298#define CODEC_FLAG_INPUT_PRESERVED 0x0100
115329f1
DB
299#define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
300#define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
301#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
302#define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
bb628dae 303#define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
115329f1
DB
304#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
305#define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
d7425f59 306 of only at frame boundaries */
115329f1
DB
307#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
308#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
3bb07d61 309#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay
115329f1
DB
310#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
311#define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
312#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
313#define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
21e59552 314/* Fx : Flag for h263+ extra options */
8d8c0294
MN
315#define CODEC_FLAG_H263P_AIC 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
316#define CODEC_FLAG_AC_PRED 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
115329f1 317#define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
f2f6134b 318#define CODEC_FLAG_CBP_RD 0x04000000 ///< use rate distortion optimization for cbp
1f26c6f3 319#define CODEC_FLAG_QP_RD 0x08000000 ///< use rate distortion optimization for qp selectioon
dba019da 320#define CODEC_FLAG_H263P_AIV 0x00000008 ///< H263 Alternative inter vlc
332f9ac4
MN
321#define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
322#define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
bb198e19
MN
323#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
324#define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
baaf3f46 325#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
f2cf4a6b 326#define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
6fc5b059 327#define CODEC_FLAG2_FAST 0x00000001 ///< allow non spec compliant speedup tricks
03581772 328#define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< strictly enforce GOP size
09b0499f 329#define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< skip bitstream encoding
90ad92b3 330#define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< place global headers at every keyframe instead of in extradata
58f7833e
RS
331#define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow b-frames to be used as references
332#define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for b-frames
333#define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 multiple references per partition
334#define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
335#define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
336#define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
337#define CODEC_FLAG2_BRDO 0x00000400 ///< b-frame rate-distortion optimization
307eb248 338#define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< use MPEG-2 intra VLC table
086bfd25 339#define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< only do ME/MC (I frames -> ref, P frame -> ME+MC)
6fc5b059 340
21e59552 341/* Unsupported options :
bb270c08
DB
342 * Syntax Arithmetic coding (SAC)
343 * Reference Picture Selection
344 * Independant Segment Decoding */
21e59552 345/* /Fx */
bf89e6b1
FB
346/* codec capabilities */
347
115329f1 348#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
6814a25c
MN
349/**
350 * Codec uses get_buffer() for allocating buffers.
351 * direct rendering method 1
352 */
353#define CODEC_CAP_DR1 0x0002
917e06c8
FB
354/* if 'parse_only' field is true, then avcodec_parse_frame() can be
355 used */
356#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 357#define CODEC_CAP_TRUNCATED 0x0008
5e5c247a
IK
358/* codec can export data for HW decoding (XvMC) */
359#define CODEC_CAP_HWACCEL 0x0010
115329f1 360/**
934982c4
MN
361 * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
362 * if this is not set, the codec is guranteed to never be feeded with NULL data
363 */
6f824977 364#define CODEC_CAP_DELAY 0x0020
cef7cc72
JR
365/**
366 * Codec can be fed a final frame with a smaller size.
367 * This can be used to prevent truncation of the last audio samples.
368 */
369#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
bf89e6b1 370
bb628dae 371//the following defines may change, don't expect compatibility if you use them
8d7ec294
WH
372#define MB_TYPE_INTRA4x4 0x0001
373#define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
374#define MB_TYPE_INTRA_PCM 0x0004 //FIXME h264 specific
375#define MB_TYPE_16x16 0x0008
376#define MB_TYPE_16x8 0x0010
377#define MB_TYPE_8x16 0x0020
378#define MB_TYPE_8x8 0x0040
379#define MB_TYPE_INTERLACED 0x0080
380#define MB_TYPE_DIRECT2 0x0100 //FIXME
381#define MB_TYPE_ACPRED 0x0200
382#define MB_TYPE_GMC 0x0400
383#define MB_TYPE_SKIP 0x0800
384#define MB_TYPE_P0L0 0x1000
385#define MB_TYPE_P1L0 0x2000
386#define MB_TYPE_P0L1 0x4000
387#define MB_TYPE_P1L1 0x8000
388#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
389#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
390#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
391#define MB_TYPE_QUANT 0x00010000
392#define MB_TYPE_CBP 0x00020000
393//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
394
fa384dcc
MN
395/**
396 * Pan Scan area.
397 * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
398 */
399typedef struct AVPanScan{
400 /**
401 * id.
402 * - encoding: set by user.
403 * - decoding: set by lavc
404 */
405 int id;
406
407 /**
408 * width and height in 1/16 pel
409 * - encoding: set by user.
410 * - decoding: set by lavc
411 */
412 int width;
413 int height;
414
415 /**
416 * position of the top left corner in 1/16 pel for up to 3 fields/frames.
417 * - encoding: set by user.
418 * - decoding: set by lavc
419 */
420 int16_t position[3][2];
421}AVPanScan;
422
492cd3a9 423#define FF_COMMON_FRAME \
b536d0aa
MN
424 /**\
425 * pointer to the picture planes.\
426 * this might be different from the first allocated byte\
427 * - encoding: \
428 * - decoding: \
429 */\
1e491e29
MN
430 uint8_t *data[4];\
431 int linesize[4];\
432 /**\
32db2b1d 433 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
bb628dae 434 * this isn't used by lavc unless the default get/release_buffer() is used\
64863965
MN
435 * - encoding: \
436 * - decoding: \
1e491e29
MN
437 */\
438 uint8_t *base[4];\
439 /**\
440 * 1 -> keyframe, 0-> not\
64863965
MN
441 * - encoding: set by lavc\
442 * - decoding: set by lavc\
1e491e29
MN
443 */\
444 int key_frame;\
445\
446 /**\
0da71265 447 * picture type of the frame, see ?_TYPE below.\
64863965
MN
448 * - encoding: set by lavc for coded_picture (and set by user for input)\
449 * - decoding: set by lavc\
1e491e29
MN
450 */\
451 int pict_type;\
452\
453 /**\
c0df9d75
MN
454 * presentation timestamp in time_base units (time when frame should be shown to user)\
455 * if AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed\
64863965
MN
456 * - encoding: MUST be set by user\
457 * - decoding: set by lavc\
1e491e29 458 */\
be6784dc 459 int64_t pts;\
1e491e29
MN
460\
461 /**\
462 * picture number in bitstream order.\
64863965
MN
463 * - encoding: set by\
464 * - decoding: set by lavc\
1e491e29
MN
465 */\
466 int coded_picture_number;\
467 /**\
1e491e29 468 * picture number in display order.\
64863965
MN
469 * - encoding: set by\
470 * - decoding: set by lavc\
1e491e29
MN
471 */\
472 int display_picture_number;\
473\
474 /**\
158c7f05 475 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
64863965
MN
476 * - encoding: set by lavc for coded_picture (and set by user for input)\
477 * - decoding: set by lavc\
1e491e29 478 */\
158c7f05 479 int quality; \
1e491e29
MN
480\
481 /**\
482 * buffer age (1->was last buffer and dint change, 2->..., ...).\
158c7f05 483 * set to INT_MAX if the buffer has not been used yet \
64863965
MN
484 * - encoding: unused\
485 * - decoding: MUST be set by get_buffer()\
1e491e29
MN
486 */\
487 int age;\
488\
489 /**\
490 * is this picture used as reference\
64863965
MN
491 * - encoding: unused\
492 * - decoding: set by lavc (before get_buffer() call))\
1e491e29
MN
493 */\
494 int reference;\
495\
496 /**\
497 * QP table\
64863965
MN
498 * - encoding: unused\
499 * - decoding: set by lavc\
1e491e29
MN
500 */\
501 int8_t *qscale_table;\
502 /**\
503 * QP store stride\
64863965
MN
504 * - encoding: unused\
505 * - decoding: set by lavc\
1e491e29
MN
506 */\
507 int qstride;\
508\
509 /**\
510 * mbskip_table[mb]>=1 if MB didnt change\
511 * stride= mb_width = (width+15)>>4\
64863965
MN
512 * - encoding: unused\
513 * - decoding: set by lavc\
1e491e29
MN
514 */\
515 uint8_t *mbskip_table;\
516\
517 /**\
61436073
MN
518 * Motion vector table.\
519 * @code\
520 * example:\
521 * int mv_sample_log2= 4 - motion_subsample_log2;\
522 * int mb_width= (width+15)>>4;\
523 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
524 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
525 * @endcode\
a4d36c11 526 * - encoding: set by user\
8d7ec294
WH
527 * - decoding: set by lavc\
528 */\
529 int16_t (*motion_val[2])[2];\
530\
531 /**\
532 * Macroblock type table\
533 * mb_type_base + mb_width + 2\
a4d36c11 534 * - encoding: set by user\
8d7ec294
WH
535 * - decoding: set by lavc\
536 */\
537 uint32_t *mb_type;\
538\
539 /**\
f0b77c69
MN
540 * log2 of the size of the block which a single vector in motion_val represents: \
541 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
8d7ec294
WH
542 * - encoding: unused\
543 * - decoding: set by lavc\
544 */\
545 uint8_t motion_subsample_log2;\
546\
547 /**\
1e491e29 548 * for some private data of the user\
64863965
MN
549 * - encoding: unused\
550 * - decoding: set by user\
1e491e29
MN
551 */\
552 void *opaque;\
140cb663
MN
553\
554 /**\
555 * error\
64863965
MN
556 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
557 * - decoding: unused\
140cb663
MN
558 */\
559 uint64_t error[4];\
4e00e76b
MN
560\
561 /**\
562 * type of the buffer (to keep track of who has to dealloc data[*])\
64863965
MN
563 * - encoding: set by the one who allocs it\
564 * - decoding: set by the one who allocs it\
3db320ea 565 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
4e00e76b
MN
566 */\
567 int type;\
2ec23b6d
MN
568 \
569 /**\
570 * when decoding, this signal how much the picture must be delayed.\
571 * extra_delay = repeat_pict / (2*fps)\
64863965
MN
572 * - encoding: unused\
573 * - decoding: set by lavc\
2ec23b6d 574 */\
0426af31
MN
575 int repeat_pict;\
576 \
577 /**\
578 * \
579 */\
580 int qscale_type;\
2744ca9a
RS
581 \
582 /**\
583 * The content of the picture is interlaced.\
584 * - encoding: set by user\
585 * - decoding: set by lavc (default 0)\
586 */\
587 int interlaced_frame;\
588 \
589 /**\
9dad924e 590 * if the content is interlaced, is top field displayed first.\
2744ca9a 591 * - encoding: set by user\
9dad924e 592 * - decoding: set by lavc\
2744ca9a 593 */\
9dad924e 594 int top_field_first;\
fa384dcc
MN
595 \
596 /**\
597 * Pan scan.\
598 * - encoding: set by user\
599 * - decoding: set by lavc\
600 */\
601 AVPanScan *pan_scan;\
2a2bbcb0
MM
602 \
603 /**\
604 * tell user application that palette has changed from previous frame.\
605 * - encoding: ??? (no palette-enabled encoder yet)\
606 * - decoding: set by lavc (default 0)\
607 */\
608 int palette_has_changed;\
074c4ca7
RT
609 \
610 /**\
611 * Codec suggestion on buffer type if != 0\
612 * - encoding: unused\
613 * - decoding: set by lavc (before get_buffer() call))\
614 */\
615 int buffer_hints;\
8289c6fa
WH
616\
617 /**\
618 * DCT coeffitients\
619 * - encoding: unused\
620 * - decoding: set by lavc\
621 */\
622 short *dct_coeff;\
a4d36c11
MN
623\
624 /**\
625 * Motion referece frame index\
626 * - encoding: set by user\
627 * - decoding: set by lavc\
628 */\
629 int8_t *ref_index[2];
2ec23b6d 630
bb270c08
DB
631#define FF_QSCALE_TYPE_MPEG1 0
632#define FF_QSCALE_TYPE_MPEG2 1
633#define FF_QSCALE_TYPE_H264 2
4e00e76b
MN
634
635#define FF_BUFFER_TYPE_INTERNAL 1
9b56edf5 636#define FF_BUFFER_TYPE_USER 2 ///< Direct rendering buffers (image is (de)allocated by user)
bb628dae
DB
637#define FF_BUFFER_TYPE_SHARED 4 ///< buffer from somewhere else, don't dealloc image (data/base), all other tables are not shared
638#define FF_BUFFER_TYPE_COPY 8 ///< just a (modified) copy of some other buffer, don't dealloc anything
4e00e76b 639
1e491e29 640
140cb663
MN
641#define FF_I_TYPE 1 // Intra
642#define FF_P_TYPE 2 // Predicted
643#define FF_B_TYPE 3 // Bi-dir predicted
644#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
0da71265
MN
645#define FF_SI_TYPE 5
646#define FF_SP_TYPE 6
1e491e29 647
074c4ca7
RT
648#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore)
649#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer
650#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content
651#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update)
652
0da71265
MN
653/**
654 * Audio Video Frame.
655 */
492cd3a9
MN
656typedef struct AVFrame {
657 FF_COMMON_FRAME
658} AVFrame;
1e491e29 659
14bea432 660#define DEFAULT_FRAME_RATE_BASE 1001000
d33c949c
MN
661
662/**
663 * main external api structure.
664 */
de6d9b64 665typedef struct AVCodecContext {
b71901e6 666 /**
bc874dae
MB
667 * Info on struct for av_log
668 * - set by avcodec_alloc_context
669 */
43465395 670 AVClass *av_class;
bc874dae 671 /**
64863965
MN
672 * the average bitrate.
673 * - encoding: set by user. unused for constant quantizer encoding
115329f1 674 * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
b71901e6 675 */
de6d9b64 676 int bit_rate;
b71901e6
MN
677
678 /**
64863965 679 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 680 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
64863965
MN
681 * - encoding: set by user. unused for constant quantizer encoding
682 * - decoding: unused
b71901e6 683 */
115329f1 684 int bit_rate_tolerance;
b71901e6
MN
685
686 /**
64863965
MN
687 * CODEC_FLAG_*.
688 * - encoding: set by user.
689 * - decoding: set by user.
b71901e6 690 */
de6d9b64 691 int flags;
b71901e6
MN
692
693 /**
694 * some codecs needs additionnal format info. It is stored here
115329f1 695 * - encoding: set by user.
64863965 696 * - decoding: set by lavc. (FIXME is this ok?)
b71901e6
MN
697 */
698 int sub_id;
699
700 /**
64863965 701 * motion estimation algorithm used for video coding.
58f7833e
RS
702 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
703 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
64863965
MN
704 * - encoding: MUST be set by user.
705 * - decoding: unused
b71901e6
MN
706 */
707 int me_method;
708
709 /**
64863965 710 * some codecs need / can use extra-data like huffman tables.
b71901e6
MN
711 * mjpeg: huffman tables
712 * rv10: additional flags
b704e742 713 * mpeg4: global headers (they can be in the bitstream or here)
dffcdbb5
MN
714 * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
715 * then extradata_size to avoid prolems if its read with the bitstream reader
ed57bb79 716 * the bytewise contents of extradata must not depend on the architecture or cpu endianness
64863965
MN
717 * - encoding: set/allocated/freed by lavc.
718 * - decoding: set/allocated/freed by user.
b71901e6 719 */
e84c31dc
A
720 void *extradata;
721 int extradata_size;
115329f1 722
b71901e6 723 /**
5b28c8c3
MN
724 * this is the fundamental unit of time (in seconds) in terms
725 * of which frame timestamps are represented. for fixed-fps content,
726 * timebase should be 1/framerate and timestamp increments should be
727 * identically 1.
64863965 728 * - encoding: MUST be set by user
c0df9d75 729 * - decoding: set by lavc.
b71901e6 730 */
c0df9d75 731 AVRational time_base;
115329f1 732
5b28c8c3 733 /* video only */
14bea432 734 /**
21adafec 735 * picture width / height.
115329f1 736 * - encoding: MUST be set by user.
21adafec 737 * - decoding: set by lavc.
115329f1 738 * Note, for compatibility its possible to set this instead of
21adafec 739 * coded_width/height before decoding
b71901e6 740 */
de6d9b64 741 int width, height;
115329f1 742
e769f053 743#define FF_ASPECT_EXTENDED 15
b71901e6
MN
744
745 /**
64863965
MN
746 * the number of pictures in a group of pitures, or 0 for intra_only.
747 * - encoding: set by user.
748 * - decoding: unused
b71901e6
MN
749 */
750 int gop_size;
751
752 /**
64863965 753 * pixel format, see PIX_FMT_xxx.
a3a5f4d6 754 * - encoding: set by user.
64863965 755 * - decoding: set by lavc.
b71901e6 756 */
e4eadb4b 757 enum PixelFormat pix_fmt;
115329f1 758
bdfcbbed 759 /**
115329f1 760 * Frame rate emulation. If not zero lower layer (i.e. format handler)
bdfcbbed
MK
761 * has to read frames at native frame rate.
762 * - encoding: set by user.
763 * - decoding: unused.
764 */
765 int rate_emu;
115329f1 766
b71901e6
MN
767 /**
768 * if non NULL, 'draw_horiz_band' is called by the libavcodec
769 * decoder to draw an horizontal band. It improve cache usage. Not
770 * all codecs can do that. You must check the codec capabilities
771 * before
64863965
MN
772 * - encoding: unused
773 * - decoding: set by user.
3bb07d61
MN
774 * @param height the height of the slice
775 * @param y the y position of the slice
776 * @param type 1->top field, 2->bottom field, 3->frame
777 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 778 */
bf89e6b1 779 void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3 780 const AVFrame *src, int offset[4],
3bb07d61 781 int y, int type, int height);
bf89e6b1 782
de6d9b64 783 /* audio only */
115329f1 784 int sample_rate; ///< samples per sec
de6d9b64 785 int channels;
a3a5f4d6
MN
786
787 /**
788 * audio sample format.
789 * - encoding: set by user.
790 * - decoding: set by lavc.
791 */
115329f1 792 enum SampleFormat sample_fmt; ///< sample format, currenly unused
de6d9b64
FB
793
794 /* the following data should not be initialized */
718b27a7 795 /**
115329f1 796 * samples per packet. initialized when calling 'init'
718b27a7
MN
797 */
798 int frame_size;
115329f1
DB
799 int frame_number; ///< audio or video frame number
800 int real_pict_num; ///< returns the real picture number of previous encoded frame
801
b71901e6 802 /**
115329f1 803 * number of frames the decoded output will be delayed relative to
64863965
MN
804 * the encoded input.
805 * - encoding: set by lavc.
806 * - decoding: unused
b71901e6
MN
807 */
808 int delay;
115329f1 809
64863965
MN
810 /* - encoding parameters */
811 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
115329f1
DB
812 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
813
b71901e6 814 /**
64863965
MN
815 * minimum quantizer.
816 * - encoding: set by user.
817 * - decoding: unused
b71901e6
MN
818 */
819 int qmin;
820
821 /**
64863965
MN
822 * maximum quantizer.
823 * - encoding: set by user.
824 * - decoding: unused
b71901e6
MN
825 */
826 int qmax;
827
828 /**
64863965
MN
829 * maximum quantizer difference etween frames.
830 * - encoding: set by user.
831 * - decoding: unused
b71901e6
MN
832 */
833 int max_qdiff;
834
835 /**
64863965 836 * maximum number of b frames between non b frames.
b71901e6 837 * note: the output will be delayed by max_b_frames+1 relative to the input
64863965
MN
838 * - encoding: set by user.
839 * - decoding: unused
b71901e6
MN
840 */
841 int max_b_frames;
842
843 /**
64863965
MN
844 * qscale factor between ip and b frames.
845 * - encoding: set by user.
846 * - decoding: unused
b71901e6
MN
847 */
848 float b_quant_factor;
115329f1 849
b71901e6
MN
850 /** obsolete FIXME remove */
851 int rc_strategy;
64b7c5b6
MN
852#define FF_RC_STRATEGY_XVID 1
853
8b4c7dbc 854 int b_frame_strategy;
9dbcbd92 855
b71901e6 856 /**
64863965 857 * hurry up amount.
8c3eba7c 858 * deprecated in favor of skip_idct and skip_frame
64863965
MN
859 * - encoding: unused
860 * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
b71901e6
MN
861 */
862 int hurry_up;
115329f1 863
de6d9b64 864 struct AVCodec *codec;
115329f1 865
de6d9b64
FB
866 void *priv_data;
867
ba58dabc
MN
868 /* unused, FIXME remove*/
869 int rtp_mode;
115329f1 870
bb628dae 871 int rtp_payload_size; /* The size of the RTP payload: the coder will */
644d98a4
J
872 /* do it's best to deliver a chunk with size */
873 /* below rtp_payload_size, the chunk will start */
874 /* with a start code on some codecs like H.263 */
875 /* This doesn't take account of any particular */
876 /* headers inside the transmited RTP payload */
81401c1f 877
115329f1 878
bb628dae
DB
879 /* The RTP callback: This function is called */
880 /* every time the encoder has a packet to send */
881 /* Depends on the encoder if the data starts */
882 /* with a Start Code (it should) H.263 does. */
883 /* mb_nb contains the number of macroblocks */
884 /* encoded in the RTP payload */
115329f1 885 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
81401c1f 886
098eefe1
MN
887 /* statistics, used for 2-pass encoding */
888 int mv_bits;
889 int header_bits;
890 int i_tex_bits;
891 int p_tex_bits;
892 int i_count;
893 int p_count;
894 int skip_count;
b71901e6 895 int misc_bits;
115329f1 896
b71901e6 897 /**
64863965
MN
898 * number of bits used for the previously encoded frame.
899 * - encoding: set by lavc
7004ffb3 900 * - decoding: unused
b71901e6 901 */
098eefe1 902 int frame_bits;
7004ffb3 903
b71901e6 904 /**
64863965
MN
905 * private data of the user, can be used to carry app specific stuff.
906 * - encoding: set by user
907 * - decoding: set by user
b71901e6
MN
908 */
909 void *opaque;
910
de6d9b64 911 char codec_name[32];
4a663d80
PG
912 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
913 enum CodecID codec_id; /* see CODEC_ID_xxx */
115329f1 914
7004ffb3
MN
915 /**
916 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
917 * this is used to workaround some encoder bugs
bd5a6020 918 * - encoding: set by user, if not then the default based on codec_id will be used
7004ffb3
MN
919 * - decoding: set by user, will be converted to upper case by lavc during init
920 */
921 unsigned int codec_tag;
115329f1 922
b71901e6 923 /**
64863965 924 * workaround bugs in encoders which sometimes cannot be detected automatically.
59fa3f96 925 * - encoding: set by user
64863965 926 * - decoding: set by user
b71901e6
MN
927 */
928 int workaround_bugs;
64863965 929#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
930#define FF_BUG_OLD_MSMPEG4 2
931#define FF_BUG_XVID_ILACE 4
932#define FF_BUG_UMP4 8
933#define FF_BUG_NO_PADDING 16
3116cb14 934#define FF_BUG_AMV 32
ac0c6638 935#define FF_BUG_AC_VLC 0 ///< will be removed, libavcodec can now handle these non compliant files by default
03e93d35 936#define FF_BUG_QPEL_CHROMA 64
db794953 937#define FF_BUG_STD_QPEL 128
36df8805 938#define FF_BUG_QPEL_CHROMA2 256
c40c3482 939#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 940#define FF_BUG_EDGE 1024
b44bdf7e 941#define FF_BUG_HPEL_CHROMA 2048
4ccde216 942#define FF_BUG_DC_CLIP 4096
59fa3f96 943#define FF_BUG_MS 8192 ///< workaround various bugs in microsofts broken decoders
4d2858de 944//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
115329f1 945
b71901e6 946 /**
64863965
MN
947 * luma single coeff elimination threshold.
948 * - encoding: set by user
949 * - decoding: unused
b71901e6 950 */
1f6b6e50 951 int luma_elim_threshold;
115329f1 952
b71901e6 953 /**
64863965
MN
954 * chroma single coeff elimination threshold.
955 * - encoding: set by user
956 * - decoding: unused
b71901e6 957 */
1f6b6e50 958 int chroma_elim_threshold;
115329f1 959
b71901e6 960 /**
64863965
MN
961 * strictly follow the std (MPEG4, ...).
962 * - encoding: set by user
963 * - decoding: unused
b71901e6
MN
964 */
965 int strict_std_compliance;
9cd81798
MN
966#define FF_COMPLIANCE_VERY_STRICT 2 ///< strictly conform to a older more strict version of the spec or reference software
967#define FF_COMPLIANCE_STRICT 1 ///< strictly conform to all the things in the spec no matter what consequences
968#define FF_COMPLIANCE_NORMAL 0
969#define FF_COMPLIANCE_INOFFICIAL -1 ///< allow inofficial extensions
970#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< allow non standarized experimental things
971
b71901e6 972 /**
64863965 973 * qscale offset between ip and b frames.
b3a391e8
MN
974 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
975 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
976 * - encoding: set by user.
977 * - decoding: unused
b71901e6
MN
978 */
979 float b_quant_offset;
115329f1 980
b71901e6 981 /**
ce3bcaed 982 * error resilience higher values will detect more errors but may missdetect
64863965
MN
983 * some more or less valid parts as errors.
984 * - encoding: unused
985 * - decoding: set by user
b71901e6 986 */
1f6b6e50 987 int error_resilience;
1471c6c2 988#define FF_ER_CAREFUL 1
ce3bcaed
MN
989#define FF_ER_COMPLIANT 2
990#define FF_ER_AGGRESSIVE 3
991#define FF_ER_VERY_AGGRESSIVE 4
115329f1 992
6b72ac63 993 /**
1e491e29
MN
994 * called at the beginning of each frame to get a buffer for it.
995 * if pic.reference is set then the frame will be read later by lavc
2b5296d2
MN
996 * avcodec_align_dimensions() should be used to find the required width and
997 * height, as they normally need to be rounded up to the next multiple of 16
64863965
MN
998 * - encoding: unused
999 * - decoding: set by lavc, user can override
b71901e6 1000 */
492cd3a9 1001 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1 1002
b71901e6 1003 /**
1e491e29
MN
1004 * called to release buffers which where allocated with get_buffer.
1005 * a released buffer can be reused in get_buffer()
1006 * pic.data[*] must be set to NULL
64863965
MN
1007 * - encoding: unused
1008 * - decoding: set by lavc, user can override
b71901e6 1009 */
492cd3a9 1010 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 1011
b71901e6 1012 /**
e6a2ac34
MN
1013 * if 1 the stream has a 1 frame delay during decoding.
1014 * - encoding: set by lavc
64863965 1015 * - decoding: set by lavc
b71901e6
MN
1016 */
1017 int has_b_frames;
718b27a7
MN
1018
1019 /**
1020 * number of bytes per packet if constant and known or 0
1021 * used by some WAV based audio codecs
1022 */
1023 int block_align;
115329f1 1024
64863965 1025 int parse_only; /* - decoding only: if true, only parsing is done
917e06c8
FB
1026 (function avcodec_parse_frame()). The frame
1027 data is returned. Only MPEG codecs support this now. */
115329f1 1028
b71901e6 1029 /**
e4eadb4b 1030 * 0-> h263 quant 1-> mpeg quant.
64863965
MN
1031 * - encoding: set by user.
1032 * - decoding: unused
b71901e6
MN
1033 */
1034 int mpeg_quant;
115329f1 1035
b71901e6 1036 /**
64863965
MN
1037 * pass1 encoding statistics output buffer.
1038 * - encoding: set by lavc
1039 * - decoding: unused
b71901e6 1040 */
64863965 1041 char *stats_out;
115329f1 1042
b71901e6
MN
1043 /**
1044 * pass2 encoding statistics input buffer.
1045 * concatenated stuff from stats_out of pass1 should be placed here
64863965
MN
1046 * - encoding: allocated/set/freed by user
1047 * - decoding: unused
b71901e6
MN
1048 */
1049 char *stats_in;
115329f1 1050
b71901e6 1051 /**
64863965 1052 * ratecontrol qmin qmax limiting method.
b71901e6 1053 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
64863965
MN
1054 * - encoding: set by user.
1055 * - decoding: unused
b71901e6 1056 */
ce980a95 1057 float rc_qsquish;
b71901e6 1058
ce980a95
MN
1059 float rc_qmod_amp;
1060 int rc_qmod_freq;
115329f1 1061
b71901e6 1062 /**
64863965
MN
1063 * ratecontrol override, see RcOverride.
1064 * - encoding: allocated/set/freed by user.
1065 * - decoding: unused
b71901e6 1066 */
ce980a95
MN
1067 RcOverride *rc_override;
1068 int rc_override_count;
115329f1 1069
b71901e6 1070 /**
64863965
MN
1071 * rate control equation.
1072 * - encoding: set by user
1073 * - decoding: unused
b71901e6 1074 */
ce980a95 1075 char *rc_eq;
115329f1 1076
b71901e6 1077 /**
64863965
MN
1078 * maximum bitrate.
1079 * - encoding: set by user.
1080 * - decoding: unused
b71901e6 1081 */
ce980a95 1082 int rc_max_rate;
115329f1 1083
b71901e6 1084 /**
64863965
MN
1085 * minimum bitrate.
1086 * - encoding: set by user.
1087 * - decoding: unused
b71901e6 1088 */
ce980a95 1089 int rc_min_rate;
115329f1 1090
b71901e6 1091 /**
64863965
MN
1092 * decoder bitstream buffer size.
1093 * - encoding: set by user.
1094 * - decoding: unused
b71901e6 1095 */
ce980a95
MN
1096 int rc_buffer_size;
1097 float rc_buffer_aggressivity;
b71901e6
MN
1098
1099 /**
64863965 1100 * qscale factor between p and i frames.
a1e257b2
MN
1101 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
1102 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
1103 * - encoding: set by user.
1104 * - decoding: unused
b71901e6
MN
1105 */
1106 float i_quant_factor;
115329f1 1107
b71901e6 1108 /**
64863965 1109 * qscale offset between p and i frames.
64863965
MN
1110 * - encoding: set by user.
1111 * - decoding: unused
b71901e6
MN
1112 */
1113 float i_quant_offset;
115329f1 1114
b71901e6 1115 /**
64863965
MN
1116 * initial complexity for pass1 ratecontrol.
1117 * - encoding: set by user.
1118 * - decoding: unused
b71901e6 1119 */
ce980a95 1120 float rc_initial_cplx;
917e06c8 1121
b71901e6 1122 /**
64863965
MN
1123 * dct algorithm, see FF_DCT_* below.
1124 * - encoding: set by user
1125 * - decoding: unused
b71901e6 1126 */
28db7fce 1127 int dct_algo;
c7e07931 1128#define FF_DCT_AUTO 0
28db7fce 1129#define FF_DCT_FASTINT 1
c7e07931
MO
1130#define FF_DCT_INT 2
1131#define FF_DCT_MMX 3
1132#define FF_DCT_MLIB 4
05c4072b 1133#define FF_DCT_ALTIVEC 5
65e4c8c9 1134#define FF_DCT_FAAN 6
115329f1 1135
c5d309f2 1136 /**
64863965
MN
1137 * luminance masking (0-> disabled).
1138 * - encoding: set by user
1139 * - decoding: unused
c5d309f2
MN
1140 */
1141 float lumi_masking;
115329f1 1142
c5d309f2 1143 /**
64863965
MN
1144 * temporary complexity masking (0-> disabled).
1145 * - encoding: set by user
1146 * - decoding: unused
c5d309f2
MN
1147 */
1148 float temporal_cplx_masking;
115329f1 1149
c5d309f2 1150 /**
64863965
MN
1151 * spatial complexity masking (0-> disabled).
1152 * - encoding: set by user
1153 * - decoding: unused
c5d309f2
MN
1154 */
1155 float spatial_cplx_masking;
115329f1 1156
c5d309f2 1157 /**
64863965
MN
1158 * p block masking (0-> disabled).
1159 * - encoding: set by user
1160 * - decoding: unused
c5d309f2
MN
1161 */
1162 float p_masking;
15415af4 1163
5e746b99 1164 /**
64863965
MN
1165 * darkness masking (0-> disabled).
1166 * - encoding: set by user
1167 * - decoding: unused
5e746b99
MN
1168 */
1169 float dark_masking;
115329f1
DB
1170
1171
3a694b04
NK
1172 /* for binary compatibility */
1173 int unused;
115329f1 1174
0c2dd16e 1175 /**
64863965
MN
1176 * idct algorithm, see FF_IDCT_* below.
1177 * - encoding: set by user
1178 * - decoding: set by user
2ad1516a
MN
1179 */
1180 int idct_algo;
1181#define FF_IDCT_AUTO 0
1182#define FF_IDCT_INT 1
1183#define FF_IDCT_SIMPLE 2
1184#define FF_IDCT_SIMPLEMMX 3
1185#define FF_IDCT_LIBMPEG2MMX 4
1186#define FF_IDCT_PS2 5
1187#define FF_IDCT_MLIB 6
1188#define FF_IDCT_ARM 7
05c4072b 1189#define FF_IDCT_ALTIVEC 8
b82cdc72 1190#define FF_IDCT_SH4 9
bd7d1ea7 1191#define FF_IDCT_SIMPLEARM 10
0fa8158d 1192#define FF_IDCT_H264 11
8b6103da 1193#define FF_IDCT_VP3 12
eba9ae3c 1194#define FF_IDCT_IPP 13
84740d59 1195#define FF_IDCT_XVIDMMX 14
595e7bd9 1196#define FF_IDCT_CAVS 15
2ad1516a 1197
144f0625 1198 /**
64863965
MN
1199 * slice count.
1200 * - encoding: set by lavc
1201 * - decoding: set by user (or 0)
144f0625
MN
1202 */
1203 int slice_count;
1204 /**
64863965
MN
1205 * slice offsets in the frame in bytes.
1206 * - encoding: set/allocated by lavc
1207 * - decoding: set/allocated by user (or NULL)
144f0625
MN
1208 */
1209 int *slice_offset;
1210
4d2858de 1211 /**
64863965
MN
1212 * error concealment flags.
1213 * - encoding: unused
1214 * - decoding: set by user
4d2858de
MN
1215 */
1216 int error_concealment;
1217#define FF_EC_GUESS_MVS 1
1218#define FF_EC_DEBLOCK 2
1219
6b72ac63 1220 /**
bec89a84 1221 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1222 * CPU features (i.e. MMX, SSE. ...)
bec89a84
ZK
1223 *
1224 * with FORCE flag you may instead enable given CPU features
1225 * (Dangerous: usable in case of misdetection, improper usage however will
1226 * result into program crash)
1227 */
1228 unsigned dsp_mask;
bb270c08 1229#define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
bec89a84
ZK
1230 /* lower 16 bits - CPU features */
1231#ifdef HAVE_MMX
bb270c08
DB
1232#define FF_MM_MMX 0x0001 /* standard MMX */
1233#define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1234#define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1235#define FF_MM_SSE 0x0008 /* SSE functions */
1236#define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1237#define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
bec89a84 1238#endif /* HAVE_MMX */
eba9ae3c 1239#ifdef HAVE_IWMMXT
bb270c08 1240#define FF_MM_IWMMXT 0x0100 /* XScale IWMMXT */
eba9ae3c 1241#endif /* HAVE_IWMMXT */
11f18faf
MN
1242
1243 /**
64863965
MN
1244 * bits per sample/pixel from the demuxer (needed for huffyuv).
1245 * - encoding: set by lavc
1246 * - decoding: set by user
11f18faf
MN
1247 */
1248 int bits_per_sample;
115329f1 1249
11f18faf 1250 /**
64863965
MN
1251 * prediction method (needed for huffyuv).
1252 * - encoding: set by user
1253 * - decoding: unused
11f18faf
MN
1254 */
1255 int prediction_method;
1256#define FF_PRED_LEFT 0
1257#define FF_PRED_PLANE 1
1258#define FF_PRED_MEDIAN 2
115329f1 1259
5d3cea3a 1260 /**
5ff85f1d 1261 * sample aspect ratio (0 if unknown).
1f26c6f3 1262 * numerator and denominator must be relative prime and smaller then 256 for some video standards
64863965
MN
1263 * - encoding: set by user.
1264 * - decoding: set by lavc.
5d3cea3a 1265 */
5ff85f1d 1266 AVRational sample_aspect_ratio;
1e491e29
MN
1267
1268 /**
64863965
MN
1269 * the picture in the bitstream.
1270 * - encoding: set by lavc
1271 * - decoding: set by lavc
1e491e29 1272 */
492cd3a9 1273 AVFrame *coded_frame;
c8c437bc
MN
1274
1275 /**
64863965
MN
1276 * debug.
1277 * - encoding: set by user.
1278 * - decoding: set by user.
c8c437bc
MN
1279 */
1280 int debug;
1281#define FF_DEBUG_PICT_INFO 1
1282#define FF_DEBUG_RC 2
1283#define FF_DEBUG_BITSTREAM 4
1284#define FF_DEBUG_MB_TYPE 8
1285#define FF_DEBUG_QP 16
1286#define FF_DEBUG_MV 32
8289c6fa 1287#define FF_DEBUG_DCT_COEFF 0x00000040
41773b73
MN
1288#define FF_DEBUG_SKIP 0x00000080
1289#define FF_DEBUG_STARTCODE 0x00000100
1290#define FF_DEBUG_PTS 0x00000200
46b4feec 1291#define FF_DEBUG_ER 0x00000400
0da71265 1292#define FF_DEBUG_MMCO 0x00000800
8fc6c2b5 1293#define FF_DEBUG_BUGS 0x00001000
864119b6
MN
1294#define FF_DEBUG_VIS_QP 0x00002000
1295#define FF_DEBUG_VIS_MB_TYPE 0x00004000
115329f1 1296
140cb663 1297 /**
0c9bbaec
WH
1298 * debug.
1299 * - encoding: set by user.
1300 * - decoding: set by user.
1301 */
1302 int debug_mv;
1303#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1304#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1305#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1306
1307 /**
64863965
MN
1308 * error.
1309 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
1310 * - decoding: unused
140cb663
MN
1311 */
1312 uint64_t error[4];
115329f1 1313
17a70fde 1314 /**
64863965 1315 * minimum MB quantizer.
6e0d8c06 1316 * - encoding: unused
64863965 1317 * - decoding: unused
17a70fde
MN
1318 */
1319 int mb_qmin;
1320
1321 /**
64863965 1322 * maximum MB quantizer.
6e0d8c06 1323 * - encoding: unused
64863965 1324 * - decoding: unused
17a70fde
MN
1325 */
1326 int mb_qmax;
115329f1 1327
1457ab52 1328 /**
64863965
MN
1329 * motion estimation compare function.
1330 * - encoding: set by user.
1331 * - decoding: unused
1457ab52
MN
1332 */
1333 int me_cmp;
1334 /**
64863965
MN
1335 * subpixel motion estimation compare function.
1336 * - encoding: set by user.
1337 * - decoding: unused
1457ab52
MN
1338 */
1339 int me_sub_cmp;
1340 /**
64863965
MN
1341 * macroblock compare function (not supported yet).
1342 * - encoding: set by user.
1343 * - decoding: unused
1457ab52
MN
1344 */
1345 int mb_cmp;
622348f9
MN
1346 /**
1347 * interlaced dct compare function
1348 * - encoding: set by user.
1349 * - decoding: unused
1350 */
1351 int ildct_cmp;
1457ab52
MN
1352#define FF_CMP_SAD 0
1353#define FF_CMP_SSE 1
1354#define FF_CMP_SATD 2
1355#define FF_CMP_DCT 3
1356#define FF_CMP_PSNR 4
1357#define FF_CMP_BIT 5
1358#define FF_CMP_RD 6
1359#define FF_CMP_ZERO 7
622348f9
MN
1360#define FF_CMP_VSAD 8
1361#define FF_CMP_VSSE 9
e6a2ac34 1362#define FF_CMP_NSSE 10
26efc54e
MN
1363#define FF_CMP_W53 11
1364#define FF_CMP_W97 12
0fd6aea1 1365#define FF_CMP_DCTMAX 13
27c61ac5 1366#define FF_CMP_DCT264 14
1457ab52 1367#define FF_CMP_CHROMA 256
115329f1 1368
1457ab52 1369 /**
64863965
MN
1370 * ME diamond size & shape.
1371 * - encoding: set by user.
1372 * - decoding: unused
1457ab52
MN
1373 */
1374 int dia_size;
b07a5980
MN
1375
1376 /**
64863965
MN
1377 * amount of previous MV predictors (2a+1 x 2a+1 square).
1378 * - encoding: set by user.
1379 * - decoding: unused
b07a5980
MN
1380 */
1381 int last_predictor_count;
70ac76c0 1382
f5fb6b34 1383 /**
64863965
MN
1384 * pre pass for motion estimation.
1385 * - encoding: set by user.
1386 * - decoding: unused
f5fb6b34
MN
1387 */
1388 int pre_me;
b07a5980 1389
70ac76c0 1390 /**
64863965
MN
1391 * motion estimation pre pass compare function.
1392 * - encoding: set by user.
1393 * - decoding: unused
70ac76c0
MN
1394 */
1395 int me_pre_cmp;
826f429a 1396
70ac76c0 1397 /**
64863965
MN
1398 * ME pre pass diamond size & shape.
1399 * - encoding: set by user.
1400 * - decoding: unused
70ac76c0
MN
1401 */
1402 int pre_dia_size;
1403
826f429a 1404 /**
64863965
MN
1405 * subpel ME quality.
1406 * - encoding: set by user.
1407 * - decoding: unused
826f429a
MN
1408 */
1409 int me_subpel_quality;
1410
a33c7159 1411 /**
64863965 1412 * callback to negotiate the pixelFormat.
a33c7159
MN
1413 * @param fmt is the list of formats which are supported by the codec,
1414 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1415 * the first is allways the native one
1416 * @return the choosen format
64863965
MN
1417 * - encoding: unused
1418 * - decoding: set by user, if not set then the native format will always be choosen
a33c7159 1419 */
494c56d3 1420 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
e2f9490e
FB
1421
1422 /**
1423 * DTG active format information (additionnal aspect ratio
1424 * information only used in DVB MPEG2 transport streams). 0 if
1425 * not set.
115329f1 1426 *
64863965 1427 * - encoding: unused.
115329f1 1428 * - decoding: set by decoder
e2f9490e
FB
1429 */
1430 int dtg_active_format;
1431#define FF_DTG_AFD_SAME 8
1432#define FF_DTG_AFD_4_3 9
1433#define FF_DTG_AFD_16_9 10
1434#define FF_DTG_AFD_14_9 11
1435#define FF_DTG_AFD_4_3_SP_14_9 13
1436#define FF_DTG_AFD_16_9_SP_14_9 14
1437#define FF_DTG_AFD_SP_4_3 15
1438
ebbcdc9a
MN
1439 /**
1440 * Maximum motion estimation search range in subpel units.
1441 * if 0 then no limit
115329f1 1442 *
64863965
MN
1443 * - encoding: set by user.
1444 * - decoding: unused.
ebbcdc9a 1445 */
59e0ac8e 1446 int me_range;
ebbcdc9a 1447
65f7062d 1448 /**
1984f635
MN
1449 * intra quantizer bias.
1450 * - encoding: set by user.
1451 * - decoding: unused
1452 */
1453 int intra_quant_bias;
1454#define FF_DEFAULT_QUANT_BIAS 999999
115329f1 1455
1984f635
MN
1456 /**
1457 * inter quantizer bias.
1458 * - encoding: set by user.
1459 * - decoding: unused
1460 */
1461 int inter_quant_bias;
5cd62665
ZK
1462
1463 /**
1464 * color table ID.
1465 * - encoding: unused.
1466 * - decoding: which clrtable should be used for 8bit RGB images
1467 * table have to be stored somewhere FIXME
1468 */
1469 int color_table_id;
115329f1 1470
d90cf87b 1471 /**
115329f1 1472 * internal_buffer count.
bb628dae 1473 * Don't touch, used by lavc default_get_buffer()
d90cf87b
MN
1474 */
1475 int internal_buffer_count;
115329f1 1476
d90cf87b 1477 /**
115329f1 1478 * internal_buffers.
bb628dae 1479 * Don't touch, used by lavc default_get_buffer()
d90cf87b
MN
1480 */
1481 void *internal_buffer;
158c7f05
MN
1482
1483#define FF_LAMBDA_SHIFT 7
1484#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1485#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1486#define FF_LAMBDA_MAX (256*128-1)
1487
1488#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce
MN
1489 /**
1490 * global quality for codecs which cannot change it per frame.
1491 * this should be proportional to MPEG1/2/4 qscale.
1492 * - encoding: set by user.
1493 * - decoding: unused
1494 */
1495 int global_quality;
115329f1 1496
11e659c2
MN
1497#define FF_CODER_TYPE_VLC 0
1498#define FF_CODER_TYPE_AC 1
1499 /**
1500 * coder type
1501 * - encoding: set by user.
1502 * - decoding: unused
1503 */
1504 int coder_type;
1505
1506 /**
1507 * context model
1508 * - encoding: set by user.
1509 * - decoding: unused
1510 */
1511 int context_model;
5639729b
MN
1512#if 0
1513 /**
1514 *
1515 * - encoding: unused
1516 * - decoding: set by user.
1517 */
1518 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1519#endif
115329f1 1520
3bb07d61
MN
1521 /**
1522 * slice flags
1523 * - encoding: unused
1524 * - decoding: set by user.
1525 */
1526 int slice_flags;
1527#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1528#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1529#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1530
fb364ada
IK
1531 /**
1532 * XVideo Motion Acceleration
1533 * - encoding: forbidden
1534 * - decoding: set by decoder
1535 */
1536 int xvmc_acceleration;
115329f1 1537
7d1c3fc1
MN
1538 /**
1539 * macroblock decision mode
1540 * - encoding: set by user.
1541 * - decoding: unused
1542 */
1543 int mb_decision;
1544#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1545#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1546#define FF_MB_DECISION_RD 2 ///< rate distoration
d6eb3c50
MN
1547
1548 /**
1549 * custom intra quantization matrix
1550 * - encoding: set by user, can be NULL
1551 * - decoding: set by lavc
1552 */
1553 uint16_t *intra_matrix;
1554
1555 /**
1556 * custom inter quantization matrix
1557 * - encoding: set by user, can be NULL
1558 * - decoding: set by lavc
1559 */
1560 uint16_t *inter_matrix;
115329f1 1561
541ae140
MN
1562 /**
1563 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1564 * this is used to workaround some encoder bugs
1565 * - encoding: unused
1566 * - decoding: set by user, will be converted to upper case by lavc during init
1567 */
1568 unsigned int stream_codec_tag;
05fbd0a2
MN
1569
1570 /**
1571 * scene change detection threshold.
1572 * 0 is default, larger means fewer detected scene changes
1573 * - encoding: set by user.
1574 * - decoding: unused
1575 */
1576 int scenechange_threshold;
158c7f05
MN
1577
1578 /**
1579 * minimum lagrange multipler
1580 * - encoding: set by user.
1581 * - decoding: unused
1582 */
1583 int lmin;
1584
1585 /**
1586 * maximum lagrange multipler
1587 * - encoding: set by user.
1588 * - decoding: unused
1589 */
1590 int lmax;
2a2bbcb0
MM
1591
1592 /**
1593 * Palette control structure
1594 * - encoding: ??? (no palette-enabled encoder yet)
1595 * - decoding: set by user.
1596 */
1597 struct AVPaletteControl *palctrl;
821cb11f
MN
1598
1599 /**
1600 * noise reduction strength
1601 * - encoding: set by user.
1602 * - decoding: unused
1603 */
1604 int noise_reduction;
115329f1 1605
074c4ca7 1606 /**
e1c2a5a0
RT
1607 * called at the beginning of a frame to get cr buffer for it.
1608 * buffer type (size, hints) must be the same. lavc won't check it.
1609 * lavc will pass previous buffer in pic, function should return
1610 * same buffer or new buffer with old frame "painted" into it.
1611 * if pic.data[0] == NULL must behave like get_buffer().
074c4ca7 1612 * - encoding: unused
e1c2a5a0 1613 * - decoding: set by lavc, user can override
074c4ca7 1614 */
e1c2a5a0 1615 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
MN
1616
1617 /**
1618 * number of bits which should be loaded into the rc buffer before decoding starts
1619 * - encoding: set by user.
1620 * - decoding: unused
1621 */
1622 int rc_initial_buffer_occupancy;
1623
1624 /**
1625 *
1626 * - encoding: set by user.
1627 * - decoding: unused
1628 */
1629 int inter_threshold;
1630
1631 /**
1632 * CODEC_FLAG2_*.
1633 * - encoding: set by user.
1634 * - decoding: set by user.
1635 */
1636 int flags2;
7ebfc0ea
MN
1637
1638 /**
1639 * simulates errors in the bitstream to test error concealment.
1640 * - encoding: set by user.
1641 * - decoding: unused.
1642 */
1643 int error_rate;
115329f1 1644
a1e257b2
MN
1645 /**
1646 * MP3 antialias algorithm, see FF_AA_* below.
1647 * - encoding: unused
1648 * - decoding: set by user
1649 */
1650 int antialias_algo;
1651#define FF_AA_AUTO 0
1652#define FF_AA_FASTINT 1 //not implemented yet
1653#define FF_AA_INT 2
1654#define FF_AA_FLOAT 3
77ea0d4b
MN
1655 /**
1656 * Quantizer noise shaping.
1657 * - encoding: set by user
1658 * - decoding: unused
1659 */
1660 int quantizer_noise_shaping;
9c3d33d6
MN
1661
1662 /**
1663 * Thread count.
1664 * is used to decide how many independant tasks should be passed to execute()
1665 * - encoding: set by user
1666 * - decoding: set by user
1667 */
1668 int thread_count;
115329f1 1669
9c3d33d6
MN
1670 /**
1671 * the codec may call this to execute several independant things. it will return only after
1672 * finishing all tasks, the user may replace this with some multithreaded implementation, the
1673 * default implementation will execute the parts serially
399cec2f 1674 * @param count the number of things to execute
9c3d33d6
MN
1675 * - encoding: set by lavc, user can override
1676 * - decoding: set by lavc, user can override
1677 */
1678 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
115329f1 1679
9c3d33d6
MN
1680 /**
1681 * Thread opaque.
1682 * can be used by execute() to store some per AVCodecContext stuff.
1683 * - encoding: set by execute()
1684 * - decoding: set by execute()
1685 */
1686 void *thread_opaque;
a4d36c11
MN
1687
1688 /**
115329f1 1689 * Motion estimation threshold. under which no motion estimation is
f20f8a8b 1690 * performed, but instead the user specified motion vectors are used
115329f1 1691 *
a4d36c11 1692 * - encoding: set by user
f20f8a8b 1693 * - decoding: unused
a4d36c11 1694 */
2750b827 1695 int me_threshold;
f20f8a8b
MN
1696
1697 /**
1698 * Macroblock threshold. under which the user specified macroblock types will be used
1699 * - encoding: set by user
1700 * - decoding: unused
1701 */
1702 int mb_threshold;
bf266e19
MN
1703
1704 /**
d4c5d2ad 1705 * precision of the intra dc coefficient - 8.
bf266e19
MN
1706 * - encoding: set by user
1707 * - decoding: unused
1708 */
1709 int intra_dc_precision;
d4c5d2ad
MN
1710
1711 /**
1712 * noise vs. sse weight for the nsse comparsion function.
1713 * - encoding: set by user
1714 * - decoding: unused
1715 */
1716 int nsse_weight;
0dfd33c3
MN
1717
1718 /**
160d679c 1719 * number of macroblock rows at the top which are skipped.
0dfd33c3
MN
1720 * - encoding: unused
1721 * - decoding: set by user
1722 */
1723 int skip_top;
1724
1725 /**
160d679c 1726 * number of macroblock rows at the bottom which are skipped.
0dfd33c3
MN
1727 * - encoding: unused
1728 * - decoding: set by user
1729 */
1730 int skip_bottom;
baced9f5
MN
1731
1732 /**
1733 * profile
1734 * - encoding: set by user
1735 * - decoding: set by lavc
1736 */
1737 int profile;
1738#define FF_PROFILE_UNKNOWN -99
1739
1740 /**
1741 * level
1742 * - encoding: set by user
1743 * - decoding: set by lavc
1744 */
1745 int level;
1746#define FF_LEVEL_UNKNOWN -99
178fcca8
MN
1747
1748 /**
1749 * low resolution decoding. 1-> 1/2 size, 2->1/4 size
1750 * - encoding: unused
1751 * - decoding: set by user
1752 */
1753 int lowres;
21adafec
MN
1754
1755 /**
bbf18b21 1756 * bitsream width / height. may be different from width/height if lowres
21adafec
MN
1757 * or other things are used
1758 * - encoding: unused
1759 * - decoding: set by user before init if known, codec should override / dynamically change if needed
1760 */
1761 int coded_width, coded_height;
bbf18b21
MN
1762
1763 /**
1764 * frame skip threshold
1765 * - encoding: set by user
1766 * - decoding: unused
1767 */
1768 int frame_skip_threshold;
1769
1770 /**
1771 * frame skip factor
1772 * - encoding: set by user
1773 * - decoding: unused
1774 */
1775 int frame_skip_factor;
0fd6aea1
MN
1776
1777 /**
1778 * frame skip exponent
1779 * - encoding: set by user
1780 * - decoding: unused
1781 */
1782 int frame_skip_exp;
1783
1784 /**
1785 * frame skip comparission function
1786 * - encoding: set by user.
1787 * - decoding: unused
1788 */
1789 int frame_skip_cmp;
957c743a
CM
1790
1791 /**
1792 * border processing masking. raises the quantizer for mbs on the borders
1793 * of the picture.
1794 * - encoding: set by user
1795 * - decoding: unused
1796 */
1797 float border_masking;
6e0d8c06
MN
1798
1799 /**
1800 * minimum MB lagrange multipler.
1801 * - encoding: set by user.
1802 * - decoding: unused
1803 */
1804 int mb_lmin;
1805
1806 /**
1807 * maximum MB lagrange multipler.
1808 * - encoding: set by user.
1809 * - decoding: unused
1810 */
1811 int mb_lmax;
09c3e44e
MN
1812
1813 /**
115329f1 1814 *
09c3e44e
MN
1815 * - encoding: set by user.
1816 * - decoding: unused
1817 */
1818 int me_penalty_compensation;
8c3eba7c
MN
1819
1820 /**
115329f1 1821 *
8c3eba7c
MN
1822 * - encoding: unused
1823 * - decoding: set by user.
1824 */
1825 enum AVDiscard skip_loop_filter;
1826
1827 /**
115329f1 1828 *
8c3eba7c
MN
1829 * - encoding: unused
1830 * - decoding: set by user.
1831 */
1832 enum AVDiscard skip_idct;
1833
1834 /**
115329f1 1835 *
8c3eba7c
MN
1836 * - encoding: unused
1837 * - decoding: set by user.
1838 */
1839 enum AVDiscard skip_frame;
316a2ec8
MN
1840
1841 /**
1842 *
1843 * - encoding: set by user.
1844 * - decoding: unused
1845 */
1846 int bidir_refine;
e8501c93
MN
1847
1848 /**
1849 *
1850 * - encoding: set by user.
1851 * - decoding: unused
1852 */
1853 int brd_scale;
58f7833e
RS
1854
1855 /**
1856 * constant rate factor - quality-based VBR - values ~correspond to qps
1857 * - encoding: set by user.
1858 * - decoding: unused
1859 */
1860 int crf;
1861
1862 /**
1863 * constant quantization parameter rate control method
1864 * - encoding: set by user.
1865 * - decoding: unused
1866 */
1867 int cqp;
1868
1869 /**
1870 * minimum gop size
1871 * - encoding: set by user.
1872 * - decoding: unused
1873 */
1874 int keyint_min;
1875
1876 /**
1877 * number of reference frames
1878 * - encoding: set by user.
1879 * - decoding: unused
1880 */
1881 int refs;
1882
1883 /**
1884 * chroma qp offset from luma
1885 * - encoding: set by user.
1886 * - decoding: unused
1887 */
1888 int chromaoffset;
1889
1890 /**
1891 * influences how often b-frames are used
1892 * - encoding: set by user.
1893 * - decoding: unused
1894 */
1895 int bframebias;
1896
1897 /**
1898 * trellis RD quantization
1899 * - encoding: set by user.
1900 * - decoding: unused
1901 */
1902 int trellis;
1903
1904 /**
1905 * reduce fluctuations in qp (before curve compression)
1906 * - encoding: set by user.
1907 * - decoding: unused
1908 */
1909 float complexityblur;
1910
1911 /**
1912 * in-loop deblocking filter alphac0 parameter
1913 * alpha is in the range -6...6
1914 * - encoding: set by user.
1915 * - decoding: unused
1916 */
1917 int deblockalpha;
1918
1919 /**
1920 * in-loop deblocking filter beta parameter
1921 * beta is in the range -6...6
1922 * - encoding: set by user.
1923 * - decoding: unused
1924 */
1925 int deblockbeta;
1926
1927 /**
1928 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
1929 * - encoding: set by user.
1930 * - decoding: unused
1931 */
1932 int partitions;
1933#define X264_PART_I4X4 0x001 /* Analyse i4x4 */
1934#define X264_PART_I8X8 0x002 /* Analyse i8x8 (requires 8x8 transform) */
1935#define X264_PART_P8X8 0x010 /* Analyse p16x8, p8x16 and p8x8 */
1936#define X264_PART_P4X4 0x020 /* Analyse p8x4, p4x8, p4x4 */
1937#define X264_PART_B8X8 0x100 /* Analyse b16x8, b8x16 and b8x8 */
1938
1939 /**
1940 * direct mv prediction mode - 0 (none), 1 (spatial), 2 (temporal)
1941 * - encoding: set by user.
1942 * - decoding: unused
1943 */
1944 int directpred;
4f59b684 1945
14f0c8e2
LA
1946 /**
1947 * audio cutoff bandwidth (0 means "automatic") . Currently used only by FAAC
1948 * - encoding: set by user.
1949 * - decoding: unused
1950 */
1951 int cutoff;
39a64e30
CH
1952
1953 /**
1954 * multiplied by qscale for each frame and added to scene_change_score
1955 * - encoding: set by user.
1956 * - decoding: unused
1957 */
1958 int scenechange_factor;
1dd509b1
MN
1959
1960 /**
1961 *
1962 * note: value depends upon the compare functin used for fullpel ME
1963 * - encoding: set by user.
1964 * - decoding: unused
1965 */
1966 int mv0_threshold;
f9243d34
CH
1967
1968 /**
1969 * adjusts sensitivity of b_frame_strategy 1
1970 * - encoding: set by user.
1971 * - decoding: unused
1972 */
1973 int b_sensitivity;
a403fc03
JR
1974
1975 /**
1976 * - encoding: set by user.
1977 * - decoding: unused
1978 */
1979 int compression_level;
1980#define FF_COMPRESSION_DEFAULT -1
1981
1982 /**
1983 * sets whether to use LPC mode - used by FLAC encoder
1984 * - encoding: set by user.
1985 * - decoding: unused.
1986 */
1987 int use_lpc;
1988
1989 /**
1990 * LPC coefficient precision - used by FLAC encoder
1991 * - encoding: set by user.
1992 * - decoding: unused.
1993 */
1994 int lpc_coeff_precision;
1995
1996 /**
1997 * - encoding: set by user.
1998 * - decoding: unused.
1999 */
2000 int min_prediction_order;
2001
2002 /**
2003 * - encoding: set by user.
2004 * - decoding: unused.
2005 */
2006 int max_prediction_order;
2007
2008 /**
2009 * search method for selecting prediction order
2010 * - encoding: set by user.
2011 * - decoding: unused.
2012 */
2013 int prediction_order_method;
2014
2015 /**
2016 * - encoding: set by user.
2017 * - decoding: unused.
2018 */
2019 int min_partition_order;
2020
2021 /**
2022 * - encoding: set by user.
2023 * - decoding: unused.
2024 */
2025 int max_partition_order;
de6d9b64
FB
2026} AVCodecContext;
2027
64863965
MN
2028/**
2029 * AVCodec.
2030 */
de6d9b64 2031typedef struct AVCodec {
18f77016 2032 const char *name;
5d234974 2033 enum CodecType type;
9297ddd3 2034 enum CodecID id;
de6d9b64
FB
2035 int priv_data_size;
2036 int (*init)(AVCodecContext *);
0c1a9eda 2037 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 2038 int (*close)(AVCodecContext *);
0fd90455 2039 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
0c1a9eda 2040 uint8_t *buf, int buf_size);
bf89e6b1 2041 int capabilities;
a1043f9c 2042#if LIBAVCODEC_VERSION_INT < ((50<<16)+(0<<8)+0)
40c5fa26 2043 void *dummy; // FIXME remove next time we break binary compatibility
a1043f9c 2044#endif
de6d9b64 2045 struct AVCodec *next;
7a06ff14 2046 void (*flush)(AVCodecContext *);
b0df362b 2047 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
fcee0164 2048 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
de6d9b64
FB
2049} AVCodec;
2050
97d96aaa 2051/**
d7425f59
MN
2052 * four components are given, that's all.
2053 * the last component is alpha
2054 */
de6d9b64 2055typedef struct AVPicture {
0c1a9eda 2056 uint8_t *data[4];
cd394651 2057 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
2058} AVPicture;
2059
ba118447
MM
2060/**
2061 * AVPaletteControl
2062 * This structure defines a method for communicating palette changes
2063 * between and demuxer and a decoder.
2064 */
2e99641b 2065#define AVPALETTE_SIZE 1024
432d84c3 2066#define AVPALETTE_COUNT 256
ba118447
MM
2067typedef struct AVPaletteControl {
2068
2069 /* demuxer sets this to 1 to indicate the palette has changed;
2070 * decoder resets to 0 */
2071 int palette_changed;
2072
2a2bbcb0
MM
2073 /* 4-byte ARGB palette entries, stored in native byte order; note that
2074 * the individual palette components should be on a 8-bit scale; if
2075 * the palette data comes from a IBM VGA native format, the component
2076 * data is probably 6 bits in size and needs to be scaled */
2e99641b 2077 unsigned int palette[AVPALETTE_COUNT];
ba118447
MM
2078
2079} AVPaletteControl;
2080
c6ec28b1 2081typedef struct AVSubtitleRect {
240c1657
FB
2082 uint16_t x;
2083 uint16_t y;
2084 uint16_t w;
2085 uint16_t h;
2086 uint16_t nb_colors;
240c1657
FB
2087 int linesize;
2088 uint32_t *rgba_palette;
2089 uint8_t *bitmap;
c6ec28b1
MN
2090} AVSubtitleRect;
2091
2092typedef struct AVSubtitle {
2093 uint16_t format; /* 0 = graphics */
2094 uint32_t start_display_time; /* relative to packet pts, in ms */
2095 uint32_t end_display_time; /* relative to packet pts, in ms */
2096 uint32_t num_rects;
2097 AVSubtitleRect *rects;
240c1657
FB
2098} AVSubtitle;
2099
de6d9b64
FB
2100extern AVCodec ac3_encoder;
2101extern AVCodec mp2_encoder;
9d36bdc9 2102extern AVCodec mp3lame_encoder;
81e0d0b4 2103extern AVCodec oggvorbis_encoder;
29d48296 2104extern AVCodec faac_encoder;
9e96ab03 2105extern AVCodec flac_encoder;
1ddadfa9 2106extern AVCodec xvid_encoder;
de6d9b64 2107extern AVCodec mpeg1video_encoder;
029911d1 2108extern AVCodec mpeg2video_encoder;
1c3990db 2109extern AVCodec h261_encoder;
de6d9b64
FB
2110extern AVCodec h263_encoder;
2111extern AVCodec h263p_encoder;
d4f5d74a 2112extern AVCodec flv_encoder;
de6d9b64 2113extern AVCodec rv10_encoder;
68b94c35 2114extern AVCodec rv20_encoder;
6faa4645 2115extern AVCodec dvvideo_encoder;
de6d9b64 2116extern AVCodec mjpeg_encoder;
b1e6b355 2117extern AVCodec ljpeg_encoder;
5639729b 2118extern AVCodec jpegls_encoder;
4eff7cf4 2119extern AVCodec png_encoder;
5b6d5596
MN
2120extern AVCodec ppm_encoder;
2121extern AVCodec pgm_encoder;
2122extern AVCodec pgmyuv_encoder;
2123extern AVCodec pbm_encoder;
2124extern AVCodec pam_encoder;
bf89e6b1 2125extern AVCodec mpeg4_encoder;
84afee34
MN
2126extern AVCodec msmpeg4v1_encoder;
2127extern AVCodec msmpeg4v2_encoder;
2128extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
2129extern AVCodec wmv1_encoder;
2130extern AVCodec wmv2_encoder;
11f18faf 2131extern AVCodec huffyuv_encoder;
f37b9768 2132extern AVCodec ffvhuff_encoder;
0da71265 2133extern AVCodec h264_encoder;
3d2e8cce 2134extern AVCodec asv1_encoder;
9b56edf5 2135extern AVCodec asv2_encoder;
be3564ed 2136extern AVCodec vcr1_encoder;
5e20f836 2137extern AVCodec ffv1_encoder;
791e7b83 2138extern AVCodec snow_encoder;
c3bf0288 2139extern AVCodec mdec_encoder;
a273bbfb 2140extern AVCodec zlib_encoder;
54f5fd22
AB
2141extern AVCodec sonic_encoder;
2142extern AVCodec sonic_ls_encoder;
3b64893d 2143extern AVCodec svq1_encoder;
6662ec29 2144extern AVCodec x264_encoder;
de6d9b64
FB
2145
2146extern AVCodec h263_decoder;
c6148de2 2147extern AVCodec h261_decoder;
bf89e6b1 2148extern AVCodec mpeg4_decoder;
84afee34
MN
2149extern AVCodec msmpeg4v1_decoder;
2150extern AVCodec msmpeg4v2_decoder;
2151extern AVCodec msmpeg4v3_decoder;
e1a9dbff 2152extern AVCodec wmv1_decoder;
0151a6f5 2153extern AVCodec wmv2_decoder;
10b9c374 2154extern AVCodec vc1_decoder;
21aa398f 2155extern AVCodec wmv3_decoder;
922bc38d
MN
2156extern AVCodec mpeg1video_decoder;
2157extern AVCodec mpeg2video_decoder;
c512b303 2158extern AVCodec mpegvideo_decoder;
fb364ada 2159extern AVCodec mpeg_xvmc_decoder;
de6d9b64 2160extern AVCodec h263i_decoder;
d4f5d74a 2161extern AVCodec flv_decoder;
de6d9b64 2162extern AVCodec rv10_decoder;
68b94c35 2163extern AVCodec rv20_decoder;
3f05305d
MN
2164extern AVCodec rv30_decoder;
2165extern AVCodec rv40_decoder;
be8ffec9 2166extern AVCodec svq1_decoder;
8b82a956 2167extern AVCodec svq3_decoder;
020fcc94 2168extern AVCodec dvvideo_decoder;
bc8d1857
FB
2169extern AVCodec wmav1_decoder;
2170extern AVCodec wmav2_decoder;
4e66ab3b 2171extern AVCodec mjpeg_decoder;
b135d9fb 2172extern AVCodec mjpegb_decoder;
5e83dec4 2173extern AVCodec sp5x_decoder;
4eff7cf4 2174extern AVCodec png_decoder;
4b1f4f23 2175extern AVCodec mp2_decoder;
a96b68b7 2176extern AVCodec mp3_decoder;
1ede228a 2177extern AVCodec mp3adu_decoder;
d2a7718d 2178extern AVCodec mp3on4_decoder;
d9b1c197 2179extern AVCodec qdm2_decoder;
e0f7e329 2180extern AVCodec cook_decoder;
bf3027c8 2181extern AVCodec truespeech_decoder;
a24c4a2a 2182extern AVCodec tta_decoder;
3f95e843
FR
2183extern AVCodec mace3_decoder;
2184extern AVCodec mace6_decoder;
11f18faf 2185extern AVCodec huffyuv_decoder;
f37b9768 2186extern AVCodec ffvhuff_decoder;
3aca208a 2187extern AVCodec oggvorbis_decoder;
f70f7c6d 2188extern AVCodec cyuv_decoder;
0da71265 2189extern AVCodec h264_decoder;
deabd4fd 2190extern AVCodec indeo3_decoder;
d86053a4 2191extern AVCodec vp3_decoder;
f44ee2c3 2192extern AVCodec theora_decoder;
891f64b3 2193extern AVCodec amr_nb_decoder;
bc634f6f 2194extern AVCodec amr_nb_encoder;
d663a1fd
MN
2195extern AVCodec amr_wb_encoder;
2196extern AVCodec amr_wb_decoder;
280bd7b7
ZK
2197extern AVCodec aac_decoder;
2198extern AVCodec mpeg4aac_decoder;
3d2e8cce 2199extern AVCodec asv1_decoder;
9b56edf5 2200extern AVCodec asv2_decoder;
be3564ed 2201extern AVCodec vcr1_decoder;
3aff069b 2202extern AVCodec cljr_decoder;
5e20f836 2203extern AVCodec ffv1_decoder;
791e7b83 2204extern AVCodec snow_decoder;
8809cfee 2205extern AVCodec fourxm_decoder;
c3bf0288 2206extern AVCodec mdec_decoder;
3ef8be2b
MM
2207extern AVCodec roq_decoder;
2208extern AVCodec interplay_video_decoder;
9937e686 2209extern AVCodec xan_wc3_decoder;
2fdf638b
MM
2210extern AVCodec rpza_decoder;
2211extern AVCodec cinepak_decoder;
2212extern AVCodec msrle_decoder;
2213extern AVCodec msvideo1_decoder;
6955a882 2214extern AVCodec vqa_decoder;
4120a53a 2215extern AVCodec idcin_decoder;
1dc1ed99 2216extern AVCodec eightbps_decoder;
11e29a41 2217extern AVCodec smc_decoder;
42cad81a 2218extern AVCodec flic_decoder;
fafa0b75
MM
2219extern AVCodec vmdvideo_decoder;
2220extern AVCodec vmdaudio_decoder;
9a4117d5 2221extern AVCodec truemotion1_decoder;
64af6168 2222extern AVCodec truemotion2_decoder;
a273bbfb
RT
2223extern AVCodec mszh_decoder;
2224extern AVCodec zlib_decoder;
b8414bbd
NK
2225extern AVCodec ra_144_decoder;
2226extern AVCodec ra_288_decoder;
3ef8be2b
MM
2227extern AVCodec roq_dpcm_decoder;
2228extern AVCodec interplay_dpcm_decoder;
9937e686 2229extern AVCodec xan_dpcm_decoder;
d08d7142 2230extern AVCodec sol_dpcm_decoder;
54f5fd22 2231extern AVCodec sonic_decoder;
070ed1bc 2232extern AVCodec qtrle_decoder;
ac2570a8 2233extern AVCodec flac_decoder;
9d53d58e 2234extern AVCodec tscc_decoder;
e0f80bd7 2235extern AVCodec cscd_decoder;
dfca23e3 2236extern AVCodec nuv_decoder;
d0a0bbd2 2237extern AVCodec ulti_decoder;
d08d7142 2238extern AVCodec qdraw_decoder;
ab711b3c 2239extern AVCodec xl_decoder;
acfd8f0f 2240extern AVCodec qpeg_decoder;
85ad5695 2241extern AVCodec shorten_decoder;
9c7fb608 2242extern AVCodec loco_decoder;
a8a15e9d 2243extern AVCodec wnv1_decoder;
589f8220 2244extern AVCodec aasc_decoder;
6d6d7970 2245extern AVCodec alac_decoder;
034eeaa1 2246extern AVCodec ws_snd1_decoder;
856dbbff 2247extern AVCodec indeo2_decoder;
0bde73d9 2248extern AVCodec vorbis_decoder;
b81f8949 2249extern AVCodec fraps_decoder;
bb4c2140
MN
2250extern AVCodec libgsm_encoder;
2251extern AVCodec libgsm_decoder;
9fa62f2a 2252extern AVCodec bmp_decoder;
4e114829 2253extern AVCodec mmvideo_decoder;
9c8d8e84 2254extern AVCodec zmbv_decoder;
26376701 2255extern AVCodec avs_decoder;
348efc18
KS
2256extern AVCodec smacker_decoder;
2257extern AVCodec smackaud_decoder;
0c35eb1c 2258extern AVCodec kmvc_decoder;
0919e788 2259extern AVCodec flashsv_decoder;
20ffddb9 2260extern AVCodec cavs_decoder;
de6d9b64 2261
a96b68b7
FB
2262/* pcm codecs */
2263#define PCM_CODEC(id, name) \
2264extern AVCodec name ## _decoder; \
f11d3f23 2265extern AVCodec name ## _encoder
a96b68b7 2266
b461b3bc
RD
2267PCM_CODEC(CODEC_ID_PCM_S32LE, pcm_s32le);
2268PCM_CODEC(CODEC_ID_PCM_S32BE, pcm_s32be);
2269PCM_CODEC(CODEC_ID_PCM_U32LE, pcm_u32le);
2270PCM_CODEC(CODEC_ID_PCM_U32BE, pcm_u32be);
2271PCM_CODEC(CODEC_ID_PCM_S24LE, pcm_s24le);
2272PCM_CODEC(CODEC_ID_PCM_S24BE, pcm_s24be);
2273PCM_CODEC(CODEC_ID_PCM_U24LE, pcm_u24le);
2274PCM_CODEC(CODEC_ID_PCM_U24BE, pcm_u24be);
2275PCM_CODEC(CODEC_ID_PCM_S24DAUD, pcm_s24daud);
a96b68b7
FB
2276PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
2277PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
2278PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
2279PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
2280PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
2281PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
2282PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
2283PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
2284
0147f198
FR
2285/* adpcm codecs */
2286
2287PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
2288PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
9937e686
MM
2289PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
2290PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2fdf638b 2291PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
7d8379f2 2292PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
0147f198 2293PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
4b465299 2294PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
fc384777
MM
2295PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
2296PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
7d8379f2 2297PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
e5966052 2298PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
b3bfb299 2299PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
659c3692 2300PCM_CODEC(CODEC_ID_ADPCM_SWF, adpcm_swf);
2ff4524e 2301PCM_CODEC(CODEC_ID_ADPCM_YAMAHA, adpcm_yamaha);
2433f24f
AJ
2302PCM_CODEC(CODEC_ID_ADPCM_SBPRO_4, adpcm_sbpro_4);
2303PCM_CODEC(CODEC_ID_ADPCM_SBPRO_3, adpcm_sbpro_3);
2304PCM_CODEC(CODEC_ID_ADPCM_SBPRO_2, adpcm_sbpro_2);
0147f198 2305
a96b68b7
FB
2306#undef PCM_CODEC
2307
2308/* dummy raw video codec */
63167088
RS
2309extern AVCodec rawvideo_encoder;
2310extern AVCodec rawvideo_decoder;
de6d9b64
FB
2311
2312/* the following codecs use external GPL libs */
de6d9b64 2313extern AVCodec ac3_decoder;
23c99253 2314extern AVCodec dts_decoder;
de6d9b64 2315
240c1657 2316/* subtitles */
689abe56 2317extern AVCodec dvdsub_encoder;
240c1657
FB
2318extern AVCodec dvdsub_decoder;
2319extern AVCodec dvbsub_encoder;
c6ec28b1 2320extern AVCodec dvbsub_decoder;
240c1657 2321
de6d9b64
FB
2322/* resample.c */
2323
2324struct ReSampleContext;
aaaf1635 2325struct AVResampleContext;
de6d9b64
FB
2326
2327typedef struct ReSampleContext ReSampleContext;
2328
115329f1 2329ReSampleContext *audio_resample_init(int output_channels, int input_channels,
de6d9b64
FB
2330 int output_rate, int input_rate);
2331int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2332void audio_resample_close(ReSampleContext *s);
2333
6e225de2 2334struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
aaaf1635 2335int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2d48eddd 2336void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
d88443ae 2337void av_resample_close(struct AVResampleContext *c);
aaaf1635 2338
de6d9b64
FB
2339/* YUV420 format is assumed ! */
2340
2341struct ImgReSampleContext;
2342
2343typedef struct ImgReSampleContext ImgReSampleContext;
2344
2345ImgReSampleContext *img_resample_init(int output_width, int output_height,
2346 int input_width, int input_height);
ab6d194a
MN
2347
2348ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2349 int iwidth, int iheight,
2350 int topBand, int bottomBand,
1ff93ffc
TK
2351 int leftBand, int rightBand,
2352 int padtop, int padbottom,
2353 int padleft, int padright);
2354
ab6d194a 2355
115329f1 2356void img_resample(ImgReSampleContext *s,
da64ecc3 2357 AVPicture *output, const AVPicture *input);
de6d9b64
FB
2358
2359void img_resample_close(ImgReSampleContext *s);
2360
75917b88
DH
2361/**
2362 * Allocate memory for a picture. Call avpicture_free to free it.
2363 *
2364 * @param picture the picture to be filled in.
2365 * @param pix_fmt the format of the picture.
2366 * @param width the width of the picture.
2367 * @param height the height of the picture.
2368 * @return 0 if successful, -1 if not.
2369 */
2370int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2371
2372/* Free a picture previously allocated by avpicture_alloc. */
2373void avpicture_free(AVPicture *picture);
2374
0c1a9eda 2375int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2d1a4094 2376 int pix_fmt, int width, int height);
da64ecc3 2377int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
63167088 2378 unsigned char *dest, int dest_size);
219b06c6 2379int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
FB
2380void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2381const char *avcodec_get_pix_fmt_name(int pix_fmt);
21adafec 2382void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
63167088 2383enum PixelFormat avcodec_get_pix_fmt(const char* name);
d07730dd 2384unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
219b06c6 2385
fab21997
FB
2386#define FF_LOSS_RESOLUTION 0x0001 /* loss due to resolution change */
2387#define FF_LOSS_DEPTH 0x0002 /* loss due to color depth change */
2388#define FF_LOSS_COLORSPACE 0x0004 /* loss due to color space conversion */
2389#define FF_LOSS_ALPHA 0x0008 /* loss of alpha bits */
2390#define FF_LOSS_COLORQUANT 0x0010 /* loss due to color quantization */
2391#define FF_LOSS_CHROMA 0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
2392
2393int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2394 int has_alpha);
2395int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2396 int has_alpha, int *loss_ptr);
2397
0469baf1
FB
2398#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2399#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
da64ecc3 2400int img_get_alpha_info(const AVPicture *src,
bb270c08 2401 int pix_fmt, int width, int height);
0469baf1 2402
219b06c6
FB
2403/* convert among pixel formats */
2404int img_convert(AVPicture *dst, int dst_pix_fmt,
115329f1 2405 const AVPicture *src, int pix_fmt,
219b06c6
FB
2406 int width, int height);
2407
2408/* deinterlace a picture */
da64ecc3 2409int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
de6d9b64
FB
2410 int pix_fmt, int width, int height);
2411
2412/* external high level API */
2413
2414extern AVCodec *first_avcodec;
2415
156e5023 2416/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 2417unsigned avcodec_version(void);
8bceb6af 2418/* returns LIBAVCODEC_BUILD constant */
51a49663 2419unsigned avcodec_build(void);
de6d9b64
FB
2420void avcodec_init(void);
2421
2422void register_avcodec(AVCodec *format);
2423AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 2424AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
2425AVCodec *avcodec_find_decoder(enum CodecID id);
2426AVCodec *avcodec_find_decoder_by_name(const char *name);
2427void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2428
1e491e29 2429void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 2430AVCodecContext *avcodec_alloc_context(void);
7906085f 2431void avcodec_get_frame_defaults(AVFrame *pic);
492cd3a9 2432AVFrame *avcodec_alloc_frame(void);
1e491e29 2433
492cd3a9
MN
2434int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2435void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3a569751
MN
2436int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2437void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
0ecca7a4 2438int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3a569751 2439enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
1e491e29 2440
5a815088
MN
2441int avcodec_thread_init(AVCodecContext *s, int thread_count);
2442void avcodec_thread_free(AVCodecContext *s);
2443int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
3a569751 2444int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
9c3d33d6
MN
2445//FIXME func typedef
2446
7a06ff14
MN
2447/**
2448 * opens / inits the AVCodecContext.
2449 * not thread save!
2450 */
de6d9b64 2451int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
7a06ff14 2452
115329f1 2453int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
de6d9b64 2454 int *frame_size_ptr,
0c1a9eda 2455 uint8_t *buf, int buf_size);
115329f1 2456int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64 2457 int *got_picture_ptr,
0c1a9eda 2458 uint8_t *buf, int buf_size);
240c1657
FB
2459int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2460 int *got_sub_ptr,
2461 const uint8_t *buf, int buf_size);
115329f1 2462int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
917e06c8 2463 int *data_size_ptr,
0c1a9eda 2464 uint8_t *buf, int buf_size);
115329f1 2465int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
de6d9b64 2466 const short *samples);
115329f1 2467int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
492cd3a9 2468 const AVFrame *pict);
115329f1 2469int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
240c1657 2470 const AVSubtitle *sub);
de6d9b64
FB
2471
2472int avcodec_close(AVCodecContext *avctx);
2473
2474void avcodec_register_all(void);
a96b68b7 2475
1c2a8c7f
MN
2476void avcodec_flush_buffers(AVCodecContext *avctx);
2477
88730be6
MR
2478void avcodec_default_free_buffers(AVCodecContext *s);
2479
14bea432 2480/* misc usefull functions */
d8085ea7
MN
2481
2482/**
2483 * returns a single letter to describe the picture type
2484 */
2485char av_get_pict_type_char(int pict_type);
2486
ac3e1834
BC
2487/**
2488 * returns codec bits per sample
2489 */
2490int av_get_bits_per_sample(enum CodecID codec_id);
2e8f2c20 2491
8424cf50
FB
2492/* frame parsing */
2493typedef struct AVCodecParserContext {
2494 void *priv_data;
2495 struct AVCodecParser *parser;
2496 int64_t frame_offset; /* offset of the current frame */
115329f1 2497 int64_t cur_offset; /* current offset
8424cf50
FB
2498 (incremented by each av_parser_parse()) */
2499 int64_t last_frame_offset; /* offset of the last frame */
2500 /* video info */
2501 int pict_type; /* XXX: put it back in AVCodecContext */
2502 int repeat_pict; /* XXX: put it back in AVCodecContext */
b84f2a35
FB
2503 int64_t pts; /* pts of the current frame */
2504 int64_t dts; /* dts of the current frame */
2505
2506 /* private data */
2507 int64_t last_pts;
2508 int64_t last_dts;
a62aecce 2509 int fetch_timestamp;
b84f2a35
FB
2510
2511#define AV_PARSER_PTS_NB 4
2512 int cur_frame_start_index;
2513 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2514 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2515 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
115329f1 2516
7cbaa7ba
MN
2517 int flags;
2518#define PARSER_FLAG_COMPLETE_FRAMES 0x0001
8424cf50
FB
2519} AVCodecParserContext;
2520
2521typedef struct AVCodecParser {
99f06236 2522 int codec_ids[5]; /* several codec IDs are permitted */
8424cf50
FB
2523 int priv_data_size;
2524 int (*parser_init)(AVCodecParserContext *s);
115329f1 2525 int (*parser_parse)(AVCodecParserContext *s,
8424cf50 2526 AVCodecContext *avctx,
115329f1 2527 uint8_t **poutbuf, int *poutbuf_size,
8424cf50
FB
2528 const uint8_t *buf, int buf_size);
2529 void (*parser_close)(AVCodecParserContext *s);
90ad92b3 2530 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
8424cf50
FB
2531 struct AVCodecParser *next;
2532} AVCodecParser;
2533
2534extern AVCodecParser *av_first_parser;
2535
2536void av_register_codec_parser(AVCodecParser *parser);
2537AVCodecParserContext *av_parser_init(int codec_id);
115329f1 2538int av_parser_parse(AVCodecParserContext *s,
8424cf50 2539 AVCodecContext *avctx,
115329f1 2540 uint8_t **poutbuf, int *poutbuf_size,
b84f2a35
FB
2541 const uint8_t *buf, int buf_size,
2542 int64_t pts, int64_t dts);
90ad92b3
MN
2543int av_parser_change(AVCodecParserContext *s,
2544 AVCodecContext *avctx,
115329f1 2545 uint8_t **poutbuf, int *poutbuf_size,
90ad92b3 2546 const uint8_t *buf, int buf_size, int keyframe);
8424cf50
FB
2547void av_parser_close(AVCodecParserContext *s);
2548
2549extern AVCodecParser mpegvideo_parser;
2550extern AVCodecParser mpeg4video_parser;
20ffddb9 2551extern AVCodecParser cavsvideo_parser;
c6148de2 2552extern AVCodecParser h261_parser;
8424cf50
FB
2553extern AVCodecParser h263_parser;
2554extern AVCodecParser h264_parser;
8e6325b9 2555extern AVCodecParser mjpeg_parser;
99f06236 2556extern AVCodecParser pnm_parser;
8424cf50
FB
2557extern AVCodecParser mpegaudio_parser;
2558extern AVCodecParser ac3_parser;
240c1657 2559extern AVCodecParser dvdsub_parser;
c6ec28b1 2560extern AVCodecParser dvbsub_parser;
da46276f 2561extern AVCodecParser aac_parser;
8424cf50 2562
748c2fca
MN
2563
2564typedef struct AVBitStreamFilterContext {
514e0831 2565 void *priv_data;
748c2fca
MN
2566 struct AVBitStreamFilter *filter;
2567 AVCodecParserContext *parser;
2568 struct AVBitStreamFilterContext *next;
2569} AVBitStreamFilterContext;
2570
2571
2572typedef struct AVBitStreamFilter {
2573 const char *name;
514e0831 2574 int priv_data_size;
748c2fca
MN
2575 int (*filter)(AVBitStreamFilterContext *bsfc,
2576 AVCodecContext *avctx, const char *args,
2577 uint8_t **poutbuf, int *poutbuf_size,
2578 const uint8_t *buf, int buf_size, int keyframe);
2579 struct AVBitStreamFilter *next;
2580} AVBitStreamFilter;
2581
2582extern AVBitStreamFilter *av_first_bitstream_filter;
2583
2584void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2585AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2586int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2587 AVCodecContext *avctx, const char *args,
2588 uint8_t **poutbuf, int *poutbuf_size,
2589 const uint8_t *buf, int buf_size, int keyframe);
2590void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2591
2592extern AVBitStreamFilter dump_extradata_bsf;
2593extern AVBitStreamFilter remove_extradata_bsf;
514e0831 2594extern AVBitStreamFilter noise_bsf;
748c2fca
MN
2595
2596
544eb99c 2597/* memory */
18f77016 2598void *av_mallocz(unsigned int size);
8e1e6f31 2599char *av_strdup(const char *s);
81c5f887 2600void av_freep(void *ptr);
97d96aaa 2601void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
855ea723
ZK
2602/* for static data only */
2603/* call av_free_static to release all staticaly allocated tables */
628d601b 2604void av_free_static(void);
8d1f2ba5 2605void *av_mallocz_static(unsigned int size);
073c2593 2606void *av_realloc_static(void *ptr, unsigned int size);
544eb99c 2607
e1c2a5a0
RT
2608void img_copy(AVPicture *dst, const AVPicture *src,
2609 int pix_fmt, int width, int height);
2610
f2651e7a
BC
2611int img_crop(AVPicture *dst, const AVPicture *src,
2612 int pix_fmt, int top_band, int left_band);
2613
5341c209
LA
2614int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2615 int padtop, int padbottom, int padleft, int padright, int *color);
2616
3a278992 2617/* endian macros */
e96682e6 2618#if !defined(BE_16) || !defined(BE_32) || !defined(LE_16) || !defined(LE_32)
3a278992
MM
2619#define BE_16(x) ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
2620#define BE_32(x) ((((uint8_t*)(x))[0] << 24) | \
2621 (((uint8_t*)(x))[1] << 16) | \
2622 (((uint8_t*)(x))[2] << 8) | \
2623 ((uint8_t*)(x))[3])
2624#define LE_16(x) ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
2625#define LE_32(x) ((((uint8_t*)(x))[3] << 24) | \
2626 (((uint8_t*)(x))[2] << 16) | \
2627 (((uint8_t*)(x))[1] << 8) | \
2628 ((uint8_t*)(x))[0])
e96682e6 2629#endif
3a278992 2630
ad2b531d
MR
2631extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2632
02d697aa
ZK
2633#ifdef __cplusplus
2634}
2635#endif
2636
a96b68b7 2637#endif /* AVCODEC_H */