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