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