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