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