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