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