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