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