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