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