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