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