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