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