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