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