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