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