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