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