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