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