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