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