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