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