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