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