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