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