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