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