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