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