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