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