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