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