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