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