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