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