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