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