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