avcodec: add Interplay ACM decoder
[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 /**
77  * @defgroup lavc_core Core functions/structures.
78  * @ingroup libavc
79  *
80  * Basic definitions, functions for querying libavcodec capabilities,
81  * allocating core structures, etc.
82  * @{
83  */
84
85
86 /**
87  * Identify the syntax and semantics of the bitstream.
88  * The principle is roughly:
89  * Two decoders with the same ID can decode the same streams.
90  * Two encoders with the same ID can encode compatible streams.
91  * There may be slight deviations from the principle due to implementation
92  * details.
93  *
94  * If you add a codec ID to this list, add it so that
95  * 1. no value of a existing codec ID changes (that would break ABI),
96  * 2. it is as close as possible to similar codecs
97  *
98  * After adding new codec IDs, do not forget to add an entry to the codec
99  * descriptor list and bump libavcodec minor version.
100  */
101 enum AVCodecID {
102     AV_CODEC_ID_NONE,
103
104     /* video codecs */
105     AV_CODEC_ID_MPEG1VIDEO,
106     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
107 #if FF_API_XVMC
108     AV_CODEC_ID_MPEG2VIDEO_XVMC,
109 #endif /* FF_API_XVMC */
110     AV_CODEC_ID_H261,
111     AV_CODEC_ID_H263,
112     AV_CODEC_ID_RV10,
113     AV_CODEC_ID_RV20,
114     AV_CODEC_ID_MJPEG,
115     AV_CODEC_ID_MJPEGB,
116     AV_CODEC_ID_LJPEG,
117     AV_CODEC_ID_SP5X,
118     AV_CODEC_ID_JPEGLS,
119     AV_CODEC_ID_MPEG4,
120     AV_CODEC_ID_RAWVIDEO,
121     AV_CODEC_ID_MSMPEG4V1,
122     AV_CODEC_ID_MSMPEG4V2,
123     AV_CODEC_ID_MSMPEG4V3,
124     AV_CODEC_ID_WMV1,
125     AV_CODEC_ID_WMV2,
126     AV_CODEC_ID_H263P,
127     AV_CODEC_ID_H263I,
128     AV_CODEC_ID_FLV1,
129     AV_CODEC_ID_SVQ1,
130     AV_CODEC_ID_SVQ3,
131     AV_CODEC_ID_DVVIDEO,
132     AV_CODEC_ID_HUFFYUV,
133     AV_CODEC_ID_CYUV,
134     AV_CODEC_ID_H264,
135     AV_CODEC_ID_INDEO3,
136     AV_CODEC_ID_VP3,
137     AV_CODEC_ID_THEORA,
138     AV_CODEC_ID_ASV1,
139     AV_CODEC_ID_ASV2,
140     AV_CODEC_ID_FFV1,
141     AV_CODEC_ID_4XM,
142     AV_CODEC_ID_VCR1,
143     AV_CODEC_ID_CLJR,
144     AV_CODEC_ID_MDEC,
145     AV_CODEC_ID_ROQ,
146     AV_CODEC_ID_INTERPLAY_VIDEO,
147     AV_CODEC_ID_XAN_WC3,
148     AV_CODEC_ID_XAN_WC4,
149     AV_CODEC_ID_RPZA,
150     AV_CODEC_ID_CINEPAK,
151     AV_CODEC_ID_WS_VQA,
152     AV_CODEC_ID_MSRLE,
153     AV_CODEC_ID_MSVIDEO1,
154     AV_CODEC_ID_IDCIN,
155     AV_CODEC_ID_8BPS,
156     AV_CODEC_ID_SMC,
157     AV_CODEC_ID_FLIC,
158     AV_CODEC_ID_TRUEMOTION1,
159     AV_CODEC_ID_VMDVIDEO,
160     AV_CODEC_ID_MSZH,
161     AV_CODEC_ID_ZLIB,
162     AV_CODEC_ID_QTRLE,
163     AV_CODEC_ID_TSCC,
164     AV_CODEC_ID_ULTI,
165     AV_CODEC_ID_QDRAW,
166     AV_CODEC_ID_VIXL,
167     AV_CODEC_ID_QPEG,
168     AV_CODEC_ID_PNG,
169     AV_CODEC_ID_PPM,
170     AV_CODEC_ID_PBM,
171     AV_CODEC_ID_PGM,
172     AV_CODEC_ID_PGMYUV,
173     AV_CODEC_ID_PAM,
174     AV_CODEC_ID_FFVHUFF,
175     AV_CODEC_ID_RV30,
176     AV_CODEC_ID_RV40,
177     AV_CODEC_ID_VC1,
178     AV_CODEC_ID_WMV3,
179     AV_CODEC_ID_LOCO,
180     AV_CODEC_ID_WNV1,
181     AV_CODEC_ID_AASC,
182     AV_CODEC_ID_INDEO2,
183     AV_CODEC_ID_FRAPS,
184     AV_CODEC_ID_TRUEMOTION2,
185     AV_CODEC_ID_BMP,
186     AV_CODEC_ID_CSCD,
187     AV_CODEC_ID_MMVIDEO,
188     AV_CODEC_ID_ZMBV,
189     AV_CODEC_ID_AVS,
190     AV_CODEC_ID_SMACKVIDEO,
191     AV_CODEC_ID_NUV,
192     AV_CODEC_ID_KMVC,
193     AV_CODEC_ID_FLASHSV,
194     AV_CODEC_ID_CAVS,
195     AV_CODEC_ID_JPEG2000,
196     AV_CODEC_ID_VMNC,
197     AV_CODEC_ID_VP5,
198     AV_CODEC_ID_VP6,
199     AV_CODEC_ID_VP6F,
200     AV_CODEC_ID_TARGA,
201     AV_CODEC_ID_DSICINVIDEO,
202     AV_CODEC_ID_TIERTEXSEQVIDEO,
203     AV_CODEC_ID_TIFF,
204     AV_CODEC_ID_GIF,
205     AV_CODEC_ID_DXA,
206     AV_CODEC_ID_DNXHD,
207     AV_CODEC_ID_THP,
208     AV_CODEC_ID_SGI,
209     AV_CODEC_ID_C93,
210     AV_CODEC_ID_BETHSOFTVID,
211     AV_CODEC_ID_PTX,
212     AV_CODEC_ID_TXD,
213     AV_CODEC_ID_VP6A,
214     AV_CODEC_ID_AMV,
215     AV_CODEC_ID_VB,
216     AV_CODEC_ID_PCX,
217     AV_CODEC_ID_SUNRAST,
218     AV_CODEC_ID_INDEO4,
219     AV_CODEC_ID_INDEO5,
220     AV_CODEC_ID_MIMIC,
221     AV_CODEC_ID_RL2,
222     AV_CODEC_ID_ESCAPE124,
223     AV_CODEC_ID_DIRAC,
224     AV_CODEC_ID_BFI,
225     AV_CODEC_ID_CMV,
226     AV_CODEC_ID_MOTIONPIXELS,
227     AV_CODEC_ID_TGV,
228     AV_CODEC_ID_TGQ,
229     AV_CODEC_ID_TQI,
230     AV_CODEC_ID_AURA,
231     AV_CODEC_ID_AURA2,
232     AV_CODEC_ID_V210X,
233     AV_CODEC_ID_TMV,
234     AV_CODEC_ID_V210,
235     AV_CODEC_ID_DPX,
236     AV_CODEC_ID_MAD,
237     AV_CODEC_ID_FRWU,
238     AV_CODEC_ID_FLASHSV2,
239     AV_CODEC_ID_CDGRAPHICS,
240     AV_CODEC_ID_R210,
241     AV_CODEC_ID_ANM,
242     AV_CODEC_ID_BINKVIDEO,
243     AV_CODEC_ID_IFF_ILBM,
244 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
245     AV_CODEC_ID_KGV1,
246     AV_CODEC_ID_YOP,
247     AV_CODEC_ID_VP8,
248     AV_CODEC_ID_PICTOR,
249     AV_CODEC_ID_ANSI,
250     AV_CODEC_ID_A64_MULTI,
251     AV_CODEC_ID_A64_MULTI5,
252     AV_CODEC_ID_R10K,
253     AV_CODEC_ID_MXPEG,
254     AV_CODEC_ID_LAGARITH,
255     AV_CODEC_ID_PRORES,
256     AV_CODEC_ID_JV,
257     AV_CODEC_ID_DFA,
258     AV_CODEC_ID_WMV3IMAGE,
259     AV_CODEC_ID_VC1IMAGE,
260     AV_CODEC_ID_UTVIDEO,
261     AV_CODEC_ID_BMV_VIDEO,
262     AV_CODEC_ID_VBLE,
263     AV_CODEC_ID_DXTORY,
264     AV_CODEC_ID_V410,
265     AV_CODEC_ID_XWD,
266     AV_CODEC_ID_CDXL,
267     AV_CODEC_ID_XBM,
268     AV_CODEC_ID_ZEROCODEC,
269     AV_CODEC_ID_MSS1,
270     AV_CODEC_ID_MSA1,
271     AV_CODEC_ID_TSCC2,
272     AV_CODEC_ID_MTS2,
273     AV_CODEC_ID_CLLC,
274     AV_CODEC_ID_MSS2,
275     AV_CODEC_ID_VP9,
276     AV_CODEC_ID_AIC,
277     AV_CODEC_ID_ESCAPE130,
278     AV_CODEC_ID_G2M,
279     AV_CODEC_ID_WEBP,
280     AV_CODEC_ID_HNM4_VIDEO,
281     AV_CODEC_ID_HEVC,
282 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
283     AV_CODEC_ID_FIC,
284     AV_CODEC_ID_ALIAS_PIX,
285     AV_CODEC_ID_BRENDER_PIX,
286     AV_CODEC_ID_PAF_VIDEO,
287     AV_CODEC_ID_EXR,
288     AV_CODEC_ID_VP7,
289     AV_CODEC_ID_SANM,
290     AV_CODEC_ID_SGIRLE,
291     AV_CODEC_ID_MVC1,
292     AV_CODEC_ID_MVC2,
293     AV_CODEC_ID_HQX,
294     AV_CODEC_ID_TDSC,
295     AV_CODEC_ID_HQ_HQA,
296     AV_CODEC_ID_HAP,
297     AV_CODEC_ID_DDS,
298     AV_CODEC_ID_DXV,
299     AV_CODEC_ID_SCREENPRESSO,
300     AV_CODEC_ID_RSCC,
301
302     AV_CODEC_ID_Y41P = 0x8000,
303     AV_CODEC_ID_AVRP,
304     AV_CODEC_ID_012V,
305     AV_CODEC_ID_AVUI,
306     AV_CODEC_ID_AYUV,
307     AV_CODEC_ID_TARGA_Y216,
308     AV_CODEC_ID_V308,
309     AV_CODEC_ID_V408,
310     AV_CODEC_ID_YUV4,
311     AV_CODEC_ID_AVRN,
312     AV_CODEC_ID_CPIA,
313     AV_CODEC_ID_XFACE,
314     AV_CODEC_ID_SNOW,
315     AV_CODEC_ID_SMVJPEG,
316     AV_CODEC_ID_APNG,
317     AV_CODEC_ID_DAALA,
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
501     /* subtitle codecs */
502     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
503     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
504     AV_CODEC_ID_DVB_SUBTITLE,
505     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
506     AV_CODEC_ID_XSUB,
507     AV_CODEC_ID_SSA,
508     AV_CODEC_ID_MOV_TEXT,
509     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
510     AV_CODEC_ID_DVB_TELETEXT,
511     AV_CODEC_ID_SRT,
512
513     AV_CODEC_ID_MICRODVD   = 0x17800,
514     AV_CODEC_ID_EIA_608,
515     AV_CODEC_ID_JACOSUB,
516     AV_CODEC_ID_SAMI,
517     AV_CODEC_ID_REALTEXT,
518     AV_CODEC_ID_STL,
519     AV_CODEC_ID_SUBVIEWER1,
520     AV_CODEC_ID_SUBVIEWER,
521     AV_CODEC_ID_SUBRIP,
522     AV_CODEC_ID_WEBVTT,
523     AV_CODEC_ID_MPL2,
524     AV_CODEC_ID_VPLAYER,
525     AV_CODEC_ID_PJS,
526     AV_CODEC_ID_ASS,
527     AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
528
529     /* other specific kind of codecs (generally used for attachments) */
530     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
531     AV_CODEC_ID_TTF = 0x18000,
532
533     AV_CODEC_ID_BINTEXT    = 0x18800,
534     AV_CODEC_ID_XBIN,
535     AV_CODEC_ID_IDF,
536     AV_CODEC_ID_OTF,
537     AV_CODEC_ID_SMPTE_KLV,
538     AV_CODEC_ID_DVD_NAV,
539     AV_CODEC_ID_TIMED_ID3,
540     AV_CODEC_ID_BIN_DATA,
541
542
543     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
544
545     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
546                                 * stream (only used by libavformat) */
547     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
548                                 * stream (only used by libavformat) */
549     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
550     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
551 };
552
553 /**
554  * This struct describes the properties of a single codec described by an
555  * AVCodecID.
556  * @see avcodec_descriptor_get()
557  */
558 typedef struct AVCodecDescriptor {
559     enum AVCodecID     id;
560     enum AVMediaType type;
561     /**
562      * Name of the codec described by this descriptor. It is non-empty and
563      * unique for each codec descriptor. It should contain alphanumeric
564      * characters and '_' only.
565      */
566     const char      *name;
567     /**
568      * A more descriptive name for this codec. May be NULL.
569      */
570     const char *long_name;
571     /**
572      * Codec properties, a combination of AV_CODEC_PROP_* flags.
573      */
574     int             props;
575
576     /**
577      * MIME type(s) associated with the codec.
578      * May be NULL; if not, a NULL-terminated array of MIME types.
579      * The first item is always non-NULL and is the preferred MIME type.
580      */
581     const char *const *mime_types;
582 } AVCodecDescriptor;
583
584 /**
585  * Codec uses only intra compression.
586  * Video codecs only.
587  */
588 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
589 /**
590  * Codec supports lossy compression. Audio and video codecs only.
591  * @note a codec may support both lossy and lossless
592  * compression modes
593  */
594 #define AV_CODEC_PROP_LOSSY         (1 << 1)
595 /**
596  * Codec supports lossless compression. Audio and video codecs only.
597  */
598 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
599 /**
600  * Codec supports frame reordering. That is, the coded order (the order in which
601  * the encoded packets are output by the encoders / stored / input to the
602  * decoders) may be different from the presentation order of the corresponding
603  * frames.
604  *
605  * For codecs that do not have this property set, PTS and DTS should always be
606  * equal.
607  */
608 #define AV_CODEC_PROP_REORDER       (1 << 3)
609 /**
610  * Subtitle codec is bitmap based
611  * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
612  */
613 #define AV_CODEC_PROP_BITMAP_SUB    (1 << 16)
614 /**
615  * Subtitle codec is text based.
616  * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
617  */
618 #define AV_CODEC_PROP_TEXT_SUB      (1 << 17)
619
620 /**
621  * @ingroup lavc_decoding
622  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
623  * This is mainly needed because some optimized bitstream readers read
624  * 32 or 64 bit at once and could read over the end.<br>
625  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
626  * MPEG bitstreams could cause overread and segfault.
627  */
628 #define AV_INPUT_BUFFER_PADDING_SIZE 32
629
630 /**
631  * @ingroup lavc_encoding
632  * minimum encoding buffer size
633  * Used to avoid some checks during header writing.
634  */
635 #define AV_INPUT_BUFFER_MIN_SIZE 16384
636
637 #if FF_API_WITHOUT_PREFIX
638 /**
639  * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
640  */
641 #define FF_INPUT_BUFFER_PADDING_SIZE 32
642
643 /**
644  * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
645  */
646 #define FF_MIN_BUFFER_SIZE 16384
647 #endif /* FF_API_WITHOUT_PREFIX */
648
649 /**
650  * @ingroup lavc_encoding
651  * motion estimation type.
652  * @deprecated use codec private option instead
653  */
654 #if FF_API_MOTION_EST
655 enum Motion_Est_ID {
656     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
657     ME_FULL,
658     ME_LOG,
659     ME_PHODS,
660     ME_EPZS,        ///< enhanced predictive zonal search
661     ME_X1,          ///< reserved for experiments
662     ME_HEX,         ///< hexagon based search
663     ME_UMH,         ///< uneven multi-hexagon search
664     ME_TESA,        ///< transformed exhaustive search algorithm
665     ME_ITER=50,     ///< iterative search
666 };
667 #endif
668
669 /**
670  * @ingroup lavc_decoding
671  */
672 enum AVDiscard{
673     /* We leave some space between them for extensions (drop some
674      * keyframes for intra-only or drop just some bidir frames). */
675     AVDISCARD_NONE    =-16, ///< discard nothing
676     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
677     AVDISCARD_NONREF  =  8, ///< discard all non reference
678     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
679     AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
680     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
681     AVDISCARD_ALL     = 48, ///< discard all
682 };
683
684 enum AVAudioServiceType {
685     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
686     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
687     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
688     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
689     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
690     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
691     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
692     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
693     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
694     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
695 };
696
697 /**
698  * @ingroup lavc_encoding
699  */
700 typedef struct RcOverride{
701     int start_frame;
702     int end_frame;
703     int qscale; // If this is 0 then quality_factor will be used instead.
704     float quality_factor;
705 } RcOverride;
706
707 #if FF_API_MAX_BFRAMES
708 /**
709  * @deprecated there is no libavcodec-wide limit on the number of B-frames
710  */
711 #define FF_MAX_B_FRAMES 16
712 #endif
713
714 /* encoding support
715    These flags can be passed in AVCodecContext.flags before initialization.
716    Note: Not everything is supported yet.
717 */
718
719 /**
720  * Allow decoders to produce frames with data planes that are not aligned
721  * to CPU requirements (e.g. due to cropping).
722  */
723 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
724 /**
725  * Use fixed qscale.
726  */
727 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
728 /**
729  * 4 MV per MB allowed / advanced prediction for H.263.
730  */
731 #define AV_CODEC_FLAG_4MV             (1 <<  2)
732 /**
733  * Output even those frames that might be corrupted.
734  */
735 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
736 /**
737  * Use qpel MC.
738  */
739 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
740 /**
741  * Use internal 2pass ratecontrol in first pass mode.
742  */
743 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
744 /**
745  * Use internal 2pass ratecontrol in second pass mode.
746  */
747 #define AV_CODEC_FLAG_PASS2           (1 << 10)
748 /**
749  * loop filter.
750  */
751 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
752 /**
753  * Only decode/encode grayscale.
754  */
755 #define AV_CODEC_FLAG_GRAY            (1 << 13)
756 /**
757  * error[?] variables will be set during encoding.
758  */
759 #define AV_CODEC_FLAG_PSNR            (1 << 15)
760 /**
761  * Input bitstream might be truncated at a random location
762  * instead of only at frame boundaries.
763  */
764 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
765 /**
766  * Use interlaced DCT.
767  */
768 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
769 /**
770  * Force low delay.
771  */
772 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
773 /**
774  * Place global headers in extradata instead of every keyframe.
775  */
776 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
777 /**
778  * Use only bitexact stuff (except (I)DCT).
779  */
780 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
781 /* Fx : Flag for h263+ extra options */
782 /**
783  * H.263 advanced intra coding / MPEG-4 AC prediction
784  */
785 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
786 /**
787  * interlaced motion estimation
788  */
789 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
790 /**
791  * Allow non spec compliant speedup tricks.
792  */
793 #define AV_CODEC_FLAG_CLOSED_GOP      (1U << 31)
794
795 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
796 /**
797  * Skip bitstream encoding.
798  */
799 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
800 /**
801  * Place global headers at every keyframe instead of in extradata.
802  */
803 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
804
805 /**
806  * timecode is in drop frame format. DEPRECATED!!!!
807  */
808 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
809
810 /**
811  * Input bitstream might be truncated at a packet boundaries
812  * instead of only at frame boundaries.
813  */
814 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
815 /**
816  * Discard cropping information from SPS.
817  */
818 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
819
820 /**
821  * Show all frames before the first keyframe
822  */
823 #define AV_CODEC_FLAG2_SHOW_ALL       (1 << 22)
824 /**
825  * Export motion vectors through frame side data
826  */
827 #define AV_CODEC_FLAG2_EXPORT_MVS     (1 << 28)
828 /**
829  * Do not skip samples and export skip information as frame side data
830  */
831 #define AV_CODEC_FLAG2_SKIP_MANUAL    (1 << 29)
832
833 /* Unsupported options :
834  *              Syntax Arithmetic coding (SAC)
835  *              Reference Picture Selection
836  *              Independent Segment Decoding */
837 /* /Fx */
838 /* codec capabilities */
839
840 /**
841  * Decoder can use draw_horiz_band callback.
842  */
843 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
844 /**
845  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
846  * If not set, it might not use get_buffer() at all or use operations that
847  * assume the buffer was allocated by avcodec_default_get_buffer.
848  */
849 #define AV_CODEC_CAP_DR1                 (1 <<  1)
850 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
851 /**
852  * Encoder or decoder requires flushing with NULL input at the end in order to
853  * give the complete and correct output.
854  *
855  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
856  *       with NULL data. The user can still send NULL data to the public encode
857  *       or decode function, but libavcodec will not pass it along to the codec
858  *       unless this flag is set.
859  *
860  * Decoders:
861  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
862  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
863  * returns frames.
864  *
865  * Encoders:
866  * The encoder needs to be fed with NULL data at the end of encoding until the
867  * encoder no longer returns data.
868  *
869  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
870  *       flag also means that the encoder must set the pts and duration for
871  *       each output packet. If this flag is not set, the pts and duration will
872  *       be determined by libavcodec from the input frame.
873  */
874 #define AV_CODEC_CAP_DELAY               (1 <<  5)
875 /**
876  * Codec can be fed a final frame with a smaller size.
877  * This can be used to prevent truncation of the last audio samples.
878  */
879 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
880
881 #if FF_API_CAP_VDPAU
882 /**
883  * Codec can export data for HW decoding (VDPAU).
884  */
885 #define AV_CODEC_CAP_HWACCEL_VDPAU       (1 <<  7)
886 #endif
887
888 /**
889  * Codec can output multiple frames per AVPacket
890  * Normally demuxers return one frame at a time, demuxers which do not do
891  * are connected to a parser to split what they return into proper frames.
892  * This flag is reserved to the very rare category of codecs which have a
893  * bitstream that cannot be split into frames without timeconsuming
894  * operations like full decoding. Demuxers carring such bitstreams thus
895  * may return multiple frames in a packet. This has many disadvantages like
896  * prohibiting stream copy in many cases thus it should only be considered
897  * as a last resort.
898  */
899 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
900 /**
901  * Codec is experimental and is thus avoided in favor of non experimental
902  * encoders
903  */
904 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
905 /**
906  * Codec should fill in channel configuration and samplerate instead of container
907  */
908 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
909 /**
910  * Codec supports frame-level multithreading.
911  */
912 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
913 /**
914  * Codec supports slice-based (or partition-based) multithreading.
915  */
916 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
917 /**
918  * Codec supports changed parameters at any point.
919  */
920 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
921 /**
922  * Codec supports avctx->thread_count == 0 (auto).
923  */
924 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
925 /**
926  * Audio encoder supports receiving a different number of samples in each call.
927  */
928 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
929 /**
930  * Codec is intra only.
931  */
932 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
933 /**
934  * Codec is lossless.
935  */
936 #define AV_CODEC_CAP_LOSSLESS         0x80000000
937
938
939 #if FF_API_WITHOUT_PREFIX
940 /**
941  * Allow decoders to produce frames with data planes that are not aligned
942  * to CPU requirements (e.g. due to cropping).
943  */
944 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
945 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
946 #define CODEC_FLAG_4MV    AV_CODEC_FLAG_4MV
947 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
948 #define CODEC_FLAG_QPEL   AV_CODEC_FLAG_QPEL
949 #if FF_API_GMC
950 /**
951  * @deprecated use the "gmc" private option of the libxvid encoder
952  */
953 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
954 #endif
955 #if FF_API_MV0
956 /**
957  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
958  * mpegvideo encoders
959  */
960 #define CODEC_FLAG_MV0    0x0040
961 #endif
962 #if FF_API_INPUT_PRESERVED
963 /**
964  * @deprecated passing reference-counted frames to the encoders replaces this
965  * flag
966  */
967 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
968 #endif
969 #define CODEC_FLAG_PASS1           AV_CODEC_FLAG_PASS1
970 #define CODEC_FLAG_PASS2           AV_CODEC_FLAG_PASS2
971 #define CODEC_FLAG_GRAY            AV_CODEC_FLAG_GRAY
972 #if FF_API_EMU_EDGE
973 /**
974  * @deprecated edges are not used/required anymore. I.e. this flag is now always
975  * set.
976  */
977 #define CODEC_FLAG_EMU_EDGE        0x4000
978 #endif
979 #define CODEC_FLAG_PSNR            AV_CODEC_FLAG_PSNR
980 #define CODEC_FLAG_TRUNCATED       AV_CODEC_FLAG_TRUNCATED
981
982 #if FF_API_NORMALIZE_AQP
983 /**
984  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
985  * mpegvideo encoders
986  */
987 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
988 #endif
989 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
990 #define CODEC_FLAG_LOW_DELAY      AV_CODEC_FLAG_LOW_DELAY
991 #define CODEC_FLAG_GLOBAL_HEADER  AV_CODEC_FLAG_GLOBAL_HEADER
992 #define CODEC_FLAG_BITEXACT       AV_CODEC_FLAG_BITEXACT
993 #define CODEC_FLAG_AC_PRED        AV_CODEC_FLAG_AC_PRED
994 #define CODEC_FLAG_LOOP_FILTER    AV_CODEC_FLAG_LOOP_FILTER
995 #define CODEC_FLAG_INTERLACED_ME  AV_CODEC_FLAG_INTERLACED_ME
996 #define CODEC_FLAG_CLOSED_GOP     AV_CODEC_FLAG_CLOSED_GOP
997 #define CODEC_FLAG2_FAST          AV_CODEC_FLAG2_FAST
998 #define CODEC_FLAG2_NO_OUTPUT     AV_CODEC_FLAG2_NO_OUTPUT
999 #define CODEC_FLAG2_LOCAL_HEADER  AV_CODEC_FLAG2_LOCAL_HEADER
1000 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1001 #define CODEC_FLAG2_IGNORE_CROP   AV_CODEC_FLAG2_IGNORE_CROP
1002
1003 #define CODEC_FLAG2_CHUNKS        AV_CODEC_FLAG2_CHUNKS
1004 #define CODEC_FLAG2_SHOW_ALL      AV_CODEC_FLAG2_SHOW_ALL
1005 #define CODEC_FLAG2_EXPORT_MVS    AV_CODEC_FLAG2_EXPORT_MVS
1006 #define CODEC_FLAG2_SKIP_MANUAL   AV_CODEC_FLAG2_SKIP_MANUAL
1007
1008 /* Unsupported options :
1009  *              Syntax Arithmetic coding (SAC)
1010  *              Reference Picture Selection
1011  *              Independent Segment Decoding */
1012 /* /Fx */
1013 /* codec capabilities */
1014
1015 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1016 /**
1017  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1018  * If not set, it might not use get_buffer() at all or use operations that
1019  * assume the buffer was allocated by avcodec_default_get_buffer.
1020  */
1021 #define CODEC_CAP_DR1             AV_CODEC_CAP_DR1
1022 #define CODEC_CAP_TRUNCATED       AV_CODEC_CAP_TRUNCATED
1023 #if FF_API_XVMC
1024 /* Codec can export data for HW decoding. This flag indicates that
1025  * the codec would call get_format() with list that might contain HW accelerated
1026  * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1027  * including raw image format.
1028  * The application can use the passed context to determine bitstream version,
1029  * chroma format, resolution etc.
1030  */
1031 #define CODEC_CAP_HWACCEL         0x0010
1032 #endif /* FF_API_XVMC */
1033 /**
1034  * Encoder or decoder requires flushing with NULL input at the end in order to
1035  * give the complete and correct output.
1036  *
1037  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1038  *       with NULL data. The user can still send NULL data to the public encode
1039  *       or decode function, but libavcodec will not pass it along to the codec
1040  *       unless this flag is set.
1041  *
1042  * Decoders:
1043  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1044  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1045  * returns frames.
1046  *
1047  * Encoders:
1048  * The encoder needs to be fed with NULL data at the end of encoding until the
1049  * encoder no longer returns data.
1050  *
1051  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1052  *       flag also means that the encoder must set the pts and duration for
1053  *       each output packet. If this flag is not set, the pts and duration will
1054  *       be determined by libavcodec from the input frame.
1055  */
1056 #define CODEC_CAP_DELAY           AV_CODEC_CAP_DELAY
1057 /**
1058  * Codec can be fed a final frame with a smaller size.
1059  * This can be used to prevent truncation of the last audio samples.
1060  */
1061 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1062 #if FF_API_CAP_VDPAU
1063 /**
1064  * Codec can export data for HW decoding (VDPAU).
1065  */
1066 #define CODEC_CAP_HWACCEL_VDPAU    AV_CODEC_CAP_HWACCEL_VDPAU
1067 #endif
1068 /**
1069  * Codec can output multiple frames per AVPacket
1070  * Normally demuxers return one frame at a time, demuxers which do not do
1071  * are connected to a parser to split what they return into proper frames.
1072  * This flag is reserved to the very rare category of codecs which have a
1073  * bitstream that cannot be split into frames without timeconsuming
1074  * operations like full decoding. Demuxers carring such bitstreams thus
1075  * may return multiple frames in a packet. This has many disadvantages like
1076  * prohibiting stream copy in many cases thus it should only be considered
1077  * as a last resort.
1078  */
1079 #define CODEC_CAP_SUBFRAMES        AV_CODEC_CAP_SUBFRAMES
1080 /**
1081  * Codec is experimental and is thus avoided in favor of non experimental
1082  * encoders
1083  */
1084 #define CODEC_CAP_EXPERIMENTAL     AV_CODEC_CAP_EXPERIMENTAL
1085 /**
1086  * Codec should fill in channel configuration and samplerate instead of container
1087  */
1088 #define CODEC_CAP_CHANNEL_CONF     AV_CODEC_CAP_CHANNEL_CONF
1089 #if FF_API_NEG_LINESIZES
1090 /**
1091  * @deprecated no codecs use this capability
1092  */
1093 #define CODEC_CAP_NEG_LINESIZES    0x0800
1094 #endif
1095 /**
1096  * Codec supports frame-level multithreading.
1097  */
1098 #define CODEC_CAP_FRAME_THREADS    AV_CODEC_CAP_FRAME_THREADS
1099 /**
1100  * Codec supports slice-based (or partition-based) multithreading.
1101  */
1102 #define CODEC_CAP_SLICE_THREADS    AV_CODEC_CAP_SLICE_THREADS
1103 /**
1104  * Codec supports changed parameters at any point.
1105  */
1106 #define CODEC_CAP_PARAM_CHANGE     AV_CODEC_CAP_PARAM_CHANGE
1107 /**
1108  * Codec supports avctx->thread_count == 0 (auto).
1109  */
1110 #define CODEC_CAP_AUTO_THREADS     AV_CODEC_CAP_AUTO_THREADS
1111 /**
1112  * Audio encoder supports receiving a different number of samples in each call.
1113  */
1114 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1115 /**
1116  * Codec is intra only.
1117  */
1118 #define CODEC_CAP_INTRA_ONLY       AV_CODEC_CAP_INTRA_ONLY
1119 /**
1120  * Codec is lossless.
1121  */
1122 #define CODEC_CAP_LOSSLESS         AV_CODEC_CAP_LOSSLESS
1123
1124 /**
1125  * HWAccel is experimental and is thus avoided in favor of non experimental
1126  * codecs
1127  */
1128 #define HWACCEL_CODEC_CAP_EXPERIMENTAL     0x0200
1129 #endif /* FF_API_WITHOUT_PREFIX */
1130
1131 #if FF_API_MB_TYPE
1132 //The following defines may change, don't expect compatibility if you use them.
1133 #define MB_TYPE_INTRA4x4   0x0001
1134 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1135 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
1136 #define MB_TYPE_16x16      0x0008
1137 #define MB_TYPE_16x8       0x0010
1138 #define MB_TYPE_8x16       0x0020
1139 #define MB_TYPE_8x8        0x0040
1140 #define MB_TYPE_INTERLACED 0x0080
1141 #define MB_TYPE_DIRECT2    0x0100 //FIXME
1142 #define MB_TYPE_ACPRED     0x0200
1143 #define MB_TYPE_GMC        0x0400
1144 #define MB_TYPE_SKIP       0x0800
1145 #define MB_TYPE_P0L0       0x1000
1146 #define MB_TYPE_P1L0       0x2000
1147 #define MB_TYPE_P0L1       0x4000
1148 #define MB_TYPE_P1L1       0x8000
1149 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1150 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1151 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
1152 #define MB_TYPE_QUANT      0x00010000
1153 #define MB_TYPE_CBP        0x00020000
1154 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1155 #endif
1156
1157 /**
1158  * Pan Scan area.
1159  * This specifies the area which should be displayed.
1160  * Note there may be multiple such areas for one frame.
1161  */
1162 typedef struct AVPanScan{
1163     /**
1164      * id
1165      * - encoding: Set by user.
1166      * - decoding: Set by libavcodec.
1167      */
1168     int id;
1169
1170     /**
1171      * width and height in 1/16 pel
1172      * - encoding: Set by user.
1173      * - decoding: Set by libavcodec.
1174      */
1175     int width;
1176     int height;
1177
1178     /**
1179      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1180      * - encoding: Set by user.
1181      * - decoding: Set by libavcodec.
1182      */
1183     int16_t position[3][2];
1184 }AVPanScan;
1185
1186 #if FF_API_QSCALE_TYPE
1187 #define FF_QSCALE_TYPE_MPEG1 0
1188 #define FF_QSCALE_TYPE_MPEG2 1
1189 #define FF_QSCALE_TYPE_H264  2
1190 #define FF_QSCALE_TYPE_VP56  3
1191 #endif
1192
1193 /**
1194  * The decoder will keep a reference to the frame and may reuse it later.
1195  */
1196 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1197
1198 /**
1199  * @defgroup lavc_packet AVPacket
1200  *
1201  * Types and functions for working with AVPacket.
1202  * @{
1203  */
1204 enum AVPacketSideDataType {
1205     AV_PKT_DATA_PALETTE,
1206     AV_PKT_DATA_NEW_EXTRADATA,
1207
1208     /**
1209      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1210      * @code
1211      * u32le param_flags
1212      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1213      *     s32le channel_count
1214      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1215      *     u64le channel_layout
1216      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1217      *     s32le sample_rate
1218      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1219      *     s32le width
1220      *     s32le height
1221      * @endcode
1222      */
1223     AV_PKT_DATA_PARAM_CHANGE,
1224
1225     /**
1226      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1227      * structures with info about macroblocks relevant to splitting the
1228      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1229      * That is, it does not necessarily contain info about all macroblocks,
1230      * as long as the distance between macroblocks in the info is smaller
1231      * than the target payload size.
1232      * Each MB info structure is 12 bytes, and is laid out as follows:
1233      * @code
1234      * u32le bit offset from the start of the packet
1235      * u8    current quantizer at the start of the macroblock
1236      * u8    GOB number
1237      * u16le macroblock address within the GOB
1238      * u8    horizontal MV predictor
1239      * u8    vertical MV predictor
1240      * u8    horizontal MV predictor for block number 3
1241      * u8    vertical MV predictor for block number 3
1242      * @endcode
1243      */
1244     AV_PKT_DATA_H263_MB_INFO,
1245
1246     /**
1247      * This side data should be associated with an audio stream and contains
1248      * ReplayGain information in form of the AVReplayGain struct.
1249      */
1250     AV_PKT_DATA_REPLAYGAIN,
1251
1252     /**
1253      * This side data contains a 3x3 transformation matrix describing an affine
1254      * transformation that needs to be applied to the decoded video frames for
1255      * correct presentation.
1256      *
1257      * See libavutil/display.h for a detailed description of the data.
1258      */
1259     AV_PKT_DATA_DISPLAYMATRIX,
1260
1261     /**
1262      * This side data should be associated with a video stream and contains
1263      * Stereoscopic 3D information in form of the AVStereo3D struct.
1264      */
1265     AV_PKT_DATA_STEREO3D,
1266
1267     /**
1268      * This side data should be associated with an audio stream and corresponds
1269      * to enum AVAudioServiceType.
1270      */
1271     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1272
1273     /**
1274      * This side data contains quality related information from the encoder.
1275      * @code
1276      * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1277      * u8    picture type
1278      * u8    error count
1279      * u16   reserved
1280      * u64le[error count] sum of squared differences between encoder in and output
1281      * @endcode
1282      */
1283     AV_PKT_DATA_QUALITY_STATS,
1284
1285     /**
1286      * Recommmends skipping the specified number of samples
1287      * @code
1288      * u32le number of samples to skip from start of this packet
1289      * u32le number of samples to skip from end of this packet
1290      * u8    reason for start skip
1291      * u8    reason for end   skip (0=padding silence, 1=convergence)
1292      * @endcode
1293      */
1294     AV_PKT_DATA_SKIP_SAMPLES=70,
1295
1296     /**
1297      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1298      * the packet may contain "dual mono" audio specific to Japanese DTV
1299      * and if it is true, recommends only the selected channel to be used.
1300      * @code
1301      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
1302      * @endcode
1303      */
1304     AV_PKT_DATA_JP_DUALMONO,
1305
1306     /**
1307      * A list of zero terminated key/value strings. There is no end marker for
1308      * the list, so it is required to rely on the side data size to stop.
1309      */
1310     AV_PKT_DATA_STRINGS_METADATA,
1311
1312     /**
1313      * Subtitle event position
1314      * @code
1315      * u32le x1
1316      * u32le y1
1317      * u32le x2
1318      * u32le y2
1319      * @endcode
1320      */
1321     AV_PKT_DATA_SUBTITLE_POSITION,
1322
1323     /**
1324      * Data found in BlockAdditional element of matroska container. There is
1325      * no end marker for the data, so it is required to rely on the side data
1326      * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1327      * by data.
1328      */
1329     AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1330
1331     /**
1332      * The optional first identifier line of a WebVTT cue.
1333      */
1334     AV_PKT_DATA_WEBVTT_IDENTIFIER,
1335
1336     /**
1337      * The optional settings (rendering instructions) that immediately
1338      * follow the timestamp specifier of a WebVTT cue.
1339      */
1340     AV_PKT_DATA_WEBVTT_SETTINGS,
1341
1342     /**
1343      * A list of zero terminated key/value strings. There is no end marker for
1344      * the list, so it is required to rely on the side data size to stop. This
1345      * side data includes updated metadata which appeared in the stream.
1346      */
1347     AV_PKT_DATA_METADATA_UPDATE,
1348 };
1349
1350 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1351
1352 typedef struct AVPacketSideData {
1353     uint8_t *data;
1354     int      size;
1355     enum AVPacketSideDataType type;
1356 } AVPacketSideData;
1357
1358 /**
1359  * This structure stores compressed data. It is typically exported by demuxers
1360  * and then passed as input to decoders, or received as output from encoders and
1361  * then passed to muxers.
1362  *
1363  * For video, it should typically contain one compressed frame. For audio it may
1364  * contain several compressed frames. Encoders are allowed to output empty
1365  * packets, with no compressed data, containing only side data
1366  * (e.g. to update some stream parameters at the end of encoding).
1367  *
1368  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1369  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1370  * without libavcodec and libavformat major bump.
1371  *
1372  * The semantics of data ownership depends on the buf field.
1373  * If it is set, the packet data is dynamically allocated and is
1374  * valid indefinitely until a call to av_packet_unref() reduces the
1375  * reference count to 0.
1376  *
1377  * If the buf field is not set av_packet_ref() would make a copy instead
1378  * of increasing the reference count.
1379  *
1380  * The side data is always allocated with av_malloc(), copied by
1381  * av_packet_ref() and freed by av_packet_unref().
1382  *
1383  * @see av_packet_ref
1384  * @see av_packet_unref
1385  */
1386 typedef struct AVPacket {
1387     /**
1388      * A reference to the reference-counted buffer where the packet data is
1389      * stored.
1390      * May be NULL, then the packet data is not reference-counted.
1391      */
1392     AVBufferRef *buf;
1393     /**
1394      * Presentation timestamp in AVStream->time_base units; the time at which
1395      * the decompressed packet will be presented to the user.
1396      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1397      * pts MUST be larger or equal to dts as presentation cannot happen before
1398      * decompression, unless one wants to view hex dumps. Some formats misuse
1399      * the terms dts and pts/cts to mean something different. Such timestamps
1400      * must be converted to true pts/dts before they are stored in AVPacket.
1401      */
1402     int64_t pts;
1403     /**
1404      * Decompression timestamp in AVStream->time_base units; the time at which
1405      * the packet is decompressed.
1406      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1407      */
1408     int64_t dts;
1409     uint8_t *data;
1410     int   size;
1411     int   stream_index;
1412     /**
1413      * A combination of AV_PKT_FLAG values
1414      */
1415     int   flags;
1416     /**
1417      * Additional packet data that can be provided by the container.
1418      * Packet can contain several types of side information.
1419      */
1420     AVPacketSideData *side_data;
1421     int side_data_elems;
1422
1423     /**
1424      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1425      * Equals next_pts - this_pts in presentation order.
1426      */
1427     int64_t duration;
1428
1429     int64_t pos;                            ///< byte position in stream, -1 if unknown
1430
1431 #if FF_API_CONVERGENCE_DURATION
1432     /**
1433      * @deprecated Same as the duration field, but as int64_t. This was required
1434      * for Matroska subtitles, whose duration values could overflow when the
1435      * duration field was still an int.
1436      */
1437     attribute_deprecated
1438     int64_t convergence_duration;
1439 #endif
1440 } AVPacket;
1441 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1442 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1443
1444 enum AVSideDataParamChangeFlags {
1445     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1446     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1447     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1448     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1449 };
1450 /**
1451  * @}
1452  */
1453
1454 struct AVCodecInternal;
1455
1456 enum AVFieldOrder {
1457     AV_FIELD_UNKNOWN,
1458     AV_FIELD_PROGRESSIVE,
1459     AV_FIELD_TT,          //< Top coded_first, top displayed first
1460     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1461     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1462     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1463 };
1464
1465 /**
1466  * main external API structure.
1467  * New fields can be added to the end with minor version bumps.
1468  * Removal, reordering and changes to existing fields require a major
1469  * version bump.
1470  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1471  * applications.
1472  * sizeof(AVCodecContext) must not be used outside libav*.
1473  */
1474 typedef struct AVCodecContext {
1475     /**
1476      * information on struct for av_log
1477      * - set by avcodec_alloc_context3
1478      */
1479     const AVClass *av_class;
1480     int log_level_offset;
1481
1482     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1483     const struct AVCodec  *codec;
1484 #if FF_API_CODEC_NAME
1485     /**
1486      * @deprecated this field is not used for anything in libavcodec
1487      */
1488     attribute_deprecated
1489     char             codec_name[32];
1490 #endif
1491     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1492
1493     /**
1494      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1495      * This is used to work around some encoder bugs.
1496      * A demuxer should set this to what is stored in the field used to identify the codec.
1497      * If there are multiple such fields in a container then the demuxer should choose the one
1498      * which maximizes the information about the used codec.
1499      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1500      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1501      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1502      * first.
1503      * - encoding: Set by user, if not then the default based on codec_id will be used.
1504      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1505      */
1506     unsigned int codec_tag;
1507
1508 #if FF_API_STREAM_CODEC_TAG
1509     /**
1510      * @deprecated this field is unused
1511      */
1512     attribute_deprecated
1513     unsigned int stream_codec_tag;
1514 #endif
1515
1516     void *priv_data;
1517
1518     /**
1519      * Private context used for internal data.
1520      *
1521      * Unlike priv_data, this is not codec-specific. It is used in general
1522      * libavcodec functions.
1523      */
1524     struct AVCodecInternal *internal;
1525
1526     /**
1527      * Private data of the user, can be used to carry app specific stuff.
1528      * - encoding: Set by user.
1529      * - decoding: Set by user.
1530      */
1531     void *opaque;
1532
1533     /**
1534      * the average bitrate
1535      * - encoding: Set by user; unused for constant quantizer encoding.
1536      * - decoding: Set by user, may be overwritten by libavcodec
1537      *             if this info is available in the stream
1538      */
1539     int64_t bit_rate;
1540
1541     /**
1542      * number of bits the bitstream is allowed to diverge from the reference.
1543      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1544      * - encoding: Set by user; unused for constant quantizer encoding.
1545      * - decoding: unused
1546      */
1547     int bit_rate_tolerance;
1548
1549     /**
1550      * Global quality for codecs which cannot change it per frame.
1551      * This should be proportional to MPEG-1/2/4 qscale.
1552      * - encoding: Set by user.
1553      * - decoding: unused
1554      */
1555     int global_quality;
1556
1557     /**
1558      * - encoding: Set by user.
1559      * - decoding: unused
1560      */
1561     int compression_level;
1562 #define FF_COMPRESSION_DEFAULT -1
1563
1564     /**
1565      * AV_CODEC_FLAG_*.
1566      * - encoding: Set by user.
1567      * - decoding: Set by user.
1568      */
1569     int flags;
1570
1571     /**
1572      * AV_CODEC_FLAG2_*
1573      * - encoding: Set by user.
1574      * - decoding: Set by user.
1575      */
1576     int flags2;
1577
1578     /**
1579      * some codecs need / can use extradata like Huffman tables.
1580      * mjpeg: Huffman tables
1581      * rv10: additional flags
1582      * mpeg4: global headers (they can be in the bitstream or here)
1583      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1584      * than extradata_size to avoid problems if it is read with the bitstream reader.
1585      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1586      * - encoding: Set/allocated/freed by libavcodec.
1587      * - decoding: Set/allocated/freed by user.
1588      */
1589     uint8_t *extradata;
1590     int extradata_size;
1591
1592     /**
1593      * This is the fundamental unit of time (in seconds) in terms
1594      * of which frame timestamps are represented. For fixed-fps content,
1595      * timebase should be 1/framerate and timestamp increments should be
1596      * identically 1.
1597      * This often, but not always is the inverse of the frame rate or field rate
1598      * for video.
1599      * - encoding: MUST be set by user.
1600      * - decoding: the use of this field for decoding is deprecated.
1601      *             Use framerate instead.
1602      */
1603     AVRational time_base;
1604
1605     /**
1606      * For some codecs, the time base is closer to the field rate than the frame rate.
1607      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1608      * if no telecine is used ...
1609      *
1610      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1611      */
1612     int ticks_per_frame;
1613
1614     /**
1615      * Codec delay.
1616      *
1617      * Encoding: Number of frames delay there will be from the encoder input to
1618      *           the decoder output. (we assume the decoder matches the spec)
1619      * Decoding: Number of frames delay in addition to what a standard decoder
1620      *           as specified in the spec would produce.
1621      *
1622      * Video:
1623      *   Number of frames the decoded output will be delayed relative to the
1624      *   encoded input.
1625      *
1626      * Audio:
1627      *   For encoding, this field is unused (see initial_padding).
1628      *
1629      *   For decoding, this is the number of samples the decoder needs to
1630      *   output before the decoder's output is valid. When seeking, you should
1631      *   start decoding this many samples prior to your desired seek point.
1632      *
1633      * - encoding: Set by libavcodec.
1634      * - decoding: Set by libavcodec.
1635      */
1636     int delay;
1637
1638
1639     /* video only */
1640     /**
1641      * picture width / height.
1642      *
1643      * @note Those fields may not match the values of the last
1644      * AVFrame outputted by avcodec_decode_video2 due frame
1645      * reordering.
1646      *
1647      * - encoding: MUST be set by user.
1648      * - decoding: May be set by the user before opening the decoder if known e.g.
1649      *             from the container. Some decoders will require the dimensions
1650      *             to be set by the caller. During decoding, the decoder may
1651      *             overwrite those values as required while parsing the data.
1652      */
1653     int width, height;
1654
1655     /**
1656      * Bitstream width / height, may be different from width/height e.g. when
1657      * the decoded frame is cropped before being output or lowres is enabled.
1658      *
1659      * @note Those field may not match the value of the last
1660      * AVFrame outputted by avcodec_decode_video2 due frame
1661      * reordering.
1662      *
1663      * - encoding: unused
1664      * - decoding: May be set by the user before opening the decoder if known
1665      *             e.g. from the container. During decoding, the decoder may
1666      *             overwrite those values as required while parsing the data.
1667      */
1668     int coded_width, coded_height;
1669
1670 #if FF_API_ASPECT_EXTENDED
1671 #define FF_ASPECT_EXTENDED 15
1672 #endif
1673
1674     /**
1675      * the number of pictures in a group of pictures, or 0 for intra_only
1676      * - encoding: Set by user.
1677      * - decoding: unused
1678      */
1679     int gop_size;
1680
1681     /**
1682      * Pixel format, see AV_PIX_FMT_xxx.
1683      * May be set by the demuxer if known from headers.
1684      * May be overridden by the decoder if it knows better.
1685      *
1686      * @note This field may not match the value of the last
1687      * AVFrame outputted by avcodec_decode_video2 due frame
1688      * reordering.
1689      *
1690      * - encoding: Set by user.
1691      * - decoding: Set by user if known, overridden by libavcodec while
1692      *             parsing the data.
1693      */
1694     enum AVPixelFormat pix_fmt;
1695
1696 #if FF_API_MOTION_EST
1697     /**
1698      * This option does nothing
1699      * @deprecated use codec private options instead
1700      */
1701     attribute_deprecated int me_method;
1702 #endif
1703
1704     /**
1705      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1706      * decoder to draw a horizontal band. It improves cache usage. Not
1707      * all codecs can do that. You must check the codec capabilities
1708      * beforehand.
1709      * When multithreading is used, it may be called from multiple threads
1710      * at the same time; threads might draw different parts of the same AVFrame,
1711      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1712      * in order.
1713      * The function is also used by hardware acceleration APIs.
1714      * It is called at least once during frame decoding to pass
1715      * the data needed for hardware render.
1716      * In that mode instead of pixel data, AVFrame points to
1717      * a structure specific to the acceleration API. The application
1718      * reads the structure and can change some fields to indicate progress
1719      * or mark state.
1720      * - encoding: unused
1721      * - decoding: Set by user.
1722      * @param height the height of the slice
1723      * @param y the y position of the slice
1724      * @param type 1->top field, 2->bottom field, 3->frame
1725      * @param offset offset into the AVFrame.data from which the slice should be read
1726      */
1727     void (*draw_horiz_band)(struct AVCodecContext *s,
1728                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1729                             int y, int type, int height);
1730
1731     /**
1732      * callback to negotiate the pixelFormat
1733      * @param fmt is the list of formats which are supported by the codec,
1734      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1735      * The first is always the native one.
1736      * @note The callback may be called again immediately if initialization for
1737      * the selected (hardware-accelerated) pixel format failed.
1738      * @warning Behavior is undefined if the callback returns a value not
1739      * in the fmt list of formats.
1740      * @return the chosen format
1741      * - encoding: unused
1742      * - decoding: Set by user, if not set the native format will be chosen.
1743      */
1744     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1745
1746     /**
1747      * maximum number of B-frames between non-B-frames
1748      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1749      * - encoding: Set by user.
1750      * - decoding: unused
1751      */
1752     int max_b_frames;
1753
1754     /**
1755      * qscale factor between IP and B-frames
1756      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1757      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1758      * - encoding: Set by user.
1759      * - decoding: unused
1760      */
1761     float b_quant_factor;
1762
1763 #if FF_API_RC_STRATEGY
1764     /** @deprecated use codec private option instead */
1765     attribute_deprecated int rc_strategy;
1766 #define FF_RC_STRATEGY_XVID 1
1767 #endif
1768
1769     int b_frame_strategy;
1770
1771     /**
1772      * qscale offset between IP and B-frames
1773      * - encoding: Set by user.
1774      * - decoding: unused
1775      */
1776     float b_quant_offset;
1777
1778     /**
1779      * Size of the frame reordering buffer in the decoder.
1780      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1781      * - encoding: Set by libavcodec.
1782      * - decoding: Set by libavcodec.
1783      */
1784     int has_b_frames;
1785
1786     /**
1787      * 0-> h263 quant 1-> mpeg quant
1788      * - encoding: Set by user.
1789      * - decoding: unused
1790      */
1791     int mpeg_quant;
1792
1793     /**
1794      * qscale factor between P and I-frames
1795      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1796      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1797      * - encoding: Set by user.
1798      * - decoding: unused
1799      */
1800     float i_quant_factor;
1801
1802     /**
1803      * qscale offset between P and I-frames
1804      * - encoding: Set by user.
1805      * - decoding: unused
1806      */
1807     float i_quant_offset;
1808
1809     /**
1810      * luminance masking (0-> disabled)
1811      * - encoding: Set by user.
1812      * - decoding: unused
1813      */
1814     float lumi_masking;
1815
1816     /**
1817      * temporary complexity masking (0-> disabled)
1818      * - encoding: Set by user.
1819      * - decoding: unused
1820      */
1821     float temporal_cplx_masking;
1822
1823     /**
1824      * spatial complexity masking (0-> disabled)
1825      * - encoding: Set by user.
1826      * - decoding: unused
1827      */
1828     float spatial_cplx_masking;
1829
1830     /**
1831      * p block masking (0-> disabled)
1832      * - encoding: Set by user.
1833      * - decoding: unused
1834      */
1835     float p_masking;
1836
1837     /**
1838      * darkness masking (0-> disabled)
1839      * - encoding: Set by user.
1840      * - decoding: unused
1841      */
1842     float dark_masking;
1843
1844     /**
1845      * slice count
1846      * - encoding: Set by libavcodec.
1847      * - decoding: Set by user (or 0).
1848      */
1849     int slice_count;
1850     /**
1851      * prediction method (needed for huffyuv)
1852      * - encoding: Set by user.
1853      * - decoding: unused
1854      */
1855      int prediction_method;
1856 #define FF_PRED_LEFT   0
1857 #define FF_PRED_PLANE  1
1858 #define FF_PRED_MEDIAN 2
1859
1860     /**
1861      * slice offsets in the frame in bytes
1862      * - encoding: Set/allocated by libavcodec.
1863      * - decoding: Set/allocated by user (or NULL).
1864      */
1865     int *slice_offset;
1866
1867     /**
1868      * sample aspect ratio (0 if unknown)
1869      * That is the width of a pixel divided by the height of the pixel.
1870      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1871      * - encoding: Set by user.
1872      * - decoding: Set by libavcodec.
1873      */
1874     AVRational sample_aspect_ratio;
1875
1876     /**
1877      * motion estimation comparison function
1878      * - encoding: Set by user.
1879      * - decoding: unused
1880      */
1881     int me_cmp;
1882     /**
1883      * subpixel motion estimation comparison function
1884      * - encoding: Set by user.
1885      * - decoding: unused
1886      */
1887     int me_sub_cmp;
1888     /**
1889      * macroblock comparison function (not supported yet)
1890      * - encoding: Set by user.
1891      * - decoding: unused
1892      */
1893     int mb_cmp;
1894     /**
1895      * interlaced DCT comparison function
1896      * - encoding: Set by user.
1897      * - decoding: unused
1898      */
1899     int ildct_cmp;
1900 #define FF_CMP_SAD    0
1901 #define FF_CMP_SSE    1
1902 #define FF_CMP_SATD   2
1903 #define FF_CMP_DCT    3
1904 #define FF_CMP_PSNR   4
1905 #define FF_CMP_BIT    5
1906 #define FF_CMP_RD     6
1907 #define FF_CMP_ZERO   7
1908 #define FF_CMP_VSAD   8
1909 #define FF_CMP_VSSE   9
1910 #define FF_CMP_NSSE   10
1911 #define FF_CMP_W53    11
1912 #define FF_CMP_W97    12
1913 #define FF_CMP_DCTMAX 13
1914 #define FF_CMP_DCT264 14
1915 #define FF_CMP_CHROMA 256
1916
1917     /**
1918      * ME diamond size & shape
1919      * - encoding: Set by user.
1920      * - decoding: unused
1921      */
1922     int dia_size;
1923
1924     /**
1925      * amount of previous MV predictors (2a+1 x 2a+1 square)
1926      * - encoding: Set by user.
1927      * - decoding: unused
1928      */
1929     int last_predictor_count;
1930
1931     /**
1932      * prepass for motion estimation
1933      * - encoding: Set by user.
1934      * - decoding: unused
1935      */
1936     int pre_me;
1937
1938     /**
1939      * motion estimation prepass comparison function
1940      * - encoding: Set by user.
1941      * - decoding: unused
1942      */
1943     int me_pre_cmp;
1944
1945     /**
1946      * ME prepass diamond size & shape
1947      * - encoding: Set by user.
1948      * - decoding: unused
1949      */
1950     int pre_dia_size;
1951
1952     /**
1953      * subpel ME quality
1954      * - encoding: Set by user.
1955      * - decoding: unused
1956      */
1957     int me_subpel_quality;
1958
1959 #if FF_API_AFD
1960     /**
1961      * DTG active format information (additional aspect ratio
1962      * information only used in DVB MPEG-2 transport streams)
1963      * 0 if not set.
1964      *
1965      * - encoding: unused
1966      * - decoding: Set by decoder.
1967      * @deprecated Deprecated in favor of AVSideData
1968      */
1969     attribute_deprecated int dtg_active_format;
1970 #define FF_DTG_AFD_SAME         8
1971 #define FF_DTG_AFD_4_3          9
1972 #define FF_DTG_AFD_16_9         10
1973 #define FF_DTG_AFD_14_9         11
1974 #define FF_DTG_AFD_4_3_SP_14_9  13
1975 #define FF_DTG_AFD_16_9_SP_14_9 14
1976 #define FF_DTG_AFD_SP_4_3       15
1977 #endif /* FF_API_AFD */
1978
1979     /**
1980      * maximum motion estimation search range in subpel units
1981      * If 0 then no limit.
1982      *
1983      * - encoding: Set by user.
1984      * - decoding: unused
1985      */
1986     int me_range;
1987
1988 #if FF_API_QUANT_BIAS
1989     /**
1990      * @deprecated use encoder private option instead
1991      */
1992     attribute_deprecated int intra_quant_bias;
1993 #define FF_DEFAULT_QUANT_BIAS 999999
1994
1995     /**
1996      * @deprecated use encoder private option instead
1997      */
1998     attribute_deprecated int inter_quant_bias;
1999 #endif
2000
2001     /**
2002      * slice flags
2003      * - encoding: unused
2004      * - decoding: Set by user.
2005      */
2006     int slice_flags;
2007 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2008 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2009 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2010
2011 #if FF_API_XVMC
2012     /**
2013      * XVideo Motion Acceleration
2014      * - encoding: forbidden
2015      * - decoding: set by decoder
2016      * @deprecated XvMC doesn't need it anymore.
2017      */
2018     attribute_deprecated int xvmc_acceleration;
2019 #endif /* FF_API_XVMC */
2020
2021     /**
2022      * macroblock decision mode
2023      * - encoding: Set by user.
2024      * - decoding: unused
2025      */
2026     int mb_decision;
2027 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2028 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2029 #define FF_MB_DECISION_RD     2        ///< rate distortion
2030
2031     /**
2032      * custom intra quantization matrix
2033      * - encoding: Set by user, can be NULL.
2034      * - decoding: Set by libavcodec.
2035      */
2036     uint16_t *intra_matrix;
2037
2038     /**
2039      * custom inter quantization matrix
2040      * - encoding: Set by user, can be NULL.
2041      * - decoding: Set by libavcodec.
2042      */
2043     uint16_t *inter_matrix;
2044
2045     /**
2046      * scene change detection threshold
2047      * 0 is default, larger means fewer detected scene changes.
2048      * - encoding: Set by user.
2049      * - decoding: unused
2050      */
2051     int scenechange_threshold;
2052
2053     /**
2054      * noise reduction strength
2055      * - encoding: Set by user.
2056      * - decoding: unused
2057      */
2058     int noise_reduction;
2059
2060 #if FF_API_MPV_OPT
2061     /**
2062      * @deprecated this field is unused
2063      */
2064     attribute_deprecated
2065     int me_threshold;
2066
2067     /**
2068      * @deprecated this field is unused
2069      */
2070     attribute_deprecated
2071     int mb_threshold;
2072 #endif
2073
2074     /**
2075      * precision of the intra DC coefficient - 8
2076      * - encoding: Set by user.
2077      * - decoding: Set by libavcodec
2078      */
2079     int intra_dc_precision;
2080
2081     /**
2082      * Number of macroblock rows at the top which are skipped.
2083      * - encoding: unused
2084      * - decoding: Set by user.
2085      */
2086     int skip_top;
2087
2088     /**
2089      * Number of macroblock rows at the bottom which are skipped.
2090      * - encoding: unused
2091      * - decoding: Set by user.
2092      */
2093     int skip_bottom;
2094
2095 #if FF_API_MPV_OPT
2096     /**
2097      * @deprecated use encoder private options instead
2098      */
2099     attribute_deprecated
2100     float border_masking;
2101 #endif
2102
2103     /**
2104      * minimum MB lagrange multipler
2105      * - encoding: Set by user.
2106      * - decoding: unused
2107      */
2108     int mb_lmin;
2109
2110     /**
2111      * maximum MB lagrange multipler
2112      * - encoding: Set by user.
2113      * - decoding: unused
2114      */
2115     int mb_lmax;
2116
2117     /**
2118      *
2119      * - encoding: Set by user.
2120      * - decoding: unused
2121      */
2122     int me_penalty_compensation;
2123
2124     /**
2125      *
2126      * - encoding: Set by user.
2127      * - decoding: unused
2128      */
2129     int bidir_refine;
2130
2131     /**
2132      *
2133      * - encoding: Set by user.
2134      * - decoding: unused
2135      */
2136     int brd_scale;
2137
2138     /**
2139      * minimum GOP size
2140      * - encoding: Set by user.
2141      * - decoding: unused
2142      */
2143     int keyint_min;
2144
2145     /**
2146      * number of reference frames
2147      * - encoding: Set by user.
2148      * - decoding: Set by lavc.
2149      */
2150     int refs;
2151
2152     /**
2153      * chroma qp offset from luma
2154      * - encoding: Set by user.
2155      * - decoding: unused
2156      */
2157     int chromaoffset;
2158
2159 #if FF_API_UNUSED_MEMBERS
2160     /**
2161      * Multiplied by qscale for each frame and added to scene_change_score.
2162      * - encoding: Set by user.
2163      * - decoding: unused
2164      */
2165     attribute_deprecated int scenechange_factor;
2166 #endif
2167
2168     /**
2169      *
2170      * Note: Value depends upon the compare function used for fullpel ME.
2171      * - encoding: Set by user.
2172      * - decoding: unused
2173      */
2174     int mv0_threshold;
2175
2176     /**
2177      * Adjust sensitivity of b_frame_strategy 1.
2178      * - encoding: Set by user.
2179      * - decoding: unused
2180      */
2181     int b_sensitivity;
2182
2183     /**
2184      * Chromaticity coordinates of the source primaries.
2185      * - encoding: Set by user
2186      * - decoding: Set by libavcodec
2187      */
2188     enum AVColorPrimaries color_primaries;
2189
2190     /**
2191      * Color Transfer Characteristic.
2192      * - encoding: Set by user
2193      * - decoding: Set by libavcodec
2194      */
2195     enum AVColorTransferCharacteristic color_trc;
2196
2197     /**
2198      * YUV colorspace type.
2199      * - encoding: Set by user
2200      * - decoding: Set by libavcodec
2201      */
2202     enum AVColorSpace colorspace;
2203
2204     /**
2205      * MPEG vs JPEG YUV range.
2206      * - encoding: Set by user
2207      * - decoding: Set by libavcodec
2208      */
2209     enum AVColorRange color_range;
2210
2211     /**
2212      * This defines the location of chroma samples.
2213      * - encoding: Set by user
2214      * - decoding: Set by libavcodec
2215      */
2216     enum AVChromaLocation chroma_sample_location;
2217
2218     /**
2219      * Number of slices.
2220      * Indicates number of picture subdivisions. Used for parallelized
2221      * decoding.
2222      * - encoding: Set by user
2223      * - decoding: unused
2224      */
2225     int slices;
2226
2227     /** Field order
2228      * - encoding: set by libavcodec
2229      * - decoding: Set by user.
2230      */
2231     enum AVFieldOrder field_order;
2232
2233     /* audio only */
2234     int sample_rate; ///< samples per second
2235     int channels;    ///< number of audio channels
2236
2237     /**
2238      * audio sample format
2239      * - encoding: Set by user.
2240      * - decoding: Set by libavcodec.
2241      */
2242     enum AVSampleFormat sample_fmt;  ///< sample format
2243
2244     /* The following data should not be initialized. */
2245     /**
2246      * Number of samples per channel in an audio frame.
2247      *
2248      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2249      *   except the last must contain exactly frame_size samples per channel.
2250      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2251      *   frame size is not restricted.
2252      * - decoding: may be set by some decoders to indicate constant frame size
2253      */
2254     int frame_size;
2255
2256     /**
2257      * Frame counter, set by libavcodec.
2258      *
2259      * - decoding: total number of frames returned from the decoder so far.
2260      * - encoding: total number of frames passed to the encoder so far.
2261      *
2262      *   @note the counter is not incremented if encoding/decoding resulted in
2263      *   an error.
2264      */
2265     int frame_number;
2266
2267     /**
2268      * number of bytes per packet if constant and known or 0
2269      * Used by some WAV based audio codecs.
2270      */
2271     int block_align;
2272
2273     /**
2274      * Audio cutoff bandwidth (0 means "automatic")
2275      * - encoding: Set by user.
2276      * - decoding: unused
2277      */
2278     int cutoff;
2279
2280     /**
2281      * Audio channel layout.
2282      * - encoding: set by user.
2283      * - decoding: set by user, may be overwritten by libavcodec.
2284      */
2285     uint64_t channel_layout;
2286
2287     /**
2288      * Request decoder to use this channel layout if it can (0 for default)
2289      * - encoding: unused
2290      * - decoding: Set by user.
2291      */
2292     uint64_t request_channel_layout;
2293
2294     /**
2295      * Type of service that the audio stream conveys.
2296      * - encoding: Set by user.
2297      * - decoding: Set by libavcodec.
2298      */
2299     enum AVAudioServiceType audio_service_type;
2300
2301     /**
2302      * desired sample format
2303      * - encoding: Not used.
2304      * - decoding: Set by user.
2305      * Decoder will decode to this format if it can.
2306      */
2307     enum AVSampleFormat request_sample_fmt;
2308
2309     /**
2310      * This callback is called at the beginning of each frame to get data
2311      * buffer(s) for it. There may be one contiguous buffer for all the data or
2312      * there may be a buffer per each data plane or anything in between. What
2313      * this means is, you may set however many entries in buf[] you feel necessary.
2314      * Each buffer must be reference-counted using the AVBuffer API (see description
2315      * of buf[] below).
2316      *
2317      * The following fields will be set in the frame before this callback is
2318      * called:
2319      * - format
2320      * - width, height (video only)
2321      * - sample_rate, channel_layout, nb_samples (audio only)
2322      * Their values may differ from the corresponding values in
2323      * AVCodecContext. This callback must use the frame values, not the codec
2324      * context values, to calculate the required buffer size.
2325      *
2326      * This callback must fill the following fields in the frame:
2327      * - data[]
2328      * - linesize[]
2329      * - extended_data:
2330      *   * if the data is planar audio with more than 8 channels, then this
2331      *     callback must allocate and fill extended_data to contain all pointers
2332      *     to all data planes. data[] must hold as many pointers as it can.
2333      *     extended_data must be allocated with av_malloc() and will be freed in
2334      *     av_frame_unref().
2335      *   * otherwise exended_data must point to data
2336      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2337      *   the frame's data and extended_data pointers must be contained in these. That
2338      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2339      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2340      *   and av_buffer_ref().
2341      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2342      *   this callback and filled with the extra buffers if there are more
2343      *   buffers than buf[] can hold. extended_buf will be freed in
2344      *   av_frame_unref().
2345      *
2346      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2347      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2348      * some other means.
2349      *
2350      * Each data plane must be aligned to the maximum required by the target
2351      * CPU.
2352      *
2353      * @see avcodec_default_get_buffer2()
2354      *
2355      * Video:
2356      *
2357      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2358      * (read and/or written to if it is writable) later by libavcodec.
2359      *
2360      * avcodec_align_dimensions2() should be used to find the required width and
2361      * height, as they normally need to be rounded up to the next multiple of 16.
2362      *
2363      * Some decoders do not support linesizes changing between frames.
2364      *
2365      * If frame multithreading is used and thread_safe_callbacks is set,
2366      * this callback may be called from a different thread, but not from more
2367      * than one at once. Does not need to be reentrant.
2368      *
2369      * @see avcodec_align_dimensions2()
2370      *
2371      * Audio:
2372      *
2373      * Decoders request a buffer of a particular size by setting
2374      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2375      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2376      * to a smaller value in the output frame.
2377      *
2378      * As a convenience, av_samples_get_buffer_size() and
2379      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2380      * functions to find the required data size and to fill data pointers and
2381      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2382      * since all planes must be the same size.
2383      *
2384      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2385      *
2386      * - encoding: unused
2387      * - decoding: Set by libavcodec, user can override.
2388      */
2389     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2390
2391     /**
2392      * If non-zero, the decoded audio and video frames returned from
2393      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2394      * and are valid indefinitely. The caller must free them with
2395      * av_frame_unref() when they are not needed anymore.
2396      * Otherwise, the decoded frames must not be freed by the caller and are
2397      * only valid until the next decode call.
2398      *
2399      * - encoding: unused
2400      * - decoding: set by the caller before avcodec_open2().
2401      */
2402     int refcounted_frames;
2403
2404     /* - encoding parameters */
2405     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2406     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2407
2408     /**
2409      * minimum quantizer
2410      * - encoding: Set by user.
2411      * - decoding: unused
2412      */
2413     int qmin;
2414
2415     /**
2416      * maximum quantizer
2417      * - encoding: Set by user.
2418      * - decoding: unused
2419      */
2420     int qmax;
2421
2422     /**
2423      * maximum quantizer difference between frames
2424      * - encoding: Set by user.
2425      * - decoding: unused
2426      */
2427     int max_qdiff;
2428
2429 #if FF_API_MPV_OPT
2430     /**
2431      * @deprecated use encoder private options instead
2432      */
2433     attribute_deprecated
2434     float rc_qsquish;
2435
2436     attribute_deprecated
2437     float rc_qmod_amp;
2438     attribute_deprecated
2439     int rc_qmod_freq;
2440 #endif
2441
2442     /**
2443      * decoder bitstream buffer size
2444      * - encoding: Set by user.
2445      * - decoding: unused
2446      */
2447     int rc_buffer_size;
2448
2449     /**
2450      * ratecontrol override, see RcOverride
2451      * - encoding: Allocated/set/freed by user.
2452      * - decoding: unused
2453      */
2454     int rc_override_count;
2455     RcOverride *rc_override;
2456
2457 #if FF_API_MPV_OPT
2458     /**
2459      * @deprecated use encoder private options instead
2460      */
2461     attribute_deprecated
2462     const char *rc_eq;
2463 #endif
2464
2465     /**
2466      * maximum bitrate
2467      * - encoding: Set by user.
2468      * - decoding: Set by user, may be overwritten by libavcodec.
2469      */
2470     int64_t rc_max_rate;
2471
2472     /**
2473      * minimum bitrate
2474      * - encoding: Set by user.
2475      * - decoding: unused
2476      */
2477     int64_t rc_min_rate;
2478
2479 #if FF_API_MPV_OPT
2480     /**
2481      * @deprecated use encoder private options instead
2482      */
2483     attribute_deprecated
2484     float rc_buffer_aggressivity;
2485
2486     attribute_deprecated
2487     float rc_initial_cplx;
2488 #endif
2489
2490     /**
2491      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2492      * - encoding: Set by user.
2493      * - decoding: unused.
2494      */
2495     float rc_max_available_vbv_use;
2496
2497     /**
2498      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2499      * - encoding: Set by user.
2500      * - decoding: unused.
2501      */
2502     float rc_min_vbv_overflow_use;
2503
2504     /**
2505      * Number of bits which should be loaded into the rc buffer before decoding starts.
2506      * - encoding: Set by user.
2507      * - decoding: unused
2508      */
2509     int rc_initial_buffer_occupancy;
2510
2511 #define FF_CODER_TYPE_VLC       0
2512 #define FF_CODER_TYPE_AC        1
2513 #define FF_CODER_TYPE_RAW       2
2514 #define FF_CODER_TYPE_RLE       3
2515 #if FF_API_UNUSED_MEMBERS
2516 #define FF_CODER_TYPE_DEFLATE   4
2517 #endif /* FF_API_UNUSED_MEMBERS */
2518     /**
2519      * coder type
2520      * - encoding: Set by user.
2521      * - decoding: unused
2522      */
2523     int coder_type;
2524
2525     /**
2526      * context model
2527      * - encoding: Set by user.
2528      * - decoding: unused
2529      */
2530     int context_model;
2531
2532 #if FF_API_MPV_OPT
2533     /**
2534      * @deprecated use encoder private options instead
2535      */
2536     attribute_deprecated
2537     int lmin;
2538
2539     /**
2540      * @deprecated use encoder private options instead
2541      */
2542     attribute_deprecated
2543     int lmax;
2544 #endif
2545
2546     /**
2547      * frame skip threshold
2548      * - encoding: Set by user.
2549      * - decoding: unused
2550      */
2551     int frame_skip_threshold;
2552
2553     /**
2554      * frame skip factor
2555      * - encoding: Set by user.
2556      * - decoding: unused
2557      */
2558     int frame_skip_factor;
2559
2560     /**
2561      * frame skip exponent
2562      * - encoding: Set by user.
2563      * - decoding: unused
2564      */
2565     int frame_skip_exp;
2566
2567     /**
2568      * frame skip comparison function
2569      * - encoding: Set by user.
2570      * - decoding: unused
2571      */
2572     int frame_skip_cmp;
2573
2574     /**
2575      * trellis RD quantization
2576      * - encoding: Set by user.
2577      * - decoding: unused
2578      */
2579     int trellis;
2580
2581     /**
2582      * - encoding: Set by user.
2583      * - decoding: unused
2584      */
2585     int min_prediction_order;
2586
2587     /**
2588      * - encoding: Set by user.
2589      * - decoding: unused
2590      */
2591     int max_prediction_order;
2592
2593     /**
2594      * GOP timecode frame start number
2595      * - encoding: Set by user, in non drop frame format
2596      * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2597      */
2598     int64_t timecode_frame_start;
2599
2600     /* The RTP callback: This function is called    */
2601     /* every time the encoder has a packet to send. */
2602     /* It depends on the encoder if the data starts */
2603     /* with a Start Code (it should). H.263 does.   */
2604     /* mb_nb contains the number of macroblocks     */
2605     /* encoded in the RTP payload.                  */
2606     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2607
2608     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2609                             /* do its best to deliver a chunk with size     */
2610                             /* below rtp_payload_size, the chunk will start */
2611                             /* with a start code on some codecs like H.263. */
2612                             /* This doesn't take account of any particular  */
2613                             /* headers inside the transmitted RTP payload.  */
2614
2615     /* statistics, used for 2-pass encoding */
2616     int mv_bits;
2617     int header_bits;
2618     int i_tex_bits;
2619     int p_tex_bits;
2620     int i_count;
2621     int p_count;
2622     int skip_count;
2623     int misc_bits;
2624
2625     /**
2626      * number of bits used for the previously encoded frame
2627      * - encoding: Set by libavcodec.
2628      * - decoding: unused
2629      */
2630     int frame_bits;
2631
2632     /**
2633      * pass1 encoding statistics output buffer
2634      * - encoding: Set by libavcodec.
2635      * - decoding: unused
2636      */
2637     char *stats_out;
2638
2639     /**
2640      * pass2 encoding statistics input buffer
2641      * Concatenated stuff from stats_out of pass1 should be placed here.
2642      * - encoding: Allocated/set/freed by user.
2643      * - decoding: unused
2644      */
2645     char *stats_in;
2646
2647     /**
2648      * Work around bugs in encoders which sometimes cannot be detected automatically.
2649      * - encoding: Set by user
2650      * - decoding: Set by user
2651      */
2652     int workaround_bugs;
2653 #define FF_BUG_AUTODETECT       1  ///< autodetection
2654 #if FF_API_OLD_MSMPEG4
2655 #define FF_BUG_OLD_MSMPEG4      2
2656 #endif
2657 #define FF_BUG_XVID_ILACE       4
2658 #define FF_BUG_UMP4             8
2659 #define FF_BUG_NO_PADDING       16
2660 #define FF_BUG_AMV              32
2661 #if FF_API_AC_VLC
2662 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2663 #endif
2664 #define FF_BUG_QPEL_CHROMA      64
2665 #define FF_BUG_STD_QPEL         128
2666 #define FF_BUG_QPEL_CHROMA2     256
2667 #define FF_BUG_DIRECT_BLOCKSIZE 512
2668 #define FF_BUG_EDGE             1024
2669 #define FF_BUG_HPEL_CHROMA      2048
2670 #define FF_BUG_DC_CLIP          4096
2671 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2672 #define FF_BUG_TRUNCATED       16384
2673
2674     /**
2675      * strictly follow the standard (MPEG4, ...).
2676      * - encoding: Set by user.
2677      * - decoding: Set by user.
2678      * Setting this to STRICT or higher means the encoder and decoder will
2679      * generally do stupid things, whereas setting it to unofficial or lower
2680      * will mean the encoder might produce output that is not supported by all
2681      * spec-compliant decoders. Decoders don't differentiate between normal,
2682      * unofficial and experimental (that is, they always try to decode things
2683      * when they can) unless they are explicitly asked to behave stupidly
2684      * (=strictly conform to the specs)
2685      */
2686     int strict_std_compliance;
2687 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2688 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2689 #define FF_COMPLIANCE_NORMAL        0
2690 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2691 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2692
2693     /**
2694      * error concealment flags
2695      * - encoding: unused
2696      * - decoding: Set by user.
2697      */
2698     int error_concealment;
2699 #define FF_EC_GUESS_MVS   1
2700 #define FF_EC_DEBLOCK     2
2701 #define FF_EC_FAVOR_INTER 256
2702
2703     /**
2704      * debug
2705      * - encoding: Set by user.
2706      * - decoding: Set by user.
2707      */
2708     int debug;
2709 #define FF_DEBUG_PICT_INFO   1
2710 #define FF_DEBUG_RC          2
2711 #define FF_DEBUG_BITSTREAM   4
2712 #define FF_DEBUG_MB_TYPE     8
2713 #define FF_DEBUG_QP          16
2714 #if FF_API_DEBUG_MV
2715 /**
2716  * @deprecated this option does nothing
2717  */
2718 #define FF_DEBUG_MV          32
2719 #endif
2720 #define FF_DEBUG_DCT_COEFF   0x00000040
2721 #define FF_DEBUG_SKIP        0x00000080
2722 #define FF_DEBUG_STARTCODE   0x00000100
2723 #if FF_API_UNUSED_MEMBERS
2724 #define FF_DEBUG_PTS         0x00000200
2725 #endif /* FF_API_UNUSED_MEMBERS */
2726 #define FF_DEBUG_ER          0x00000400
2727 #define FF_DEBUG_MMCO        0x00000800
2728 #define FF_DEBUG_BUGS        0x00001000
2729 #if FF_API_DEBUG_MV
2730 #define FF_DEBUG_VIS_QP      0x00002000 ///< only access through AVOptions from outside libavcodec
2731 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2732 #endif
2733 #define FF_DEBUG_BUFFERS     0x00008000
2734 #define FF_DEBUG_THREADS     0x00010000
2735 #define FF_DEBUG_GREEN_MD    0x00800000
2736 #define FF_DEBUG_NOMC        0x01000000
2737
2738 #if FF_API_DEBUG_MV
2739     /**
2740      * debug
2741      * Code outside libavcodec should access this field using AVOptions
2742      * - encoding: Set by user.
2743      * - decoding: Set by user.
2744      */
2745     int debug_mv;
2746 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2747 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2748 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2749 #endif
2750
2751     /**
2752      * Error recognition; may misdetect some more or less valid parts as errors.
2753      * - encoding: unused
2754      * - decoding: Set by user.
2755      */
2756     int err_recognition;
2757
2758 /**
2759  * Verify checksums embedded in the bitstream (could be of either encoded or
2760  * decoded data, depending on the codec) and print an error message on mismatch.
2761  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2762  * decoder returning an error.
2763  */
2764 #define AV_EF_CRCCHECK  (1<<0)
2765 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
2766 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
2767 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
2768
2769 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
2770 #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
2771 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
2772 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
2773
2774
2775     /**
2776      * opaque 64bit number (generally a PTS) that will be reordered and
2777      * output in AVFrame.reordered_opaque
2778      * - encoding: unused
2779      * - decoding: Set by user.
2780      */
2781     int64_t reordered_opaque;
2782
2783     /**
2784      * Hardware accelerator in use
2785      * - encoding: unused.
2786      * - decoding: Set by libavcodec
2787      */
2788     struct AVHWAccel *hwaccel;
2789
2790     /**
2791      * Hardware accelerator context.
2792      * For some hardware accelerators, a global context needs to be
2793      * provided by the user. In that case, this holds display-dependent
2794      * data FFmpeg cannot instantiate itself. Please refer to the
2795      * FFmpeg HW accelerator documentation to know how to fill this
2796      * is. e.g. for VA API, this is a struct vaapi_context.
2797      * - encoding: unused
2798      * - decoding: Set by user
2799      */
2800     void *hwaccel_context;
2801
2802     /**
2803      * error
2804      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2805      * - decoding: unused
2806      */
2807     uint64_t error[AV_NUM_DATA_POINTERS];
2808
2809     /**
2810      * DCT algorithm, see FF_DCT_* below
2811      * - encoding: Set by user.
2812      * - decoding: unused
2813      */
2814     int dct_algo;
2815 #define FF_DCT_AUTO    0
2816 #define FF_DCT_FASTINT 1
2817 #define FF_DCT_INT     2
2818 #define FF_DCT_MMX     3
2819 #define FF_DCT_ALTIVEC 5
2820 #define FF_DCT_FAAN    6
2821
2822     /**
2823      * IDCT algorithm, see FF_IDCT_* below.
2824      * - encoding: Set by user.
2825      * - decoding: Set by user.
2826      */
2827     int idct_algo;
2828 #define FF_IDCT_AUTO          0
2829 #define FF_IDCT_INT           1
2830 #define FF_IDCT_SIMPLE        2
2831 #define FF_IDCT_SIMPLEMMX     3
2832 #define FF_IDCT_ARM           7
2833 #define FF_IDCT_ALTIVEC       8
2834 #if FF_API_ARCH_SH4
2835 #define FF_IDCT_SH4           9
2836 #endif
2837 #define FF_IDCT_SIMPLEARM     10
2838 #if FF_API_UNUSED_MEMBERS
2839 #define FF_IDCT_IPP           13
2840 #endif /* FF_API_UNUSED_MEMBERS */
2841 #define FF_IDCT_XVID          14
2842 #if FF_API_IDCT_XVIDMMX
2843 #define FF_IDCT_XVIDMMX       14
2844 #endif /* FF_API_IDCT_XVIDMMX */
2845 #define FF_IDCT_SIMPLEARMV5TE 16
2846 #define FF_IDCT_SIMPLEARMV6   17
2847 #if FF_API_ARCH_SPARC
2848 #define FF_IDCT_SIMPLEVIS     18
2849 #endif
2850 #define FF_IDCT_FAAN          20
2851 #define FF_IDCT_SIMPLENEON    22
2852 #if FF_API_ARCH_ALPHA
2853 #define FF_IDCT_SIMPLEALPHA   23
2854 #endif
2855 #define FF_IDCT_SIMPLEAUTO    128
2856
2857     /**
2858      * bits per sample/pixel from the demuxer (needed for huffyuv).
2859      * - encoding: Set by libavcodec.
2860      * - decoding: Set by user.
2861      */
2862      int bits_per_coded_sample;
2863
2864     /**
2865      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2866      * - encoding: set by user.
2867      * - decoding: set by libavcodec.
2868      */
2869     int bits_per_raw_sample;
2870
2871 #if FF_API_LOWRES
2872     /**
2873      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2874      * - encoding: unused
2875      * - decoding: Set by user.
2876      * Code outside libavcodec should access this field using:
2877      * av_codec_{get,set}_lowres(avctx)
2878      */
2879      int lowres;
2880 #endif
2881
2882 #if FF_API_CODED_FRAME
2883     /**
2884      * the picture in the bitstream
2885      * - encoding: Set by libavcodec.
2886      * - decoding: unused
2887      *
2888      * @deprecated use the quality factor packet side data instead
2889      */
2890     attribute_deprecated AVFrame *coded_frame;
2891 #endif
2892
2893     /**
2894      * thread count
2895      * is used to decide how many independent tasks should be passed to execute()
2896      * - encoding: Set by user.
2897      * - decoding: Set by user.
2898      */
2899     int thread_count;
2900
2901     /**
2902      * Which multithreading methods to use.
2903      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2904      * so clients which cannot provide future frames should not use it.
2905      *
2906      * - encoding: Set by user, otherwise the default is used.
2907      * - decoding: Set by user, otherwise the default is used.
2908      */
2909     int thread_type;
2910 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2911 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2912
2913     /**
2914      * Which multithreading methods are in use by the codec.
2915      * - encoding: Set by libavcodec.
2916      * - decoding: Set by libavcodec.
2917      */
2918     int active_thread_type;
2919
2920     /**
2921      * Set by the client if its custom get_buffer() callback can be called
2922      * synchronously from another thread, which allows faster multithreaded decoding.
2923      * draw_horiz_band() will be called from other threads regardless of this setting.
2924      * Ignored if the default get_buffer() is used.
2925      * - encoding: Set by user.
2926      * - decoding: Set by user.
2927      */
2928     int thread_safe_callbacks;
2929
2930     /**
2931      * The codec may call this to execute several independent things.
2932      * It will return only after finishing all tasks.
2933      * The user may replace this with some multithreaded implementation,
2934      * the default implementation will execute the parts serially.
2935      * @param count the number of things to execute
2936      * - encoding: Set by libavcodec, user can override.
2937      * - decoding: Set by libavcodec, user can override.
2938      */
2939     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2940
2941     /**
2942      * The codec may call this to execute several independent things.
2943      * It will return only after finishing all tasks.
2944      * The user may replace this with some multithreaded implementation,
2945      * the default implementation will execute the parts serially.
2946      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2947      * @param c context passed also to func
2948      * @param count the number of things to execute
2949      * @param arg2 argument passed unchanged to func
2950      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2951      * @param func function that will be called count times, with jobnr from 0 to count-1.
2952      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2953      *             two instances of func executing at the same time will have the same threadnr.
2954      * @return always 0 currently, but code should handle a future improvement where when any call to func
2955      *         returns < 0 no further calls to func may be done and < 0 is returned.
2956      * - encoding: Set by libavcodec, user can override.
2957      * - decoding: Set by libavcodec, user can override.
2958      */
2959     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2960
2961     /**
2962      * noise vs. sse weight for the nsse comparison function
2963      * - encoding: Set by user.
2964      * - decoding: unused
2965      */
2966      int nsse_weight;
2967
2968     /**
2969      * profile
2970      * - encoding: Set by user.
2971      * - decoding: Set by libavcodec.
2972      */
2973      int profile;
2974 #define FF_PROFILE_UNKNOWN -99
2975 #define FF_PROFILE_RESERVED -100
2976
2977 #define FF_PROFILE_AAC_MAIN 0
2978 #define FF_PROFILE_AAC_LOW  1
2979 #define FF_PROFILE_AAC_SSR  2
2980 #define FF_PROFILE_AAC_LTP  3
2981 #define FF_PROFILE_AAC_HE   4
2982 #define FF_PROFILE_AAC_HE_V2 28
2983 #define FF_PROFILE_AAC_LD   22
2984 #define FF_PROFILE_AAC_ELD  38
2985 #define FF_PROFILE_MPEG2_AAC_LOW 128
2986 #define FF_PROFILE_MPEG2_AAC_HE  131
2987
2988 #define FF_PROFILE_DTS         20
2989 #define FF_PROFILE_DTS_ES      30
2990 #define FF_PROFILE_DTS_96_24   40
2991 #define FF_PROFILE_DTS_HD_HRA  50
2992 #define FF_PROFILE_DTS_HD_MA   60
2993 #define FF_PROFILE_DTS_EXPRESS 70
2994
2995 #define FF_PROFILE_MPEG2_422    0
2996 #define FF_PROFILE_MPEG2_HIGH   1
2997 #define FF_PROFILE_MPEG2_SS     2
2998 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2999 #define FF_PROFILE_MPEG2_MAIN   4
3000 #define FF_PROFILE_MPEG2_SIMPLE 5
3001
3002 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
3003 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
3004
3005 #define FF_PROFILE_H264_BASELINE             66
3006 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3007 #define FF_PROFILE_H264_MAIN                 77
3008 #define FF_PROFILE_H264_EXTENDED             88
3009 #define FF_PROFILE_H264_HIGH                 100
3010 #define FF_PROFILE_H264_HIGH_10              110
3011 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
3012 #define FF_PROFILE_H264_HIGH_422             122
3013 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
3014 #define FF_PROFILE_H264_HIGH_444             144
3015 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
3016 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
3017 #define FF_PROFILE_H264_CAVLC_444            44
3018
3019 #define FF_PROFILE_VC1_SIMPLE   0
3020 #define FF_PROFILE_VC1_MAIN     1
3021 #define FF_PROFILE_VC1_COMPLEX  2
3022 #define FF_PROFILE_VC1_ADVANCED 3
3023
3024 #define FF_PROFILE_MPEG4_SIMPLE                     0
3025 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
3026 #define FF_PROFILE_MPEG4_CORE                       2
3027 #define FF_PROFILE_MPEG4_MAIN                       3
3028 #define FF_PROFILE_MPEG4_N_BIT                      4
3029 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
3030 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
3031 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
3032 #define FF_PROFILE_MPEG4_HYBRID                     8
3033 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
3034 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
3035 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
3036 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
3037 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3038 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3039 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3040
3041 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   0
3042 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   1
3043 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  2
3044 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
3045 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
3046
3047 #define FF_PROFILE_VP9_0                            0
3048 #define FF_PROFILE_VP9_1                            1
3049 #define FF_PROFILE_VP9_2                            2
3050 #define FF_PROFILE_VP9_3                            3
3051
3052 #define FF_PROFILE_HEVC_MAIN                        1
3053 #define FF_PROFILE_HEVC_MAIN_10                     2
3054 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
3055 #define FF_PROFILE_HEVC_REXT                        4
3056
3057     /**
3058      * level
3059      * - encoding: Set by user.
3060      * - decoding: Set by libavcodec.
3061      */
3062      int level;
3063 #define FF_LEVEL_UNKNOWN -99
3064
3065     /**
3066      * Skip loop filtering for selected frames.
3067      * - encoding: unused
3068      * - decoding: Set by user.
3069      */
3070     enum AVDiscard skip_loop_filter;
3071
3072     /**
3073      * Skip IDCT/dequantization for selected frames.
3074      * - encoding: unused
3075      * - decoding: Set by user.
3076      */
3077     enum AVDiscard skip_idct;
3078
3079     /**
3080      * Skip decoding for selected frames.
3081      * - encoding: unused
3082      * - decoding: Set by user.
3083      */
3084     enum AVDiscard skip_frame;
3085
3086     /**
3087      * Header containing style information for text subtitles.
3088      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3089      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3090      * the Format line following. It shouldn't include any Dialogue line.
3091      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3092      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3093      */
3094     uint8_t *subtitle_header;
3095     int subtitle_header_size;
3096
3097 #if FF_API_ERROR_RATE
3098     /**
3099      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3100      * encoders
3101      */
3102     attribute_deprecated
3103     int error_rate;
3104 #endif
3105
3106     /**
3107      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3108      * Used for compliant TS muxing.
3109      * - encoding: Set by libavcodec.
3110      * - decoding: unused.
3111      */
3112     uint64_t vbv_delay;
3113
3114 #if FF_API_SIDEDATA_ONLY_PKT
3115     /**
3116      * Encoding only and set by default. Allow encoders to output packets
3117      * that do not contain any encoded data, only side data.
3118      *
3119      * Some encoders need to output such packets, e.g. to update some stream
3120      * parameters at the end of encoding.
3121      *
3122      * @deprecated this field disables the default behaviour and
3123      *             it is kept only for compatibility.
3124      */
3125     attribute_deprecated
3126     int side_data_only_packets;
3127 #endif
3128
3129     /**
3130      * Audio only. The number of "priming" samples (padding) inserted by the
3131      * encoder at the beginning of the audio. I.e. this number of leading
3132      * decoded samples must be discarded by the caller to get the original audio
3133      * without leading padding.
3134      *
3135      * - decoding: unused
3136      * - encoding: Set by libavcodec. The timestamps on the output packets are
3137      *             adjusted by the encoder so that they always refer to the
3138      *             first sample of the data actually contained in the packet,
3139      *             including any added padding.  E.g. if the timebase is
3140      *             1/samplerate and the timestamp of the first input sample is
3141      *             0, the timestamp of the first output packet will be
3142      *             -initial_padding.
3143      */
3144     int initial_padding;
3145
3146     /**
3147      * - decoding: For codecs that store a framerate value in the compressed
3148      *             bitstream, the decoder may export it here. { 0, 1} when
3149      *             unknown.
3150      * - encoding: unused
3151      */
3152     AVRational framerate;
3153
3154     /**
3155      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3156      * - encoding: unused.
3157      * - decoding: Set by libavcodec before calling get_format()
3158      */
3159     enum AVPixelFormat sw_pix_fmt;
3160
3161     /**
3162      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3163      * Code outside libavcodec should access this field using:
3164      * av_codec_{get,set}_pkt_timebase(avctx)
3165      * - encoding unused.
3166      * - decoding set by user.
3167      */
3168     AVRational pkt_timebase;
3169
3170     /**
3171      * AVCodecDescriptor
3172      * Code outside libavcodec should access this field using:
3173      * av_codec_{get,set}_codec_descriptor(avctx)
3174      * - encoding: unused.
3175      * - decoding: set by libavcodec.
3176      */
3177     const AVCodecDescriptor *codec_descriptor;
3178
3179 #if !FF_API_LOWRES
3180     /**
3181      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3182      * - encoding: unused
3183      * - decoding: Set by user.
3184      * Code outside libavcodec should access this field using:
3185      * av_codec_{get,set}_lowres(avctx)
3186      */
3187      int lowres;
3188 #endif
3189
3190     /**
3191      * Current statistics for PTS correction.
3192      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3193      * - encoding: unused
3194      */
3195     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3196     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3197     int64_t pts_correction_last_pts;       /// PTS of the last frame
3198     int64_t pts_correction_last_dts;       /// DTS of the last frame
3199
3200     /**
3201      * Character encoding of the input subtitles file.
3202      * - decoding: set by user
3203      * - encoding: unused
3204      */
3205     char *sub_charenc;
3206
3207     /**
3208      * Subtitles character encoding mode. Formats or codecs might be adjusting
3209      * this setting (if they are doing the conversion themselves for instance).
3210      * - decoding: set by libavcodec
3211      * - encoding: unused
3212      */
3213     int sub_charenc_mode;
3214 #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)
3215 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3216 #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
3217
3218     /**
3219      * Skip processing alpha if supported by codec.
3220      * Note that if the format uses pre-multiplied alpha (common with VP6,
3221      * and recommended due to better video quality/compression)
3222      * the image will look as if alpha-blended onto a black background.
3223      * However for formats that do not use pre-multiplied alpha
3224      * there might be serious artefacts (though e.g. libswscale currently
3225      * assumes pre-multiplied alpha anyway).
3226      * Code outside libavcodec should access this field using AVOptions
3227      *
3228      * - decoding: set by user
3229      * - encoding: unused
3230      */
3231     int skip_alpha;
3232
3233     /**
3234      * Number of samples to skip after a discontinuity
3235      * - decoding: unused
3236      * - encoding: set by libavcodec
3237      */
3238     int seek_preroll;
3239
3240 #if !FF_API_DEBUG_MV
3241     /**
3242      * debug motion vectors
3243      * Code outside libavcodec should access this field using AVOptions
3244      * - encoding: Set by user.
3245      * - decoding: Set by user.
3246      */
3247     int debug_mv;
3248 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3249 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3250 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3251 #endif
3252
3253     /**
3254      * custom intra quantization matrix
3255      * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3256      * - encoding: Set by user, can be NULL.
3257      * - decoding: unused.
3258      */
3259     uint16_t *chroma_intra_matrix;
3260
3261     /**
3262      * dump format separator.
3263      * can be ", " or "\n      " or anything else
3264      * Code outside libavcodec should access this field using AVOptions
3265      * (NO direct access).
3266      * - encoding: Set by user.
3267      * - decoding: Set by user.
3268      */
3269     uint8_t *dump_separator;
3270
3271     /**
3272      * ',' separated list of allowed decoders.
3273      * If NULL then all are allowed
3274      * - encoding: unused
3275      * - decoding: set by user through AVOPtions (NO direct access)
3276      */
3277     char *codec_whitelist;
3278
3279     /*
3280      * Properties of the stream that gets decoded
3281      * To be accessed through av_codec_get_properties() (NO direct access)
3282      * - encoding: unused
3283      * - decoding: set by libavcodec
3284      */
3285     unsigned properties;
3286 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3287 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3288 } AVCodecContext;
3289
3290 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3291 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3292
3293 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3294 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3295
3296 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3297
3298 int  av_codec_get_lowres(const AVCodecContext *avctx);
3299 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3300
3301 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3302 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3303
3304 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3305 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3306
3307 /**
3308  * AVProfile.
3309  */
3310 typedef struct AVProfile {
3311     int profile;
3312     const char *name; ///< short name for the profile
3313 } AVProfile;
3314
3315 typedef struct AVCodecDefault AVCodecDefault;
3316
3317 struct AVSubtitle;
3318
3319 /**
3320  * AVCodec.
3321  */
3322 typedef struct AVCodec {
3323     /**
3324      * Name of the codec implementation.
3325      * The name is globally unique among encoders and among decoders (but an
3326      * encoder and a decoder can share the same name).
3327      * This is the primary way to find a codec from the user perspective.
3328      */
3329     const char *name;
3330     /**
3331      * Descriptive name for the codec, meant to be more human readable than name.
3332      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3333      */
3334     const char *long_name;
3335     enum AVMediaType type;
3336     enum AVCodecID id;
3337     /**
3338      * Codec capabilities.
3339      * see AV_CODEC_CAP_*
3340      */
3341     int capabilities;
3342     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3343     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3344     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3345     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3346     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3347     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3348     const AVClass *priv_class;              ///< AVClass for the private context
3349     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3350
3351     /*****************************************************************
3352      * No fields below this line are part of the public API. They
3353      * may not be used outside of libavcodec and can be changed and
3354      * removed at will.
3355      * New public fields should be added right above.
3356      *****************************************************************
3357      */
3358     int priv_data_size;
3359     struct AVCodec *next;
3360     /**
3361      * @name Frame-level threading support functions
3362      * @{
3363      */
3364     /**
3365      * If defined, called on thread contexts when they are created.
3366      * If the codec allocates writable tables in init(), re-allocate them here.
3367      * priv_data will be set to a copy of the original.
3368      */
3369     int (*init_thread_copy)(AVCodecContext *);
3370     /**
3371      * Copy necessary context variables from a previous thread context to the current one.
3372      * If not defined, the next thread will start automatically; otherwise, the codec
3373      * must call ff_thread_finish_setup().
3374      *
3375      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3376      */
3377     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3378     /** @} */
3379
3380     /**
3381      * Private codec-specific defaults.
3382      */
3383     const AVCodecDefault *defaults;
3384
3385     /**
3386      * Initialize codec static data, called from avcodec_register().
3387      */
3388     void (*init_static_data)(struct AVCodec *codec);
3389
3390     int (*init)(AVCodecContext *);
3391     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3392                       const struct AVSubtitle *sub);
3393     /**
3394      * Encode data to an AVPacket.
3395      *
3396      * @param      avctx          codec context
3397      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3398      * @param[in]  frame          AVFrame containing the raw data to be encoded
3399      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3400      *                            non-empty packet was returned in avpkt.
3401      * @return 0 on success, negative error code on failure
3402      */
3403     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3404                    int *got_packet_ptr);
3405     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3406     int (*close)(AVCodecContext *);
3407     /**
3408      * Flush buffers.
3409      * Will be called when seeking
3410      */
3411     void (*flush)(AVCodecContext *);
3412     /**
3413      * Internal codec capabilities.
3414      * See FF_CODEC_CAP_* in internal.h
3415      */
3416     int caps_internal;
3417 } AVCodec;
3418
3419 int av_codec_get_max_lowres(const AVCodec *codec);
3420
3421 struct MpegEncContext;
3422
3423 /**
3424  * @defgroup lavc_hwaccel AVHWAccel
3425  * @{
3426  */
3427 typedef struct AVHWAccel {
3428     /**
3429      * Name of the hardware accelerated codec.
3430      * The name is globally unique among encoders and among decoders (but an
3431      * encoder and a decoder can share the same name).
3432      */
3433     const char *name;
3434
3435     /**
3436      * Type of codec implemented by the hardware accelerator.
3437      *
3438      * See AVMEDIA_TYPE_xxx
3439      */
3440     enum AVMediaType type;
3441
3442     /**
3443      * Codec implemented by the hardware accelerator.
3444      *
3445      * See AV_CODEC_ID_xxx
3446      */
3447     enum AVCodecID id;
3448
3449     /**
3450      * Supported pixel format.
3451      *
3452      * Only hardware accelerated formats are supported here.
3453      */
3454     enum AVPixelFormat pix_fmt;
3455
3456     /**
3457      * Hardware accelerated codec capabilities.
3458      * see HWACCEL_CODEC_CAP_*
3459      */
3460     int capabilities;
3461
3462     /*****************************************************************
3463      * No fields below this line are part of the public API. They
3464      * may not be used outside of libavcodec and can be changed and
3465      * removed at will.
3466      * New public fields should be added right above.
3467      *****************************************************************
3468      */
3469     struct AVHWAccel *next;
3470
3471     /**
3472      * Allocate a custom buffer
3473      */
3474     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3475
3476     /**
3477      * Called at the beginning of each frame or field picture.
3478      *
3479      * Meaningful frame information (codec specific) is guaranteed to
3480      * be parsed at this point. This function is mandatory.
3481      *
3482      * Note that buf can be NULL along with buf_size set to 0.
3483      * Otherwise, this means the whole frame is available at this point.
3484      *
3485      * @param avctx the codec context
3486      * @param buf the frame data buffer base
3487      * @param buf_size the size of the frame in bytes
3488      * @return zero if successful, a negative value otherwise
3489      */
3490     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3491
3492     /**
3493      * Callback for each slice.
3494      *
3495      * Meaningful slice information (codec specific) is guaranteed to
3496      * be parsed at this point. This function is mandatory.
3497      * The only exception is XvMC, that works on MB level.
3498      *
3499      * @param avctx the codec context
3500      * @param buf the slice data buffer base
3501      * @param buf_size the size of the slice in bytes
3502      * @return zero if successful, a negative value otherwise
3503      */
3504     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3505
3506     /**
3507      * Called at the end of each frame or field picture.
3508      *
3509      * The whole picture is parsed at this point and can now be sent
3510      * to the hardware accelerator. This function is mandatory.
3511      *
3512      * @param avctx the codec context
3513      * @return zero if successful, a negative value otherwise
3514      */
3515     int (*end_frame)(AVCodecContext *avctx);
3516
3517     /**
3518      * Size of per-frame hardware accelerator private data.
3519      *
3520      * Private data is allocated with av_mallocz() before
3521      * AVCodecContext.get_buffer() and deallocated after
3522      * AVCodecContext.release_buffer().
3523      */
3524     int frame_priv_data_size;
3525
3526     /**
3527      * Called for every Macroblock in a slice.
3528      *
3529      * XvMC uses it to replace the ff_mpv_decode_mb().
3530      * Instead of decoding to raw picture, MB parameters are
3531      * stored in an array provided by the video driver.
3532      *
3533      * @param s the mpeg context
3534      */
3535     void (*decode_mb)(struct MpegEncContext *s);
3536
3537     /**
3538      * Initialize the hwaccel private data.
3539      *
3540      * This will be called from ff_get_format(), after hwaccel and
3541      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3542      * is allocated.
3543      */
3544     int (*init)(AVCodecContext *avctx);
3545
3546     /**
3547      * Uninitialize the hwaccel private data.
3548      *
3549      * This will be called from get_format() or avcodec_close(), after hwaccel
3550      * and hwaccel_context are already uninitialized.
3551      */
3552     int (*uninit)(AVCodecContext *avctx);
3553
3554     /**
3555      * Size of the private data to allocate in
3556      * AVCodecInternal.hwaccel_priv_data.
3557      */
3558     int priv_data_size;
3559 } AVHWAccel;
3560