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