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