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