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