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