added support for EA ADPCM and SMJPEG IMA ADPCM
[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
de6d9b64 14#include "common.h"
5ff85f1d 15#include "rational.h"
4b813d5c 16#include <sys/types.h> /* size_t */
de6d9b64 17
7b7d86f1
FB
18#define FFMPEG_VERSION_INT 0x000408
19#define FFMPEG_VERSION "0.4.8"
77ea0d4b 20#define LIBAVCODEC_BUILD 4700
4b1f4f23 21
7b7d86f1
FB
22#define LIBAVCODEC_VERSION_INT FFMPEG_VERSION_INT
23#define LIBAVCODEC_VERSION FFMPEG_VERSION
24
25#define AV_STRINGIFY(s) AV_TOSTRING(s)
26#define AV_TOSTRING(s) #s
27#define LIBAVCODEC_IDENT "FFmpeg" LIBAVCODEC_VERSION "b" AV_STRINGIFY(LIBAVCODEC_BUILD)
ce2749d2 28
de6d9b64
FB
29enum CodecID {
30 CODEC_ID_NONE,
31 CODEC_ID_MPEG1VIDEO,
dcedf586 32 CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
fb364ada 33 CODEC_ID_MPEG2VIDEO_XVMC,
de6d9b64
FB
34 CODEC_ID_H263,
35 CODEC_ID_RV10,
68b94c35 36 CODEC_ID_RV20,
de6d9b64 37 CODEC_ID_MP2,
dcedf586 38 CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
81e0d0b4 39 CODEC_ID_VORBIS,
de6d9b64
FB
40 CODEC_ID_AC3,
41 CODEC_ID_MJPEG,
b135d9fb 42 CODEC_ID_MJPEGB,
b1e6b355 43 CODEC_ID_LJPEG,
5e83dec4 44 CODEC_ID_SP5X,
bf89e6b1 45 CODEC_ID_MPEG4,
de6d9b64 46 CODEC_ID_RAWVIDEO,
84afee34
MN
47 CODEC_ID_MSMPEG4V1,
48 CODEC_ID_MSMPEG4V2,
49 CODEC_ID_MSMPEG4V3,
e1a9dbff 50 CODEC_ID_WMV1,
b50eef3a 51 CODEC_ID_WMV2,
de6d9b64
FB
52 CODEC_ID_H263P,
53 CODEC_ID_H263I,
d4f5d74a 54 CODEC_ID_FLV1,
be8ffec9 55 CODEC_ID_SVQ1,
8b82a956 56 CODEC_ID_SVQ3,
020fcc94
FB
57 CODEC_ID_DVVIDEO,
58 CODEC_ID_DVAUDIO,
bc8d1857
FB
59 CODEC_ID_WMAV1,
60 CODEC_ID_WMAV2,
3f95e843
FR
61 CODEC_ID_MACE3,
62 CODEC_ID_MACE6,
11f18faf 63 CODEC_ID_HUFFYUV,
f70f7c6d 64 CODEC_ID_CYUV,
0da71265 65 CODEC_ID_H264,
deabd4fd 66 CODEC_ID_INDEO3,
d86053a4 67 CODEC_ID_VP3,
f44ee2c3 68 CODEC_ID_THEORA,
280bd7b7
ZK
69 CODEC_ID_AAC,
70 CODEC_ID_MPEG4AAC,
3d2e8cce 71 CODEC_ID_ASV1,
9b56edf5 72 CODEC_ID_ASV2,
5e20f836 73 CODEC_ID_FFV1,
e2a7bb28 74 CODEC_ID_4XM,
be3564ed 75 CODEC_ID_VCR1,
3aff069b 76 CODEC_ID_CLJR,
c3bf0288 77 CODEC_ID_MDEC,
3ef8be2b
MM
78 CODEC_ID_ROQ,
79 CODEC_ID_INTERPLAY_VIDEO,
9937e686
MM
80 CODEC_ID_XAN_WC3,
81 CODEC_ID_XAN_WC4,
2fdf638b
MM
82 CODEC_ID_RPZA,
83 CODEC_ID_CINEPAK,
84 CODEC_ID_WS_VQA,
85 CODEC_ID_MSRLE,
86 CODEC_ID_MSVIDEO1,
4120a53a 87 CODEC_ID_IDCIN,
1dc1ed99 88 CODEC_ID_8BPS,
11e29a41 89 CODEC_ID_SMC,
42cad81a 90 CODEC_ID_FLIC,
9a4117d5 91 CODEC_ID_TRUEMOTION1,
fafa0b75
MM
92 CODEC_ID_VMDVIDEO,
93 CODEC_ID_VMDAUDIO,
a273bbfb
RT
94 CODEC_ID_MSZH,
95 CODEC_ID_ZLIB,
a96b68b7
FB
96
97 /* various pcm "codecs" */
98 CODEC_ID_PCM_S16LE,
99 CODEC_ID_PCM_S16BE,
100 CODEC_ID_PCM_U16LE,
101 CODEC_ID_PCM_U16BE,
102 CODEC_ID_PCM_S8,
103 CODEC_ID_PCM_U8,
104 CODEC_ID_PCM_MULAW,
105 CODEC_ID_PCM_ALAW,
0147f198
FR
106
107 /* various adpcm codecs */
108 CODEC_ID_ADPCM_IMA_QT,
109 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
110 CODEC_ID_ADPCM_IMA_DK3,
111 CODEC_ID_ADPCM_IMA_DK4,
2fdf638b 112 CODEC_ID_ADPCM_IMA_WS,
7d8379f2 113 CODEC_ID_ADPCM_IMA_SMJPEG,
0147f198 114 CODEC_ID_ADPCM_MS,
e2a7bb28 115 CODEC_ID_ADPCM_4XM,
fc384777
MM
116 CODEC_ID_ADPCM_XA,
117 CODEC_ID_ADPCM_ADX,
7d8379f2 118 CODEC_ID_ADPCM_EA,
891f64b3 119
120 /* AMR */
121 CODEC_ID_AMR_NB,
d663a1fd
MN
122 CODEC_ID_AMR_WB,
123
b8414bbd
NK
124 /* RealAudio codecs*/
125 CODEC_ID_RA_144,
126 CODEC_ID_RA_288,
3ef8be2b
MM
127
128 /* various DPCM codecs */
129 CODEC_ID_ROQ_DPCM,
130 CODEC_ID_INTERPLAY_DPCM,
9937e686 131 CODEC_ID_XAN_DPCM,
985180a1
FB
132
133 CODEC_ID_MPEG2TS, /* _FAKE_ codec to indicate a raw MPEG2 transport
134 stream (only used by libavformat) */
de6d9b64 135};
dcedf586
FB
136
137/* CODEC_ID_MP3LAME is absolete */
138#define CODEC_ID_MP3LAME CODEC_ID_MP3
de6d9b64
FB
139
140enum CodecType {
4a663d80 141 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
142 CODEC_TYPE_VIDEO,
143 CODEC_TYPE_AUDIO,
985180a1 144 CODEC_TYPE_DATA,
de6d9b64
FB
145};
146
64863965 147/**
0f371e3e
MM
148 * Pixel format. Notes:
149 *
150 * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
151 * color is put together as:
152 * (A << 24) | (R << 16) | (G << 8) | B
153 * This is stored as BGRA on little endian CPU architectures and ARGB on
154 * big endian CPUs.
155 *
156 * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
157 * image data is stored in AVFrame.data[0]. The palette is transported in
158 * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
159 * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
fc384777
MM
160 * also endian-specific). Note also that the individual RGB palette
161 * components stored in AVFrame.data[1] should be in the range 0..255.
162 * This is important as many custom PAL8 video codecs that were designed
163 * to run on the IBM VGA graphics adapter use 6-bit palette components.
64863965 164 */
de6d9b64 165enum PixelFormat {
cd394651
MN
166 PIX_FMT_YUV420P, ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
167 PIX_FMT_YUV422,
168 PIX_FMT_RGB24, ///< Packed pixel, 3 bytes per pixel, RGBRGB...
169 PIX_FMT_BGR24, ///< Packed pixel, 3 bytes per pixel, BGRBGR...
170 PIX_FMT_YUV422P, ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
171 PIX_FMT_YUV444P, ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
0f371e3e 172 PIX_FMT_RGBA32, ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
cd394651
MN
173 PIX_FMT_YUV410P, ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
174 PIX_FMT_YUV411P, ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
64863965
MN
175 PIX_FMT_RGB565, ///< always stored in cpu endianness
176 PIX_FMT_RGB555, ///< always stored in cpu endianness, most significant bit to 1
dab64ebc 177 PIX_FMT_GRAY8,
64863965
MN
178 PIX_FMT_MONOWHITE, ///< 0 is white
179 PIX_FMT_MONOBLACK, ///< 0 is black
180 PIX_FMT_PAL8, ///< 8 bit with RGBA palette
cd394651
MN
181 PIX_FMT_YUVJ420P, ///< Planar YUV 4:2:0 full scale (jpeg)
182 PIX_FMT_YUVJ422P, ///< Planar YUV 4:2:2 full scale (jpeg)
183 PIX_FMT_YUVJ444P, ///< Planar YUV 4:4:4 full scale (jpeg)
fb364ada
IK
184 PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
185 PIX_FMT_XVMC_MPEG2_IDCT,
dab64ebc 186 PIX_FMT_NB,
de6d9b64
FB
187};
188
a96b68b7
FB
189/* currently unused, may be used if 24/32 bits samples ever supported */
190enum SampleFormat {
64863965 191 SAMPLE_FMT_S16 = 0, ///< signed 16 bits
a96b68b7
FB
192};
193
de6d9b64 194/* in bytes */
bc8d1857 195#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
de6d9b64 196
d7425f59 197/**
cf713bb8
MN
198 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
199 * this is mainly needed because some optimized bitstream readers read
200 * 32 or 64 bit at once and could read over the end<br>
201 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
202 * MPEG bitstreams could cause overread and segfault
d7425f59
MN
203 */
204#define FF_INPUT_BUFFER_PADDING_SIZE 8
205
e4986da9
J
206/* motion estimation type, EPZS by default */
207enum Motion_Est_ID {
101bea5f 208 ME_ZERO = 1,
e4986da9
J
209 ME_FULL,
210 ME_LOG,
211 ME_PHODS,
212 ME_EPZS,
213 ME_X1
214};
215
ce980a95
MN
216typedef struct RcOverride{
217 int start_frame;
218 int end_frame;
219 int qscale; // if this is 0 then quality_factor will be used instead
220 float quality_factor;
221} RcOverride;
222
101bea5f
J
223/* only for ME compatiblity with old apps */
224extern int motion_estimation_method;
225
e4986da9 226/* ME algos sorted by quality */
8d8c0294 227//FIXME remove IMHO
dc7cb06a
DC
228static const __attribute__((unused)) int Motion_Est_QTab[] =
229 { ME_ZERO, ME_PHODS, ME_LOG, ME_X1, ME_EPZS, ME_FULL };
de6d9b64 230
28db7fce 231
4e00e76b 232#define FF_MAX_B_FRAMES 8
9dbcbd92 233
a949d72e
MN
234/* encoding support
235 these flags can be passed in AVCodecContext.flags before initing
236 Note: note not everything is supported yet
237*/
de6d9b64 238
64863965 239#define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
dba019da 240#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / Advanced prediction for H263
64863965
MN
241#define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
242#define CODEC_FLAG_GMC 0x0020 ///< use GMC
ca7d05d5 243#define CODEC_FLAG_MV0 0x0040 ///< always try a MB with MV=<0,0>
64863965 244#define CODEC_FLAG_PART 0x0080 ///< use data partitioning
9dbcbd92
MN
245/* parent program gurantees that the input for b-frame containing streams is not written to
246 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 247#define CODEC_FLAG_INPUT_PRESERVED 0x0100
64863965
MN
248#define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
249#define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
250#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
251#define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
252#define CODEC_FLAG_EMU_EDGE 0x4000///< dont draw edges
253#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
254#define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
d7425f59 255 of only at frame boundaries */
64863965
MN
256#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
257#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
3bb07d61 258#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay
64863965
MN
259#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
260#define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
261#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
262#define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
21e59552 263/* Fx : Flag for h263+ extra options */
8d8c0294
MN
264#define CODEC_FLAG_H263P_AIC 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
265#define CODEC_FLAG_AC_PRED 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
64863965 266#define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
f2f6134b 267#define CODEC_FLAG_CBP_RD 0x04000000 ///< use rate distortion optimization for cbp
1f26c6f3 268#define CODEC_FLAG_QP_RD 0x08000000 ///< use rate distortion optimization for qp selectioon
dba019da 269#define CODEC_FLAG_H263P_AIV 0x00000008 ///< H263 Alternative inter vlc
332f9ac4
MN
270#define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
271#define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
bb198e19
MN
272#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
273#define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
baaf3f46 274#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
303e50e6 275#define CODEC_FLAG_CLOSED_GOP 0x80000000
21e59552
MN
276/* Unsupported options :
277 * Syntax Arithmetic coding (SAC)
21e59552 278 * Reference Picture Selection
ba58dabc 279 * Independant Segment Decoding */
21e59552 280/* /Fx */
bf89e6b1
FB
281/* codec capabilities */
282
64863965 283#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
6814a25c
MN
284/**
285 * Codec uses get_buffer() for allocating buffers.
286 * direct rendering method 1
287 */
288#define CODEC_CAP_DR1 0x0002
917e06c8
FB
289/* if 'parse_only' field is true, then avcodec_parse_frame() can be
290 used */
291#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 292#define CODEC_CAP_TRUNCATED 0x0008
bf89e6b1 293
8d7ec294
WH
294//the following defines might change, so dont expect compatibility if u use them
295#define MB_TYPE_INTRA4x4 0x0001
296#define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
297#define MB_TYPE_INTRA_PCM 0x0004 //FIXME h264 specific
298#define MB_TYPE_16x16 0x0008
299#define MB_TYPE_16x8 0x0010
300#define MB_TYPE_8x16 0x0020
301#define MB_TYPE_8x8 0x0040
302#define MB_TYPE_INTERLACED 0x0080
303#define MB_TYPE_DIRECT2 0x0100 //FIXME
304#define MB_TYPE_ACPRED 0x0200
305#define MB_TYPE_GMC 0x0400
306#define MB_TYPE_SKIP 0x0800
307#define MB_TYPE_P0L0 0x1000
308#define MB_TYPE_P1L0 0x2000
309#define MB_TYPE_P0L1 0x4000
310#define MB_TYPE_P1L1 0x8000
311#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
312#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
313#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
314#define MB_TYPE_QUANT 0x00010000
315#define MB_TYPE_CBP 0x00020000
316//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
317
fa384dcc
MN
318/**
319 * Pan Scan area.
320 * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
321 */
322typedef struct AVPanScan{
323 /**
324 * id.
325 * - encoding: set by user.
326 * - decoding: set by lavc
327 */
328 int id;
329
330 /**
331 * width and height in 1/16 pel
332 * - encoding: set by user.
333 * - decoding: set by lavc
334 */
335 int width;
336 int height;
337
338 /**
339 * position of the top left corner in 1/16 pel for up to 3 fields/frames.
340 * - encoding: set by user.
341 * - decoding: set by lavc
342 */
343 int16_t position[3][2];
344}AVPanScan;
345
492cd3a9 346#define FF_COMMON_FRAME \
b536d0aa
MN
347 /**\
348 * pointer to the picture planes.\
349 * this might be different from the first allocated byte\
350 * - encoding: \
351 * - decoding: \
352 */\
1e491e29
MN
353 uint8_t *data[4];\
354 int linesize[4];\
355 /**\
32db2b1d 356 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
1e491e29 357 * this isnt used by lavc unless the default get/release_buffer() is used\
64863965
MN
358 * - encoding: \
359 * - decoding: \
1e491e29
MN
360 */\
361 uint8_t *base[4];\
362 /**\
363 * 1 -> keyframe, 0-> not\
64863965
MN
364 * - encoding: set by lavc\
365 * - decoding: set by lavc\
1e491e29
MN
366 */\
367 int key_frame;\
368\
369 /**\
0da71265 370 * picture type of the frame, see ?_TYPE below.\
64863965
MN
371 * - encoding: set by lavc for coded_picture (and set by user for input)\
372 * - decoding: set by lavc\
1e491e29
MN
373 */\
374 int pict_type;\
375\
376 /**\
377 * presentation timestamp in micro seconds (time when frame should be shown to user)\
378 * if 0 then the frame_rate will be used as reference\
64863965
MN
379 * - encoding: MUST be set by user\
380 * - decoding: set by lavc\
1e491e29 381 */\
be6784dc 382 int64_t pts;\
1e491e29
MN
383\
384 /**\
385 * picture number in bitstream order.\
64863965
MN
386 * - encoding: set by\
387 * - decoding: set by lavc\
1e491e29
MN
388 */\
389 int coded_picture_number;\
390 /**\
1e491e29 391 * picture number in display order.\
64863965
MN
392 * - encoding: set by\
393 * - decoding: set by lavc\
1e491e29
MN
394 */\
395 int display_picture_number;\
396\
397 /**\
158c7f05 398 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
64863965
MN
399 * - encoding: set by lavc for coded_picture (and set by user for input)\
400 * - decoding: set by lavc\
1e491e29 401 */\
158c7f05 402 int quality; \
1e491e29
MN
403\
404 /**\
405 * buffer age (1->was last buffer and dint change, 2->..., ...).\
158c7f05 406 * set to INT_MAX if the buffer has not been used yet \
64863965
MN
407 * - encoding: unused\
408 * - decoding: MUST be set by get_buffer()\
1e491e29
MN
409 */\
410 int age;\
411\
412 /**\
413 * is this picture used as reference\
64863965
MN
414 * - encoding: unused\
415 * - decoding: set by lavc (before get_buffer() call))\
1e491e29
MN
416 */\
417 int reference;\
418\
419 /**\
420 * QP table\
64863965
MN
421 * - encoding: unused\
422 * - decoding: set by lavc\
1e491e29
MN
423 */\
424 int8_t *qscale_table;\
425 /**\
426 * QP store stride\
64863965
MN
427 * - encoding: unused\
428 * - decoding: set by lavc\
1e491e29
MN
429 */\
430 int qstride;\
431\
432 /**\
433 * mbskip_table[mb]>=1 if MB didnt change\
434 * stride= mb_width = (width+15)>>4\
64863965
MN
435 * - encoding: unused\
436 * - decoding: set by lavc\
1e491e29
MN
437 */\
438 uint8_t *mbskip_table;\
439\
440 /**\
8d7ec294
WH
441 * Motion vector table\
442 * - encoding: unused\
443 * - decoding: set by lavc\
444 */\
445 int16_t (*motion_val[2])[2];\
446\
447 /**\
448 * Macroblock type table\
449 * mb_type_base + mb_width + 2\
450 * - encoding: unused\
451 * - decoding: set by lavc\
452 */\
453 uint32_t *mb_type;\
454\
455 /**\
456 * Macroblock size: (0->16x16, 1->8x8, 2-> 4x4, 3-> 2x2)\
457 * - encoding: unused\
458 * - decoding: set by lavc\
459 */\
460 uint8_t motion_subsample_log2;\
461\
462 /**\
1e491e29 463 * for some private data of the user\
64863965
MN
464 * - encoding: unused\
465 * - decoding: set by user\
1e491e29
MN
466 */\
467 void *opaque;\
140cb663
MN
468\
469 /**\
470 * error\
64863965
MN
471 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
472 * - decoding: unused\
140cb663
MN
473 */\
474 uint64_t error[4];\
4e00e76b
MN
475\
476 /**\
477 * type of the buffer (to keep track of who has to dealloc data[*])\
64863965
MN
478 * - encoding: set by the one who allocs it\
479 * - decoding: set by the one who allocs it\
3db320ea 480 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
4e00e76b
MN
481 */\
482 int type;\
2ec23b6d
MN
483 \
484 /**\
485 * when decoding, this signal how much the picture must be delayed.\
486 * extra_delay = repeat_pict / (2*fps)\
64863965
MN
487 * - encoding: unused\
488 * - decoding: set by lavc\
2ec23b6d 489 */\
0426af31
MN
490 int repeat_pict;\
491 \
492 /**\
493 * \
494 */\
495 int qscale_type;\
2744ca9a
RS
496 \
497 /**\
498 * The content of the picture is interlaced.\
499 * - encoding: set by user\
500 * - decoding: set by lavc (default 0)\
501 */\
502 int interlaced_frame;\
503 \
504 /**\
9dad924e 505 * if the content is interlaced, is top field displayed first.\
2744ca9a 506 * - encoding: set by user\
9dad924e 507 * - decoding: set by lavc\
2744ca9a 508 */\
9dad924e 509 int top_field_first;\
fa384dcc
MN
510 \
511 /**\
512 * Pan scan.\
513 * - encoding: set by user\
514 * - decoding: set by lavc\
515 */\
516 AVPanScan *pan_scan;\
2a2bbcb0
MM
517 \
518 /**\
519 * tell user application that palette has changed from previous frame.\
520 * - encoding: ??? (no palette-enabled encoder yet)\
521 * - decoding: set by lavc (default 0)\
522 */\
523 int palette_has_changed;\
074c4ca7
RT
524 \
525 /**\
526 * Codec suggestion on buffer type if != 0\
527 * - encoding: unused\
528 * - decoding: set by lavc (before get_buffer() call))\
529 */\
530 int buffer_hints;\
2ec23b6d 531
0426af31
MN
532#define FF_QSCALE_TYPE_MPEG1 0
533#define FF_QSCALE_TYPE_MPEG2 1
4e00e76b
MN
534
535#define FF_BUFFER_TYPE_INTERNAL 1
9b56edf5
MN
536#define FF_BUFFER_TYPE_USER 2 ///< Direct rendering buffers (image is (de)allocated by user)
537#define FF_BUFFER_TYPE_SHARED 4 ///< buffer from somewher else, dont dealloc image (data/base)
538#define FF_BUFFER_TYPE_COPY 8 ///< just a (modified) copy of some other buffer, dont dealloc anything
4e00e76b 539
1e491e29 540
140cb663
MN
541#define FF_I_TYPE 1 // Intra
542#define FF_P_TYPE 2 // Predicted
543#define FF_B_TYPE 3 // Bi-dir predicted
544#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
0da71265
MN
545#define FF_SI_TYPE 5
546#define FF_SP_TYPE 6
1e491e29 547
074c4ca7
RT
548#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore)
549#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer
550#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content
551#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update)
552
0da71265
MN
553/**
554 * Audio Video Frame.
555 */
492cd3a9
MN
556typedef struct AVFrame {
557 FF_COMMON_FRAME
558} AVFrame;
1e491e29 559
14bea432 560#define DEFAULT_FRAME_RATE_BASE 1001000
d33c949c
MN
561
562/**
563 * main external api structure.
564 */
de6d9b64 565typedef struct AVCodecContext {
b71901e6 566 /**
64863965
MN
567 * the average bitrate.
568 * - encoding: set by user. unused for constant quantizer encoding
569 * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
b71901e6 570 */
de6d9b64 571 int bit_rate;
b71901e6
MN
572
573 /**
64863965 574 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 575 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
64863965
MN
576 * - encoding: set by user. unused for constant quantizer encoding
577 * - decoding: unused
b71901e6
MN
578 */
579 int bit_rate_tolerance;
580
581 /**
64863965
MN
582 * CODEC_FLAG_*.
583 * - encoding: set by user.
584 * - decoding: set by user.
b71901e6 585 */
de6d9b64 586 int flags;
b71901e6
MN
587
588 /**
589 * some codecs needs additionnal format info. It is stored here
64863965
MN
590 * - encoding: set by user.
591 * - decoding: set by lavc. (FIXME is this ok?)
b71901e6
MN
592 */
593 int sub_id;
594
595 /**
64863965
MN
596 * motion estimation algorithm used for video coding.
597 * - encoding: MUST be set by user.
598 * - decoding: unused
b71901e6
MN
599 */
600 int me_method;
601
602 /**
64863965 603 * some codecs need / can use extra-data like huffman tables.
b71901e6
MN
604 * mjpeg: huffman tables
605 * rv10: additional flags
b704e742 606 * mpeg4: global headers (they can be in the bitstream or here)
64863965
MN
607 * - encoding: set/allocated/freed by lavc.
608 * - decoding: set/allocated/freed by user.
b71901e6 609 */
e84c31dc
A
610 void *extradata;
611 int extradata_size;
612
de6d9b64 613 /* video only */
b71901e6 614 /**
14bea432 615 * frames per sec multiplied by frame_rate_base.
b71901e6 616 * for variable fps this is the precission, so if the timestamps
14bea432 617 * can be specified in msec precssion then this is 1000*frame_rate_base
64863965
MN
618 * - encoding: MUST be set by user
619 * - decoding: set by lavc. 0 or the frame_rate if available
b71901e6
MN
620 */
621 int frame_rate;
14bea432
MN
622
623 /**
64863965
MN
624 * width / height.
625 * - encoding: MUST be set by user.
95831f48 626 * - decoding: set by user if known, codec should override / dynamically change if needed
b71901e6 627 */
de6d9b64 628 int width, height;
b71901e6 629
2efe097a
MN
630#define FF_ASPECT_SQUARE 1
631#define FF_ASPECT_4_3_625 2
632#define FF_ASPECT_4_3_525 3
633#define FF_ASPECT_16_9_625 4
634#define FF_ASPECT_16_9_525 5
e769f053 635#define FF_ASPECT_EXTENDED 15
b71901e6
MN
636
637 /**
64863965
MN
638 * the number of pictures in a group of pitures, or 0 for intra_only.
639 * - encoding: set by user.
640 * - decoding: unused
b71901e6
MN
641 */
642 int gop_size;
643
644 /**
64863965 645 * pixel format, see PIX_FMT_xxx.
36b58e85
RS
646 * - encoding: FIXME: used by ffmpeg to decide whether an pix_fmt
647 * conversion is in order. This only works for
648 * codecs with one supported pix_fmt, we should
649 * do something for a generic case as well.
64863965 650 * - decoding: set by lavc.
b71901e6 651 */
e4eadb4b 652 enum PixelFormat pix_fmt;
bdfcbbed
MK
653
654 /**
655 * Frame rate emulation. If not zero lower layer (i.e. format handler)
656 * has to read frames at native frame rate.
657 * - encoding: set by user.
658 * - decoding: unused.
659 */
660 int rate_emu;
661
b71901e6
MN
662 /**
663 * if non NULL, 'draw_horiz_band' is called by the libavcodec
664 * decoder to draw an horizontal band. It improve cache usage. Not
665 * all codecs can do that. You must check the codec capabilities
666 * before
64863965
MN
667 * - encoding: unused
668 * - decoding: set by user.
3bb07d61
MN
669 * @param height the height of the slice
670 * @param y the y position of the slice
671 * @param type 1->top field, 2->bottom field, 3->frame
672 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 673 */
bf89e6b1 674 void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3 675 const AVFrame *src, int offset[4],
3bb07d61 676 int y, int type, int height);
bf89e6b1 677
de6d9b64 678 /* audio only */
64863965 679 int sample_rate; ///< samples per sec
de6d9b64 680 int channels;
64863965 681 int sample_fmt; ///< sample format, currenly unused
de6d9b64
FB
682
683 /* the following data should not be initialized */
64863965
MN
684 int frame_size; ///< in samples, initialized when calling 'init'
685 int frame_number; ///< audio or video frame number
686 int real_pict_num; ///< returns the real picture number of previous encoded frame
1e491e29 687
b71901e6 688 /**
b71901e6 689 * number of frames the decoded output will be delayed relative to
64863965
MN
690 * the encoded input.
691 * - encoding: set by lavc.
692 * - decoding: unused
b71901e6
MN
693 */
694 int delay;
1ff662cc 695
64863965
MN
696 /* - encoding parameters */
697 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
698 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
b71901e6
MN
699
700 /**
64863965
MN
701 * minimum quantizer.
702 * - encoding: set by user.
703 * - decoding: unused
b71901e6
MN
704 */
705 int qmin;
706
707 /**
64863965
MN
708 * maximum quantizer.
709 * - encoding: set by user.
710 * - decoding: unused
b71901e6
MN
711 */
712 int qmax;
713
714 /**
64863965
MN
715 * maximum quantizer difference etween frames.
716 * - encoding: set by user.
717 * - decoding: unused
b71901e6
MN
718 */
719 int max_qdiff;
720
721 /**
64863965 722 * maximum number of b frames between non b frames.
b71901e6 723 * note: the output will be delayed by max_b_frames+1 relative to the input
64863965
MN
724 * - encoding: set by user.
725 * - decoding: unused
b71901e6
MN
726 */
727 int max_b_frames;
728
729 /**
64863965
MN
730 * qscale factor between ip and b frames.
731 * - encoding: set by user.
732 * - decoding: unused
b71901e6
MN
733 */
734 float b_quant_factor;
735
736 /** obsolete FIXME remove */
737 int rc_strategy;
8b4c7dbc 738 int b_frame_strategy;
9dbcbd92 739
b71901e6 740 /**
64863965
MN
741 * hurry up amount.
742 * - encoding: unused
743 * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
b71901e6
MN
744 */
745 int hurry_up;
2417652e 746
de6d9b64 747 struct AVCodec *codec;
b71901e6 748
de6d9b64
FB
749 void *priv_data;
750
ba58dabc
MN
751 /* unused, FIXME remove*/
752 int rtp_mode;
644d98a4
J
753
754 int rtp_payload_size; /* The size of the RTP payload, the coder will */
755 /* do it's best to deliver a chunk with size */
756 /* below rtp_payload_size, the chunk will start */
757 /* with a start code on some codecs like H.263 */
758 /* This doesn't take account of any particular */
759 /* headers inside the transmited RTP payload */
81401c1f
J
760
761
762 /* The RTP callcack: This function is called */
763 /* every time the encoder as a packet to send */
764 /* Depends on the encoder if the data starts */
765 /* with a Start Code (it should) H.263 does */
766 void (*rtp_callback)(void *data, int size, int packet_number);
767
098eefe1
MN
768 /* statistics, used for 2-pass encoding */
769 int mv_bits;
770 int header_bits;
771 int i_tex_bits;
772 int p_tex_bits;
773 int i_count;
774 int p_count;
775 int skip_count;
b71901e6
MN
776 int misc_bits;
777
778 /**
64863965
MN
779 * number of bits used for the previously encoded frame.
780 * - encoding: set by lavc
7004ffb3 781 * - decoding: unused
b71901e6 782 */
098eefe1 783 int frame_bits;
7004ffb3 784
b71901e6 785 /**
64863965
MN
786 * private data of the user, can be used to carry app specific stuff.
787 * - encoding: set by user
788 * - decoding: set by user
b71901e6
MN
789 */
790 void *opaque;
791
de6d9b64 792 char codec_name[32];
4a663d80
PG
793 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
794 enum CodecID codec_id; /* see CODEC_ID_xxx */
7004ffb3
MN
795
796 /**
797 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
798 * this is used to workaround some encoder bugs
bd5a6020 799 * - encoding: set by user, if not then the default based on codec_id will be used
7004ffb3
MN
800 * - decoding: set by user, will be converted to upper case by lavc during init
801 */
802 unsigned int codec_tag;
92ba5ffb 803
b71901e6 804 /**
64863965
MN
805 * workaround bugs in encoders which sometimes cannot be detected automatically.
806 * - encoding: unused
807 * - decoding: set by user
b71901e6
MN
808 */
809 int workaround_bugs;
64863965 810#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
811#define FF_BUG_OLD_MSMPEG4 2
812#define FF_BUG_XVID_ILACE 4
813#define FF_BUG_UMP4 8
814#define FF_BUG_NO_PADDING 16
ac0c6638 815#define FF_BUG_AC_VLC 0 ///< will be removed, libavcodec can now handle these non compliant files by default
03e93d35 816#define FF_BUG_QPEL_CHROMA 64
db794953 817#define FF_BUG_STD_QPEL 128
36df8805 818#define FF_BUG_QPEL_CHROMA2 256
c40c3482 819#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 820#define FF_BUG_EDGE 1024
4d2858de
MN
821//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
822
b71901e6 823 /**
64863965
MN
824 * luma single coeff elimination threshold.
825 * - encoding: set by user
826 * - decoding: unused
b71901e6 827 */
1f6b6e50 828 int luma_elim_threshold;
b71901e6
MN
829
830 /**
64863965
MN
831 * chroma single coeff elimination threshold.
832 * - encoding: set by user
833 * - decoding: unused
b71901e6 834 */
1f6b6e50 835 int chroma_elim_threshold;
b71901e6
MN
836
837 /**
64863965
MN
838 * strictly follow the std (MPEG4, ...).
839 * - encoding: set by user
840 * - decoding: unused
b71901e6
MN
841 */
842 int strict_std_compliance;
843
844 /**
64863965 845 * qscale offset between ip and b frames.
b3a391e8
MN
846 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
847 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
848 * - encoding: set by user.
849 * - decoding: unused
b71901e6
MN
850 */
851 float b_quant_offset;
852
853 /**
ce3bcaed 854 * error resilience higher values will detect more errors but may missdetect
64863965
MN
855 * some more or less valid parts as errors.
856 * - encoding: unused
857 * - decoding: set by user
b71901e6 858 */
1f6b6e50 859 int error_resilience;
ce3bcaed
MN
860#define FF_ER_CAREFULL 1
861#define FF_ER_COMPLIANT 2
862#define FF_ER_AGGRESSIVE 3
863#define FF_ER_VERY_AGGRESSIVE 4
ae72cda6 864
6b72ac63 865 /**
1e491e29
MN
866 * called at the beginning of each frame to get a buffer for it.
867 * if pic.reference is set then the frame will be read later by lavc
3bb07d61 868 * width and height should be rounded up to the next multiple of 16
64863965
MN
869 * - encoding: unused
870 * - decoding: set by lavc, user can override
b71901e6 871 */
492cd3a9 872 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
b71901e6
MN
873
874 /**
1e491e29
MN
875 * called to release buffers which where allocated with get_buffer.
876 * a released buffer can be reused in get_buffer()
877 * pic.data[*] must be set to NULL
64863965
MN
878 * - encoding: unused
879 * - decoding: set by lavc, user can override
b71901e6 880 */
492cd3a9 881 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 882
b71901e6 883 /**
64863965
MN
884 * is 1 if the decoded stream contains b frames, 0 otherwise.
885 * - encoding: unused
886 * - decoding: set by lavc
b71901e6
MN
887 */
888 int has_b_frames;
b71901e6 889
64863965 890 int block_align; ///< used by some WAV based audio codecs
ce980a95 891
64863965 892 int parse_only; /* - decoding only: if true, only parsing is done
917e06c8
FB
893 (function avcodec_parse_frame()). The frame
894 data is returned. Only MPEG codecs support this now. */
ce980a95 895
b71901e6 896 /**
e4eadb4b 897 * 0-> h263 quant 1-> mpeg quant.
64863965
MN
898 * - encoding: set by user.
899 * - decoding: unused
b71901e6
MN
900 */
901 int mpeg_quant;
ce980a95 902
b71901e6 903 /**
64863965
MN
904 * pass1 encoding statistics output buffer.
905 * - encoding: set by lavc
906 * - decoding: unused
b71901e6 907 */
64863965 908 char *stats_out;
b71901e6
MN
909
910 /**
911 * pass2 encoding statistics input buffer.
912 * concatenated stuff from stats_out of pass1 should be placed here
64863965
MN
913 * - encoding: allocated/set/freed by user
914 * - decoding: unused
b71901e6
MN
915 */
916 char *stats_in;
917
918 /**
64863965 919 * ratecontrol qmin qmax limiting method.
b71901e6 920 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
64863965
MN
921 * - encoding: set by user.
922 * - decoding: unused
b71901e6 923 */
ce980a95 924 float rc_qsquish;
b71901e6 925
ce980a95
MN
926 float rc_qmod_amp;
927 int rc_qmod_freq;
b71901e6
MN
928
929 /**
64863965
MN
930 * ratecontrol override, see RcOverride.
931 * - encoding: allocated/set/freed by user.
932 * - decoding: unused
b71901e6 933 */
ce980a95
MN
934 RcOverride *rc_override;
935 int rc_override_count;
b71901e6
MN
936
937 /**
64863965
MN
938 * rate control equation.
939 * - encoding: set by user
940 * - decoding: unused
b71901e6 941 */
ce980a95 942 char *rc_eq;
b71901e6
MN
943
944 /**
64863965
MN
945 * maximum bitrate.
946 * - encoding: set by user.
947 * - decoding: unused
b71901e6 948 */
ce980a95 949 int rc_max_rate;
b71901e6
MN
950
951 /**
64863965
MN
952 * minimum bitrate.
953 * - encoding: set by user.
954 * - decoding: unused
b71901e6 955 */
ce980a95 956 int rc_min_rate;
b71901e6
MN
957
958 /**
64863965
MN
959 * decoder bitstream buffer size.
960 * - encoding: set by user.
961 * - decoding: unused
b71901e6 962 */
ce980a95
MN
963 int rc_buffer_size;
964 float rc_buffer_aggressivity;
b71901e6
MN
965
966 /**
64863965 967 * qscale factor between p and i frames.
a1e257b2
MN
968 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
969 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
970 * - encoding: set by user.
971 * - decoding: unused
b71901e6
MN
972 */
973 float i_quant_factor;
974
975 /**
64863965 976 * qscale offset between p and i frames.
64863965
MN
977 * - encoding: set by user.
978 * - decoding: unused
b71901e6
MN
979 */
980 float i_quant_offset;
981
982 /**
64863965
MN
983 * initial complexity for pass1 ratecontrol.
984 * - encoding: set by user.
985 * - decoding: unused
b71901e6 986 */
ce980a95 987 float rc_initial_cplx;
917e06c8 988
b71901e6 989 /**
64863965
MN
990 * dct algorithm, see FF_DCT_* below.
991 * - encoding: set by user
992 * - decoding: unused
b71901e6 993 */
28db7fce 994 int dct_algo;
c7e07931 995#define FF_DCT_AUTO 0
28db7fce 996#define FF_DCT_FASTINT 1
c7e07931
MO
997#define FF_DCT_INT 2
998#define FF_DCT_MMX 3
999#define FF_DCT_MLIB 4
05c4072b 1000#define FF_DCT_ALTIVEC 5
65e4c8c9 1001#define FF_DCT_FAAN 6
c5d309f2
MN
1002
1003 /**
64863965
MN
1004 * luminance masking (0-> disabled).
1005 * - encoding: set by user
1006 * - decoding: unused
c5d309f2
MN
1007 */
1008 float lumi_masking;
1009
1010 /**
64863965
MN
1011 * temporary complexity masking (0-> disabled).
1012 * - encoding: set by user
1013 * - decoding: unused
c5d309f2
MN
1014 */
1015 float temporal_cplx_masking;
1016
1017 /**
64863965
MN
1018 * spatial complexity masking (0-> disabled).
1019 * - encoding: set by user
1020 * - decoding: unused
c5d309f2
MN
1021 */
1022 float spatial_cplx_masking;
1023
1024 /**
64863965
MN
1025 * p block masking (0-> disabled).
1026 * - encoding: set by user
1027 * - decoding: unused
c5d309f2
MN
1028 */
1029 float p_masking;
15415af4 1030
5e746b99 1031 /**
64863965
MN
1032 * darkness masking (0-> disabled).
1033 * - encoding: set by user
1034 * - decoding: unused
5e746b99
MN
1035 */
1036 float dark_masking;
0c2dd16e 1037
3a694b04
NK
1038
1039 /* for binary compatibility */
1040 int unused;
1041
0c2dd16e 1042 /**
64863965
MN
1043 * idct algorithm, see FF_IDCT_* below.
1044 * - encoding: set by user
1045 * - decoding: set by user
2ad1516a
MN
1046 */
1047 int idct_algo;
1048#define FF_IDCT_AUTO 0
1049#define FF_IDCT_INT 1
1050#define FF_IDCT_SIMPLE 2
1051#define FF_IDCT_SIMPLEMMX 3
1052#define FF_IDCT_LIBMPEG2MMX 4
1053#define FF_IDCT_PS2 5
1054#define FF_IDCT_MLIB 6
1055#define FF_IDCT_ARM 7
05c4072b 1056#define FF_IDCT_ALTIVEC 8
b82cdc72 1057#define FF_IDCT_SH4 9
bd7d1ea7 1058#define FF_IDCT_SIMPLEARM 10
2ad1516a 1059
144f0625 1060 /**
64863965
MN
1061 * slice count.
1062 * - encoding: set by lavc
1063 * - decoding: set by user (or 0)
144f0625
MN
1064 */
1065 int slice_count;
1066 /**
64863965
MN
1067 * slice offsets in the frame in bytes.
1068 * - encoding: set/allocated by lavc
1069 * - decoding: set/allocated by user (or NULL)
144f0625
MN
1070 */
1071 int *slice_offset;
1072
4d2858de 1073 /**
64863965
MN
1074 * error concealment flags.
1075 * - encoding: unused
1076 * - decoding: set by user
4d2858de
MN
1077 */
1078 int error_concealment;
1079#define FF_EC_GUESS_MVS 1
1080#define FF_EC_DEBLOCK 2
1081
6b72ac63 1082 /**
bec89a84 1083 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1084 * CPU features (i.e. MMX, SSE. ...)
bec89a84
ZK
1085 *
1086 * with FORCE flag you may instead enable given CPU features
1087 * (Dangerous: usable in case of misdetection, improper usage however will
1088 * result into program crash)
1089 */
1090 unsigned dsp_mask;
1091#define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
1092 /* lower 16 bits - CPU features */
1093#ifdef HAVE_MMX
1094#define FF_MM_MMX 0x0001 /* standard MMX */
1095#define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1096#define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1097#define FF_MM_SSE 0x0008 /* SSE functions */
1098#define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1099#endif /* HAVE_MMX */
11f18faf
MN
1100
1101 /**
64863965
MN
1102 * bits per sample/pixel from the demuxer (needed for huffyuv).
1103 * - encoding: set by lavc
1104 * - decoding: set by user
11f18faf
MN
1105 */
1106 int bits_per_sample;
1107
1108 /**
64863965
MN
1109 * prediction method (needed for huffyuv).
1110 * - encoding: set by user
1111 * - decoding: unused
11f18faf
MN
1112 */
1113 int prediction_method;
1114#define FF_PRED_LEFT 0
1115#define FF_PRED_PLANE 1
1116#define FF_PRED_MEDIAN 2
5d3cea3a
MN
1117
1118 /**
5ff85f1d 1119 * sample aspect ratio (0 if unknown).
1f26c6f3 1120 * numerator and denominator must be relative prime and smaller then 256 for some video standards
64863965
MN
1121 * - encoding: set by user.
1122 * - decoding: set by lavc.
5d3cea3a 1123 */
5ff85f1d 1124 AVRational sample_aspect_ratio;
1e491e29
MN
1125
1126 /**
64863965
MN
1127 * the picture in the bitstream.
1128 * - encoding: set by lavc
1129 * - decoding: set by lavc
1e491e29 1130 */
492cd3a9 1131 AVFrame *coded_frame;
c8c437bc
MN
1132
1133 /**
64863965
MN
1134 * debug.
1135 * - encoding: set by user.
1136 * - decoding: set by user.
c8c437bc
MN
1137 */
1138 int debug;
1139#define FF_DEBUG_PICT_INFO 1
1140#define FF_DEBUG_RC 2
1141#define FF_DEBUG_BITSTREAM 4
1142#define FF_DEBUG_MB_TYPE 8
1143#define FF_DEBUG_QP 16
1144#define FF_DEBUG_MV 32
0c9bbaec 1145//#define FF_DEBUG_VIS_MV 0x00000040
41773b73
MN
1146#define FF_DEBUG_SKIP 0x00000080
1147#define FF_DEBUG_STARTCODE 0x00000100
1148#define FF_DEBUG_PTS 0x00000200
46b4feec 1149#define FF_DEBUG_ER 0x00000400
0da71265 1150#define FF_DEBUG_MMCO 0x00000800
8fc6c2b5 1151#define FF_DEBUG_BUGS 0x00001000
864119b6
MN
1152#define FF_DEBUG_VIS_QP 0x00002000
1153#define FF_DEBUG_VIS_MB_TYPE 0x00004000
140cb663
MN
1154
1155 /**
0c9bbaec
WH
1156 * debug.
1157 * - encoding: set by user.
1158 * - decoding: set by user.
1159 */
1160 int debug_mv;
1161#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1162#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1163#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1164
1165 /**
64863965
MN
1166 * error.
1167 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
1168 * - decoding: unused
140cb663
MN
1169 */
1170 uint64_t error[4];
17a70fde
MN
1171
1172 /**
64863965
MN
1173 * minimum MB quantizer.
1174 * - encoding: set by user.
1175 * - decoding: unused
17a70fde
MN
1176 */
1177 int mb_qmin;
1178
1179 /**
64863965
MN
1180 * maximum MB quantizer.
1181 * - encoding: set by user.
1182 * - decoding: unused
17a70fde
MN
1183 */
1184 int mb_qmax;
1457ab52
MN
1185
1186 /**
64863965
MN
1187 * motion estimation compare function.
1188 * - encoding: set by user.
1189 * - decoding: unused
1457ab52
MN
1190 */
1191 int me_cmp;
1192 /**
64863965
MN
1193 * subpixel motion estimation compare function.
1194 * - encoding: set by user.
1195 * - decoding: unused
1457ab52
MN
1196 */
1197 int me_sub_cmp;
1198 /**
64863965
MN
1199 * macroblock compare function (not supported yet).
1200 * - encoding: set by user.
1201 * - decoding: unused
1457ab52
MN
1202 */
1203 int mb_cmp;
622348f9
MN
1204 /**
1205 * interlaced dct compare function
1206 * - encoding: set by user.
1207 * - decoding: unused
1208 */
1209 int ildct_cmp;
1457ab52
MN
1210#define FF_CMP_SAD 0
1211#define FF_CMP_SSE 1
1212#define FF_CMP_SATD 2
1213#define FF_CMP_DCT 3
1214#define FF_CMP_PSNR 4
1215#define FF_CMP_BIT 5
1216#define FF_CMP_RD 6
1217#define FF_CMP_ZERO 7
622348f9
MN
1218#define FF_CMP_VSAD 8
1219#define FF_CMP_VSSE 9
1457ab52
MN
1220#define FF_CMP_CHROMA 256
1221
1222 /**
64863965
MN
1223 * ME diamond size & shape.
1224 * - encoding: set by user.
1225 * - decoding: unused
1457ab52
MN
1226 */
1227 int dia_size;
b07a5980
MN
1228
1229 /**
64863965
MN
1230 * amount of previous MV predictors (2a+1 x 2a+1 square).
1231 * - encoding: set by user.
1232 * - decoding: unused
b07a5980
MN
1233 */
1234 int last_predictor_count;
70ac76c0 1235
f5fb6b34 1236 /**
64863965
MN
1237 * pre pass for motion estimation.
1238 * - encoding: set by user.
1239 * - decoding: unused
f5fb6b34
MN
1240 */
1241 int pre_me;
b07a5980 1242
70ac76c0 1243 /**
64863965
MN
1244 * motion estimation pre pass compare function.
1245 * - encoding: set by user.
1246 * - decoding: unused
70ac76c0
MN
1247 */
1248 int me_pre_cmp;
826f429a 1249
70ac76c0 1250 /**
64863965
MN
1251 * ME pre pass diamond size & shape.
1252 * - encoding: set by user.
1253 * - decoding: unused
70ac76c0
MN
1254 */
1255 int pre_dia_size;
1256
826f429a 1257 /**
64863965
MN
1258 * subpel ME quality.
1259 * - encoding: set by user.
1260 * - decoding: unused
826f429a
MN
1261 */
1262 int me_subpel_quality;
1263
a33c7159 1264 /**
64863965 1265 * callback to negotiate the pixelFormat.
a33c7159
MN
1266 * @param fmt is the list of formats which are supported by the codec,
1267 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1268 * the first is allways the native one
1269 * @return the choosen format
64863965
MN
1270 * - encoding: unused
1271 * - decoding: set by user, if not set then the native format will always be choosen
a33c7159
MN
1272 */
1273 enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
e2f9490e
FB
1274
1275 /**
1276 * DTG active format information (additionnal aspect ratio
1277 * information only used in DVB MPEG2 transport streams). 0 if
1278 * not set.
1279 *
64863965
MN
1280 * - encoding: unused.
1281 * - decoding: set by decoder
e2f9490e
FB
1282 */
1283 int dtg_active_format;
1284#define FF_DTG_AFD_SAME 8
1285#define FF_DTG_AFD_4_3 9
1286#define FF_DTG_AFD_16_9 10
1287#define FF_DTG_AFD_14_9 11
1288#define FF_DTG_AFD_4_3_SP_14_9 13
1289#define FF_DTG_AFD_16_9_SP_14_9 14
1290#define FF_DTG_AFD_SP_4_3 15
1291
ebbcdc9a
MN
1292 /**
1293 * Maximum motion estimation search range in subpel units.
1294 * if 0 then no limit
1295 *
64863965
MN
1296 * - encoding: set by user.
1297 * - decoding: unused.
ebbcdc9a 1298 */
59e0ac8e 1299 int me_range;
ebbcdc9a 1300
65f7062d
MN
1301 /**
1302 * frame_rate_base.
1303 * for variable fps this is 1
1304 * - encoding: set by user.
1305 * - decoding: set by lavc.
1306 * @todo move this after frame_rate
1307 */
65f7062d 1308
1984f635
MN
1309 int frame_rate_base;
1310 /**
1311 * intra quantizer bias.
1312 * - encoding: set by user.
1313 * - decoding: unused
1314 */
1315 int intra_quant_bias;
1316#define FF_DEFAULT_QUANT_BIAS 999999
1317
1318 /**
1319 * inter quantizer bias.
1320 * - encoding: set by user.
1321 * - decoding: unused
1322 */
1323 int inter_quant_bias;
5cd62665
ZK
1324
1325 /**
1326 * color table ID.
1327 * - encoding: unused.
1328 * - decoding: which clrtable should be used for 8bit RGB images
1329 * table have to be stored somewhere FIXME
1330 */
1331 int color_table_id;
1984f635 1332
d90cf87b
MN
1333 /**
1334 * internal_buffer count.
1335 * Dont touch, used by lavc default_get_buffer()
1336 */
1337 int internal_buffer_count;
1338
1339 /**
1340 * internal_buffers.
1341 * Dont touch, used by lavc default_get_buffer()
1342 */
1343 void *internal_buffer;
158c7f05
MN
1344
1345#define FF_LAMBDA_SHIFT 7
1346#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1347#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1348#define FF_LAMBDA_MAX (256*128-1)
1349
1350#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce
MN
1351 /**
1352 * global quality for codecs which cannot change it per frame.
1353 * this should be proportional to MPEG1/2/4 qscale.
1354 * - encoding: set by user.
1355 * - decoding: unused
1356 */
1357 int global_quality;
11e659c2
MN
1358
1359#define FF_CODER_TYPE_VLC 0
1360#define FF_CODER_TYPE_AC 1
1361 /**
1362 * coder type
1363 * - encoding: set by user.
1364 * - decoding: unused
1365 */
1366 int coder_type;
1367
1368 /**
1369 * context model
1370 * - encoding: set by user.
1371 * - decoding: unused
1372 */
1373 int context_model;
3bb07d61
MN
1374
1375 /**
1376 * slice flags
1377 * - encoding: unused
1378 * - decoding: set by user.
1379 */
1380 int slice_flags;
1381#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1382#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1383#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1384
fb364ada
IK
1385 /**
1386 * XVideo Motion Acceleration
1387 * - encoding: forbidden
1388 * - decoding: set by decoder
1389 */
1390 int xvmc_acceleration;
7d1c3fc1
MN
1391
1392 /**
1393 * macroblock decision mode
1394 * - encoding: set by user.
1395 * - decoding: unused
1396 */
1397 int mb_decision;
1398#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1399#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1400#define FF_MB_DECISION_RD 2 ///< rate distoration
d6eb3c50
MN
1401
1402 /**
1403 * custom intra quantization matrix
1404 * - encoding: set by user, can be NULL
1405 * - decoding: set by lavc
1406 */
1407 uint16_t *intra_matrix;
1408
1409 /**
1410 * custom inter quantization matrix
1411 * - encoding: set by user, can be NULL
1412 * - decoding: set by lavc
1413 */
1414 uint16_t *inter_matrix;
7d1c3fc1 1415
541ae140
MN
1416 /**
1417 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1418 * this is used to workaround some encoder bugs
1419 * - encoding: unused
1420 * - decoding: set by user, will be converted to upper case by lavc during init
1421 */
1422 unsigned int stream_codec_tag;
05fbd0a2
MN
1423
1424 /**
1425 * scene change detection threshold.
1426 * 0 is default, larger means fewer detected scene changes
1427 * - encoding: set by user.
1428 * - decoding: unused
1429 */
1430 int scenechange_threshold;
158c7f05
MN
1431
1432 /**
1433 * minimum lagrange multipler
1434 * - encoding: set by user.
1435 * - decoding: unused
1436 */
1437 int lmin;
1438
1439 /**
1440 * maximum lagrange multipler
1441 * - encoding: set by user.
1442 * - decoding: unused
1443 */
1444 int lmax;
2a2bbcb0
MM
1445
1446 /**
1447 * Palette control structure
1448 * - encoding: ??? (no palette-enabled encoder yet)
1449 * - decoding: set by user.
1450 */
1451 struct AVPaletteControl *palctrl;
821cb11f
MN
1452
1453 /**
1454 * noise reduction strength
1455 * - encoding: set by user.
1456 * - decoding: unused
1457 */
1458 int noise_reduction;
fa384dcc 1459
074c4ca7 1460 /**
e1c2a5a0
RT
1461 * called at the beginning of a frame to get cr buffer for it.
1462 * buffer type (size, hints) must be the same. lavc won't check it.
1463 * lavc will pass previous buffer in pic, function should return
1464 * same buffer or new buffer with old frame "painted" into it.
1465 * if pic.data[0] == NULL must behave like get_buffer().
074c4ca7 1466 * - encoding: unused
e1c2a5a0 1467 * - decoding: set by lavc, user can override
074c4ca7 1468 */
e1c2a5a0 1469 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
MN
1470
1471 /**
1472 * number of bits which should be loaded into the rc buffer before decoding starts
1473 * - encoding: set by user.
1474 * - decoding: unused
1475 */
1476 int rc_initial_buffer_occupancy;
1477
1478 /**
1479 *
1480 * - encoding: set by user.
1481 * - decoding: unused
1482 */
1483 int inter_threshold;
1484
1485 /**
1486 * CODEC_FLAG2_*.
1487 * - encoding: set by user.
1488 * - decoding: set by user.
1489 */
1490 int flags2;
7ebfc0ea
MN
1491
1492 /**
1493 * simulates errors in the bitstream to test error concealment.
1494 * - encoding: set by user.
1495 * - decoding: unused.
1496 */
1497 int error_rate;
a1e257b2
MN
1498
1499 /**
1500 * MP3 antialias algorithm, see FF_AA_* below.
1501 * - encoding: unused
1502 * - decoding: set by user
1503 */
1504 int antialias_algo;
1505#define FF_AA_AUTO 0
1506#define FF_AA_FASTINT 1 //not implemented yet
1507#define FF_AA_INT 2
1508#define FF_AA_FLOAT 3
77ea0d4b
MN
1509 /**
1510 * Quantizer noise shaping.
1511 * - encoding: set by user
1512 * - decoding: unused
1513 */
1514 int quantizer_noise_shaping;
de6d9b64
FB
1515} AVCodecContext;
1516
97d96aaa 1517
64863965
MN
1518/**
1519 * AVOption.
1520 */
97d96aaa
ZK
1521typedef struct AVOption {
1522 /** options' name */
1523 const char *name; /* if name is NULL, it indicates a link to next */
bec89a84
ZK
1524 /** short English text help or const struct AVOption* subpointer */
1525 const char *help; // const struct AVOption* sub;
97d96aaa
ZK
1526 /** offset to context structure where the parsed value should be stored */
1527 int offset;
1528 /** options' type */
1529 int type;
64863965
MN
1530#define FF_OPT_TYPE_BOOL 1 ///< boolean - true,1,on (or simply presence)
1531#define FF_OPT_TYPE_DOUBLE 2 ///< double
1532#define FF_OPT_TYPE_INT 3 ///< integer
1533#define FF_OPT_TYPE_STRING 4 ///< string (finished with \0)
1534#define FF_OPT_TYPE_MASK 0x1f ///< mask for types - upper bits are various flags
97d96aaa
ZK
1535//#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1536#define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1537#define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1538 /** min value (min == max -> no limits) */
1539 double min;
1540 /** maximum value for double/int */
1541 double max;
1542 /** default boo [0,1]l/double/int value */
1543 double defval;
1544 /**
1545 * default string value (with optional semicolon delimited extra option-list
1546 * i.e. option1;option2;option3
1547 * defval might select other then first argument as default
1548 */
1549 const char *defstr;
97d96aaa
ZK
1550#define FF_OPT_MAX_DEPTH 10
1551} AVOption;
1552
64863965 1553/**
bec89a84
ZK
1554 * Parse option(s) and sets fields in passed structure
1555 * @param strct structure where the parsed results will be written
1556 * @param list list with AVOptions
1557 * @param opts string with options for parsing
1558 */
1559int avoption_parse(void* strct, const AVOption* list, const char* opts);
1560
1561
1562/**
64863965
MN
1563 * AVCodec.
1564 */
de6d9b64 1565typedef struct AVCodec {
18f77016 1566 const char *name;
5d234974 1567 enum CodecType type;
de6d9b64
FB
1568 int id;
1569 int priv_data_size;
1570 int (*init)(AVCodecContext *);
0c1a9eda 1571 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 1572 int (*close)(AVCodecContext *);
0fd90455 1573 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
0c1a9eda 1574 uint8_t *buf, int buf_size);
bf89e6b1 1575 int capabilities;
97d96aaa 1576 const AVOption *options;
de6d9b64 1577 struct AVCodec *next;
7a06ff14 1578 void (*flush)(AVCodecContext *);
de6d9b64
FB
1579} AVCodec;
1580
97d96aaa 1581/**
d7425f59
MN
1582 * four components are given, that's all.
1583 * the last component is alpha
1584 */
de6d9b64 1585typedef struct AVPicture {
0c1a9eda 1586 uint8_t *data[4];
cd394651 1587 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
1588} AVPicture;
1589
ba118447
MM
1590/**
1591 * AVPaletteControl
1592 * This structure defines a method for communicating palette changes
1593 * between and demuxer and a decoder.
1594 */
2e99641b 1595#define AVPALETTE_SIZE 1024
432d84c3 1596#define AVPALETTE_COUNT 256
ba118447
MM
1597typedef struct AVPaletteControl {
1598
1599 /* demuxer sets this to 1 to indicate the palette has changed;
1600 * decoder resets to 0 */
1601 int palette_changed;
1602
2a2bbcb0
MM
1603 /* 4-byte ARGB palette entries, stored in native byte order; note that
1604 * the individual palette components should be on a 8-bit scale; if
1605 * the palette data comes from a IBM VGA native format, the component
1606 * data is probably 6 bits in size and needs to be scaled */
2e99641b 1607 unsigned int palette[AVPALETTE_COUNT];
ba118447
MM
1608
1609} AVPaletteControl;
1610
de6d9b64
FB
1611extern AVCodec ac3_encoder;
1612extern AVCodec mp2_encoder;
9d36bdc9 1613extern AVCodec mp3lame_encoder;
81e0d0b4 1614extern AVCodec oggvorbis_encoder;
29d48296 1615extern AVCodec faac_encoder;
de6d9b64 1616extern AVCodec mpeg1video_encoder;
029911d1 1617extern AVCodec mpeg2video_encoder;
de6d9b64
FB
1618extern AVCodec h263_encoder;
1619extern AVCodec h263p_encoder;
d4f5d74a 1620extern AVCodec flv_encoder;
de6d9b64 1621extern AVCodec rv10_encoder;
68b94c35 1622extern AVCodec rv20_encoder;
de6d9b64 1623extern AVCodec mjpeg_encoder;
b1e6b355 1624extern AVCodec ljpeg_encoder;
bf89e6b1 1625extern AVCodec mpeg4_encoder;
84afee34
MN
1626extern AVCodec msmpeg4v1_encoder;
1627extern AVCodec msmpeg4v2_encoder;
1628extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
1629extern AVCodec wmv1_encoder;
1630extern AVCodec wmv2_encoder;
11f18faf 1631extern AVCodec huffyuv_encoder;
0da71265 1632extern AVCodec h264_encoder;
3d2e8cce 1633extern AVCodec asv1_encoder;
9b56edf5 1634extern AVCodec asv2_encoder;
be3564ed 1635extern AVCodec vcr1_encoder;
5e20f836 1636extern AVCodec ffv1_encoder;
c3bf0288 1637extern AVCodec mdec_encoder;
a273bbfb 1638extern AVCodec zlib_encoder;
de6d9b64
FB
1639
1640extern AVCodec h263_decoder;
bf89e6b1 1641extern AVCodec mpeg4_decoder;
84afee34
MN
1642extern AVCodec msmpeg4v1_decoder;
1643extern AVCodec msmpeg4v2_decoder;
1644extern AVCodec msmpeg4v3_decoder;
e1a9dbff 1645extern AVCodec wmv1_decoder;
0151a6f5 1646extern AVCodec wmv2_decoder;
922bc38d
MN
1647extern AVCodec mpeg1video_decoder;
1648extern AVCodec mpeg2video_decoder;
c512b303 1649extern AVCodec mpegvideo_decoder;
fb364ada 1650extern AVCodec mpeg_xvmc_decoder;
de6d9b64 1651extern AVCodec h263i_decoder;
d4f5d74a 1652extern AVCodec flv_decoder;
de6d9b64 1653extern AVCodec rv10_decoder;
68b94c35 1654extern AVCodec rv20_decoder;
be8ffec9 1655extern AVCodec svq1_decoder;
8b82a956 1656extern AVCodec svq3_decoder;
020fcc94 1657extern AVCodec dvvideo_decoder;
bc8d1857
FB
1658extern AVCodec wmav1_decoder;
1659extern AVCodec wmav2_decoder;
4e66ab3b 1660extern AVCodec mjpeg_decoder;
b135d9fb 1661extern AVCodec mjpegb_decoder;
5e83dec4 1662extern AVCodec sp5x_decoder;
4b1f4f23 1663extern AVCodec mp2_decoder;
a96b68b7 1664extern AVCodec mp3_decoder;
3f95e843
FR
1665extern AVCodec mace3_decoder;
1666extern AVCodec mace6_decoder;
11f18faf 1667extern AVCodec huffyuv_decoder;
3aca208a 1668extern AVCodec oggvorbis_decoder;
f70f7c6d 1669extern AVCodec cyuv_decoder;
0da71265 1670extern AVCodec h264_decoder;
deabd4fd 1671extern AVCodec indeo3_decoder;
d86053a4 1672extern AVCodec vp3_decoder;
f44ee2c3 1673extern AVCodec theora_decoder;
891f64b3 1674extern AVCodec amr_nb_decoder;
bc634f6f 1675extern AVCodec amr_nb_encoder;
d663a1fd
MN
1676extern AVCodec amr_wb_encoder;
1677extern AVCodec amr_wb_decoder;
280bd7b7
ZK
1678extern AVCodec aac_decoder;
1679extern AVCodec mpeg4aac_decoder;
3d2e8cce 1680extern AVCodec asv1_decoder;
9b56edf5 1681extern AVCodec asv2_decoder;
be3564ed 1682extern AVCodec vcr1_decoder;
3aff069b 1683extern AVCodec cljr_decoder;
5e20f836 1684extern AVCodec ffv1_decoder;
8809cfee 1685extern AVCodec fourxm_decoder;
c3bf0288 1686extern AVCodec mdec_decoder;
3ef8be2b
MM
1687extern AVCodec roq_decoder;
1688extern AVCodec interplay_video_decoder;
9937e686 1689extern AVCodec xan_wc3_decoder;
2fdf638b
MM
1690extern AVCodec rpza_decoder;
1691extern AVCodec cinepak_decoder;
1692extern AVCodec msrle_decoder;
1693extern AVCodec msvideo1_decoder;
6955a882 1694extern AVCodec vqa_decoder;
4120a53a 1695extern AVCodec idcin_decoder;
1dc1ed99 1696extern AVCodec eightbps_decoder;
11e29a41 1697extern AVCodec smc_decoder;
42cad81a 1698extern AVCodec flic_decoder;
fafa0b75
MM
1699extern AVCodec vmdvideo_decoder;
1700extern AVCodec vmdaudio_decoder;
9a4117d5 1701extern AVCodec truemotion1_decoder;
a273bbfb
RT
1702extern AVCodec mszh_decoder;
1703extern AVCodec zlib_decoder;
b8414bbd
NK
1704extern AVCodec ra_144_decoder;
1705extern AVCodec ra_288_decoder;
3ef8be2b
MM
1706extern AVCodec roq_dpcm_decoder;
1707extern AVCodec interplay_dpcm_decoder;
9937e686 1708extern AVCodec xan_dpcm_decoder;
de6d9b64 1709
a96b68b7
FB
1710/* pcm codecs */
1711#define PCM_CODEC(id, name) \
1712extern AVCodec name ## _decoder; \
f11d3f23 1713extern AVCodec name ## _encoder
a96b68b7
FB
1714
1715PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
1716PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
1717PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
1718PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
1719PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
1720PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
1721PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
1722PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
1723
0147f198
FR
1724/* adpcm codecs */
1725
1726PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
1727PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
9937e686
MM
1728PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
1729PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2fdf638b 1730PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
7d8379f2 1731PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
0147f198 1732PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
4b465299 1733PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
fc384777
MM
1734PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
1735PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
7d8379f2 1736PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
0147f198 1737
a96b68b7
FB
1738#undef PCM_CODEC
1739
1740/* dummy raw video codec */
63167088
RS
1741extern AVCodec rawvideo_encoder;
1742extern AVCodec rawvideo_decoder;
de6d9b64
FB
1743
1744/* the following codecs use external GPL libs */
de6d9b64
FB
1745extern AVCodec ac3_decoder;
1746
1747/* resample.c */
1748
1749struct ReSampleContext;
1750
1751typedef struct ReSampleContext ReSampleContext;
1752
1753ReSampleContext *audio_resample_init(int output_channels, int input_channels,
1754 int output_rate, int input_rate);
1755int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
1756void audio_resample_close(ReSampleContext *s);
1757
1758/* YUV420 format is assumed ! */
1759
1760struct ImgReSampleContext;
1761
1762typedef struct ImgReSampleContext ImgReSampleContext;
1763
1764ImgReSampleContext *img_resample_init(int output_width, int output_height,
1765 int input_width, int input_height);
ab6d194a
MN
1766
1767ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1768 int iwidth, int iheight,
1769 int topBand, int bottomBand,
1770 int leftBand, int rightBand);
1771
de6d9b64 1772void img_resample(ImgReSampleContext *s,
da64ecc3 1773 AVPicture *output, const AVPicture *input);
de6d9b64
FB
1774
1775void img_resample_close(ImgReSampleContext *s);
1776
75917b88
DH
1777/**
1778 * Allocate memory for a picture. Call avpicture_free to free it.
1779 *
1780 * @param picture the picture to be filled in.
1781 * @param pix_fmt the format of the picture.
1782 * @param width the width of the picture.
1783 * @param height the height of the picture.
1784 * @return 0 if successful, -1 if not.
1785 */
1786int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
1787
1788/* Free a picture previously allocated by avpicture_alloc. */
1789void avpicture_free(AVPicture *picture);
1790
0c1a9eda 1791int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2d1a4094 1792 int pix_fmt, int width, int height);
da64ecc3 1793int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
63167088 1794 unsigned char *dest, int dest_size);
219b06c6 1795int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
FB
1796void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
1797const char *avcodec_get_pix_fmt_name(int pix_fmt);
63167088 1798enum PixelFormat avcodec_get_pix_fmt(const char* name);
219b06c6 1799
fab21997
FB
1800#define FF_LOSS_RESOLUTION 0x0001 /* loss due to resolution change */
1801#define FF_LOSS_DEPTH 0x0002 /* loss due to color depth change */
1802#define FF_LOSS_COLORSPACE 0x0004 /* loss due to color space conversion */
1803#define FF_LOSS_ALPHA 0x0008 /* loss of alpha bits */
1804#define FF_LOSS_COLORQUANT 0x0010 /* loss due to color quantization */
1805#define FF_LOSS_CHROMA 0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
1806
1807int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
1808 int has_alpha);
1809int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
1810 int has_alpha, int *loss_ptr);
1811
0469baf1
FB
1812#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
1813#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
da64ecc3
DH
1814int img_get_alpha_info(const AVPicture *src,
1815 int pix_fmt, int width, int height);
0469baf1 1816
219b06c6
FB
1817/* convert among pixel formats */
1818int img_convert(AVPicture *dst, int dst_pix_fmt,
da64ecc3 1819 const AVPicture *src, int pix_fmt,
219b06c6
FB
1820 int width, int height);
1821
1822/* deinterlace a picture */
da64ecc3 1823int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
de6d9b64
FB
1824 int pix_fmt, int width, int height);
1825
1826/* external high level API */
1827
1828extern AVCodec *first_avcodec;
1829
156e5023 1830/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 1831unsigned avcodec_version(void);
8bceb6af 1832/* returns LIBAVCODEC_BUILD constant */
51a49663 1833unsigned avcodec_build(void);
de6d9b64
FB
1834void avcodec_init(void);
1835
1836void register_avcodec(AVCodec *format);
1837AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 1838AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
1839AVCodec *avcodec_find_decoder(enum CodecID id);
1840AVCodec *avcodec_find_decoder_by_name(const char *name);
1841void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1842
1e491e29 1843void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 1844AVCodecContext *avcodec_alloc_context(void);
492cd3a9 1845AVFrame *avcodec_alloc_frame(void);
1e491e29 1846
492cd3a9
MN
1847int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1848void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
d90cf87b 1849void avcodec_default_free_buffers(AVCodecContext *s);
1e491e29 1850
7a06ff14
MN
1851/**
1852 * opens / inits the AVCodecContext.
1853 * not thread save!
1854 */
de6d9b64 1855int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
7a06ff14 1856
0c1a9eda 1857int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
de6d9b64 1858 int *frame_size_ptr,
0c1a9eda 1859 uint8_t *buf, int buf_size);
492cd3a9 1860int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64 1861 int *got_picture_ptr,
0c1a9eda
ZK
1862 uint8_t *buf, int buf_size);
1863int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
917e06c8 1864 int *data_size_ptr,
0c1a9eda
ZK
1865 uint8_t *buf, int buf_size);
1866int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
de6d9b64 1867 const short *samples);
0c1a9eda 1868int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
492cd3a9 1869 const AVFrame *pict);
de6d9b64
FB
1870
1871int avcodec_close(AVCodecContext *avctx);
1872
1873void avcodec_register_all(void);
a96b68b7 1874
1c2a8c7f
MN
1875void avcodec_flush_buffers(AVCodecContext *avctx);
1876
14bea432 1877/* misc usefull functions */
d8085ea7
MN
1878
1879/**
1880 * returns a single letter to describe the picture type
1881 */
1882char av_get_pict_type_char(int pict_type);
1883
14bea432
MN
1884/**
1885 * reduce a fraction.
1886 * this is usefull for framerate calculations
1887 * @param max the maximum allowed for dst_nom & dst_den
1888 * @return 1 if exact, 0 otherwise
1889 */
1890int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
1891
1892/**
1893 * rescale a 64bit integer.
1894 * a simple a*b/c isnt possible as it can overflow
1895 */
1896int64_t av_rescale(int64_t a, int b, int c);
628d601b 1897
628d601b 1898
e8f14793
ZK
1899/**
1900 * Interface for 0.5.0 version
1901 *
1902 * do not even think about it's usage for this moment
1903 */
1904
1905typedef struct {
64863965 1906 /// compressed size used from given memory buffer
e8f14793
ZK
1907 int size;
1908 /// I/P/B frame type
1909 int frame_type;
1910} avc_enc_result_t;
1911
1912/**
1913 * Commands
1914 * order can't be changed - once it was defined
1915 */
1916typedef enum {
1917 // general commands
1918 AVC_OPEN_BY_NAME = 0xACA000,
1919 AVC_OPEN_BY_CODEC_ID,
1920 AVC_OPEN_BY_FOURCC,
1921 AVC_CLOSE,
1922
1923 AVC_FLUSH,
1924 // pin - struct { uint8_t* src, uint_t src_size }
1925 // pout - struct { AVPicture* img, consumed_bytes,
1926 AVC_DECODE,
1927 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1928 // pout - uint_t used_from_dest_size
1929 AVC_ENCODE,
1930
1931 // query/get video commands
1932 AVC_GET_VERSION = 0xACB000,
1933 AVC_GET_WIDTH,
1934 AVC_GET_HEIGHT,
1935 AVC_GET_DELAY,
1936 AVC_GET_QUANT_TABLE,
1937 // ...
1938
1939 // query/get audio commands
1940 AVC_GET_FRAME_SIZE = 0xABC000,
1941
1942 // maybe define some simple structure which
1943 // might be passed to the user - but they can't
1944 // contain any codec specific parts and these
1945 // calls are usualy necessary only few times
1946
1947 // set video commands
1948 AVC_SET_WIDTH = 0xACD000,
1949 AVC_SET_HEIGHT,
1950
1951 // set video encoding commands
1952 AVC_SET_FRAME_RATE = 0xACD800,
1953 AVC_SET_QUALITY,
1954 AVC_SET_HURRY_UP,
1955
1956 // set audio commands
1957 AVC_SET_SAMPLE_RATE = 0xACE000,
1958 AVC_SET_CHANNELS,
1959
1960} avc_cmd_t;
1961
1962/**
1963 * \param handle allocated private structure by libavcodec
1964 * for initialization pass NULL - will be returned pout
1965 * user is supposed to know nothing about its structure
1966 * \param cmd type of operation to be performed
1967 * \param pint input parameter
1968 * \param pout output parameter
1969 *
1970 * \returns command status - eventually for query command it might return
1971 * integer resulting value
1972 */
1973int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1974
8424cf50
FB
1975/* frame parsing */
1976typedef struct AVCodecParserContext {
1977 void *priv_data;
1978 struct AVCodecParser *parser;
1979 int64_t frame_offset; /* offset of the current frame */
1980 int64_t cur_offset; /* current offset
1981 (incremented by each av_parser_parse()) */
1982 int64_t last_frame_offset; /* offset of the last frame */
1983 /* video info */
1984 int pict_type; /* XXX: put it back in AVCodecContext */
1985 int repeat_pict; /* XXX: put it back in AVCodecContext */
b84f2a35
FB
1986 int64_t pts; /* pts of the current frame */
1987 int64_t dts; /* dts of the current frame */
1988
1989 /* private data */
1990 int64_t last_pts;
1991 int64_t last_dts;
1992
1993#define AV_PARSER_PTS_NB 4
1994 int cur_frame_start_index;
1995 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
1996 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
1997 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
8424cf50
FB
1998} AVCodecParserContext;
1999
2000typedef struct AVCodecParser {
2001 int codec_ids[3]; /* several codec IDs are permitted */
2002 int priv_data_size;
2003 int (*parser_init)(AVCodecParserContext *s);
2004 int (*parser_parse)(AVCodecParserContext *s,
2005 AVCodecContext *avctx,
2006 uint8_t **poutbuf, int *poutbuf_size,
2007 const uint8_t *buf, int buf_size);
2008 void (*parser_close)(AVCodecParserContext *s);
2009 struct AVCodecParser *next;
2010} AVCodecParser;
2011
2012extern AVCodecParser *av_first_parser;
2013
2014void av_register_codec_parser(AVCodecParser *parser);
2015AVCodecParserContext *av_parser_init(int codec_id);
2016int av_parser_parse(AVCodecParserContext *s,
2017 AVCodecContext *avctx,
2018 uint8_t **poutbuf, int *poutbuf_size,
b84f2a35
FB
2019 const uint8_t *buf, int buf_size,
2020 int64_t pts, int64_t dts);
8424cf50
FB
2021void av_parser_close(AVCodecParserContext *s);
2022
2023extern AVCodecParser mpegvideo_parser;
2024extern AVCodecParser mpeg4video_parser;
2025extern AVCodecParser h263_parser;
2026extern AVCodecParser h264_parser;
2027extern AVCodecParser mpegaudio_parser;
2028extern AVCodecParser ac3_parser;
2029
544eb99c 2030/* memory */
e4eadb4b 2031void *av_malloc(unsigned int size);
18f77016 2032void *av_mallocz(unsigned int size);
8e1e6f31 2033void *av_realloc(void *ptr, unsigned int size);
544eb99c 2034void av_free(void *ptr);
8e1e6f31 2035char *av_strdup(const char *s);
544eb99c
FB
2036void __av_freep(void **ptr);
2037#define av_freep(p) __av_freep((void **)(p))
97d96aaa 2038void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
855ea723
ZK
2039/* for static data only */
2040/* call av_free_static to release all staticaly allocated tables */
628d601b 2041void av_free_static(void);
855ea723
ZK
2042void *__av_mallocz_static(void** location, unsigned int size);
2043#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 2044
fc384777
MM
2045/* add by bero : in adx.c */
2046int is_adx(const unsigned char *buf,size_t bufsize);
2047
e1c2a5a0
RT
2048void img_copy(AVPicture *dst, const AVPicture *src,
2049 int pix_fmt, int width, int height);
2050
9b879566
MB
2051/* av_log API */
2052
2053#include <stdarg.h>
2054
2055#define AV_LOG_ERROR 0
2056#define AV_LOG_INFO 1
2057#define AV_LOG_DEBUG 2
2058
2059extern void av_log(AVCodecContext*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
2060extern void av_vlog(AVCodecContext*, int level, const char *fmt, va_list);
2061extern int av_log_get_level(void);
2062extern void av_log_set_level(int);
2063extern void av_log_set_callback(void (*)(AVCodecContext*, int, const char*, va_list));
2064
2065#undef AV_LOG_TRAP_PRINTF
2066#ifdef AV_LOG_TRAP_PRINTF
2067#define printf DO NOT USE
2068#define fprintf DO NOT USE
2069#undef stderr
2070#define stderr DO NOT USE
2071#endif
2072
02d697aa
ZK
2073#ifdef __cplusplus
2074}
2075#endif
2076
a96b68b7 2077#endif /* AVCODEC_H */