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