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