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