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