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