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