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