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