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