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