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