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