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