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