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