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