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