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