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