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