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