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