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