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