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