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