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