ce862b66c0d5b69dd1b6a150465c826db988b8ea
[ffmpeg.git] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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
26  * external API header
27  */
28
29 #include <errno.h>
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
37
38 #include "libavcodec/version.h"
39
40 /**
41  * Identify the syntax and semantics of the bitstream.
42  * The principle is roughly:
43  * Two decoders with the same ID can decode the same streams.
44  * Two encoders with the same ID can encode compatible streams.
45  * There may be slight deviations from the principle due to implementation
46  * details.
47  *
48  * If you add a codec ID to this list, add it so that
49  * 1. no value of a existing codec ID changes (that would break ABI),
50  * 2. it is as close as possible to similar codecs.
51  */
52 enum CodecID {
53     CODEC_ID_NONE,
54
55     /* video codecs */
56     CODEC_ID_MPEG1VIDEO,
57     CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
58     CODEC_ID_MPEG2VIDEO_XVMC,
59     CODEC_ID_H261,
60     CODEC_ID_H263,
61     CODEC_ID_RV10,
62     CODEC_ID_RV20,
63     CODEC_ID_MJPEG,
64     CODEC_ID_MJPEGB,
65     CODEC_ID_LJPEG,
66     CODEC_ID_SP5X,
67     CODEC_ID_JPEGLS,
68     CODEC_ID_MPEG4,
69     CODEC_ID_RAWVIDEO,
70     CODEC_ID_MSMPEG4V1,
71     CODEC_ID_MSMPEG4V2,
72     CODEC_ID_MSMPEG4V3,
73     CODEC_ID_WMV1,
74     CODEC_ID_WMV2,
75     CODEC_ID_H263P,
76     CODEC_ID_H263I,
77     CODEC_ID_FLV1,
78     CODEC_ID_SVQ1,
79     CODEC_ID_SVQ3,
80     CODEC_ID_DVVIDEO,
81     CODEC_ID_HUFFYUV,
82     CODEC_ID_CYUV,
83     CODEC_ID_H264,
84     CODEC_ID_INDEO3,
85     CODEC_ID_VP3,
86     CODEC_ID_THEORA,
87     CODEC_ID_ASV1,
88     CODEC_ID_ASV2,
89     CODEC_ID_FFV1,
90     CODEC_ID_4XM,
91     CODEC_ID_VCR1,
92     CODEC_ID_CLJR,
93     CODEC_ID_MDEC,
94     CODEC_ID_ROQ,
95     CODEC_ID_INTERPLAY_VIDEO,
96     CODEC_ID_XAN_WC3,
97     CODEC_ID_XAN_WC4,
98     CODEC_ID_RPZA,
99     CODEC_ID_CINEPAK,
100     CODEC_ID_WS_VQA,
101     CODEC_ID_MSRLE,
102     CODEC_ID_MSVIDEO1,
103     CODEC_ID_IDCIN,
104     CODEC_ID_8BPS,
105     CODEC_ID_SMC,
106     CODEC_ID_FLIC,
107     CODEC_ID_TRUEMOTION1,
108     CODEC_ID_VMDVIDEO,
109     CODEC_ID_MSZH,
110     CODEC_ID_ZLIB,
111     CODEC_ID_QTRLE,
112     CODEC_ID_SNOW,
113     CODEC_ID_TSCC,
114     CODEC_ID_ULTI,
115     CODEC_ID_QDRAW,
116     CODEC_ID_VIXL,
117     CODEC_ID_QPEG,
118     CODEC_ID_PNG,
119     CODEC_ID_PPM,
120     CODEC_ID_PBM,
121     CODEC_ID_PGM,
122     CODEC_ID_PGMYUV,
123     CODEC_ID_PAM,
124     CODEC_ID_FFVHUFF,
125     CODEC_ID_RV30,
126     CODEC_ID_RV40,
127     CODEC_ID_VC1,
128     CODEC_ID_WMV3,
129     CODEC_ID_LOCO,
130     CODEC_ID_WNV1,
131     CODEC_ID_AASC,
132     CODEC_ID_INDEO2,
133     CODEC_ID_FRAPS,
134     CODEC_ID_TRUEMOTION2,
135     CODEC_ID_BMP,
136     CODEC_ID_CSCD,
137     CODEC_ID_MMVIDEO,
138     CODEC_ID_ZMBV,
139     CODEC_ID_AVS,
140     CODEC_ID_SMACKVIDEO,
141     CODEC_ID_NUV,
142     CODEC_ID_KMVC,
143     CODEC_ID_FLASHSV,
144     CODEC_ID_CAVS,
145     CODEC_ID_JPEG2000,
146     CODEC_ID_VMNC,
147     CODEC_ID_VP5,
148     CODEC_ID_VP6,
149     CODEC_ID_VP6F,
150     CODEC_ID_TARGA,
151     CODEC_ID_DSICINVIDEO,
152     CODEC_ID_TIERTEXSEQVIDEO,
153     CODEC_ID_TIFF,
154     CODEC_ID_GIF,
155     CODEC_ID_FFH264,
156     CODEC_ID_DXA,
157     CODEC_ID_DNXHD,
158     CODEC_ID_THP,
159     CODEC_ID_SGI,
160     CODEC_ID_C93,
161     CODEC_ID_BETHSOFTVID,
162     CODEC_ID_PTX,
163     CODEC_ID_TXD,
164     CODEC_ID_VP6A,
165     CODEC_ID_AMV,
166     CODEC_ID_VB,
167     CODEC_ID_PCX,
168     CODEC_ID_SUNRAST,
169     CODEC_ID_INDEO4,
170     CODEC_ID_INDEO5,
171     CODEC_ID_MIMIC,
172     CODEC_ID_RL2,
173     CODEC_ID_8SVX_EXP,
174     CODEC_ID_8SVX_FIB,
175     CODEC_ID_ESCAPE124,
176     CODEC_ID_DIRAC,
177     CODEC_ID_BFI,
178     CODEC_ID_CMV,
179     CODEC_ID_MOTIONPIXELS,
180     CODEC_ID_TGV,
181     CODEC_ID_TGQ,
182     CODEC_ID_TQI,
183     CODEC_ID_AURA,
184     CODEC_ID_AURA2,
185     CODEC_ID_V210X,
186     CODEC_ID_TMV,
187     CODEC_ID_V210,
188     CODEC_ID_DPX,
189     CODEC_ID_MAD,
190     CODEC_ID_FRWU,
191     CODEC_ID_FLASHSV2,
192     CODEC_ID_CDGRAPHICS,
193     CODEC_ID_R210,
194     CODEC_ID_ANM,
195     CODEC_ID_BINKVIDEO,
196     CODEC_ID_IFF_ILBM,
197     CODEC_ID_IFF_BYTERUN1,
198     CODEC_ID_KGV1,
199     CODEC_ID_YOP,
200     CODEC_ID_VP8,
201     CODEC_ID_PICTOR,
202     CODEC_ID_ANSI,
203     CODEC_ID_A64_MULTI,
204     CODEC_ID_A64_MULTI5,
205     CODEC_ID_R10K,
206     CODEC_ID_MXPEG,
207     CODEC_ID_LAGARITH,
208     CODEC_ID_PRORES,
209     CODEC_ID_JV,
210     CODEC_ID_DFA,
211     CODEC_ID_WMV3IMAGE,
212     CODEC_ID_VC1IMAGE,
213
214     /* various PCM "codecs" */
215     CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
216     CODEC_ID_PCM_S16LE= 0x10000,
217     CODEC_ID_PCM_S16BE,
218     CODEC_ID_PCM_U16LE,
219     CODEC_ID_PCM_U16BE,
220     CODEC_ID_PCM_S8,
221     CODEC_ID_PCM_U8,
222     CODEC_ID_PCM_MULAW,
223     CODEC_ID_PCM_ALAW,
224     CODEC_ID_PCM_S32LE,
225     CODEC_ID_PCM_S32BE,
226     CODEC_ID_PCM_U32LE,
227     CODEC_ID_PCM_U32BE,
228     CODEC_ID_PCM_S24LE,
229     CODEC_ID_PCM_S24BE,
230     CODEC_ID_PCM_U24LE,
231     CODEC_ID_PCM_U24BE,
232     CODEC_ID_PCM_S24DAUD,
233     CODEC_ID_PCM_ZORK,
234     CODEC_ID_PCM_S16LE_PLANAR,
235     CODEC_ID_PCM_DVD,
236     CODEC_ID_PCM_F32BE,
237     CODEC_ID_PCM_F32LE,
238     CODEC_ID_PCM_F64BE,
239     CODEC_ID_PCM_F64LE,
240     CODEC_ID_PCM_BLURAY,
241     CODEC_ID_PCM_LXF,
242     CODEC_ID_S302M,
243
244     /* various ADPCM codecs */
245     CODEC_ID_ADPCM_IMA_QT= 0x11000,
246     CODEC_ID_ADPCM_IMA_WAV,
247     CODEC_ID_ADPCM_IMA_DK3,
248     CODEC_ID_ADPCM_IMA_DK4,
249     CODEC_ID_ADPCM_IMA_WS,
250     CODEC_ID_ADPCM_IMA_SMJPEG,
251     CODEC_ID_ADPCM_MS,
252     CODEC_ID_ADPCM_4XM,
253     CODEC_ID_ADPCM_XA,
254     CODEC_ID_ADPCM_ADX,
255     CODEC_ID_ADPCM_EA,
256     CODEC_ID_ADPCM_G726,
257     CODEC_ID_ADPCM_CT,
258     CODEC_ID_ADPCM_SWF,
259     CODEC_ID_ADPCM_YAMAHA,
260     CODEC_ID_ADPCM_SBPRO_4,
261     CODEC_ID_ADPCM_SBPRO_3,
262     CODEC_ID_ADPCM_SBPRO_2,
263     CODEC_ID_ADPCM_THP,
264     CODEC_ID_ADPCM_IMA_AMV,
265     CODEC_ID_ADPCM_EA_R1,
266     CODEC_ID_ADPCM_EA_R3,
267     CODEC_ID_ADPCM_EA_R2,
268     CODEC_ID_ADPCM_IMA_EA_SEAD,
269     CODEC_ID_ADPCM_IMA_EA_EACS,
270     CODEC_ID_ADPCM_EA_XAS,
271     CODEC_ID_ADPCM_EA_MAXIS_XA,
272     CODEC_ID_ADPCM_IMA_ISS,
273     CODEC_ID_ADPCM_G722,
274
275     /* AMR */
276     CODEC_ID_AMR_NB= 0x12000,
277     CODEC_ID_AMR_WB,
278
279     /* RealAudio codecs*/
280     CODEC_ID_RA_144= 0x13000,
281     CODEC_ID_RA_288,
282
283     /* various DPCM codecs */
284     CODEC_ID_ROQ_DPCM= 0x14000,
285     CODEC_ID_INTERPLAY_DPCM,
286     CODEC_ID_XAN_DPCM,
287     CODEC_ID_SOL_DPCM,
288
289     /* audio codecs */
290     CODEC_ID_MP2= 0x15000,
291     CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
292     CODEC_ID_AAC,
293     CODEC_ID_AC3,
294     CODEC_ID_DTS,
295     CODEC_ID_VORBIS,
296     CODEC_ID_DVAUDIO,
297     CODEC_ID_WMAV1,
298     CODEC_ID_WMAV2,
299     CODEC_ID_MACE3,
300     CODEC_ID_MACE6,
301     CODEC_ID_VMDAUDIO,
302     CODEC_ID_SONIC,
303     CODEC_ID_SONIC_LS,
304     CODEC_ID_FLAC,
305     CODEC_ID_MP3ADU,
306     CODEC_ID_MP3ON4,
307     CODEC_ID_SHORTEN,
308     CODEC_ID_ALAC,
309     CODEC_ID_WESTWOOD_SND1,
310     CODEC_ID_GSM, ///< as in Berlin toast format
311     CODEC_ID_QDM2,
312     CODEC_ID_COOK,
313     CODEC_ID_TRUESPEECH,
314     CODEC_ID_TTA,
315     CODEC_ID_SMACKAUDIO,
316     CODEC_ID_QCELP,
317     CODEC_ID_WAVPACK,
318     CODEC_ID_DSICINAUDIO,
319     CODEC_ID_IMC,
320     CODEC_ID_MUSEPACK7,
321     CODEC_ID_MLP,
322     CODEC_ID_GSM_MS, /* as found in WAV */
323     CODEC_ID_ATRAC3,
324     CODEC_ID_VOXWARE,
325     CODEC_ID_APE,
326     CODEC_ID_NELLYMOSER,
327     CODEC_ID_MUSEPACK8,
328     CODEC_ID_SPEEX,
329     CODEC_ID_WMAVOICE,
330     CODEC_ID_WMAPRO,
331     CODEC_ID_WMALOSSLESS,
332     CODEC_ID_ATRAC3P,
333     CODEC_ID_EAC3,
334     CODEC_ID_SIPR,
335     CODEC_ID_MP1,
336     CODEC_ID_TWINVQ,
337     CODEC_ID_TRUEHD,
338     CODEC_ID_MP4ALS,
339     CODEC_ID_ATRAC1,
340     CODEC_ID_BINKAUDIO_RDFT,
341     CODEC_ID_BINKAUDIO_DCT,
342     CODEC_ID_AAC_LATM,
343     CODEC_ID_QDMC,
344
345     /* subtitle codecs */
346     CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
347     CODEC_ID_DVD_SUBTITLE= 0x17000,
348     CODEC_ID_DVB_SUBTITLE,
349     CODEC_ID_TEXT,  ///< raw UTF-8 text
350     CODEC_ID_XSUB,
351     CODEC_ID_SSA,
352     CODEC_ID_MOV_TEXT,
353     CODEC_ID_HDMV_PGS_SUBTITLE,
354     CODEC_ID_DVB_TELETEXT,
355     CODEC_ID_SRT,
356
357     /* other specific kind of codecs (generally used for attachments) */
358     CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
359     CODEC_ID_TTF= 0x18000,
360
361     CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
362
363     CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
364                                 * stream (only used by libavformat) */
365     CODEC_ID_FFMETADATA=0x21000,   ///< Dummy codec for streams containing only metadata information.
366 };
367
368 #if FF_API_OLD_SAMPLE_FMT
369 #define SampleFormat AVSampleFormat
370
371 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
372 #define SAMPLE_FMT_U8   AV_SAMPLE_FMT_U8
373 #define SAMPLE_FMT_S16  AV_SAMPLE_FMT_S16
374 #define SAMPLE_FMT_S32  AV_SAMPLE_FMT_S32
375 #define SAMPLE_FMT_FLT  AV_SAMPLE_FMT_FLT
376 #define SAMPLE_FMT_DBL  AV_SAMPLE_FMT_DBL
377 #define SAMPLE_FMT_NB   AV_SAMPLE_FMT_NB
378 #endif
379
380 #if FF_API_OLD_AUDIOCONVERT
381 #include "libavutil/audioconvert.h"
382
383 /* Audio channel masks */
384 #define CH_FRONT_LEFT            AV_CH_FRONT_LEFT
385 #define CH_FRONT_RIGHT           AV_CH_FRONT_RIGHT
386 #define CH_FRONT_CENTER          AV_CH_FRONT_CENTER
387 #define CH_LOW_FREQUENCY         AV_CH_LOW_FREQUENCY
388 #define CH_BACK_LEFT             AV_CH_BACK_LEFT
389 #define CH_BACK_RIGHT            AV_CH_BACK_RIGHT
390 #define CH_FRONT_LEFT_OF_CENTER  AV_CH_FRONT_LEFT_OF_CENTER
391 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
392 #define CH_BACK_CENTER           AV_CH_BACK_CENTER
393 #define CH_SIDE_LEFT             AV_CH_SIDE_LEFT
394 #define CH_SIDE_RIGHT            AV_CH_SIDE_RIGHT
395 #define CH_TOP_CENTER            AV_CH_TOP_CENTER
396 #define CH_TOP_FRONT_LEFT        AV_CH_TOP_FRONT_LEFT
397 #define CH_TOP_FRONT_CENTER      AV_CH_TOP_FRONT_CENTER
398 #define CH_TOP_FRONT_RIGHT       AV_CH_TOP_FRONT_RIGHT
399 #define CH_TOP_BACK_LEFT         AV_CH_TOP_BACK_LEFT
400 #define CH_TOP_BACK_CENTER       AV_CH_TOP_BACK_CENTER
401 #define CH_TOP_BACK_RIGHT        AV_CH_TOP_BACK_RIGHT
402 #define CH_STEREO_LEFT           AV_CH_STEREO_LEFT
403 #define CH_STEREO_RIGHT          AV_CH_STEREO_RIGHT
404
405 /** Channel mask value used for AVCodecContext.request_channel_layout
406     to indicate that the user requests the channel order of the decoder output
407     to be the native codec channel order. */
408 #define CH_LAYOUT_NATIVE         AV_CH_LAYOUT_NATIVE
409
410 /* Audio channel convenience macros */
411 #define CH_LAYOUT_MONO           AV_CH_LAYOUT_MONO
412 #define CH_LAYOUT_STEREO         AV_CH_LAYOUT_STEREO
413 #define CH_LAYOUT_2_1            AV_CH_LAYOUT_2_1
414 #define CH_LAYOUT_SURROUND       AV_CH_LAYOUT_SURROUND
415 #define CH_LAYOUT_4POINT0        AV_CH_LAYOUT_4POINT0
416 #define CH_LAYOUT_2_2            AV_CH_LAYOUT_2_2
417 #define CH_LAYOUT_QUAD           AV_CH_LAYOUT_QUAD
418 #define CH_LAYOUT_5POINT0        AV_CH_LAYOUT_5POINT0
419 #define CH_LAYOUT_5POINT1        AV_CH_LAYOUT_5POINT1
420 #define CH_LAYOUT_5POINT0_BACK   AV_CH_LAYOUT_5POINT0_BACK
421 #define CH_LAYOUT_5POINT1_BACK   AV_CH_LAYOUT_5POINT1_BACK
422 #define CH_LAYOUT_7POINT0        AV_CH_LAYOUT_7POINT0
423 #define CH_LAYOUT_7POINT1        AV_CH_LAYOUT_7POINT1
424 #define CH_LAYOUT_7POINT1_WIDE   AV_CH_LAYOUT_7POINT1_WIDE
425 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
426 #endif
427
428 /* in bytes */
429 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
430
431 /**
432  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
433  * This is mainly needed because some optimized bitstream readers read
434  * 32 or 64 bit at once and could read over the end.<br>
435  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
436  * MPEG bitstreams could cause overread and segfault.
437  */
438 #define FF_INPUT_BUFFER_PADDING_SIZE 8
439
440 /**
441  * minimum encoding buffer size
442  * Used to avoid some checks during header writing.
443  */
444 #define FF_MIN_BUFFER_SIZE 16384
445
446
447 /**
448  * motion estimation type.
449  */
450 enum Motion_Est_ID {
451     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
452     ME_FULL,
453     ME_LOG,
454     ME_PHODS,
455     ME_EPZS,        ///< enhanced predictive zonal search
456     ME_X1,          ///< reserved for experiments
457     ME_HEX,         ///< hexagon based search
458     ME_UMH,         ///< uneven multi-hexagon search
459     ME_ITER,        ///< iterative search
460     ME_TESA,        ///< transformed exhaustive search algorithm
461 };
462
463 enum AVDiscard{
464     /* We leave some space between them for extensions (drop some
465      * keyframes for intra-only or drop just some bidir frames). */
466     AVDISCARD_NONE   =-16, ///< discard nothing
467     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
468     AVDISCARD_NONREF =  8, ///< discard all non reference
469     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
470     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
471     AVDISCARD_ALL    = 48, ///< discard all
472 };
473
474 enum AVColorPrimaries{
475     AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
476     AVCOL_PRI_UNSPECIFIED=2,
477     AVCOL_PRI_BT470M     =4,
478     AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
479     AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
480     AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
481     AVCOL_PRI_FILM       =8,
482     AVCOL_PRI_NB           , ///< Not part of ABI
483 };
484
485 enum AVColorTransferCharacteristic{
486     AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
487     AVCOL_TRC_UNSPECIFIED=2,
488     AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
489     AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
490     AVCOL_TRC_NB           , ///< Not part of ABI
491 };
492
493 enum AVColorSpace{
494     AVCOL_SPC_RGB        =0,
495     AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
496     AVCOL_SPC_UNSPECIFIED=2,
497     AVCOL_SPC_FCC        =4,
498     AVCOL_SPC_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
499     AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
500     AVCOL_SPC_SMPTE240M  =7,
501     AVCOL_SPC_NB           , ///< Not part of ABI
502 };
503
504 enum AVColorRange{
505     AVCOL_RANGE_UNSPECIFIED=0,
506     AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
507     AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
508     AVCOL_RANGE_NB           , ///< Not part of ABI
509 };
510
511 /**
512  *  X   X      3 4 X      X are luma samples,
513  *             1 2        1-6 are possible chroma positions
514  *  X   X      5 6 X      0 is undefined/unknown position
515  */
516 enum AVChromaLocation{
517     AVCHROMA_LOC_UNSPECIFIED=0,
518     AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
519     AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
520     AVCHROMA_LOC_TOPLEFT    =3, ///< DV
521     AVCHROMA_LOC_TOP        =4,
522     AVCHROMA_LOC_BOTTOMLEFT =5,
523     AVCHROMA_LOC_BOTTOM     =6,
524     AVCHROMA_LOC_NB           , ///< Not part of ABI
525 };
526
527 #if FF_API_FLAC_GLOBAL_OPTS
528 /**
529  * LPC analysis type
530  */
531 attribute_deprecated enum AVLPCType {
532     AV_LPC_TYPE_DEFAULT     = -1, ///< use the codec default LPC type
533     AV_LPC_TYPE_NONE        =  0, ///< do not use LPC prediction or use all zero coefficients
534     AV_LPC_TYPE_FIXED       =  1, ///< fixed LPC coefficients
535     AV_LPC_TYPE_LEVINSON    =  2, ///< Levinson-Durbin recursion
536     AV_LPC_TYPE_CHOLESKY    =  3, ///< Cholesky factorization
537     AV_LPC_TYPE_NB              , ///< Not part of ABI
538 };
539 #endif
540
541 enum AVAudioServiceType {
542     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
543     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
544     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
545     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
546     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
547     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
548     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
549     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
550     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
551     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
552 };
553
554 typedef struct RcOverride{
555     int start_frame;
556     int end_frame;
557     int qscale; // If this is 0 then quality_factor will be used instead.
558     float quality_factor;
559 } RcOverride;
560
561 #define FF_MAX_B_FRAMES 16
562
563 /* encoding support
564    These flags can be passed in AVCodecContext.flags before initialization.
565    Note: Not everything is supported yet.
566 */
567
568 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
569 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
570 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
571 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
572 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
573 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
574 #define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
575 #endif
576 /**
577  * The parent program guarantees that the input for B-frames containing
578  * streams is not written to for at least s->max_b_frames+1 frames, if
579  * this is not set the input will be copied.
580  */
581 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
582 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
583 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
584 #if FF_API_MJPEG_GLOBAL_OPTS
585 #define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
586 #endif
587 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
588 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
589 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
590 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
591                                                   location instead of only at frame boundaries. */
592 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
593 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
594 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
595 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
596 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
597 #endif
598 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
599 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
600 /* Fx : Flag for h263+ extra options */
601 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
602 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
603 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
604 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
605 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
606 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
607 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
608 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
609 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
610 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
611 #define CODEC_FLAG_CLOSED_GOP     0x80000000
612 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
613 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
614 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
615 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
616 #if FF_API_X264_GLOBAL_OPTS
617 #define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
618 #define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
619 #define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
620 #define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
621 #define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
622 #define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
623 #define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
624 #endif
625 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
626 #define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
627 #endif
628 #if FF_API_SNOW_GLOBAL_OPTS
629 #define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
630 #endif
631 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
632 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
633 #endif
634 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
635 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
636 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
637 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
638 #endif
639 #if FF_API_LAME_GLOBAL_OPTS
640 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
641 #endif
642 #if FF_API_X264_GLOBAL_OPTS
643 #define CODEC_FLAG2_MBTREE        0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
644 #define CODEC_FLAG2_PSY           0x00080000 ///< Use psycho visual optimizations.
645 #define CODEC_FLAG2_SSIM          0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
646 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
647 #endif
648
649 /* Unsupported options :
650  *              Syntax Arithmetic coding (SAC)
651  *              Reference Picture Selection
652  *              Independent Segment Decoding */
653 /* /Fx */
654 /* codec capabilities */
655
656 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
657 /**
658  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
659  * If not set, it might not use get_buffer() at all or use operations that
660  * assume the buffer was allocated by avcodec_default_get_buffer.
661  */
662 #define CODEC_CAP_DR1             0x0002
663 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
664 #define CODEC_CAP_PARSE_ONLY      0x0004
665 #define CODEC_CAP_TRUNCATED       0x0008
666 /* Codec can export data for HW decoding (XvMC). */
667 #define CODEC_CAP_HWACCEL         0x0010
668 /**
669  * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
670  * If this is not set, the codec is guaranteed to never be fed with NULL data.
671  */
672 #define CODEC_CAP_DELAY           0x0020
673 /**
674  * Codec can be fed a final frame with a smaller size.
675  * This can be used to prevent truncation of the last audio samples.
676  */
677 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
678 /**
679  * Codec can export data for HW decoding (VDPAU).
680  */
681 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
682 /**
683  * Codec can output multiple frames per AVPacket
684  * Normally demuxers return one frame at a time, demuxers which do not do
685  * are connected to a parser to split what they return into proper frames.
686  * This flag is reserved to the very rare category of codecs which have a
687  * bitstream that cannot be split into frames without timeconsuming
688  * operations like full decoding. Demuxers carring such bitstreams thus
689  * may return multiple frames in a packet. This has many disadvantages like
690  * prohibiting stream copy in many cases thus it should only be considered
691  * as a last resort.
692  */
693 #define CODEC_CAP_SUBFRAMES        0x0100
694 /**
695  * Codec is experimental and is thus avoided in favor of non experimental
696  * encoders
697  */
698 #define CODEC_CAP_EXPERIMENTAL     0x0200
699 /**
700  * Codec should fill in channel configuration and samplerate instead of container
701  */
702 #define CODEC_CAP_CHANNEL_CONF     0x0400
703 /**
704  * Codec is able to deal with negative linesizes
705  */
706 #define CODEC_CAP_NEG_LINESIZES    0x0800
707 /**
708  * Codec supports frame-level multithreading.
709  */
710 #define CODEC_CAP_FRAME_THREADS    0x1000
711 /**
712  * Codec supports slice-based (or partition-based) multithreading.
713  */
714 #define CODEC_CAP_SLICE_THREADS    0x2000
715
716 //The following defines may change, don't expect compatibility if you use them.
717 #define MB_TYPE_INTRA4x4   0x0001
718 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
719 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
720 #define MB_TYPE_16x16      0x0008
721 #define MB_TYPE_16x8       0x0010
722 #define MB_TYPE_8x16       0x0020
723 #define MB_TYPE_8x8        0x0040
724 #define MB_TYPE_INTERLACED 0x0080
725 #define MB_TYPE_DIRECT2    0x0100 //FIXME
726 #define MB_TYPE_ACPRED     0x0200
727 #define MB_TYPE_GMC        0x0400
728 #define MB_TYPE_SKIP       0x0800
729 #define MB_TYPE_P0L0       0x1000
730 #define MB_TYPE_P1L0       0x2000
731 #define MB_TYPE_P0L1       0x4000
732 #define MB_TYPE_P1L1       0x8000
733 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
734 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
735 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
736 #define MB_TYPE_QUANT      0x00010000
737 #define MB_TYPE_CBP        0x00020000
738 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
739
740 /**
741  * Pan Scan area.
742  * This specifies the area which should be displayed.
743  * Note there may be multiple such areas for one frame.
744  */
745 typedef struct AVPanScan{
746     /**
747      * id
748      * - encoding: Set by user.
749      * - decoding: Set by libavcodec.
750      */
751     int id;
752
753     /**
754      * width and height in 1/16 pel
755      * - encoding: Set by user.
756      * - decoding: Set by libavcodec.
757      */
758     int width;
759     int height;
760
761     /**
762      * position of the top left corner in 1/16 pel for up to 3 fields/frames
763      * - encoding: Set by user.
764      * - decoding: Set by libavcodec.
765      */
766     int16_t position[3][2];
767 }AVPanScan;
768
769 #define FF_QSCALE_TYPE_MPEG1 0
770 #define FF_QSCALE_TYPE_MPEG2 1
771 #define FF_QSCALE_TYPE_H264  2
772 #define FF_QSCALE_TYPE_VP56  3
773
774 #define FF_BUFFER_TYPE_INTERNAL 1
775 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
776 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
777 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
778
779 #if FF_API_OLD_FF_PICT_TYPES
780 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
781 #define FF_I_TYPE  AV_PICTURE_TYPE_I  ///< Intra
782 #define FF_P_TYPE  AV_PICTURE_TYPE_P  ///< Predicted
783 #define FF_B_TYPE  AV_PICTURE_TYPE_B  ///< Bi-dir predicted
784 #define FF_S_TYPE  AV_PICTURE_TYPE_S  ///< S(GMC)-VOP MPEG4
785 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
786 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
787 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
788 #endif
789
790 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
791 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
792 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
793 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
794
795 enum AVPacketSideDataType {
796     AV_PKT_DATA_PALETTE,
797 };
798
799 typedef struct AVPacket {
800     /**
801      * Presentation timestamp in AVStream->time_base units; the time at which
802      * the decompressed packet will be presented to the user.
803      * Can be AV_NOPTS_VALUE if it is not stored in the file.
804      * pts MUST be larger or equal to dts as presentation cannot happen before
805      * decompression, unless one wants to view hex dumps. Some formats misuse
806      * the terms dts and pts/cts to mean something different. Such timestamps
807      * must be converted to true pts/dts before they are stored in AVPacket.
808      */
809     int64_t pts;
810     /**
811      * Decompression timestamp in AVStream->time_base units; the time at which
812      * the packet is decompressed.
813      * Can be AV_NOPTS_VALUE if it is not stored in the file.
814      */
815     int64_t dts;
816     uint8_t *data;
817     int   size;
818     int   stream_index;
819     /**
820      * A combination of AV_PKT_FLAG values
821      */
822     int   flags;
823     /**
824      * Additional packet data that can be provided by the container.
825      * Packet can contain several types of side information.
826      */
827     struct {
828         uint8_t *data;
829         int      size;
830         enum AVPacketSideDataType type;
831     } *side_data;
832     int side_data_elems;
833
834     /**
835      * Duration of this packet in AVStream->time_base units, 0 if unknown.
836      * Equals next_pts - this_pts in presentation order.
837      */
838     int   duration;
839     void  (*destruct)(struct AVPacket *);
840     void  *priv;
841     int64_t pos;                            ///< byte position in stream, -1 if unknown
842
843     /**
844      * Time difference in AVStream->time_base units from the pts of this
845      * packet to the point at which the output from the decoder has converged
846      * independent from the availability of previous frames. That is, the
847      * frames are virtually identical no matter if decoding started from
848      * the very first frame or from this keyframe.
849      * Is AV_NOPTS_VALUE if unknown.
850      * This field is not the display duration of the current packet.
851      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
852      * set.
853      *
854      * The purpose of this field is to allow seeking in streams that have no
855      * keyframes in the conventional sense. It corresponds to the
856      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
857      * essential for some types of subtitle streams to ensure that all
858      * subtitles are correctly displayed after seeking.
859      */
860     int64_t convergence_duration;
861 } AVPacket;
862 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
863 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
864
865 /**
866  * Audio Video Frame.
867  * New fields can be added to the end of AVFRAME with minor version
868  * bumps. Removal, reordering and changes to existing fields require
869  * a major version bump.
870  * sizeof(AVFrame) must not be used outside libav*.
871  */
872 typedef struct AVFrame {
873     /**
874      * pointer to the picture planes.
875      * This might be different from the first allocated byte
876      * - encoding:
877      * - decoding:
878      */
879     uint8_t *data[4];
880     int linesize[4];
881     /**
882      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
883      * This isn't used by libavcodec unless the default get/release_buffer() is used.
884      * - encoding:
885      * - decoding:
886      */
887     uint8_t *base[4];
888     /**
889      * 1 -> keyframe, 0-> not
890      * - encoding: Set by libavcodec.
891      * - decoding: Set by libavcodec.
892      */
893     int key_frame;
894
895     /**
896      * Picture type of the frame, see ?_TYPE below.
897      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
898      * - decoding: Set by libavcodec.
899      */
900     enum AVPictureType pict_type;
901
902     /**
903      * presentation timestamp in time_base units (time when frame should be shown to user)
904      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
905      * - encoding: MUST be set by user.
906      * - decoding: Set by libavcodec.
907      */
908     int64_t pts;
909
910     /**
911      * picture number in bitstream order
912      * - encoding: set by
913      * - decoding: Set by libavcodec.
914      */
915     int coded_picture_number;
916     /**
917      * picture number in display order
918      * - encoding: set by
919      * - decoding: Set by libavcodec.
920      */
921     int display_picture_number;
922
923     /**
924      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
925      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
926      * - decoding: Set by libavcodec.
927      */
928     int quality;
929
930     /**
931      * buffer age (1->was last buffer and dint change, 2->..., ...).
932      * Set to INT_MAX if the buffer has not been used yet.
933      * - encoding: unused
934      * - decoding: MUST be set by get_buffer().
935      */
936     int age;
937
938     /**
939      * is this picture used as reference
940      * The values for this are the same as the MpegEncContext.picture_structure
941      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
942      * Set to 4 for delayed, non-reference frames.
943      * - encoding: unused
944      * - decoding: Set by libavcodec. (before get_buffer() call)).
945      */
946     int reference;
947
948     /**
949      * QP table
950      * - encoding: unused
951      * - decoding: Set by libavcodec.
952      */
953     int8_t *qscale_table;
954     /**
955      * QP store stride
956      * - encoding: unused
957      * - decoding: Set by libavcodec.
958      */
959     int qstride;
960
961     /**
962      * mbskip_table[mb]>=1 if MB didn't change
963      * stride= mb_width = (width+15)>>4
964      * - encoding: unused
965      * - decoding: Set by libavcodec.
966      */
967     uint8_t *mbskip_table;
968
969     /**
970      * motion vector table
971      * @code
972      * example:
973      * int mv_sample_log2= 4 - motion_subsample_log2;
974      * int mb_width= (width+15)>>4;
975      * int mv_stride= (mb_width << mv_sample_log2) + 1;
976      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
977      * @endcode
978      * - encoding: Set by user.
979      * - decoding: Set by libavcodec.
980      */
981     int16_t (*motion_val[2])[2];
982
983     /**
984      * macroblock type table
985      * mb_type_base + mb_width + 2
986      * - encoding: Set by user.
987      * - decoding: Set by libavcodec.
988      */
989     uint32_t *mb_type;
990
991     /**
992      * log2 of the size of the block which a single vector in motion_val represents:
993      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
994      * - encoding: unused
995      * - decoding: Set by libavcodec.
996      */
997     uint8_t motion_subsample_log2;
998
999     /**
1000      * for some private data of the user
1001      * - encoding: unused
1002      * - decoding: Set by user.
1003      */
1004     void *opaque;
1005
1006     /**
1007      * error
1008      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1009      * - decoding: unused
1010      */
1011     uint64_t error[4];
1012
1013     /**
1014      * type of the buffer (to keep track of who has to deallocate data[*])
1015      * - encoding: Set by the one who allocates it.
1016      * - decoding: Set by the one who allocates it.
1017      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1018      */
1019     int type;
1020
1021     /**
1022      * When decoding, this signals how much the picture must be delayed.
1023      * extra_delay = repeat_pict / (2*fps)
1024      * - encoding: unused
1025      * - decoding: Set by libavcodec.
1026      */
1027     int repeat_pict;
1028
1029     /**
1030      *
1031      */
1032     int qscale_type;
1033
1034     /**
1035      * The content of the picture is interlaced.
1036      * - encoding: Set by user.
1037      * - decoding: Set by libavcodec. (default 0)
1038      */
1039     int interlaced_frame;
1040
1041     /**
1042      * If the content is interlaced, is top field displayed first.
1043      * - encoding: Set by user.
1044      * - decoding: Set by libavcodec.
1045      */
1046     int top_field_first;
1047
1048     /**
1049      * Pan scan.
1050      * - encoding: Set by user.
1051      * - decoding: Set by libavcodec.
1052      */
1053     AVPanScan *pan_scan;
1054
1055     /**
1056      * Tell user application that palette has changed from previous frame.
1057      * - encoding: ??? (no palette-enabled encoder yet)
1058      * - decoding: Set by libavcodec. (default 0).
1059      */
1060     int palette_has_changed;
1061
1062     /**
1063      * codec suggestion on buffer type if != 0
1064      * - encoding: unused
1065      * - decoding: Set by libavcodec. (before get_buffer() call)).
1066      */
1067     int buffer_hints;
1068
1069     /**
1070      * DCT coefficients
1071      * - encoding: unused
1072      * - decoding: Set by libavcodec.
1073      */
1074     short *dct_coeff;
1075
1076     /**
1077      * motion reference frame index
1078      * the order in which these are stored can depend on the codec.
1079      * - encoding: Set by user.
1080      * - decoding: Set by libavcodec.
1081      */
1082     int8_t *ref_index[2];
1083
1084     /**
1085      * reordered opaque 64bit (generally an integer or a double precision float
1086      * PTS but can be anything).
1087      * The user sets AVCodecContext.reordered_opaque to represent the input at
1088      * that time,
1089      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1090      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1091      * @deprecated in favor of pkt_pts
1092      * - encoding: unused
1093      * - decoding: Read by user.
1094      */
1095     int64_t reordered_opaque;
1096
1097     /**
1098      * hardware accelerator private data (Libav-allocated)
1099      * - encoding: unused
1100      * - decoding: Set by libavcodec
1101      */
1102     void *hwaccel_picture_private;
1103
1104     /**
1105      * reordered pts from the last AVPacket that has been input into the decoder
1106      * - encoding: unused
1107      * - decoding: Read by user.
1108      */
1109     int64_t pkt_pts;
1110
1111     /**
1112      * dts from the last AVPacket that has been input into the decoder
1113      * - encoding: unused
1114      * - decoding: Read by user.
1115      */
1116     int64_t pkt_dts;
1117
1118     /**
1119      * the AVCodecContext which ff_thread_get_buffer() was last called on
1120      * - encoding: Set by libavcodec.
1121      * - decoding: Set by libavcodec.
1122      */
1123     struct AVCodecContext *owner;
1124
1125     /**
1126      * used by multithreading to store frame-specific info
1127      * - encoding: Set by libavcodec.
1128      * - decoding: Set by libavcodec.
1129      */
1130     void *thread_opaque;
1131 } AVFrame;
1132
1133 /**
1134  * main external API structure.
1135  * New fields can be added to the end with minor version bumps.
1136  * Removal, reordering and changes to existing fields require a major
1137  * version bump.
1138  * sizeof(AVCodecContext) must not be used outside libav*.
1139  */
1140 typedef struct AVCodecContext {
1141     /**
1142      * information on struct for av_log
1143      * - set by avcodec_alloc_context
1144      */
1145     const AVClass *av_class;
1146     /**
1147      * the average bitrate
1148      * - encoding: Set by user; unused for constant quantizer encoding.
1149      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1150      */
1151     int bit_rate;
1152
1153     /**
1154      * number of bits the bitstream is allowed to diverge from the reference.
1155      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1156      * - encoding: Set by user; unused for constant quantizer encoding.
1157      * - decoding: unused
1158      */
1159     int bit_rate_tolerance;
1160
1161     /**
1162      * CODEC_FLAG_*.
1163      * - encoding: Set by user.
1164      * - decoding: Set by user.
1165      */
1166     int flags;
1167
1168     /**
1169      * Some codecs need additional format info. It is stored here.
1170      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1171      * specific codec MUST set it correctly otherwise stream copy breaks.
1172      * In general use of this field by muxers is not recommanded.
1173      * - encoding: Set by libavcodec.
1174      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1175      */
1176     int sub_id;
1177
1178     /**
1179      * Motion estimation algorithm used for video coding.
1180      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1181      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1182      * - encoding: MUST be set by user.
1183      * - decoding: unused
1184      */
1185     int me_method;
1186
1187     /**
1188      * some codecs need / can use extradata like Huffman tables.
1189      * mjpeg: Huffman tables
1190      * rv10: additional flags
1191      * mpeg4: global headers (they can be in the bitstream or here)
1192      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1193      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1194      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1195      * - encoding: Set/allocated/freed by libavcodec.
1196      * - decoding: Set/allocated/freed by user.
1197      */
1198     uint8_t *extradata;
1199     int extradata_size;
1200
1201     /**
1202      * This is the fundamental unit of time (in seconds) in terms
1203      * of which frame timestamps are represented. For fixed-fps content,
1204      * timebase should be 1/framerate and timestamp increments should be
1205      * identically 1.
1206      * - encoding: MUST be set by user.
1207      * - decoding: Set by libavcodec.
1208      */
1209     AVRational time_base;
1210
1211     /* video only */
1212     /**
1213      * picture width / height.
1214      * - encoding: MUST be set by user.
1215      * - decoding: Set by libavcodec.
1216      * Note: For compatibility it is possible to set this instead of
1217      * coded_width/height before decoding.
1218      */
1219     int width, height;
1220
1221 #define FF_ASPECT_EXTENDED 15
1222
1223     /**
1224      * the number of pictures in a group of pictures, or 0 for intra_only
1225      * - encoding: Set by user.
1226      * - decoding: unused
1227      */
1228     int gop_size;
1229
1230     /**
1231      * Pixel format, see PIX_FMT_xxx.
1232      * May be set by the demuxer if known from headers.
1233      * May be overriden by the decoder if it knows better.
1234      * - encoding: Set by user.
1235      * - decoding: Set by user if known, overridden by libavcodec if known
1236      */
1237     enum PixelFormat pix_fmt;
1238
1239     /**
1240      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1241      * decoder to draw a horizontal band. It improves cache usage. Not
1242      * all codecs can do that. You must check the codec capabilities
1243      * beforehand.
1244      * When multithreading is used, it may be called from multiple threads
1245      * at the same time; threads might draw different parts of the same AVFrame,
1246      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1247      * in order.
1248      * The function is also used by hardware acceleration APIs.
1249      * It is called at least once during frame decoding to pass
1250      * the data needed for hardware render.
1251      * In that mode instead of pixel data, AVFrame points to
1252      * a structure specific to the acceleration API. The application
1253      * reads the structure and can change some fields to indicate progress
1254      * or mark state.
1255      * - encoding: unused
1256      * - decoding: Set by user.
1257      * @param height the height of the slice
1258      * @param y the y position of the slice
1259      * @param type 1->top field, 2->bottom field, 3->frame
1260      * @param offset offset into the AVFrame.data from which the slice should be read
1261      */
1262     void (*draw_horiz_band)(struct AVCodecContext *s,
1263                             const AVFrame *src, int offset[4],
1264                             int y, int type, int height);
1265
1266     /* audio only */
1267     int sample_rate; ///< samples per second
1268     int channels;    ///< number of audio channels
1269
1270     /**
1271      * audio sample format
1272      * - encoding: Set by user.
1273      * - decoding: Set by libavcodec.
1274      */
1275     enum AVSampleFormat sample_fmt;  ///< sample format
1276
1277     /* The following data should not be initialized. */
1278     /**
1279      * Samples per packet, initialized when calling 'init'.
1280      */
1281     int frame_size;
1282     int frame_number;   ///< audio or video frame number
1283
1284     /**
1285      * Number of frames the decoded output will be delayed relative to
1286      * the encoded input.
1287      * - encoding: Set by libavcodec.
1288      * - decoding: unused
1289      */
1290     int delay;
1291
1292     /* - encoding parameters */
1293     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1294     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1295
1296     /**
1297      * minimum quantizer
1298      * - encoding: Set by user.
1299      * - decoding: unused
1300      */
1301     int qmin;
1302
1303     /**
1304      * maximum quantizer
1305      * - encoding: Set by user.
1306      * - decoding: unused
1307      */
1308     int qmax;
1309
1310     /**
1311      * maximum quantizer difference between frames
1312      * - encoding: Set by user.
1313      * - decoding: unused
1314      */
1315     int max_qdiff;
1316
1317     /**
1318      * maximum number of B-frames between non-B-frames
1319      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1320      * - encoding: Set by user.
1321      * - decoding: unused
1322      */
1323     int max_b_frames;
1324
1325     /**
1326      * qscale factor between IP and B-frames
1327      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1328      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1329      * - encoding: Set by user.
1330      * - decoding: unused
1331      */
1332     float b_quant_factor;
1333
1334     /** obsolete FIXME remove */
1335     int rc_strategy;
1336 #define FF_RC_STRATEGY_XVID 1
1337
1338     int b_frame_strategy;
1339
1340     struct AVCodec *codec;
1341
1342     void *priv_data;
1343
1344     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1345                             /* do its best to deliver a chunk with size     */
1346                             /* below rtp_payload_size, the chunk will start */
1347                             /* with a start code on some codecs like H.263. */
1348                             /* This doesn't take account of any particular  */
1349                             /* headers inside the transmitted RTP payload.  */
1350
1351
1352     /* The RTP callback: This function is called    */
1353     /* every time the encoder has a packet to send. */
1354     /* It depends on the encoder if the data starts */
1355     /* with a Start Code (it should). H.263 does.   */
1356     /* mb_nb contains the number of macroblocks     */
1357     /* encoded in the RTP payload.                  */
1358     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1359
1360     /* statistics, used for 2-pass encoding */
1361     int mv_bits;
1362     int header_bits;
1363     int i_tex_bits;
1364     int p_tex_bits;
1365     int i_count;
1366     int p_count;
1367     int skip_count;
1368     int misc_bits;
1369
1370     /**
1371      * number of bits used for the previously encoded frame
1372      * - encoding: Set by libavcodec.
1373      * - decoding: unused
1374      */
1375     int frame_bits;
1376
1377     /**
1378      * Private data of the user, can be used to carry app specific stuff.
1379      * - encoding: Set by user.
1380      * - decoding: Set by user.
1381      */
1382     void *opaque;
1383
1384     char codec_name[32];
1385     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1386     enum CodecID codec_id; /* see CODEC_ID_xxx */
1387
1388     /**
1389      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1390      * This is used to work around some encoder bugs.
1391      * A demuxer should set this to what is stored in the field used to identify the codec.
1392      * If there are multiple such fields in a container then the demuxer should choose the one
1393      * which maximizes the information about the used codec.
1394      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1395      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1396      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1397      * first.
1398      * - encoding: Set by user, if not then the default based on codec_id will be used.
1399      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1400      */
1401     unsigned int codec_tag;
1402
1403     /**
1404      * Work around bugs in encoders which sometimes cannot be detected automatically.
1405      * - encoding: Set by user
1406      * - decoding: Set by user
1407      */
1408     int workaround_bugs;
1409 #define FF_BUG_AUTODETECT       1  ///< autodetection
1410 #define FF_BUG_OLD_MSMPEG4      2
1411 #define FF_BUG_XVID_ILACE       4
1412 #define FF_BUG_UMP4             8
1413 #define FF_BUG_NO_PADDING       16
1414 #define FF_BUG_AMV              32
1415 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1416 #define FF_BUG_QPEL_CHROMA      64
1417 #define FF_BUG_STD_QPEL         128
1418 #define FF_BUG_QPEL_CHROMA2     256
1419 #define FF_BUG_DIRECT_BLOCKSIZE 512
1420 #define FF_BUG_EDGE             1024
1421 #define FF_BUG_HPEL_CHROMA      2048
1422 #define FF_BUG_DC_CLIP          4096
1423 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1424 #define FF_BUG_TRUNCATED       16384
1425 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1426
1427     /**
1428      * luma single coefficient elimination threshold
1429      * - encoding: Set by user.
1430      * - decoding: unused
1431      */
1432     int luma_elim_threshold;
1433
1434     /**
1435      * chroma single coeff elimination threshold
1436      * - encoding: Set by user.
1437      * - decoding: unused
1438      */
1439     int chroma_elim_threshold;
1440
1441     /**
1442      * strictly follow the standard (MPEG4, ...).
1443      * - encoding: Set by user.
1444      * - decoding: Set by user.
1445      * Setting this to STRICT or higher means the encoder and decoder will
1446      * generally do stupid things, whereas setting it to unofficial or lower
1447      * will mean the encoder might produce output that is not supported by all
1448      * spec-compliant decoders. Decoders don't differentiate between normal,
1449      * unofficial and experimental (that is, they always try to decode things
1450      * when they can) unless they are explicitly asked to behave stupidly
1451      * (=strictly conform to the specs)
1452      */
1453     int strict_std_compliance;
1454 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1455 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1456 #define FF_COMPLIANCE_NORMAL        0
1457 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1458 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1459
1460     /**
1461      * qscale offset between IP and B-frames
1462      * - encoding: Set by user.
1463      * - decoding: unused
1464      */
1465     float b_quant_offset;
1466
1467     /**
1468      * Error recognition; higher values will detect more errors but may
1469      * misdetect some more or less valid parts as errors.
1470      * - encoding: unused
1471      * - decoding: Set by user.
1472      */
1473     int error_recognition;
1474 #define FF_ER_CAREFUL         1
1475 #define FF_ER_COMPLIANT       2
1476 #define FF_ER_AGGRESSIVE      3
1477 #if FF_API_VERY_AGGRESSIVE
1478 #define FF_ER_VERY_AGGRESSIVE 4
1479 #define FF_ER_EXPLODE         5
1480 #else
1481 #define FF_ER_EXPLODE         4
1482 #endif /* FF_API_VERY_AGGRESSIVE */
1483
1484     /**
1485      * Called at the beginning of each frame to get a buffer for it.
1486      * If pic.reference is set then the frame will be read later by libavcodec.
1487      * avcodec_align_dimensions2() should be used to find the required width and
1488      * height, as they normally need to be rounded up to the next multiple of 16.
1489      * if CODEC_CAP_DR1 is not set then get_buffer() must call
1490      * avcodec_default_get_buffer() instead of providing buffers allocated by
1491      * some other means.
1492      * If frame multithreading is used and thread_safe_callbacks is set,
1493      * it may be called from a different thread, but not from more than one at once.
1494      * Does not need to be reentrant.
1495      * - encoding: unused
1496      * - decoding: Set by libavcodec, user can override.
1497      */
1498     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1499
1500     /**
1501      * Called to release buffers which were allocated with get_buffer.
1502      * A released buffer can be reused in get_buffer().
1503      * pic.data[*] must be set to NULL.
1504      * May be called from a different thread if frame multithreading is used,
1505      * but not by more than one thread at once, so does not need to be reentrant.
1506      * - encoding: unused
1507      * - decoding: Set by libavcodec, user can override.
1508      */
1509     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1510
1511     /**
1512      * Size of the frame reordering buffer in the decoder.
1513      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1514      * - encoding: Set by libavcodec.
1515      * - decoding: Set by libavcodec.
1516      */
1517     int has_b_frames;
1518
1519     /**
1520      * number of bytes per packet if constant and known or 0
1521      * Used by some WAV based audio codecs.
1522      */
1523     int block_align;
1524
1525     int parse_only; /* - decoding only: If true, only parsing is done
1526                        (function avcodec_parse_frame()). The frame
1527                        data is returned. Only MPEG codecs support this now. */
1528
1529     /**
1530      * 0-> h263 quant 1-> mpeg quant
1531      * - encoding: Set by user.
1532      * - decoding: unused
1533      */
1534     int mpeg_quant;
1535
1536     /**
1537      * pass1 encoding statistics output buffer
1538      * - encoding: Set by libavcodec.
1539      * - decoding: unused
1540      */
1541     char *stats_out;
1542
1543     /**
1544      * pass2 encoding statistics input buffer
1545      * Concatenated stuff from stats_out of pass1 should be placed here.
1546      * - encoding: Allocated/set/freed by user.
1547      * - decoding: unused
1548      */
1549     char *stats_in;
1550
1551     /**
1552      * ratecontrol qmin qmax limiting method
1553      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1554      * - encoding: Set by user.
1555      * - decoding: unused
1556      */
1557     float rc_qsquish;
1558
1559     float rc_qmod_amp;
1560     int rc_qmod_freq;
1561
1562     /**
1563      * ratecontrol override, see RcOverride
1564      * - encoding: Allocated/set/freed by user.
1565      * - decoding: unused
1566      */
1567     RcOverride *rc_override;
1568     int rc_override_count;
1569
1570     /**
1571      * rate control equation
1572      * - encoding: Set by user
1573      * - decoding: unused
1574      */
1575     const char *rc_eq;
1576
1577     /**
1578      * maximum bitrate
1579      * - encoding: Set by user.
1580      * - decoding: unused
1581      */
1582     int rc_max_rate;
1583
1584     /**
1585      * minimum bitrate
1586      * - encoding: Set by user.
1587      * - decoding: unused
1588      */
1589     int rc_min_rate;
1590
1591     /**
1592      * decoder bitstream buffer size
1593      * - encoding: Set by user.
1594      * - decoding: unused
1595      */
1596     int rc_buffer_size;
1597     float rc_buffer_aggressivity;
1598
1599     /**
1600      * qscale factor between P and I-frames
1601      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1602      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1603      * - encoding: Set by user.
1604      * - decoding: unused
1605      */
1606     float i_quant_factor;
1607
1608     /**
1609      * qscale offset between P and I-frames
1610      * - encoding: Set by user.
1611      * - decoding: unused
1612      */
1613     float i_quant_offset;
1614
1615     /**
1616      * initial complexity for pass1 ratecontrol
1617      * - encoding: Set by user.
1618      * - decoding: unused
1619      */
1620     float rc_initial_cplx;
1621
1622     /**
1623      * DCT algorithm, see FF_DCT_* below
1624      * - encoding: Set by user.
1625      * - decoding: unused
1626      */
1627     int dct_algo;
1628 #define FF_DCT_AUTO    0
1629 #define FF_DCT_FASTINT 1
1630 #define FF_DCT_INT     2
1631 #define FF_DCT_MMX     3
1632 #define FF_DCT_MLIB    4
1633 #define FF_DCT_ALTIVEC 5
1634 #define FF_DCT_FAAN    6
1635
1636     /**
1637      * luminance masking (0-> disabled)
1638      * - encoding: Set by user.
1639      * - decoding: unused
1640      */
1641     float lumi_masking;
1642
1643     /**
1644      * temporary complexity masking (0-> disabled)
1645      * - encoding: Set by user.
1646      * - decoding: unused
1647      */
1648     float temporal_cplx_masking;
1649
1650     /**
1651      * spatial complexity masking (0-> disabled)
1652      * - encoding: Set by user.
1653      * - decoding: unused
1654      */
1655     float spatial_cplx_masking;
1656
1657     /**
1658      * p block masking (0-> disabled)
1659      * - encoding: Set by user.
1660      * - decoding: unused
1661      */
1662     float p_masking;
1663
1664     /**
1665      * darkness masking (0-> disabled)
1666      * - encoding: Set by user.
1667      * - decoding: unused
1668      */
1669     float dark_masking;
1670
1671     /**
1672      * IDCT algorithm, see FF_IDCT_* below.
1673      * - encoding: Set by user.
1674      * - decoding: Set by user.
1675      */
1676     int idct_algo;
1677 #define FF_IDCT_AUTO          0
1678 #define FF_IDCT_INT           1
1679 #define FF_IDCT_SIMPLE        2
1680 #define FF_IDCT_SIMPLEMMX     3
1681 #define FF_IDCT_LIBMPEG2MMX   4
1682 #define FF_IDCT_PS2           5
1683 #define FF_IDCT_MLIB          6
1684 #define FF_IDCT_ARM           7
1685 #define FF_IDCT_ALTIVEC       8
1686 #define FF_IDCT_SH4           9
1687 #define FF_IDCT_SIMPLEARM     10
1688 #define FF_IDCT_H264          11
1689 #define FF_IDCT_VP3           12
1690 #define FF_IDCT_IPP           13
1691 #define FF_IDCT_XVIDMMX       14
1692 #define FF_IDCT_CAVS          15
1693 #define FF_IDCT_SIMPLEARMV5TE 16
1694 #define FF_IDCT_SIMPLEARMV6   17
1695 #define FF_IDCT_SIMPLEVIS     18
1696 #define FF_IDCT_WMV2          19
1697 #define FF_IDCT_FAAN          20
1698 #define FF_IDCT_EA            21
1699 #define FF_IDCT_SIMPLENEON    22
1700 #define FF_IDCT_SIMPLEALPHA   23
1701 #define FF_IDCT_BINK          24
1702
1703     /**
1704      * slice count
1705      * - encoding: Set by libavcodec.
1706      * - decoding: Set by user (or 0).
1707      */
1708     int slice_count;
1709     /**
1710      * slice offsets in the frame in bytes
1711      * - encoding: Set/allocated by libavcodec.
1712      * - decoding: Set/allocated by user (or NULL).
1713      */
1714     int *slice_offset;
1715
1716     /**
1717      * error concealment flags
1718      * - encoding: unused
1719      * - decoding: Set by user.
1720      */
1721     int error_concealment;
1722 #define FF_EC_GUESS_MVS   1
1723 #define FF_EC_DEBLOCK     2
1724
1725     /**
1726      * dsp_mask could be add used to disable unwanted CPU features
1727      * CPU features (i.e. MMX, SSE. ...)
1728      *
1729      * With the FORCE flag you may instead enable given CPU features.
1730      * (Dangerous: Usable in case of misdetection, improper usage however will
1731      * result into program crash.)
1732      */
1733     unsigned dsp_mask;
1734
1735     /**
1736      * bits per sample/pixel from the demuxer (needed for huffyuv).
1737      * - encoding: Set by libavcodec.
1738      * - decoding: Set by user.
1739      */
1740      int bits_per_coded_sample;
1741
1742     /**
1743      * prediction method (needed for huffyuv)
1744      * - encoding: Set by user.
1745      * - decoding: unused
1746      */
1747      int prediction_method;
1748 #define FF_PRED_LEFT   0
1749 #define FF_PRED_PLANE  1
1750 #define FF_PRED_MEDIAN 2
1751
1752     /**
1753      * sample aspect ratio (0 if unknown)
1754      * That is the width of a pixel divided by the height of the pixel.
1755      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1756      * - encoding: Set by user.
1757      * - decoding: Set by libavcodec.
1758      */
1759     AVRational sample_aspect_ratio;
1760
1761     /**
1762      * the picture in the bitstream
1763      * - encoding: Set by libavcodec.
1764      * - decoding: Set by libavcodec.
1765      */
1766     AVFrame *coded_frame;
1767
1768     /**
1769      * debug
1770      * - encoding: Set by user.
1771      * - decoding: Set by user.
1772      */
1773     int debug;
1774 #define FF_DEBUG_PICT_INFO   1
1775 #define FF_DEBUG_RC          2
1776 #define FF_DEBUG_BITSTREAM   4
1777 #define FF_DEBUG_MB_TYPE     8
1778 #define FF_DEBUG_QP          16
1779 #define FF_DEBUG_MV          32
1780 #define FF_DEBUG_DCT_COEFF   0x00000040
1781 #define FF_DEBUG_SKIP        0x00000080
1782 #define FF_DEBUG_STARTCODE   0x00000100
1783 #define FF_DEBUG_PTS         0x00000200
1784 #define FF_DEBUG_ER          0x00000400
1785 #define FF_DEBUG_MMCO        0x00000800
1786 #define FF_DEBUG_BUGS        0x00001000
1787 #define FF_DEBUG_VIS_QP      0x00002000
1788 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1789 #define FF_DEBUG_BUFFERS     0x00008000
1790 #define FF_DEBUG_THREADS     0x00010000
1791
1792     /**
1793      * debug
1794      * - encoding: Set by user.
1795      * - decoding: Set by user.
1796      */
1797     int debug_mv;
1798 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1799 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1800 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1801
1802     /**
1803      * error
1804      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1805      * - decoding: unused
1806      */
1807     uint64_t error[4];
1808
1809     /**
1810      * motion estimation comparison function
1811      * - encoding: Set by user.
1812      * - decoding: unused
1813      */
1814     int me_cmp;
1815     /**
1816      * subpixel motion estimation comparison function
1817      * - encoding: Set by user.
1818      * - decoding: unused
1819      */
1820     int me_sub_cmp;
1821     /**
1822      * macroblock comparison function (not supported yet)
1823      * - encoding: Set by user.
1824      * - decoding: unused
1825      */
1826     int mb_cmp;
1827     /**
1828      * interlaced DCT comparison function
1829      * - encoding: Set by user.
1830      * - decoding: unused
1831      */
1832     int ildct_cmp;
1833 #define FF_CMP_SAD    0
1834 #define FF_CMP_SSE    1
1835 #define FF_CMP_SATD   2
1836 #define FF_CMP_DCT    3
1837 #define FF_CMP_PSNR   4
1838 #define FF_CMP_BIT    5
1839 #define FF_CMP_RD     6
1840 #define FF_CMP_ZERO   7
1841 #define FF_CMP_VSAD   8
1842 #define FF_CMP_VSSE   9
1843 #define FF_CMP_NSSE   10
1844 #define FF_CMP_W53    11
1845 #define FF_CMP_W97    12
1846 #define FF_CMP_DCTMAX 13
1847 #define FF_CMP_DCT264 14
1848 #define FF_CMP_CHROMA 256
1849
1850     /**
1851      * ME diamond size & shape
1852      * - encoding: Set by user.
1853      * - decoding: unused
1854      */
1855     int dia_size;
1856
1857     /**
1858      * amount of previous MV predictors (2a+1 x 2a+1 square)
1859      * - encoding: Set by user.
1860      * - decoding: unused
1861      */
1862     int last_predictor_count;
1863
1864     /**
1865      * prepass for motion estimation
1866      * - encoding: Set by user.
1867      * - decoding: unused
1868      */
1869     int pre_me;
1870
1871     /**
1872      * motion estimation prepass comparison function
1873      * - encoding: Set by user.
1874      * - decoding: unused
1875      */
1876     int me_pre_cmp;
1877
1878     /**
1879      * ME prepass diamond size & shape
1880      * - encoding: Set by user.
1881      * - decoding: unused
1882      */
1883     int pre_dia_size;
1884
1885     /**
1886      * subpel ME quality
1887      * - encoding: Set by user.
1888      * - decoding: unused
1889      */
1890     int me_subpel_quality;
1891
1892     /**
1893      * callback to negotiate the pixelFormat
1894      * @param fmt is the list of formats which are supported by the codec,
1895      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1896      * The first is always the native one.
1897      * @return the chosen format
1898      * - encoding: unused
1899      * - decoding: Set by user, if not set the native format will be chosen.
1900      */
1901     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1902
1903     /**
1904      * DTG active format information (additional aspect ratio
1905      * information only used in DVB MPEG-2 transport streams)
1906      * 0 if not set.
1907      *
1908      * - encoding: unused
1909      * - decoding: Set by decoder.
1910      */
1911     int dtg_active_format;
1912 #define FF_DTG_AFD_SAME         8
1913 #define FF_DTG_AFD_4_3          9
1914 #define FF_DTG_AFD_16_9         10
1915 #define FF_DTG_AFD_14_9         11
1916 #define FF_DTG_AFD_4_3_SP_14_9  13
1917 #define FF_DTG_AFD_16_9_SP_14_9 14
1918 #define FF_DTG_AFD_SP_4_3       15
1919
1920     /**
1921      * maximum motion estimation search range in subpel units
1922      * If 0 then no limit.
1923      *
1924      * - encoding: Set by user.
1925      * - decoding: unused
1926      */
1927     int me_range;
1928
1929     /**
1930      * intra quantizer bias
1931      * - encoding: Set by user.
1932      * - decoding: unused
1933      */
1934     int intra_quant_bias;
1935 #define FF_DEFAULT_QUANT_BIAS 999999
1936
1937     /**
1938      * inter quantizer bias
1939      * - encoding: Set by user.
1940      * - decoding: unused
1941      */
1942     int inter_quant_bias;
1943
1944     /**
1945      * color table ID
1946      * - encoding: unused
1947      * - decoding: Which clrtable should be used for 8bit RGB images.
1948      *             Tables have to be stored somewhere. FIXME
1949      */
1950     int color_table_id;
1951
1952     /**
1953      * internal_buffer count
1954      * Don't touch, used by libavcodec default_get_buffer().
1955      */
1956     int internal_buffer_count;
1957
1958     /**
1959      * internal_buffers
1960      * Don't touch, used by libavcodec default_get_buffer().
1961      */
1962     void *internal_buffer;
1963
1964     /**
1965      * Global quality for codecs which cannot change it per frame.
1966      * This should be proportional to MPEG-1/2/4 qscale.
1967      * - encoding: Set by user.
1968      * - decoding: unused
1969      */
1970     int global_quality;
1971
1972 #define FF_CODER_TYPE_VLC       0
1973 #define FF_CODER_TYPE_AC        1
1974 #define FF_CODER_TYPE_RAW       2
1975 #define FF_CODER_TYPE_RLE       3
1976 #define FF_CODER_TYPE_DEFLATE   4
1977     /**
1978      * coder type
1979      * - encoding: Set by user.
1980      * - decoding: unused
1981      */
1982     int coder_type;
1983
1984     /**
1985      * context model
1986      * - encoding: Set by user.
1987      * - decoding: unused
1988      */
1989     int context_model;
1990 #if 0
1991     /**
1992      *
1993      * - encoding: unused
1994      * - decoding: Set by user.
1995      */
1996     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1997 #endif
1998
1999     /**
2000      * slice flags
2001      * - encoding: unused
2002      * - decoding: Set by user.
2003      */
2004     int slice_flags;
2005 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2006 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2007 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2008
2009     /**
2010      * XVideo Motion Acceleration
2011      * - encoding: forbidden
2012      * - decoding: set by decoder
2013      */
2014     int xvmc_acceleration;
2015
2016     /**
2017      * macroblock decision mode
2018      * - encoding: Set by user.
2019      * - decoding: unused
2020      */
2021     int mb_decision;
2022 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2023 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2024 #define FF_MB_DECISION_RD     2        ///< rate distortion
2025
2026     /**
2027      * custom intra quantization matrix
2028      * - encoding: Set by user, can be NULL.
2029      * - decoding: Set by libavcodec.
2030      */
2031     uint16_t *intra_matrix;
2032
2033     /**
2034      * custom inter quantization matrix
2035      * - encoding: Set by user, can be NULL.
2036      * - decoding: Set by libavcodec.
2037      */
2038     uint16_t *inter_matrix;
2039
2040     /**
2041      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2042      * This is used to work around some encoder bugs.
2043      * - encoding: unused
2044      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2045      */
2046     unsigned int stream_codec_tag;
2047
2048     /**
2049      * scene change detection threshold
2050      * 0 is default, larger means fewer detected scene changes.
2051      * - encoding: Set by user.
2052      * - decoding: unused
2053      */
2054     int scenechange_threshold;
2055
2056     /**
2057      * minimum Lagrange multipler
2058      * - encoding: Set by user.
2059      * - decoding: unused
2060      */
2061     int lmin;
2062
2063     /**
2064      * maximum Lagrange multipler
2065      * - encoding: Set by user.
2066      * - decoding: unused
2067      */
2068     int lmax;
2069
2070 #if FF_API_PALETTE_CONTROL
2071     /**
2072      * palette control structure
2073      * - encoding: ??? (no palette-enabled encoder yet)
2074      * - decoding: Set by user.
2075      */
2076     struct AVPaletteControl *palctrl;
2077 #endif
2078
2079     /**
2080      * noise reduction strength
2081      * - encoding: Set by user.
2082      * - decoding: unused
2083      */
2084     int noise_reduction;
2085
2086     /**
2087      * Called at the beginning of a frame to get cr buffer for it.
2088      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2089      * libavcodec will pass previous buffer in pic, function should return
2090      * same buffer or new buffer with old frame "painted" into it.
2091      * If pic.data[0] == NULL must behave like get_buffer().
2092      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2093      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2094      * some other means.
2095      * - encoding: unused
2096      * - decoding: Set by libavcodec, user can override.
2097      */
2098     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2099
2100     /**
2101      * Number of bits which should be loaded into the rc buffer before decoding starts.
2102      * - encoding: Set by user.
2103      * - decoding: unused
2104      */
2105     int rc_initial_buffer_occupancy;
2106
2107     /**
2108      *
2109      * - encoding: Set by user.
2110      * - decoding: unused
2111      */
2112     int inter_threshold;
2113
2114     /**
2115      * CODEC_FLAG2_*
2116      * - encoding: Set by user.
2117      * - decoding: Set by user.
2118      */
2119     int flags2;
2120
2121     /**
2122      * Simulates errors in the bitstream to test error concealment.
2123      * - encoding: Set by user.
2124      * - decoding: unused
2125      */
2126     int error_rate;
2127
2128 #if FF_API_ANTIALIAS_ALGO
2129     /**
2130      * MP3 antialias algorithm, see FF_AA_* below.
2131      * - encoding: unused
2132      * - decoding: Set by user.
2133      */
2134     attribute_deprecated int antialias_algo;
2135 #define FF_AA_AUTO    0
2136 #define FF_AA_FASTINT 1 //not implemented yet
2137 #define FF_AA_INT     2
2138 #define FF_AA_FLOAT   3
2139 #endif
2140
2141     /**
2142      * quantizer noise shaping
2143      * - encoding: Set by user.
2144      * - decoding: unused
2145      */
2146     int quantizer_noise_shaping;
2147
2148     /**
2149      * thread count
2150      * is used to decide how many independent tasks should be passed to execute()
2151      * - encoding: Set by user.
2152      * - decoding: Set by user.
2153      */
2154     int thread_count;
2155
2156     /**
2157      * The codec may call this to execute several independent things.
2158      * It will return only after finishing all tasks.
2159      * The user may replace this with some multithreaded implementation,
2160      * the default implementation will execute the parts serially.
2161      * @param count the number of things to execute
2162      * - encoding: Set by libavcodec, user can override.
2163      * - decoding: Set by libavcodec, user can override.
2164      */
2165     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2166
2167     /**
2168      * thread opaque
2169      * Can be used by execute() to store some per AVCodecContext stuff.
2170      * - encoding: set by execute()
2171      * - decoding: set by execute()
2172      */
2173     void *thread_opaque;
2174
2175     /**
2176      * Motion estimation threshold below which no motion estimation is
2177      * performed, but instead the user specified motion vectors are used.
2178      *
2179      * - encoding: Set by user.
2180      * - decoding: unused
2181      */
2182      int me_threshold;
2183
2184     /**
2185      * Macroblock threshold below which the user specified macroblock types will be used.
2186      * - encoding: Set by user.
2187      * - decoding: unused
2188      */
2189      int mb_threshold;
2190
2191     /**
2192      * precision of the intra DC coefficient - 8
2193      * - encoding: Set by user.
2194      * - decoding: unused
2195      */
2196      int intra_dc_precision;
2197
2198     /**
2199      * noise vs. sse weight for the nsse comparsion function
2200      * - encoding: Set by user.
2201      * - decoding: unused
2202      */
2203      int nsse_weight;
2204
2205     /**
2206      * Number of macroblock rows at the top which are skipped.
2207      * - encoding: unused
2208      * - decoding: Set by user.
2209      */
2210      int skip_top;
2211
2212     /**
2213      * Number of macroblock rows at the bottom which are skipped.
2214      * - encoding: unused
2215      * - decoding: Set by user.
2216      */
2217      int skip_bottom;
2218
2219     /**
2220      * profile
2221      * - encoding: Set by user.
2222      * - decoding: Set by libavcodec.
2223      */
2224      int profile;
2225 #define FF_PROFILE_UNKNOWN -99
2226 #define FF_PROFILE_RESERVED -100
2227
2228 #define FF_PROFILE_AAC_MAIN 0
2229 #define FF_PROFILE_AAC_LOW  1
2230 #define FF_PROFILE_AAC_SSR  2
2231 #define FF_PROFILE_AAC_LTP  3
2232
2233 #define FF_PROFILE_DTS         20
2234 #define FF_PROFILE_DTS_ES      30
2235 #define FF_PROFILE_DTS_96_24   40
2236 #define FF_PROFILE_DTS_HD_HRA  50
2237 #define FF_PROFILE_DTS_HD_MA   60
2238
2239 #define FF_PROFILE_MPEG2_422    0
2240 #define FF_PROFILE_MPEG2_HIGH   1
2241 #define FF_PROFILE_MPEG2_SS     2
2242 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2243 #define FF_PROFILE_MPEG2_MAIN   4
2244 #define FF_PROFILE_MPEG2_SIMPLE 5
2245
2246 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2247 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2248
2249 #define FF_PROFILE_H264_BASELINE             66
2250 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2251 #define FF_PROFILE_H264_MAIN                 77
2252 #define FF_PROFILE_H264_EXTENDED             88
2253 #define FF_PROFILE_H264_HIGH                 100
2254 #define FF_PROFILE_H264_HIGH_10              110
2255 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2256 #define FF_PROFILE_H264_HIGH_422             122
2257 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2258 #define FF_PROFILE_H264_HIGH_444             144
2259 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2260 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2261 #define FF_PROFILE_H264_CAVLC_444            44
2262
2263 #define FF_PROFILE_VC1_SIMPLE   0
2264 #define FF_PROFILE_VC1_MAIN     1
2265 #define FF_PROFILE_VC1_COMPLEX  2
2266 #define FF_PROFILE_VC1_ADVANCED 3
2267
2268 #define FF_PROFILE_MPEG4_SIMPLE                     0
2269 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2270 #define FF_PROFILE_MPEG4_CORE                       2
2271 #define FF_PROFILE_MPEG4_MAIN                       3
2272 #define FF_PROFILE_MPEG4_N_BIT                      4
2273 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2274 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2275 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2276 #define FF_PROFILE_MPEG4_HYBRID                     8
2277 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2278 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2279 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2280 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2281 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2282 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2283 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2284
2285     /**
2286      * level
2287      * - encoding: Set by user.
2288      * - decoding: Set by libavcodec.
2289      */
2290      int level;
2291 #define FF_LEVEL_UNKNOWN -99
2292
2293     /**
2294      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2295      * - encoding: unused
2296      * - decoding: Set by user.
2297      */
2298      int lowres;
2299
2300     /**
2301      * Bitstream width / height, may be different from width/height if lowres enabled.
2302      * - encoding: unused
2303      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2304      */
2305     int coded_width, coded_height;
2306
2307     /**
2308      * frame skip threshold
2309      * - encoding: Set by user.
2310      * - decoding: unused
2311      */
2312     int frame_skip_threshold;
2313
2314     /**
2315      * frame skip factor
2316      * - encoding: Set by user.
2317      * - decoding: unused
2318      */
2319     int frame_skip_factor;
2320
2321     /**
2322      * frame skip exponent
2323      * - encoding: Set by user.
2324      * - decoding: unused
2325      */
2326     int frame_skip_exp;
2327
2328     /**
2329      * frame skip comparison function
2330      * - encoding: Set by user.
2331      * - decoding: unused
2332      */
2333     int frame_skip_cmp;
2334
2335     /**
2336      * Border processing masking, raises the quantizer for mbs on the borders
2337      * of the picture.
2338      * - encoding: Set by user.
2339      * - decoding: unused
2340      */
2341     float border_masking;
2342
2343     /**
2344      * minimum MB lagrange multipler
2345      * - encoding: Set by user.
2346      * - decoding: unused
2347      */
2348     int mb_lmin;
2349
2350     /**
2351      * maximum MB lagrange multipler
2352      * - encoding: Set by user.
2353      * - decoding: unused
2354      */
2355     int mb_lmax;
2356
2357     /**
2358      *
2359      * - encoding: Set by user.
2360      * - decoding: unused
2361      */
2362     int me_penalty_compensation;
2363
2364     /**
2365      *
2366      * - encoding: unused
2367      * - decoding: Set by user.
2368      */
2369     enum AVDiscard skip_loop_filter;
2370
2371     /**
2372      *
2373      * - encoding: unused
2374      * - decoding: Set by user.
2375      */
2376     enum AVDiscard skip_idct;
2377
2378     /**
2379      *
2380      * - encoding: unused
2381      * - decoding: Set by user.
2382      */
2383     enum AVDiscard skip_frame;
2384
2385     /**
2386      *
2387      * - encoding: Set by user.
2388      * - decoding: unused
2389      */
2390     int bidir_refine;
2391
2392     /**
2393      *
2394      * - encoding: Set by user.
2395      * - decoding: unused
2396      */
2397     int brd_scale;
2398
2399 #if FF_API_X264_GLOBAL_OPTS
2400     /**
2401      * constant rate factor - quality-based VBR - values ~correspond to qps
2402      * - encoding: Set by user.
2403      * - decoding: unused
2404      *   @deprecated use 'crf' libx264 private option
2405      */
2406     attribute_deprecated float crf;
2407
2408     /**
2409      * constant quantization parameter rate control method
2410      * - encoding: Set by user.
2411      * - decoding: unused
2412      *   @deprecated use 'cqp' libx264 private option
2413      */
2414     attribute_deprecated int cqp;
2415 #endif
2416
2417     /**
2418      * minimum GOP size
2419      * - encoding: Set by user.
2420      * - decoding: unused
2421      */
2422     int keyint_min;
2423
2424     /**
2425      * number of reference frames
2426      * - encoding: Set by user.
2427      * - decoding: Set by lavc.
2428      */
2429     int refs;
2430
2431     /**
2432      * chroma qp offset from luma
2433      * - encoding: Set by user.
2434      * - decoding: unused
2435      */
2436     int chromaoffset;
2437
2438     /**
2439      * Influences how often B-frames are used.
2440      * - encoding: Set by user.
2441      * - decoding: unused
2442      */
2443     int bframebias;
2444
2445     /**
2446      * trellis RD quantization
2447      * - encoding: Set by user.
2448      * - decoding: unused
2449      */
2450     int trellis;
2451
2452     /**
2453      * Reduce fluctuations in qp (before curve compression).
2454      * - encoding: Set by user.
2455      * - decoding: unused
2456      */
2457     float complexityblur;
2458
2459     /**
2460      * in-loop deblocking filter alphac0 parameter
2461      * alpha is in the range -6...6
2462      * - encoding: Set by user.
2463      * - decoding: unused
2464      */
2465     int deblockalpha;
2466
2467     /**
2468      * in-loop deblocking filter beta parameter
2469      * beta is in the range -6...6
2470      * - encoding: Set by user.
2471      * - decoding: unused
2472      */
2473     int deblockbeta;
2474
2475     /**
2476      * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2477      * - encoding: Set by user.
2478      * - decoding: unused
2479      */
2480     int partitions;
2481 #define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2482 #define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2483 #define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2484 #define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2485 #define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2486
2487     /**
2488      * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2489      * - encoding: Set by user.
2490      * - decoding: unused
2491      */
2492     int directpred;
2493
2494     /**
2495      * Audio cutoff bandwidth (0 means "automatic")
2496      * - encoding: Set by user.
2497      * - decoding: unused
2498      */
2499     int cutoff;
2500
2501     /**
2502      * Multiplied by qscale for each frame and added to scene_change_score.
2503      * - encoding: Set by user.
2504      * - decoding: unused
2505      */
2506     int scenechange_factor;
2507
2508     /**
2509      *
2510      * Note: Value depends upon the compare function used for fullpel ME.
2511      * - encoding: Set by user.
2512      * - decoding: unused
2513      */
2514     int mv0_threshold;
2515
2516     /**
2517      * Adjusts sensitivity of b_frame_strategy 1.
2518      * - encoding: Set by user.
2519      * - decoding: unused
2520      */
2521     int b_sensitivity;
2522
2523     /**
2524      * - encoding: Set by user.
2525      * - decoding: unused
2526      */
2527     int compression_level;
2528 #define FF_COMPRESSION_DEFAULT -1
2529
2530     /**
2531      * - encoding: Set by user.
2532      * - decoding: unused
2533      */
2534     int min_prediction_order;
2535
2536     /**
2537      * - encoding: Set by user.
2538      * - decoding: unused
2539      */
2540     int max_prediction_order;
2541
2542 #if FF_API_FLAC_GLOBAL_OPTS
2543     /**
2544      * @name FLAC options
2545      * @deprecated Use FLAC encoder private options instead.
2546      * @{
2547      */
2548
2549     /**
2550      * LPC coefficient precision - used by FLAC encoder
2551      * - encoding: Set by user.
2552      * - decoding: unused
2553      */
2554     attribute_deprecated int lpc_coeff_precision;
2555
2556     /**
2557      * search method for selecting prediction order
2558      * - encoding: Set by user.
2559      * - decoding: unused
2560      */
2561     attribute_deprecated int prediction_order_method;
2562
2563     /**
2564      * - encoding: Set by user.
2565      * - decoding: unused
2566      */
2567     attribute_deprecated int min_partition_order;
2568
2569     /**
2570      * - encoding: Set by user.
2571      * - decoding: unused
2572      */
2573     attribute_deprecated int max_partition_order;
2574     /**
2575      * @}
2576      */
2577 #endif
2578
2579     /**
2580      * GOP timecode frame start number, in non drop frame format
2581      * - encoding: Set by user.
2582      * - decoding: unused
2583      */
2584     int64_t timecode_frame_start;
2585
2586 #if FF_API_REQUEST_CHANNELS
2587     /**
2588      * Decoder should decode to this many channels if it can (0 for default)
2589      * - encoding: unused
2590      * - decoding: Set by user.
2591      * @deprecated Deprecated in favor of request_channel_layout.
2592      */
2593     int request_channels;
2594 #endif
2595
2596 #if FF_API_DRC_SCALE
2597     /**
2598      * Percentage of dynamic range compression to be applied by the decoder.
2599      * The default value is 1.0, corresponding to full compression.
2600      * - encoding: unused
2601      * - decoding: Set by user.
2602      * @deprecated use AC3 decoder private option instead.
2603      */
2604     attribute_deprecated float drc_scale;
2605 #endif
2606
2607     /**
2608      * opaque 64bit number (generally a PTS) that will be reordered and
2609      * output in AVFrame.reordered_opaque
2610      * @deprecated in favor of pkt_pts
2611      * - encoding: unused
2612      * - decoding: Set by user.
2613      */
2614     int64_t reordered_opaque;
2615
2616     /**
2617      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2618      * - encoding: set by user.
2619      * - decoding: set by libavcodec.
2620      */
2621     int bits_per_raw_sample;
2622
2623     /**
2624      * Audio channel layout.
2625      * - encoding: set by user.
2626      * - decoding: set by libavcodec.
2627      */
2628     int64_t channel_layout;
2629
2630     /**
2631      * Request decoder to use this channel layout if it can (0 for default)
2632      * - encoding: unused
2633      * - decoding: Set by user.
2634      */
2635     int64_t request_channel_layout;
2636
2637     /**
2638      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2639      * - encoding: Set by user.
2640      * - decoding: unused.
2641      */
2642     float rc_max_available_vbv_use;
2643
2644     /**
2645      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2646      * - encoding: Set by user.
2647      * - decoding: unused.
2648      */
2649     float rc_min_vbv_overflow_use;
2650
2651     /**
2652      * Hardware accelerator in use
2653      * - encoding: unused.
2654      * - decoding: Set by libavcodec
2655      */
2656     struct AVHWAccel *hwaccel;
2657
2658     /**
2659      * For some codecs, the time base is closer to the field rate than the frame rate.
2660      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2661      * if no telecine is used ...
2662      *
2663      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2664      */
2665     int ticks_per_frame;
2666
2667     /**
2668      * Hardware accelerator context.
2669      * For some hardware accelerators, a global context needs to be
2670      * provided by the user. In that case, this holds display-dependent
2671      * data Libav cannot instantiate itself. Please refer to the
2672      * Libav HW accelerator documentation to know how to fill this
2673      * is. e.g. for VA API, this is a struct vaapi_context.
2674      * - encoding: unused
2675      * - decoding: Set by user
2676      */
2677     void *hwaccel_context;
2678
2679     /**
2680      * Chromaticity coordinates of the source primaries.
2681      * - encoding: Set by user
2682      * - decoding: Set by libavcodec
2683      */
2684     enum AVColorPrimaries color_primaries;
2685
2686     /**
2687      * Color Transfer Characteristic.
2688      * - encoding: Set by user
2689      * - decoding: Set by libavcodec
2690      */
2691     enum AVColorTransferCharacteristic color_trc;
2692
2693     /**
2694      * YUV colorspace type.
2695      * - encoding: Set by user
2696      * - decoding: Set by libavcodec
2697      */
2698     enum AVColorSpace colorspace;
2699
2700     /**
2701      * MPEG vs JPEG YUV range.
2702      * - encoding: Set by user
2703      * - decoding: Set by libavcodec
2704      */
2705     enum AVColorRange color_range;
2706
2707     /**
2708      * This defines the location of chroma samples.
2709      * - encoding: Set by user
2710      * - decoding: Set by libavcodec
2711      */
2712     enum AVChromaLocation chroma_sample_location;
2713
2714     /**
2715      * The codec may call this to execute several independent things.
2716      * It will return only after finishing all tasks.
2717      * The user may replace this with some multithreaded implementation,
2718      * the default implementation will execute the parts serially.
2719      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2720      * @param c context passed also to func
2721      * @param count the number of things to execute
2722      * @param arg2 argument passed unchanged to func
2723      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2724      * @param func function that will be called count times, with jobnr from 0 to count-1.
2725      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2726      *             two instances of func executing at the same time will have the same threadnr.
2727      * @return always 0 currently, but code should handle a future improvement where when any call to func
2728      *         returns < 0 no further calls to func may be done and < 0 is returned.
2729      * - encoding: Set by libavcodec, user can override.
2730      * - decoding: Set by libavcodec, user can override.
2731      */
2732     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2733
2734 #if FF_API_X264_GLOBAL_OPTS
2735     /**
2736      * explicit P-frame weighted prediction analysis method
2737      * 0: off
2738      * 1: fast blind weighting (one reference duplicate with -1 offset)
2739      * 2: smart weighting (full fade detection analysis)
2740      * - encoding: Set by user.
2741      * - decoding: unused
2742      */
2743     attribute_deprecated int weighted_p_pred;
2744
2745     /**
2746      * AQ mode
2747      * 0: Disabled
2748      * 1: Variance AQ (complexity mask)
2749      * 2: Auto-variance AQ (experimental)
2750      * - encoding: Set by user
2751      * - decoding: unused
2752      */
2753     attribute_deprecated int aq_mode;
2754
2755     /**
2756      * AQ strength
2757      * Reduces blocking and blurring in flat and textured areas.
2758      * - encoding: Set by user
2759      * - decoding: unused
2760      */
2761     attribute_deprecated float aq_strength;
2762
2763     /**
2764      * PSY RD
2765      * Strength of psychovisual optimization
2766      * - encoding: Set by user
2767      * - decoding: unused
2768      */
2769     attribute_deprecated float psy_rd;
2770
2771     /**
2772      * PSY trellis
2773      * Strength of psychovisual optimization
2774      * - encoding: Set by user
2775      * - decoding: unused
2776      */
2777     attribute_deprecated float psy_trellis;
2778
2779     /**
2780      * RC lookahead
2781      * Number of frames for frametype and ratecontrol lookahead
2782      * - encoding: Set by user
2783      * - decoding: unused
2784      */
2785     attribute_deprecated int rc_lookahead;
2786
2787     /**
2788      * Constant rate factor maximum
2789      * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2790      * than crf_max, even if doing so would violate VBV restrictions.
2791      * - encoding: Set by user.
2792      * - decoding: unused
2793      */
2794     attribute_deprecated float crf_max;
2795 #endif
2796
2797     int log_level_offset;
2798
2799 #if FF_API_FLAC_GLOBAL_OPTS
2800     /**
2801      * Determines which LPC analysis algorithm to use.
2802      * - encoding: Set by user
2803      * - decoding: unused
2804      */
2805     attribute_deprecated enum AVLPCType lpc_type;
2806
2807     /**
2808      * Number of passes to use for Cholesky factorization during LPC analysis
2809      * - encoding: Set by user
2810      * - decoding: unused
2811      */
2812     attribute_deprecated int lpc_passes;
2813 #endif
2814
2815     /**
2816      * Number of slices.
2817      * Indicates number of picture subdivisions. Used for parallelized
2818      * decoding.
2819      * - encoding: Set by user
2820      * - decoding: unused
2821      */
2822     int slices;
2823
2824     /**
2825      * Header containing style information for text subtitles.
2826      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2827      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2828      * the Format line following. It shouldn't include any Dialogue line.
2829      * - encoding: Set/allocated/freed by user (before avcodec_open())
2830      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2831      */
2832     uint8_t *subtitle_header;
2833     int subtitle_header_size;
2834
2835     /**
2836      * Current packet as passed into the decoder, to avoid having
2837      * to pass the packet into every function. Currently only valid
2838      * inside lavc and get/release_buffer callbacks.
2839      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2840      * - encoding: unused
2841      */
2842     AVPacket *pkt;
2843
2844     /**
2845      * Whether this is a copy of the context which had init() called on it.
2846      * This is used by multithreading - shared tables and picture pointers
2847      * should be freed from the original context only.
2848      * - encoding: Set by libavcodec.
2849      * - decoding: Set by libavcodec.
2850      */
2851     int is_copy;
2852
2853     /**
2854      * Which multithreading methods to use.
2855      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2856      * so clients which cannot provide future frames should not use it.
2857      *
2858      * - encoding: Set by user, otherwise the default is used.
2859      * - decoding: Set by user, otherwise the default is used.
2860      */
2861     int thread_type;
2862 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2863 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2864
2865     /**
2866      * Which multithreading methods are in use by the codec.
2867      * - encoding: Set by libavcodec.
2868      * - decoding: Set by libavcodec.
2869      */
2870     int active_thread_type;
2871
2872     /**
2873      * Set by the client if its custom get_buffer() callback can be called
2874      * from another thread, which allows faster multithreaded decoding.
2875      * draw_horiz_band() will be called from other threads regardless of this setting.
2876      * Ignored if the default get_buffer() is used.
2877      * - encoding: Set by user.
2878      * - decoding: Set by user.
2879      */
2880     int thread_safe_callbacks;
2881
2882     /**
2883      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2884      * Used for compliant TS muxing.
2885      * - encoding: Set by libavcodec.
2886      * - decoding: unused.
2887      */
2888     uint64_t vbv_delay;
2889
2890     /**
2891      * Type of service that the audio stream conveys.
2892      * - encoding: Set by user.
2893      * - decoding: Set by libavcodec.
2894      */
2895     enum AVAudioServiceType audio_service_type;
2896
2897     /**
2898      * Used to request a sample format from the decoder.
2899      * - encoding: unused.
2900      * - decoding: Set by user.
2901      */
2902     enum AVSampleFormat request_sample_fmt;
2903 } AVCodecContext;
2904
2905 /**
2906  * AVProfile.
2907  */
2908 typedef struct AVProfile {
2909     int profile;
2910     const char *name; ///< short name for the profile
2911 } AVProfile;
2912
2913 typedef struct AVCodecDefault AVCodecDefault;
2914
2915 /**
2916  * AVCodec.
2917  */
2918 typedef struct AVCodec {
2919     /**
2920      * Name of the codec implementation.
2921      * The name is globally unique among encoders and among decoders (but an
2922      * encoder and a decoder can share the same name).
2923      * This is the primary way to find a codec from the user perspective.
2924      */
2925     const char *name;
2926     enum AVMediaType type;
2927     enum CodecID id;
2928     int priv_data_size;
2929     int (*init)(AVCodecContext *);
2930     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2931     int (*close)(AVCodecContext *);
2932     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2933     /**
2934      * Codec capabilities.
2935      * see CODEC_CAP_*
2936      */
2937     int capabilities;
2938     struct AVCodec *next;
2939     /**
2940      * Flush buffers.
2941      * Will be called when seeking
2942      */
2943     void (*flush)(AVCodecContext *);
2944     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2945     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2946     /**
2947      * Descriptive name for the codec, meant to be more human readable than name.
2948      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2949      */
2950     const char *long_name;
2951     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2952     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2953     const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2954     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2955     const AVClass *priv_class;              ///< AVClass for the private context
2956     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2957
2958     /**
2959      * @name Frame-level threading support functions
2960      * @{
2961      */
2962     /**
2963      * If defined, called on thread contexts when they are created.
2964      * If the codec allocates writable tables in init(), re-allocate them here.
2965      * priv_data will be set to a copy of the original.
2966      */
2967     int (*init_thread_copy)(AVCodecContext *);
2968     /**
2969      * Copy necessary context variables from a previous thread context to the current one.
2970      * If not defined, the next thread will start automatically; otherwise, the codec
2971      * must call ff_thread_finish_setup().
2972      *
2973      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2974      */
2975     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2976     /** @} */
2977
2978     /**
2979      * Private codec-specific defaults.
2980      */
2981     const AVCodecDefault *defaults;
2982 } AVCodec;
2983
2984 /**
2985  * AVHWAccel.
2986  */
2987 typedef struct AVHWAccel {
2988     /**
2989      * Name of the hardware accelerated codec.
2990      * The name is globally unique among encoders and among decoders (but an
2991      * encoder and a decoder can share the same name).
2992      */
2993     const char *name;
2994
2995     /**
2996      * Type of codec implemented by the hardware accelerator.
2997      *
2998      * See AVMEDIA_TYPE_xxx
2999      */
3000     enum AVMediaType type;
3001
3002     /**
3003      * Codec implemented by the hardware accelerator.
3004      *
3005      * See CODEC_ID_xxx
3006      */
3007     enum CodecID id;
3008
3009     /**
3010      * Supported pixel format.
3011      *
3012      * Only hardware accelerated formats are supported here.
3013      */
3014     enum PixelFormat pix_fmt;
3015
3016     /**
3017      * Hardware accelerated codec capabilities.
3018      * see FF_HWACCEL_CODEC_CAP_*
3019      */
3020     int capabilities;
3021
3022     struct AVHWAccel *next;
3023
3024     /**
3025      * Called at the beginning of each frame or field picture.
3026      *
3027      * Meaningful frame information (codec specific) is guaranteed to
3028      * be parsed at this point. This function is mandatory.
3029      *
3030      * Note that buf can be NULL along with buf_size set to 0.
3031      * Otherwise, this means the whole frame is available at this point.
3032      *
3033      * @param avctx the codec context
3034      * @param buf the frame data buffer base
3035      * @param buf_size the size of the frame in bytes
3036      * @return zero if successful, a negative value otherwise
3037      */
3038     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3039
3040     /**
3041      * Callback for each slice.
3042      *
3043      * Meaningful slice information (codec specific) is guaranteed to
3044      * be parsed at this point. This function is mandatory.
3045      *
3046      * @param avctx the codec context
3047      * @param buf the slice data buffer base
3048      * @param buf_size the size of the slice in bytes
3049      * @return zero if successful, a negative value otherwise
3050      */
3051     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3052
3053     /**
3054      * Called at the end of each frame or field picture.
3055      *
3056      * The whole picture is parsed at this point and can now be sent
3057      * to the hardware accelerator. This function is mandatory.
3058      *
3059      * @param avctx the codec context
3060      * @return zero if successful, a negative value otherwise
3061      */
3062     int (*end_frame)(AVCodecContext *avctx);
3063
3064     /**
3065      * Size of HW accelerator private data.
3066      *
3067      * Private data is allocated with av_mallocz() before
3068      * AVCodecContext.get_buffer() and deallocated after
3069      * AVCodecContext.release_buffer().
3070      */
3071     int priv_data_size;
3072 } AVHWAccel;
3073
3074 /**
3075  * four components are given, that's all.
3076  * the last component is alpha
3077  */
3078 typedef struct AVPicture {
3079     uint8_t *data[4];
3080     int linesize[4];       ///< number of bytes per line
3081 } AVPicture;
3082
3083 #if FF_API_PALETTE_CONTROL
3084 /**
3085  * AVPaletteControl
3086  * This structure defines a method for communicating palette changes
3087  * between and demuxer and a decoder.
3088  *
3089  * @deprecated Use AVPacket to send palette changes instead.
3090  * This is totally broken.
3091  */
3092 #define AVPALETTE_SIZE 1024
3093 #define AVPALETTE_COUNT 256
3094 typedef struct AVPaletteControl {
3095
3096     /* Demuxer sets this to 1 to indicate the palette has changed;
3097      * decoder resets to 0. */
3098     int palette_changed;
3099
3100     /* 4-byte ARGB palette entries, stored in native byte order; note that
3101      * the individual palette components should be on a 8-bit scale; if
3102      * the palette data comes from an IBM VGA native format, the component
3103      * data is probably 6 bits in size and needs to be scaled. */
3104     unsigned int palette[AVPALETTE_COUNT];
3105
3106 } AVPaletteControl attribute_deprecated;
3107 #endif
3108
3109 enum AVSubtitleType {
3110     SUBTITLE_NONE,
3111
3112     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3113
3114     /**
3115      * Plain text, the text field must be set by the decoder and is
3116      * authoritative. ass and pict fields may contain approximations.
3117      */
3118     SUBTITLE_TEXT,
3119
3120     /**
3121      * Formatted text, the ass field must be set by the decoder and is
3122      * authoritative. pict and text fields may contain approximations.
3123      */
3124     SUBTITLE_ASS,
3125 };
3126
3127 typedef struct AVSubtitleRect {
3128     int x;         ///< top left corner  of pict, undefined when pict is not set
3129     int y;         ///< top left corner  of pict, undefined when pict is not set
3130     int w;         ///< width            of pict, undefined when pict is not set
3131     int h;         ///< height           of pict, undefined when pict is not set
3132     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3133
3134     /**
3135      * data+linesize for the bitmap of this subtitle.
3136      * can be set for text/ass as well once they where rendered
3137      */
3138     AVPicture pict;
3139     enum AVSubtitleType type;
3140
3141     char *text;                     ///< 0 terminated plain UTF-8 text
3142
3143     /**
3144      * 0 terminated ASS/SSA compatible event line.
3145      * The pressentation of this is unaffected by the other values in this
3146      * struct.
3147      */
3148     char *ass;
3149 } AVSubtitleRect;
3150
3151 typedef struct AVSubtitle {
3152     uint16_t format; /* 0 = graphics */
3153     uint32_t start_display_time; /* relative to packet pts, in ms */
3154     uint32_t end_display_time; /* relative to packet pts, in ms */
3155     unsigned num_rects;
3156     AVSubtitleRect **rects;
3157     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3158 } AVSubtitle;
3159
3160 /* packet functions */
3161
3162 /**
3163  * @deprecated use NULL instead
3164  */
3165 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3166
3167 /**
3168  * Default packet destructor.
3169  */
3170 void av_destruct_packet(AVPacket *pkt);
3171
3172 /**
3173  * Initialize optional fields of a packet with default values.
3174  *
3175  * @param pkt packet
3176  */
3177 void av_init_packet(AVPacket *pkt);
3178
3179 /**
3180  * Allocate the payload of a packet and initialize its fields with
3181  * default values.
3182  *
3183  * @param pkt packet
3184  * @param size wanted payload size
3185  * @return 0 if OK, AVERROR_xxx otherwise
3186  */
3187 int av_new_packet(AVPacket *pkt, int size);
3188
3189 /**
3190  * Reduce packet size, correctly zeroing padding
3191  *
3192  * @param pkt packet
3193  * @param size new size
3194  */
3195 void av_shrink_packet(AVPacket *pkt, int size);
3196
3197 /**
3198  * Increase packet size, correctly zeroing padding
3199  *
3200  * @param pkt packet
3201  * @param grow_by number of bytes by which to increase the size of the packet
3202  */
3203 int av_grow_packet(AVPacket *pkt, int grow_by);
3204
3205 /**
3206  * @warning This is a hack - the packet memory allocation stuff is broken. The
3207  * packet is allocated if it was not really allocated.
3208  */
3209 int av_dup_packet(AVPacket *pkt);
3210
3211 /**
3212  * Free a packet.
3213  *
3214  * @param pkt packet to free
3215  */
3216 void av_free_packet(AVPacket *pkt);
3217
3218 /**
3219  * Allocate new information of a packet.
3220  *
3221  * @param pkt packet
3222  * @param type side information type
3223  * @param size side information size
3224  * @return pointer to fresh allocated data or NULL otherwise
3225  */
3226 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3227                                  int size);
3228
3229 /**
3230  * Get side information from packet.
3231  *
3232  * @param pkt packet
3233  * @param type desired side information type
3234  * @param size pointer for side information size to store (optional)
3235  * @return pointer to data if present or NULL otherwise
3236  */
3237 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3238                                  int *size);
3239
3240 /* resample.c */
3241
3242 struct ReSampleContext;
3243 struct AVResampleContext;
3244
3245 typedef struct ReSampleContext ReSampleContext;
3246
3247 /**
3248  *  Initialize audio resampling context.
3249  *
3250  * @param output_channels  number of output channels
3251  * @param input_channels   number of input channels
3252  * @param output_rate      output sample rate
3253  * @param input_rate       input sample rate
3254  * @param sample_fmt_out   requested output sample format
3255  * @param sample_fmt_in    input sample format
3256  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3257  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3258  * @param linear           if 1 then the used FIR filter will be linearly interpolated
3259                            between the 2 closest, if 0 the closest will be used
3260  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3261  * @return allocated ReSampleContext, NULL if error occured
3262  */
3263 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3264                                         int output_rate, int input_rate,
3265                                         enum AVSampleFormat sample_fmt_out,
3266                                         enum AVSampleFormat sample_fmt_in,
3267                                         int filter_length, int log2_phase_count,
3268                                         int linear, double cutoff);
3269
3270 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3271
3272 /**
3273  * Free resample context.
3274  *
3275  * @param s a non-NULL pointer to a resample context previously
3276  *          created with av_audio_resample_init()
3277  */
3278 void audio_resample_close(ReSampleContext *s);
3279
3280
3281 /**
3282  * Initialize an audio resampler.
3283  * Note, if either rate is not an integer then simply scale both rates up so they are.
3284  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3285  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3286  * @param linear If 1 then the used FIR filter will be linearly interpolated
3287                  between the 2 closest, if 0 the closest will be used
3288  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3289  */
3290 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3291
3292 /**
3293  * Resample an array of samples using a previously configured context.
3294  * @param src an array of unconsumed samples
3295  * @param consumed the number of samples of src which have been consumed are returned here
3296  * @param src_size the number of unconsumed samples available
3297  * @param dst_size the amount of space in samples available in dst
3298  * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
3299  * @return the number of samples written in dst or -1 if an error occurred
3300  */
3301 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3302
3303
3304 /**
3305  * Compensate samplerate/timestamp drift. The compensation is done by changing
3306  * the resampler parameters, so no audible clicks or similar distortions occur
3307  * @param compensation_distance distance in output samples over which the compensation should be performed
3308  * @param sample_delta number of output samples which should be output less
3309  *
3310  * example: av_resample_compensate(c, 10, 500)
3311  * here instead of 510 samples only 500 samples would be output
3312  *
3313  * note, due to rounding the actual compensation might be slightly different,
3314  * especially if the compensation_distance is large and the in_rate used during init is small
3315  */
3316 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3317 void av_resample_close(struct AVResampleContext *c);
3318
3319 /**
3320  * Allocate memory for a picture.  Call avpicture_free() to free it.
3321  *
3322  * @see avpicture_fill()
3323  *
3324  * @param picture the picture to be filled in
3325  * @param pix_fmt the format of the picture
3326  * @param width the width of the picture
3327  * @param height the height of the picture
3328  * @return zero if successful, a negative value if not
3329  */
3330 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3331
3332 /**
3333  * Free a picture previously allocated by avpicture_alloc().
3334  * The data buffer used by the AVPicture is freed, but the AVPicture structure
3335  * itself is not.
3336  *
3337  * @param picture the AVPicture to be freed
3338  */
3339 void avpicture_free(AVPicture *picture);
3340
3341 /**
3342  * Fill in the AVPicture fields.
3343  * The fields of the given AVPicture are filled in by using the 'ptr' address
3344  * which points to the image data buffer. Depending on the specified picture
3345  * format, one or multiple image data pointers and line sizes will be set.
3346  * If a planar format is specified, several pointers will be set pointing to
3347  * the different picture planes and the line sizes of the different planes
3348  * will be stored in the lines_sizes array.
3349  * Call with ptr == NULL to get the required size for the ptr buffer.
3350  *
3351  * To allocate the buffer and fill in the AVPicture fields in one call,
3352  * use avpicture_alloc().
3353  *
3354  * @param picture AVPicture whose fields are to be filled in
3355  * @param ptr Buffer which will contain or contains the actual image data
3356  * @param pix_fmt The format in which the picture data is stored.
3357  * @param width the width of the image in pixels
3358  * @param height the height of the image in pixels
3359  * @return size of the image data in bytes
3360  */
3361 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3362                    enum PixelFormat pix_fmt, int width, int height);
3363
3364 /**
3365  * Copy pixel data from an AVPicture into a buffer.
3366  * The data is stored compactly, without any gaps for alignment or padding
3367  * which may be applied by avpicture_fill().
3368  *
3369  * @see avpicture_get_size()
3370  *
3371  * @param[in] src AVPicture containing image data
3372  * @param[in] pix_fmt The format in which the picture data is stored.
3373  * @param[in] width the width of the image in pixels.
3374  * @param[in] height the height of the image in pixels.
3375  * @param[out] dest A buffer into which picture data will be copied.
3376  * @param[in] dest_size The size of 'dest'.
3377  * @return The number of bytes written to dest, or a negative value (error code) on error.
3378  */
3379 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3380                      unsigned char *dest, int dest_size);
3381
3382 /**
3383  * Calculate the size in bytes that a picture of the given width and height
3384  * would occupy if stored in the given picture format.
3385  * Note that this returns the size of a compact representation as generated
3386  * by avpicture_layout(), which can be smaller than the size required for e.g.
3387  * avpicture_fill().
3388  *
3389  * @param pix_fmt the given picture format
3390  * @param width the width of the image
3391  * @param height the height of the image
3392  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3393  */
3394 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3395 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3396
3397 #if FF_API_GET_PIX_FMT_NAME
3398 /**
3399  * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3400  */
3401 attribute_deprecated
3402 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3403 #endif
3404
3405 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3406
3407 /**
3408  * Return a value representing the fourCC code associated to the
3409  * pixel format pix_fmt, or 0 if no associated fourCC code can be
3410  * found.
3411  */
3412 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3413
3414 /**
3415  * Put a string representing the codec tag codec_tag in buf.
3416  *
3417  * @param buf_size size in bytes of buf
3418  * @return the length of the string that would have been generated if
3419  * enough space had been available, excluding the trailing null
3420  */
3421 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3422
3423 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3424 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3425 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3426 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3427 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3428 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3429
3430 /**
3431  * Compute what kind of losses will occur when converting from one specific
3432  * pixel format to another.
3433  * When converting from one pixel format to another, information loss may occur.
3434  * For example, when converting from RGB24 to GRAY, the color information will
3435  * be lost. Similarly, other losses occur when converting from some formats to
3436  * other formats. These losses can involve loss of chroma, but also loss of
3437  * resolution, loss of color depth, loss due to the color space conversion, loss
3438  * of the alpha bits or loss due to color quantization.
3439  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3440  * which will occur when converting from one pixel format to another.
3441  *
3442  * @param[in] dst_pix_fmt destination pixel format
3443  * @param[in] src_pix_fmt source pixel format
3444  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3445  * @return Combination of flags informing you what kind of losses will occur.
3446  */
3447 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3448                              int has_alpha);
3449
3450 /**
3451  * Find the best pixel format to convert to given a certain source pixel
3452  * format.  When converting from one pixel format to another, information loss
3453  * may occur.  For example, when converting from RGB24 to GRAY, the color
3454  * information will be lost. Similarly, other losses occur when converting from
3455  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3456  * the given pixel formats should be used to suffer the least amount of loss.
3457  * The pixel formats from which it chooses one, are determined by the
3458  * pix_fmt_mask parameter.
3459  *
3460  * @code
3461  * src_pix_fmt = PIX_FMT_YUV420P;
3462  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3463  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3464  * @endcode
3465  *
3466  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3467  * @param[in] src_pix_fmt source pixel format
3468  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3469  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3470  * @return The best pixel format to convert to or -1 if none was found.
3471  */
3472 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3473                               int has_alpha, int *loss_ptr);
3474
3475 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3476 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3477
3478 /**
3479  * Tell if an image really has transparent alpha values.
3480  * @return ored mask of FF_ALPHA_xxx constants
3481  */
3482 int img_get_alpha_info(const AVPicture *src,
3483                        enum PixelFormat pix_fmt, int width, int height);
3484
3485 /* deinterlace a picture */
3486 /* deinterlace - if not supported return -1 */
3487 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3488                           enum PixelFormat pix_fmt, int width, int height);
3489
3490 /* external high level API */
3491
3492 /**
3493  * If c is NULL, returns the first registered codec,
3494  * if c is non-NULL, returns the next registered codec after c,
3495  * or NULL if c is the last one.
3496  */
3497 AVCodec *av_codec_next(AVCodec *c);
3498
3499 /**
3500  * Return the LIBAVCODEC_VERSION_INT constant.
3501  */
3502 unsigned avcodec_version(void);
3503
3504 /**
3505  * Return the libavcodec build-time configuration.
3506  */
3507 const char *avcodec_configuration(void);
3508
3509 /**
3510  * Return the libavcodec license.
3511  */
3512 const char *avcodec_license(void);
3513
3514 #if FF_API_AVCODEC_INIT
3515 /**
3516  * @deprecated this function is called automatically from avcodec_register()
3517  * and avcodec_register_all(), there is no need to call it manually
3518  */
3519 attribute_deprecated
3520 void avcodec_init(void);
3521 #endif
3522
3523 /**
3524  * Register the codec codec and initialize libavcodec.
3525  *
3526  * @warning either this function or avcodec_register_all() must be called
3527  * before any other libavcodec functions.
3528  *
3529  * @see avcodec_register_all()
3530  */
3531 void avcodec_register(AVCodec *codec);
3532
3533 /**
3534  * Find a registered encoder with a matching codec ID.
3535  *
3536  * @param id CodecID of the requested encoder
3537  * @return An encoder if one was found, NULL otherwise.
3538  */
3539 AVCodec *avcodec_find_encoder(enum CodecID id);
3540
3541 /**
3542  * Find a registered encoder with the specified name.
3543  *
3544  * @param name name of the requested encoder
3545  * @return An encoder if one was found, NULL otherwise.
3546  */
3547 AVCodec *avcodec_find_encoder_by_name(const char *name);
3548
3549 /**
3550  * Find a registered decoder with a matching codec ID.
3551  *
3552  * @param id CodecID of the requested decoder
3553  * @return A decoder if one was found, NULL otherwise.
3554  */
3555 AVCodec *avcodec_find_decoder(enum CodecID id);
3556
3557 /**
3558  * Find a registered decoder with the specified name.
3559  *
3560  * @param name name of the requested decoder
3561  * @return A decoder if one was found, NULL otherwise.
3562  */
3563 AVCodec *avcodec_find_decoder_by_name(const char *name);
3564 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3565
3566 /**
3567  * Return a name for the specified profile, if available.
3568  *
3569  * @param codec the codec that is searched for the given profile
3570  * @param profile the profile value for which a name is requested
3571  * @return A name for the profile if found, NULL otherwise.
3572  */
3573 const char *av_get_profile_name(const AVCodec *codec, int profile);
3574
3575 /**
3576  * Set the fields of the given AVCodecContext to default values.
3577  *
3578  * @param s The AVCodecContext of which the fields should be set to default values.
3579  */
3580 void avcodec_get_context_defaults(AVCodecContext *s);
3581
3582 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3583  *  we WILL change its arguments and name a few times! */
3584 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3585
3586 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3587  *  we WILL change its arguments and name a few times! */
3588 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3589
3590 #if FF_API_ALLOC_CONTEXT
3591 /**
3592  * Allocate an AVCodecContext and set its fields to default values.  The
3593  * resulting struct can be deallocated by simply calling av_free().
3594  *
3595  * @return An AVCodecContext filled with default values or NULL on failure.
3596  * @see avcodec_get_context_defaults
3597  *
3598  * @deprecated use avcodec_alloc_context3()
3599  */
3600 attribute_deprecated
3601 AVCodecContext *avcodec_alloc_context(void);
3602
3603 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3604  *  we WILL change its arguments and name a few times! */
3605 attribute_deprecated
3606 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3607 #endif
3608
3609 /**
3610  * Allocate an AVCodecContext and set its fields to default values.  The
3611  * resulting struct can be deallocated by simply calling av_free().
3612  *
3613  * @param codec if non-NULL, allocate private data and initialize defaults
3614  *              for the given codec. It is illegal to then call avcodec_open()
3615  *              with a different codec.
3616  *
3617  * @return An AVCodecContext filled with default values or NULL on failure.
3618  * @see avcodec_get_context_defaults
3619  *
3620  * @deprecated use avcodec_alloc_context3()
3621  */
3622 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3623
3624 /**
3625  * Copy the settings of the source AVCodecContext into the destination
3626  * AVCodecContext. The resulting destination codec context will be
3627  * unopened, i.e. you are required to call avcodec_open() before you
3628  * can use this AVCodecContext to decode/encode video/audio data.
3629  *
3630  * @param dest target codec context, should be initialized with
3631  *             avcodec_alloc_context3(), but otherwise uninitialized
3632  * @param src source codec context
3633  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3634  */
3635 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3636
3637 /**
3638  * Set the fields of the given AVFrame to default values.
3639  *
3640  * @param pic The AVFrame of which the fields should be set to default values.
3641  */
3642 void avcodec_get_frame_defaults(AVFrame *pic);
3643
3644 /**
3645  * Allocate an AVFrame and set its fields to default values.  The resulting
3646  * struct can be deallocated by simply calling av_free().
3647  *
3648  * @return An AVFrame filled with default values or NULL on failure.
3649  * @see avcodec_get_frame_defaults
3650  */
3651 AVFrame *avcodec_alloc_frame(void);
3652
3653 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3654 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3655 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3656
3657 /**
3658  * Return the amount of padding in pixels which the get_buffer callback must
3659  * provide around the edge of the image for codecs which do not have the
3660  * CODEC_FLAG_EMU_EDGE flag.
3661  *
3662  * @return Required padding in pixels.
3663  */
3664 unsigned avcodec_get_edge_width(void);
3665 /**
3666  * Modify width and height values so that they will result in a memory
3667  * buffer that is acceptable for the codec if you do not use any horizontal
3668  * padding.
3669  *
3670  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3671  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3672  * according to avcodec_get_edge_width() before.
3673  */
3674 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3675 /**
3676  * Modify width and height values so that they will result in a memory
3677  * buffer that is acceptable for the codec if you also ensure that all
3678  * line sizes are a multiple of the respective linesize_align[i].
3679  *
3680  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3681  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3682  * according to avcodec_get_edge_width() before.
3683  */
3684 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3685                                int linesize_align[4]);
3686
3687 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3688
3689 #if FF_API_THREAD_INIT
3690 /**
3691  * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3692  */
3693 attribute_deprecated
3694 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3695 #endif
3696
3697 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3698 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3699 //FIXME func typedef
3700
3701 #if FF_API_AVCODEC_OPEN
3702 /**
3703  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3704  * function the context has to be allocated.
3705  *
3706  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3707  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3708  * retrieving a codec.
3709  *
3710  * @warning This function is not thread safe!
3711  *
3712  * @code
3713  * avcodec_register_all();
3714  * codec = avcodec_find_decoder(CODEC_ID_H264);
3715  * if (!codec)
3716  *     exit(1);
3717  *
3718  * context = avcodec_alloc_context3(codec);
3719  *
3720  * if (avcodec_open(context, codec) < 0)
3721  *     exit(1);
3722  * @endcode
3723  *
3724  * @param avctx The context which will be set up to use the given codec.
3725  * @param codec The codec to use within the context.
3726  * @return zero on success, a negative value on error
3727  * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3728  *
3729  * @deprecated use avcodec_open2
3730  */
3731 attribute_deprecated
3732 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3733 #endif
3734
3735 /**
3736  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3737  * function the context has to be allocated with avcodec_alloc_context().
3738  *
3739  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3740  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3741  * retrieving a codec.
3742  *
3743  * @warning This function is not thread safe!
3744  *
3745  * @code
3746  * avcodec_register_all();
3747  * av_dict_set(&opts, "b", "2.5M", 0);
3748  * codec = avcodec_find_decoder(CODEC_ID_H264);
3749  * if (!codec)
3750  *     exit(1);
3751  *
3752  * context = avcodec_alloc_context();
3753  *
3754  * if (avcodec_open(context, codec, opts) < 0)
3755  *     exit(1);
3756  * @endcode
3757  *
3758  * @param avctx The context to initialize.
3759  * @param options A dictionary filled with AVCodecContext and codec-private options.
3760  *                On return this object will be filled with options that were not found.
3761  *
3762  * @return zero on success, a negative value on error
3763  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3764  *      av_dict_set(), av_opt_find().
3765  */
3766 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3767
3768 /**
3769  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3770  * Some decoders may support multiple frames in a single AVPacket, such
3771  * decoders would then just decode the first frame. In this case,
3772  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3773  * the remaining data in order to decode the second frame etc.
3774  * If no frame
3775  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3776  * decompressed frame size in bytes.
3777  *
3778  * @warning You must set frame_size_ptr to the allocated size of the
3779  * output buffer before calling avcodec_decode_audio3().
3780  *
3781  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3782  * the actual read bytes because some optimized bitstream readers read 32 or 64
3783  * bits at once and could read over the end.
3784  *
3785  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3786  * no overreading happens for damaged MPEG streams.
3787  *
3788  * @note You might have to align the input buffer avpkt->data and output buffer
3789  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3790  * necessary at all, on others it won't work at all if not aligned and on others
3791  * it will work but it will have an impact on performance.
3792  *
3793  * In practice, avpkt->data should have 4 byte alignment at minimum and
3794  * samples should be 16 byte aligned unless the CPU doesn't need it
3795  * (AltiVec and SSE do).
3796  *
3797  * @param avctx the codec context
3798  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3799  * @param[in,out] frame_size_ptr the output buffer size in bytes
3800  * @param[in] avpkt The input AVPacket containing the input buffer.
3801  *            You can create such packet with av_init_packet() and by then setting
3802  *            data and size, some decoders might in addition need other fields.
3803  *            All decoders are designed to use the least fields possible though.
3804  * @return On error a negative value is returned, otherwise the number of bytes
3805  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3806  */
3807 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3808                          int *frame_size_ptr,
3809                          AVPacket *avpkt);
3810
3811 /**
3812  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3813  * Some decoders may support multiple frames in a single AVPacket, such
3814  * decoders would then just decode the first frame.
3815  *
3816  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3817  * the actual read bytes because some optimized bitstream readers read 32 or 64
3818  * bits at once and could read over the end.
3819  *
3820  * @warning The end of the input buffer buf should be set to 0 to ensure that
3821  * no overreading happens for damaged MPEG streams.
3822  *
3823  * @note You might have to align the input buffer avpkt->data.
3824  * The alignment requirements depend on the CPU: on some CPUs it isn't
3825  * necessary at all, on others it won't work at all if not aligned and on others
3826  * it will work but it will have an impact on performance.
3827  *
3828  * In practice, avpkt->data should have 4 byte alignment at minimum.
3829  *
3830  * @note Some codecs have a delay between input and output, these need to be
3831  * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3832  *
3833  * @param avctx the codec context
3834  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3835  *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3836  *             allocate memory for the actual bitmap.
3837  *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3838  *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3839  *                   decodes and the decoder tells the user once it does not need the data anymore,
3840  *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3841  *
3842  * @param[in] avpkt The input AVpacket containing the input buffer.
3843  *            You can create such packet with av_init_packet() and by then setting
3844  *            data and size, some decoders might in addition need other fields like
3845  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3846  *            fields possible.
3847  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3848  * @return On error a negative value is returned, otherwise the number of bytes
3849  * used or zero if no frame could be decompressed.
3850  */
3851 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3852                          int *got_picture_ptr,
3853                          AVPacket *avpkt);
3854
3855 /**
3856  * Decode a subtitle message.
3857  * Return a negative value on error, otherwise return the number of bytes used.
3858  * If no subtitle could be decompressed, got_sub_ptr is zero.
3859  * Otherwise, the subtitle is stored in *sub.
3860  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3861  * simplicity, because the performance difference is expect to be negligible
3862  * and reusing a get_buffer written for video codecs would probably perform badly
3863  * due to a potentially very different allocation pattern.
3864  *
3865  * @param avctx the codec context
3866  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3867                    freed with avsubtitle_free if *got_sub_ptr is set.
3868  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3869  * @param[in] avpkt The input AVPacket containing the input buffer.
3870  */
3871 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3872                             int *got_sub_ptr,
3873                             AVPacket *avpkt);
3874
3875 /**
3876  * Frees all allocated data in the given subtitle struct.
3877  *
3878  * @param sub AVSubtitle to free.
3879  */
3880 void avsubtitle_free(AVSubtitle *sub);
3881
3882 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3883                         int *data_size_ptr,
3884                         uint8_t *buf, int buf_size);
3885
3886 /**
3887  * Encode an audio frame from samples into buf.
3888  *
3889  * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3890  * However, for PCM audio the user will know how much space is needed
3891  * because it depends on the value passed in buf_size as described
3892  * below. In that case a lower value can be used.
3893  *
3894  * @param avctx the codec context
3895  * @param[out] buf the output buffer
3896  * @param[in] buf_size the output buffer size
3897  * @param[in] samples the input buffer containing the samples
3898  * The number of samples read from this buffer is frame_size*channels,
3899  * both of which are defined in avctx.
3900  * For PCM audio the number of samples read from samples is equal to
3901  * buf_size * input_sample_size / output_sample_size.
3902  * @return On error a negative value is returned, on success zero or the number
3903  * of bytes used to encode the data read from the input buffer.
3904  */
3905 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3906                          const short *samples);
3907
3908 /**
3909  * Encode a video frame from pict into buf.
3910  * The input picture should be
3911  * stored using a specific format, namely avctx.pix_fmt.
3912  *
3913  * @param avctx the codec context
3914  * @param[out] buf the output buffer for the bitstream of encoded frame
3915  * @param[in] buf_size the size of the output buffer in bytes
3916  * @param[in] pict the input picture to encode
3917  * @return On error a negative value is returned, on success zero or the number
3918  * of bytes used from the output buffer.
3919  */
3920 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3921                          const AVFrame *pict);
3922 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3923                             const AVSubtitle *sub);
3924
3925 int avcodec_close(AVCodecContext *avctx);
3926
3927 /**
3928  * Register all the codecs, parsers and bitstream filters which were enabled at
3929  * configuration time. If you do not call this function you can select exactly
3930  * which formats you want to support, by using the individual registration
3931  * functions.
3932  *
3933  * @see avcodec_register
3934  * @see av_register_codec_parser
3935  * @see av_register_bitstream_filter
3936  */
3937 void avcodec_register_all(void);
3938
3939 /**
3940  * Flush buffers, should be called when seeking or when switching to a different stream.
3941  */
3942 void avcodec_flush_buffers(AVCodecContext *avctx);
3943
3944 void avcodec_default_free_buffers(AVCodecContext *s);
3945
3946 /* misc useful functions */
3947
3948 #if FF_API_OLD_FF_PICT_TYPES
3949 /**
3950  * Return a single letter to describe the given picture type pict_type.
3951  *
3952  * @param[in] pict_type the picture type
3953  * @return A single character representing the picture type.
3954  * @deprecated Use av_get_picture_type_char() instead.
3955  */
3956 attribute_deprecated
3957 char av_get_pict_type_char(int pict_type);
3958 #endif
3959
3960 /**
3961  * Return codec bits per sample.
3962  *
3963  * @param[in] codec_id the codec
3964  * @return Number of bits per sample or zero if unknown for the given codec.
3965  */
3966 int av_get_bits_per_sample(enum CodecID codec_id);
3967
3968 #if FF_API_OLD_SAMPLE_FMT
3969 /**
3970  * @deprecated Use av_get_bytes_per_sample() instead.
3971  */
3972 attribute_deprecated
3973 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3974 #endif
3975
3976 /* frame parsing */
3977 typedef struct AVCodecParserContext {
3978     void *priv_data;
3979     struct AVCodecParser *parser;
3980     int64_t frame_offset; /* offset of the current frame */
3981     int64_t cur_offset; /* current offset
3982                            (incremented by each av_parser_parse()) */
3983     int64_t next_frame_offset; /* offset of the next frame */
3984     /* video info */
3985     int pict_type; /* XXX: Put it back in AVCodecContext. */
3986     /**
3987      * This field is used for proper frame duration computation in lavf.
3988      * It signals, how much longer the frame duration of the current frame
3989      * is compared to normal frame duration.
3990      *
3991      * frame_duration = (1 + repeat_pict) * time_base
3992      *
3993      * It is used by codecs like H.264 to display telecined material.
3994      */
3995     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3996     int64_t pts;     /* pts of the current frame */
3997     int64_t dts;     /* dts of the current frame */
3998
3999     /* private data */
4000     int64_t last_pts;
4001     int64_t last_dts;
4002     int fetch_timestamp;
4003
4004 #define AV_PARSER_PTS_NB 4
4005     int cur_frame_start_index;
4006     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4007     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4008     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4009
4010     int flags;
4011 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4012 #define PARSER_FLAG_ONCE                      0x0002
4013 /// Set if the parser has a valid file offset
4014 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4015
4016     int64_t offset;      ///< byte offset from starting packet start
4017     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4018
4019     /**
4020      * Set by parser to 1 for key frames and 0 for non-key frames.
4021      * It is initialized to -1, so if the parser doesn't set this flag,
4022      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4023      * will be used.
4024      */
4025     int key_frame;
4026
4027     /**
4028      * Time difference in stream time base units from the pts of this
4029      * packet to the point at which the output from the decoder has converged
4030      * independent from the availability of previous frames. That is, the
4031      * frames are virtually identical no matter if decoding started from
4032      * the very first frame or from this keyframe.
4033      * Is AV_NOPTS_VALUE if unknown.
4034      * This field is not the display duration of the current frame.
4035      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4036      * set.
4037      *
4038      * The purpose of this field is to allow seeking in streams that have no
4039      * keyframes in the conventional sense. It corresponds to the
4040      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4041      * essential for some types of subtitle streams to ensure that all
4042      * subtitles are correctly displayed after seeking.
4043      */
4044     int64_t convergence_duration;
4045
4046     // Timestamp generation support:
4047     /**
4048      * Synchronization point for start of timestamp generation.
4049      *
4050      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4051      * (default).
4052      *
4053      * For example, this corresponds to presence of H.264 buffering period
4054      * SEI message.
4055      */
4056     int dts_sync_point;
4057
4058     /**
4059      * Offset of the current timestamp against last timestamp sync point in
4060      * units of AVCodecContext.time_base.
4061      *
4062      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4063      * contain a valid timestamp offset.
4064      *
4065      * Note that the timestamp of sync point has usually a nonzero
4066      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4067      * the next frame after timestamp sync point will be usually 1.
4068      *
4069      * For example, this corresponds to H.264 cpb_removal_delay.
4070      */
4071     int dts_ref_dts_delta;
4072
4073     /**
4074      * Presentation delay of current frame in units of AVCodecContext.time_base.
4075      *
4076      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4077      * contain valid non-negative timestamp delta (presentation time of a frame
4078      * must not lie in the past).
4079      *
4080      * This delay represents the difference between decoding and presentation
4081      * time of the frame.
4082      *
4083      * For example, this corresponds to H.264 dpb_output_delay.
4084      */
4085     int pts_dts_delta;
4086
4087     /**
4088      * Position of the packet in file.
4089      *
4090      * Analogous to cur_frame_pts/dts
4091      */
4092     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4093
4094     /**
4095      * Byte position of currently parsed frame in stream.
4096      */
4097     int64_t pos;
4098
4099     /**
4100      * Previous frame byte position.
4101      */
4102     int64_t last_pos;
4103 } AVCodecParserContext;
4104
4105 typedef struct AVCodecParser {
4106     int codec_ids[5]; /* several codec IDs are permitted */
4107     int priv_data_size;
4108     int (*parser_init)(AVCodecParserContext *s);
4109     int (*parser_parse)(AVCodecParserContext *s,
4110                         AVCodecContext *avctx,
4111                         const uint8_t **poutbuf, int *poutbuf_size,
4112                         const uint8_t *buf, int buf_size);
4113     void (*parser_close)(AVCodecParserContext *s);
4114     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4115     struct AVCodecParser *next;
4116 } AVCodecParser;
4117
4118 AVCodecParser *av_parser_next(AVCodecParser *c);
4119
4120 void av_register_codec_parser(AVCodecParser *parser);
4121 AVCodecParserContext *av_parser_init(int codec_id);
4122
4123 /**
4124  * Parse a packet.
4125  *
4126  * @param s             parser context.
4127  * @param avctx         codec context.
4128  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4129  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4130  * @param buf           input buffer.
4131  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4132  * @param pts           input presentation timestamp.
4133  * @param dts           input decoding timestamp.
4134  * @param pos           input byte position in stream.
4135  * @return the number of bytes of the input bitstream used.
4136  *
4137  * Example:
4138  * @code
4139  *   while(in_len){
4140  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4141  *                                        in_data, in_len,
4142  *                                        pts, dts, pos);
4143  *       in_data += len;
4144  *       in_len  -= len;
4145  *
4146  *       if(size)
4147  *          decode_frame(data, size);
4148  *   }
4149  * @endcode
4150  */
4151 int av_parser_parse2(AVCodecParserContext *s,
4152                      AVCodecContext *avctx,
4153                      uint8_t **poutbuf, int *poutbuf_size,
4154                      const uint8_t *buf, int buf_size,
4155                      int64_t pts, int64_t dts,
4156                      int64_t pos);
4157
4158 int av_parser_change(AVCodecParserContext *s,
4159                      AVCodecContext *avctx,
4160                      uint8_t **poutbuf, int *poutbuf_size,
4161                      const uint8_t *buf, int buf_size, int keyframe);
4162 void av_parser_close(AVCodecParserContext *s);
4163
4164
4165 typedef struct AVBitStreamFilterContext {
4166     void *priv_data;
4167     struct AVBitStreamFilter *filter;
4168     AVCodecParserContext *parser;
4169     struct AVBitStreamFilterContext *next;
4170 } AVBitStreamFilterContext;
4171
4172
4173 typedef struct AVBitStreamFilter {
4174     const char *name;
4175     int priv_data_size;
4176     int (*filter)(AVBitStreamFilterContext *bsfc,
4177                   AVCodecContext *avctx, const char *args,
4178                   uint8_t **poutbuf, int *poutbuf_size,
4179                   const uint8_t *buf, int buf_size, int keyframe);
4180     void (*close)(AVBitStreamFilterContext *bsfc);
4181     struct AVBitStreamFilter *next;
4182 } AVBitStreamFilter;
4183
4184 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4185 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4186 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4187                                AVCodecContext *avctx, const char *args,
4188                                uint8_t **poutbuf, int *poutbuf_size,
4189                                const uint8_t *buf, int buf_size, int keyframe);
4190 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4191
4192 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4193
4194 /* memory */
4195
4196 /**
4197  * Reallocate the given block if it is not large enough, otherwise do nothing.
4198  *
4199  * @see av_realloc
4200  */
4201 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4202
4203 /**
4204  * Allocate a buffer, reusing the given one if large enough.
4205  *
4206  * Contrary to av_fast_realloc the current buffer contents might not be
4207  * preserved and on error the old buffer is freed, thus no special
4208  * handling to avoid memleaks is necessary.
4209  *
4210  * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4211  * @param size size of the buffer *ptr points to
4212  * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4213  *                 *size 0 if an error occurred.
4214  */
4215 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4216
4217 /**
4218  * Copy image src to dst. Wraps av_picture_data_copy() above.
4219  */
4220 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4221                      enum PixelFormat pix_fmt, int width, int height);
4222
4223 /**
4224  * Crop image top and left side.
4225  */
4226 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4227                     enum PixelFormat pix_fmt, int top_band, int left_band);
4228
4229 /**
4230  * Pad image.
4231  */
4232 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4233             int padtop, int padbottom, int padleft, int padright, int *color);
4234
4235 /**
4236  * Encode extradata length to a buffer. Used by xiph codecs.
4237  *
4238  * @param s buffer to write to; must be at least (v/255+1) bytes long
4239  * @param v size of extradata in bytes
4240  * @return number of bytes written to the buffer.
4241  */
4242 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4243
4244 /**
4245  * Logs a generic warning message about a missing feature. This function is
4246  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4247  * only, and would normally not be used by applications.
4248  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4249  * a pointer to an AVClass struct
4250  * @param[in] feature string containing the name of the missing feature
4251  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4252  * If want_sample is non-zero, additional verbage will be added to the log
4253  * message which tells the user how to report samples to the development
4254  * mailing list.
4255  */
4256 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4257
4258 /**
4259  * Log a generic warning message asking for a sample. This function is
4260  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4261  * only, and would normally not be used by applications.
4262  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4263  * a pointer to an AVClass struct
4264  * @param[in] msg string containing an optional message, or NULL if no message
4265  */
4266 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4267
4268 /**
4269  * Register the hardware accelerator hwaccel.
4270  */
4271 void av_register_hwaccel(AVHWAccel *hwaccel);
4272
4273 /**
4274  * If hwaccel is NULL, returns the first registered hardware accelerator,
4275  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4276  * after hwaccel, or NULL if hwaccel is the last one.
4277  */
4278 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4279
4280
4281 /**
4282  * Lock operation used by lockmgr
4283  */
4284 enum AVLockOp {
4285   AV_LOCK_CREATE,  ///< Create a mutex
4286   AV_LOCK_OBTAIN,  ///< Lock the mutex
4287   AV_LOCK_RELEASE, ///< Unlock the mutex
4288   AV_LOCK_DESTROY, ///< Free mutex resources
4289 };
4290
4291 /**
4292  * Register a user provided lock manager supporting the operations
4293  * specified by AVLockOp. mutex points to a (void *) where the
4294  * lockmgr should store/get a pointer to a user allocated mutex. It's
4295  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4296  *
4297  * @param cb User defined callback. Note: Libav may invoke calls to this
4298  *           callback during the call to av_lockmgr_register().
4299  *           Thus, the application must be prepared to handle that.
4300  *           If cb is set to NULL the lockmgr will be unregistered.
4301  *           Also note that during unregistration the previously registered
4302  *           lockmgr callback may also be invoked.
4303  */
4304 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4305
4306 /**
4307  * Get the type of the given codec.
4308  */
4309 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4310
4311 #endif /* AVCODEC_AVCODEC_H */