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