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