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