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