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