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