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