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