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