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