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