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