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