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