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