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