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