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