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