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