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