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