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