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