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