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