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