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