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