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