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