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