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