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