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