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