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