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