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