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