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