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