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