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