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