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