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