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