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