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