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