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