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