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