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