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