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