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