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