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