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