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