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