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