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