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