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