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