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