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