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