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