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