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