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