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