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