Escape 124 (RPL) 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 FFMPEG_AVCODEC_H
22 #define FFMPEG_AVCODEC_H
23
24 /**
25  * @file avcodec.h
26  * external API header
27  */
28
29
30 #include "libavutil/avutil.h"
31
32 #define LIBAVCODEC_VERSION_MAJOR 51
33 #define LIBAVCODEC_VERSION_MINOR 54
34 #define LIBAVCODEC_VERSION_MICRO  0
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     CODEC_ID_MPEG1VIDEO,
65     CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
66     CODEC_ID_MPEG2VIDEO_XVMC,
67     CODEC_ID_H261,
68     CODEC_ID_H263,
69     CODEC_ID_RV10,
70     CODEC_ID_RV20,
71     CODEC_ID_MJPEG,
72     CODEC_ID_MJPEGB,
73     CODEC_ID_LJPEG,
74     CODEC_ID_SP5X,
75     CODEC_ID_JPEGLS,
76     CODEC_ID_MPEG4,
77     CODEC_ID_RAWVIDEO,
78     CODEC_ID_MSMPEG4V1,
79     CODEC_ID_MSMPEG4V2,
80     CODEC_ID_MSMPEG4V3,
81     CODEC_ID_WMV1,
82     CODEC_ID_WMV2,
83     CODEC_ID_H263P,
84     CODEC_ID_H263I,
85     CODEC_ID_FLV1,
86     CODEC_ID_SVQ1,
87     CODEC_ID_SVQ3,
88     CODEC_ID_DVVIDEO,
89     CODEC_ID_HUFFYUV,
90     CODEC_ID_CYUV,
91     CODEC_ID_H264,
92     CODEC_ID_INDEO3,
93     CODEC_ID_VP3,
94     CODEC_ID_THEORA,
95     CODEC_ID_ASV1,
96     CODEC_ID_ASV2,
97     CODEC_ID_FFV1,
98     CODEC_ID_4XM,
99     CODEC_ID_VCR1,
100     CODEC_ID_CLJR,
101     CODEC_ID_MDEC,
102     CODEC_ID_ROQ,
103     CODEC_ID_INTERPLAY_VIDEO,
104     CODEC_ID_XAN_WC3,
105     CODEC_ID_XAN_WC4,
106     CODEC_ID_RPZA,
107     CODEC_ID_CINEPAK,
108     CODEC_ID_WS_VQA,
109     CODEC_ID_MSRLE,
110     CODEC_ID_MSVIDEO1,
111     CODEC_ID_IDCIN,
112     CODEC_ID_8BPS,
113     CODEC_ID_SMC,
114     CODEC_ID_FLIC,
115     CODEC_ID_TRUEMOTION1,
116     CODEC_ID_VMDVIDEO,
117     CODEC_ID_MSZH,
118     CODEC_ID_ZLIB,
119     CODEC_ID_QTRLE,
120     CODEC_ID_SNOW,
121     CODEC_ID_TSCC,
122     CODEC_ID_ULTI,
123     CODEC_ID_QDRAW,
124     CODEC_ID_VIXL,
125     CODEC_ID_QPEG,
126     CODEC_ID_XVID,
127     CODEC_ID_PNG,
128     CODEC_ID_PPM,
129     CODEC_ID_PBM,
130     CODEC_ID_PGM,
131     CODEC_ID_PGMYUV,
132     CODEC_ID_PAM,
133     CODEC_ID_FFVHUFF,
134     CODEC_ID_RV30,
135     CODEC_ID_RV40,
136     CODEC_ID_VC1,
137     CODEC_ID_WMV3,
138     CODEC_ID_LOCO,
139     CODEC_ID_WNV1,
140     CODEC_ID_AASC,
141     CODEC_ID_INDEO2,
142     CODEC_ID_FRAPS,
143     CODEC_ID_TRUEMOTION2,
144     CODEC_ID_BMP,
145     CODEC_ID_CSCD,
146     CODEC_ID_MMVIDEO,
147     CODEC_ID_ZMBV,
148     CODEC_ID_AVS,
149     CODEC_ID_SMACKVIDEO,
150     CODEC_ID_NUV,
151     CODEC_ID_KMVC,
152     CODEC_ID_FLASHSV,
153     CODEC_ID_CAVS,
154     CODEC_ID_JPEG2000,
155     CODEC_ID_VMNC,
156     CODEC_ID_VP5,
157     CODEC_ID_VP6,
158     CODEC_ID_VP6F,
159     CODEC_ID_TARGA,
160     CODEC_ID_DSICINVIDEO,
161     CODEC_ID_TIERTEXSEQVIDEO,
162     CODEC_ID_TIFF,
163     CODEC_ID_GIF,
164     CODEC_ID_FFH264,
165     CODEC_ID_DXA,
166     CODEC_ID_DNXHD,
167     CODEC_ID_THP,
168     CODEC_ID_SGI,
169     CODEC_ID_C93,
170     CODEC_ID_BETHSOFTVID,
171     CODEC_ID_PTX,
172     CODEC_ID_TXD,
173     CODEC_ID_VP6A,
174     CODEC_ID_AMV,
175     CODEC_ID_VB,
176     CODEC_ID_PCX,
177     CODEC_ID_SUNRAST,
178     CODEC_ID_INDEO4,
179     CODEC_ID_INDEO5,
180     CODEC_ID_MIMIC,
181     CODEC_ID_RL2,
182     CODEC_ID_8SVX_EXP,
183     CODEC_ID_8SVX_FIB,
184     CODEC_ID_ESCAPE124,
185
186     /* various PCM "codecs" */
187     CODEC_ID_PCM_S16LE= 0x10000,
188     CODEC_ID_PCM_S16BE,
189     CODEC_ID_PCM_U16LE,
190     CODEC_ID_PCM_U16BE,
191     CODEC_ID_PCM_S8,
192     CODEC_ID_PCM_U8,
193     CODEC_ID_PCM_MULAW,
194     CODEC_ID_PCM_ALAW,
195     CODEC_ID_PCM_S32LE,
196     CODEC_ID_PCM_S32BE,
197     CODEC_ID_PCM_U32LE,
198     CODEC_ID_PCM_U32BE,
199     CODEC_ID_PCM_S24LE,
200     CODEC_ID_PCM_S24BE,
201     CODEC_ID_PCM_U24LE,
202     CODEC_ID_PCM_U24BE,
203     CODEC_ID_PCM_S24DAUD,
204     CODEC_ID_PCM_ZORK,
205     CODEC_ID_PCM_S16LE_PLANAR,
206
207     /* various ADPCM codecs */
208     CODEC_ID_ADPCM_IMA_QT= 0x11000,
209     CODEC_ID_ADPCM_IMA_WAV,
210     CODEC_ID_ADPCM_IMA_DK3,
211     CODEC_ID_ADPCM_IMA_DK4,
212     CODEC_ID_ADPCM_IMA_WS,
213     CODEC_ID_ADPCM_IMA_SMJPEG,
214     CODEC_ID_ADPCM_MS,
215     CODEC_ID_ADPCM_4XM,
216     CODEC_ID_ADPCM_XA,
217     CODEC_ID_ADPCM_ADX,
218     CODEC_ID_ADPCM_EA,
219     CODEC_ID_ADPCM_G726,
220     CODEC_ID_ADPCM_CT,
221     CODEC_ID_ADPCM_SWF,
222     CODEC_ID_ADPCM_YAMAHA,
223     CODEC_ID_ADPCM_SBPRO_4,
224     CODEC_ID_ADPCM_SBPRO_3,
225     CODEC_ID_ADPCM_SBPRO_2,
226     CODEC_ID_ADPCM_THP,
227     CODEC_ID_ADPCM_IMA_AMV,
228     CODEC_ID_ADPCM_EA_R1,
229     CODEC_ID_ADPCM_EA_R3,
230     CODEC_ID_ADPCM_EA_R2,
231     CODEC_ID_ADPCM_IMA_EA_SEAD,
232     CODEC_ID_ADPCM_IMA_EA_EACS,
233     CODEC_ID_ADPCM_EA_XAS,
234
235     /* AMR */
236     CODEC_ID_AMR_NB= 0x12000,
237     CODEC_ID_AMR_WB,
238
239     /* RealAudio codecs*/
240     CODEC_ID_RA_144= 0x13000,
241     CODEC_ID_RA_288,
242
243     /* various DPCM codecs */
244     CODEC_ID_ROQ_DPCM= 0x14000,
245     CODEC_ID_INTERPLAY_DPCM,
246     CODEC_ID_XAN_DPCM,
247     CODEC_ID_SOL_DPCM,
248
249     CODEC_ID_MP2= 0x15000,
250     CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
251     CODEC_ID_AAC,
252 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
253     CODEC_ID_MPEG4AAC,
254 #endif
255     CODEC_ID_AC3,
256     CODEC_ID_DTS,
257     CODEC_ID_VORBIS,
258     CODEC_ID_DVAUDIO,
259     CODEC_ID_WMAV1,
260     CODEC_ID_WMAV2,
261     CODEC_ID_MACE3,
262     CODEC_ID_MACE6,
263     CODEC_ID_VMDAUDIO,
264     CODEC_ID_SONIC,
265     CODEC_ID_SONIC_LS,
266     CODEC_ID_FLAC,
267     CODEC_ID_MP3ADU,
268     CODEC_ID_MP3ON4,
269     CODEC_ID_SHORTEN,
270     CODEC_ID_ALAC,
271     CODEC_ID_WESTWOOD_SND1,
272     CODEC_ID_GSM, ///< as in Berlin toast format
273     CODEC_ID_QDM2,
274     CODEC_ID_COOK,
275     CODEC_ID_TRUESPEECH,
276     CODEC_ID_TTA,
277     CODEC_ID_SMACKAUDIO,
278     CODEC_ID_QCELP,
279     CODEC_ID_WAVPACK,
280     CODEC_ID_DSICINAUDIO,
281     CODEC_ID_IMC,
282     CODEC_ID_MUSEPACK7,
283     CODEC_ID_MLP,
284     CODEC_ID_GSM_MS, /* as found in WAV */
285     CODEC_ID_ATRAC3,
286     CODEC_ID_VOXWARE,
287     CODEC_ID_APE,
288     CODEC_ID_NELLYMOSER,
289     CODEC_ID_MUSEPACK8,
290     CODEC_ID_SPEEX,
291     CODEC_ID_WMAVOICE,
292     CODEC_ID_WMAPRO,
293     CODEC_ID_WMALOSSLESS,
294
295     /* subtitle codecs */
296     CODEC_ID_DVD_SUBTITLE= 0x17000,
297     CODEC_ID_DVB_SUBTITLE,
298     CODEC_ID_TEXT,  ///< raw UTF-8 text
299     CODEC_ID_XSUB,
300     CODEC_ID_SSA,
301     CODEC_ID_MOV_TEXT,
302
303     /* other specific kind of codecs (generally used for attachments) */
304     CODEC_ID_TTF= 0x18000,
305
306     CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
307                                 * stream (only used by libavformat) */
308 };
309
310 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
311 /* CODEC_ID_MP3LAME is obsolete */
312 #define CODEC_ID_MP3LAME CODEC_ID_MP3
313 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
314 #endif
315
316 enum CodecType {
317     CODEC_TYPE_UNKNOWN = -1,
318     CODEC_TYPE_VIDEO,
319     CODEC_TYPE_AUDIO,
320     CODEC_TYPE_DATA,
321     CODEC_TYPE_SUBTITLE,
322     CODEC_TYPE_ATTACHMENT,
323     CODEC_TYPE_NB
324 };
325
326 /**
327  * Currently unused, may be used if 24/32 bits samples are ever supported.
328  * all in native-endian format
329  */
330 enum SampleFormat {
331     SAMPLE_FMT_NONE = -1,
332     SAMPLE_FMT_U8,              ///< unsigned 8 bits
333     SAMPLE_FMT_S16,             ///< signed 16 bits
334     SAMPLE_FMT_S24,             ///< signed 24 bits
335     SAMPLE_FMT_S32,             ///< signed 32 bits
336     SAMPLE_FMT_FLT,             ///< float
337 };
338
339 /* in bytes */
340 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
341
342 /**
343  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
344  * This is mainly needed because some optimized bitstream readers read
345  * 32 or 64 bit at once and could read over the end.<br>
346  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
347  * MPEG bitstreams could cause overread and segfault.
348  */
349 #define FF_INPUT_BUFFER_PADDING_SIZE 8
350
351 /**
352  * minimum encoding buffer size
353  * Used to avoid some checks during header writing.
354  */
355 #define FF_MIN_BUFFER_SIZE 16384
356
357 /**
358  * motion estimation type.
359  */
360 enum Motion_Est_ID {
361     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
362     ME_FULL,
363     ME_LOG,
364     ME_PHODS,
365     ME_EPZS,        ///< enhanced predictive zonal search
366     ME_X1,          ///< reserved for experiments
367     ME_HEX,         ///< hexagon based search
368     ME_UMH,         ///< uneven multi-hexagon search
369     ME_ITER,        ///< iterative search
370 };
371
372 enum AVDiscard{
373     /* We leave some space between them for extensions (drop some
374      * keyframes for intra-only or drop just some bidir frames). */
375     AVDISCARD_NONE   =-16, ///< discard nothing
376     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
377     AVDISCARD_NONREF =  8, ///< discard all non reference
378     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
379     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
380     AVDISCARD_ALL    = 48, ///< discard all
381 };
382
383 typedef struct RcOverride{
384     int start_frame;
385     int end_frame;
386     int qscale; // If this is 0 then quality_factor will be used instead.
387     float quality_factor;
388 } RcOverride;
389
390 #define FF_MAX_B_FRAMES 16
391
392 /* encoding support
393    These flags can be passed in AVCodecContext.flags before initialization.
394    Note: Not everything is supported yet.
395 */
396
397 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
398 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
399 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
400 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
401 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
402 #define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
403 /**
404  * The parent program guarantees that the input for B-frames containing
405  * streams is not written to for at least s->max_b_frames+1 frames, if
406  * this is not set the input will be copied.
407  */
408 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
409 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
410 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
411 #define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
412 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
413 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
414 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
415 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
416                                                   location instead of only at frame boundaries. */
417 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
418 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
419 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
420 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
421 #define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< Use trellis quantization.
422 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
423 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
424 /* Fx : Flag for h263+ extra options */
425 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
426 #define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
427 #endif
428 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
429 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
430 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
431 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
432 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
433 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
434 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
435 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
436 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
437 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
438 #define CODEC_FLAG_CLOSED_GOP     0x80000000
439 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
440 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
441 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
442 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
443 #define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
444 #define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
445 #define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
446 #define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
447 #define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
448 #define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
449 #define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
450 #define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
451 #define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
452 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
453 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
454 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
455 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
456 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
457
458 /* Unsupported options :
459  *              Syntax Arithmetic coding (SAC)
460  *              Reference Picture Selection
461  *              Independent Segment Decoding */
462 /* /Fx */
463 /* codec capabilities */
464
465 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
466 /**
467  * Codec uses get_buffer() for allocating buffers.
468  * direct rendering method 1
469  */
470 #define CODEC_CAP_DR1             0x0002
471 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
472 #define CODEC_CAP_PARSE_ONLY      0x0004
473 #define CODEC_CAP_TRUNCATED       0x0008
474 /* Codec can export data for HW decoding (XvMC). */
475 #define CODEC_CAP_HWACCEL         0x0010
476 /**
477  * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
478  * If this is not set, the codec is guaranteed to never be fed with NULL data.
479  */
480 #define CODEC_CAP_DELAY           0x0020
481 /**
482  * Codec can be fed a final frame with a smaller size.
483  * This can be used to prevent truncation of the last audio samples.
484  */
485 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
486
487 //The following defines may change, don't expect compatibility if you use them.
488 #define MB_TYPE_INTRA4x4   0x0001
489 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
490 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
491 #define MB_TYPE_16x16      0x0008
492 #define MB_TYPE_16x8       0x0010
493 #define MB_TYPE_8x16       0x0020
494 #define MB_TYPE_8x8        0x0040
495 #define MB_TYPE_INTERLACED 0x0080
496 #define MB_TYPE_DIRECT2    0x0100 //FIXME
497 #define MB_TYPE_ACPRED     0x0200
498 #define MB_TYPE_GMC        0x0400
499 #define MB_TYPE_SKIP       0x0800
500 #define MB_TYPE_P0L0       0x1000
501 #define MB_TYPE_P1L0       0x2000
502 #define MB_TYPE_P0L1       0x4000
503 #define MB_TYPE_P1L1       0x8000
504 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
505 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
506 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
507 #define MB_TYPE_QUANT      0x00010000
508 #define MB_TYPE_CBP        0x00020000
509 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
510
511 /**
512  * Pan Scan area.
513  * This specifies the area which should be displayed.
514  * Note there may be multiple such areas for one frame.
515  */
516 typedef struct AVPanScan{
517     /**
518      * id
519      * - encoding: Set by user.
520      * - decoding: Set by libavcodec.
521      */
522     int id;
523
524     /**
525      * width and height in 1/16 pel
526      * - encoding: Set by user.
527      * - decoding: Set by libavcodec.
528      */
529     int width;
530     int height;
531
532     /**
533      * position of the top left corner in 1/16 pel for up to 3 fields/frames
534      * - encoding: Set by user.
535      * - decoding: Set by libavcodec.
536      */
537     int16_t position[3][2];
538 }AVPanScan;
539
540 #define FF_COMMON_FRAME \
541     /**\
542      * pointer to the picture planes.\
543      * This might be different from the first allocated byte\
544      * - encoding: \
545      * - decoding: \
546      */\
547     uint8_t *data[4];\
548     int linesize[4];\
549     /**\
550      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
551      * This isn't used by libavcodec unless the default get/release_buffer() is used.\
552      * - encoding: \
553      * - decoding: \
554      */\
555     uint8_t *base[4];\
556     /**\
557      * 1 -> keyframe, 0-> not\
558      * - encoding: Set by libavcodec.\
559      * - decoding: Set by libavcodec.\
560      */\
561     int key_frame;\
562 \
563     /**\
564      * Picture type of the frame, see ?_TYPE below.\
565      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
566      * - decoding: Set by libavcodec.\
567      */\
568     int pict_type;\
569 \
570     /**\
571      * presentation timestamp in time_base units (time when frame should be shown to user)\
572      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
573      * - encoding: MUST be set by user.\
574      * - decoding: Set by libavcodec.\
575      */\
576     int64_t pts;\
577 \
578     /**\
579      * picture number in bitstream order\
580      * - encoding: set by\
581      * - decoding: Set by libavcodec.\
582      */\
583     int coded_picture_number;\
584     /**\
585      * picture number in display order\
586      * - encoding: set by\
587      * - decoding: Set by libavcodec.\
588      */\
589     int display_picture_number;\
590 \
591     /**\
592      * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
593      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
594      * - decoding: Set by libavcodec.\
595      */\
596     int quality; \
597 \
598     /**\
599      * buffer age (1->was last buffer and dint change, 2->..., ...).\
600      * Set to INT_MAX if the buffer has not been used yet.\
601      * - encoding: unused\
602      * - decoding: MUST be set by get_buffer().\
603      */\
604     int age;\
605 \
606     /**\
607      * is this picture used as reference\
608      * The values for this are the same as the MpegEncContext.picture_structure\
609      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
610      * - encoding: unused\
611      * - decoding: Set by libavcodec. (before get_buffer() call)).\
612      */\
613     int reference;\
614 \
615     /**\
616      * QP table\
617      * - encoding: unused\
618      * - decoding: Set by libavcodec.\
619      */\
620     int8_t *qscale_table;\
621     /**\
622      * QP store stride\
623      * - encoding: unused\
624      * - decoding: Set by libavcodec.\
625      */\
626     int qstride;\
627 \
628     /**\
629      * mbskip_table[mb]>=1 if MB didn't change\
630      * stride= mb_width = (width+15)>>4\
631      * - encoding: unused\
632      * - decoding: Set by libavcodec.\
633      */\
634     uint8_t *mbskip_table;\
635 \
636     /**\
637      * motion vector table\
638      * @code\
639      * example:\
640      * int mv_sample_log2= 4 - motion_subsample_log2;\
641      * int mb_width= (width+15)>>4;\
642      * int mv_stride= (mb_width << mv_sample_log2) + 1;\
643      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
644      * @endcode\
645      * - encoding: Set by user.\
646      * - decoding: Set by libavcodec.\
647      */\
648     int16_t (*motion_val[2])[2];\
649 \
650     /**\
651      * macroblock type table\
652      * mb_type_base + mb_width + 2\
653      * - encoding: Set by user.\
654      * - decoding: Set by libavcodec.\
655      */\
656     uint32_t *mb_type;\
657 \
658     /**\
659      * log2 of the size of the block which a single vector in motion_val represents: \
660      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
661      * - encoding: unused\
662      * - decoding: Set by libavcodec.\
663      */\
664     uint8_t motion_subsample_log2;\
665 \
666     /**\
667      * for some private data of the user\
668      * - encoding: unused\
669      * - decoding: Set by user.\
670      */\
671     void *opaque;\
672 \
673     /**\
674      * error\
675      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
676      * - decoding: unused\
677      */\
678     uint64_t error[4];\
679 \
680     /**\
681      * type of the buffer (to keep track of who has to deallocate data[*])\
682      * - encoding: Set by the one who allocates it.\
683      * - decoding: Set by the one who allocates it.\
684      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
685      */\
686     int type;\
687     \
688     /**\
689      * When decoding, this signals how much the picture must be delayed.\
690      * extra_delay = repeat_pict / (2*fps)\
691      * - encoding: unused\
692      * - decoding: Set by libavcodec.\
693      */\
694     int repeat_pict;\
695     \
696     /**\
697      * \
698      */\
699     int qscale_type;\
700     \
701     /**\
702      * The content of the picture is interlaced.\
703      * - encoding: Set by user.\
704      * - decoding: Set by libavcodec. (default 0)\
705      */\
706     int interlaced_frame;\
707     \
708     /**\
709      * If the content is interlaced, is top field displayed first.\
710      * - encoding: Set by user.\
711      * - decoding: Set by libavcodec.\
712      */\
713     int top_field_first;\
714     \
715     /**\
716      * Pan scan.\
717      * - encoding: Set by user.\
718      * - decoding: Set by libavcodec.\
719      */\
720     AVPanScan *pan_scan;\
721     \
722     /**\
723      * Tell user application that palette has changed from previous frame.\
724      * - encoding: ??? (no palette-enabled encoder yet)\
725      * - decoding: Set by libavcodec. (default 0).\
726      */\
727     int palette_has_changed;\
728     \
729     /**\
730      * codec suggestion on buffer type if != 0\
731      * - encoding: unused\
732      * - decoding: Set by libavcodec. (before get_buffer() call)).\
733      */\
734     int buffer_hints;\
735 \
736     /**\
737      * DCT coefficients\
738      * - encoding: unused\
739      * - decoding: Set by libavcodec.\
740      */\
741     short *dct_coeff;\
742 \
743     /**\
744      * motion referece frame index\
745      * - encoding: Set by user.\
746      * - decoding: Set by libavcodec.\
747      */\
748     int8_t *ref_index[2];
749
750 #define FF_QSCALE_TYPE_MPEG1 0
751 #define FF_QSCALE_TYPE_MPEG2 1
752 #define FF_QSCALE_TYPE_H264  2
753
754 #define FF_BUFFER_TYPE_INTERNAL 1
755 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
756 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
757 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
758
759
760 #define FF_I_TYPE  1 ///< Intra
761 #define FF_P_TYPE  2 ///< Predicted
762 #define FF_B_TYPE  3 ///< Bi-dir predicted
763 #define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
764 #define FF_SI_TYPE 5 ///< Switching Intra
765 #define FF_SP_TYPE 6 ///< Switching Predicted
766 #define FF_BI_TYPE 7
767
768 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
769 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
770 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
771 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
772
773 /**
774  * Audio Video Frame.
775  * New fields can be added to the end of FF_COMMON_FRAME with minor version
776  * bumps.
777  * Removal, reordering and changes to existing fields require a major
778  * version bump. No fields should be added into AVFrame before or after
779  * FF_COMMON_FRAME!
780  * sizeof(AVFrame) must not be used outside libav*.
781  */
782 typedef struct AVFrame {
783     FF_COMMON_FRAME
784 } AVFrame;
785
786 #define DEFAULT_FRAME_RATE_BASE 1001000
787
788 /**
789  * main external API structure.
790  * New fields can be added to the end with minor version bumps.
791  * Removal, reordering and changes to existing fields require a major
792  * version bump.
793  * sizeof(AVCodecContext) must not be used outside libav*.
794  */
795 typedef struct AVCodecContext {
796     /**
797      * information on struct for av_log
798      * - set by avcodec_alloc_context
799      */
800     const AVClass *av_class;
801     /**
802      * the average bitrate
803      * - encoding: Set by user; unused for constant quantizer encoding.
804      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
805      */
806     int bit_rate;
807
808     /**
809      * number of bits the bitstream is allowed to diverge from the reference.
810      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
811      * - encoding: Set by user; unused for constant quantizer encoding.
812      * - decoding: unused
813      */
814     int bit_rate_tolerance;
815
816     /**
817      * CODEC_FLAG_*.
818      * - encoding: Set by user.
819      * - decoding: Set by user.
820      */
821     int flags;
822
823     /**
824      * Some codecs need additional format info. It is stored here.
825      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
826      * specific codec MUST set it correctly otherwise stream copy breaks.
827      * In general use of this field by muxers is not recommanded.
828      * - encoding: Set by libavcodec.
829      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
830      */
831     int sub_id;
832
833     /**
834      * Motion estimation algorithm used for video coding.
835      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
836      * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
837      * - encoding: MUST be set by user.
838      * - decoding: unused
839      */
840     int me_method;
841
842     /**
843      * some codecs need / can use extradata like Huffman tables.
844      * mjpeg: Huffman tables
845      * rv10: additional flags
846      * mpeg4: global headers (they can be in the bitstream or here)
847      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
848      * than extradata_size to avoid prolems if it is read with the bitstream reader.
849      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
850      * - encoding: Set/allocated/freed by libavcodec.
851      * - decoding: Set/allocated/freed by user.
852      */
853     uint8_t *extradata;
854     int extradata_size;
855
856     /**
857      * This is the fundamental unit of time (in seconds) in terms
858      * of which frame timestamps are represented. For fixed-fps content,
859      * timebase should be 1/framerate and timestamp increments should be
860      * identically 1.
861      * - encoding: MUST be set by user.
862      * - decoding: Set by libavcodec.
863      */
864     AVRational time_base;
865
866     /* video only */
867     /**
868      * picture width / height.
869      * - encoding: MUST be set by user.
870      * - decoding: Set by libavcodec.
871      * Note: For compatibility it is possible to set this instead of
872      * coded_width/height before decoding.
873      */
874     int width, height;
875
876 #define FF_ASPECT_EXTENDED 15
877
878     /**
879      * the number of pictures in a group of pictures, or 0 for intra_only
880      * - encoding: Set by user.
881      * - decoding: unused
882      */
883     int gop_size;
884
885     /**
886      * Pixel format, see PIX_FMT_xxx.
887      * - encoding: Set by user.
888      * - decoding: Set by libavcodec.
889      */
890     enum PixelFormat pix_fmt;
891
892     /**
893      * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
894      * has to read frames at native frame rate.
895      * - encoding: Set by user.
896      * - decoding: unused
897      */
898     int rate_emu;
899
900     /**
901      * If non NULL, 'draw_horiz_band' is called by the libavcodec
902      * decoder to draw a horizontal band. It improves cache usage. Not
903      * all codecs can do that. You must check the codec capabilities
904      * beforehand.
905      * - encoding: unused
906      * - decoding: Set by user.
907      * @param height the height of the slice
908      * @param y the y position of the slice
909      * @param type 1->top field, 2->bottom field, 3->frame
910      * @param offset offset into the AVFrame.data from which the slice should be read
911      */
912     void (*draw_horiz_band)(struct AVCodecContext *s,
913                             const AVFrame *src, int offset[4],
914                             int y, int type, int height);
915
916     /* audio only */
917     int sample_rate; ///< samples per second
918     int channels;
919
920     /**
921      * audio sample format
922      * - encoding: Set by user.
923      * - decoding: Set by libavcodec.
924      */
925     enum SampleFormat sample_fmt;  ///< sample format, currently unused
926
927     /* The following data should not be initialized. */
928     /**
929      * Samples per packet, initialized when calling 'init'.
930      */
931     int frame_size;
932     int frame_number;   ///< audio or video frame number
933     int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
934
935     /**
936      * Number of frames the decoded output will be delayed relative to
937      * the encoded input.
938      * - encoding: Set by libavcodec.
939      * - decoding: unused
940      */
941     int delay;
942
943     /* - encoding parameters */
944     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
945     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
946
947     /**
948      * minimum quantizer
949      * - encoding: Set by user.
950      * - decoding: unused
951      */
952     int qmin;
953
954     /**
955      * maximum quantizer
956      * - encoding: Set by user.
957      * - decoding: unused
958      */
959     int qmax;
960
961     /**
962      * maximum quantizer difference between frames
963      * - encoding: Set by user.
964      * - decoding: unused
965      */
966     int max_qdiff;
967
968     /**
969      * maximum number of B-frames between non-B-frames
970      * Note: The output will be delayed by max_b_frames+1 relative to the input.
971      * - encoding: Set by user.
972      * - decoding: unused
973      */
974     int max_b_frames;
975
976     /**
977      * qscale factor between IP and B-frames
978      * - encoding: Set by user.
979      * - decoding: unused
980      */
981     float b_quant_factor;
982
983     /** obsolete FIXME remove */
984     int rc_strategy;
985 #define FF_RC_STRATEGY_XVID 1
986
987     int b_frame_strategy;
988
989     /**
990      * hurry up amount
991      * - encoding: unused
992      * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
993      * @deprecated Deprecated in favor of skip_idct and skip_frame.
994      */
995     int hurry_up;
996
997     struct AVCodec *codec;
998
999     void *priv_data;
1000
1001 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1002     /* unused, FIXME remove*/
1003     int rtp_mode;
1004 #endif
1005
1006     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1007                             /* do its best to deliver a chunk with size     */
1008                             /* below rtp_payload_size, the chunk will start */
1009                             /* with a start code on some codecs like H.263. */
1010                             /* This doesn't take account of any particular  */
1011                             /* headers inside the transmitted RTP payload.  */
1012
1013
1014     /* The RTP callback: This function is called    */
1015     /* every time the encoder has a packet to send. */
1016     /* It depends on the encoder if the data starts */
1017     /* with a Start Code (it should). H.263 does.   */
1018     /* mb_nb contains the number of macroblocks     */
1019     /* encoded in the RTP payload.                  */
1020     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1021
1022     /* statistics, used for 2-pass encoding */
1023     int mv_bits;
1024     int header_bits;
1025     int i_tex_bits;
1026     int p_tex_bits;
1027     int i_count;
1028     int p_count;
1029     int skip_count;
1030     int misc_bits;
1031
1032     /**
1033      * number of bits used for the previously encoded frame
1034      * - encoding: Set by libavcodec.
1035      * - decoding: unused
1036      */
1037     int frame_bits;
1038
1039     /**
1040      * Private data of the user, can be used to carry app specific stuff.
1041      * - encoding: Set by user.
1042      * - decoding: Set by user.
1043      */
1044     void *opaque;
1045
1046     char codec_name[32];
1047     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1048     enum CodecID codec_id; /* see CODEC_ID_xxx */
1049
1050     /**
1051      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1052      * This is used to work around some encoder bugs.
1053      * A demuxer should set this to what is stored in the field used to identify the codec.
1054      * If there are multiple such fields in a container then the demuxer should choose the one
1055      * which maximizes the information about the used codec.
1056      * If the codec tag field in a container is larger then 32 bits then the demuxer should
1057      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1058      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1059      * first.
1060      * - encoding: Set by user, if not then the default based on codec_id will be used.
1061      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1062      */
1063     unsigned int codec_tag;
1064
1065     /**
1066      * Work around bugs in encoders which sometimes cannot be detected automatically.
1067      * - encoding: Set by user
1068      * - decoding: Set by user
1069      */
1070     int workaround_bugs;
1071 #define FF_BUG_AUTODETECT       1  ///< autodetection
1072 #define FF_BUG_OLD_MSMPEG4      2
1073 #define FF_BUG_XVID_ILACE       4
1074 #define FF_BUG_UMP4             8
1075 #define FF_BUG_NO_PADDING       16
1076 #define FF_BUG_AMV              32
1077 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1078 #define FF_BUG_QPEL_CHROMA      64
1079 #define FF_BUG_STD_QPEL         128
1080 #define FF_BUG_QPEL_CHROMA2     256
1081 #define FF_BUG_DIRECT_BLOCKSIZE 512
1082 #define FF_BUG_EDGE             1024
1083 #define FF_BUG_HPEL_CHROMA      2048
1084 #define FF_BUG_DC_CLIP          4096
1085 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1086 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1087
1088     /**
1089      * luma single coefficient elimination threshold
1090      * - encoding: Set by user.
1091      * - decoding: unused
1092      */
1093     int luma_elim_threshold;
1094
1095     /**
1096      * chroma single coeff elimination threshold
1097      * - encoding: Set by user.
1098      * - decoding: unused
1099      */
1100     int chroma_elim_threshold;
1101
1102     /**
1103      * strictly follow the standard (MPEG4, ...).
1104      * - encoding: Set by user.
1105      * - decoding: unused
1106      */
1107     int strict_std_compliance;
1108 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1109 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1110 #define FF_COMPLIANCE_NORMAL        0
1111 #define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1112 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1113
1114     /**
1115      * qscale offset between IP and B-frames
1116      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1117      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1118      * - encoding: Set by user.
1119      * - decoding: unused
1120      */
1121     float b_quant_offset;
1122
1123     /**
1124      * Error resilience; higher values will detect more errors but may
1125      * misdetect some more or less valid parts as errors.
1126      * - encoding: unused
1127      * - decoding: Set by user.
1128      */
1129     int error_resilience;
1130 #define FF_ER_CAREFUL         1
1131 #define FF_ER_COMPLIANT       2
1132 #define FF_ER_AGGRESSIVE      3
1133 #define FF_ER_VERY_AGGRESSIVE 4
1134
1135     /**
1136      * Called at the beginning of each frame to get a buffer for it.
1137      * If pic.reference is set then the frame will be read later by libavcodec.
1138      * avcodec_align_dimensions() should be used to find the required width and
1139      * height, as they normally need to be rounded up to the next multiple of 16.
1140      * - encoding: unused
1141      * - decoding: Set by libavcodec., user can override.
1142      */
1143     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1144
1145     /**
1146      * Called to release buffers which were allocated with get_buffer.
1147      * A released buffer can be reused in get_buffer().
1148      * pic.data[*] must be set to NULL.
1149      * - encoding: unused
1150      * - decoding: Set by libavcodec., user can override.
1151      */
1152     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1153
1154     /**
1155      * If 1 the stream has a 1 frame delay during decoding.
1156      * - encoding: Set by libavcodec.
1157      * - decoding: Set by libavcodec.
1158      */
1159     int has_b_frames;
1160
1161     /**
1162      * number of bytes per packet if constant and known or 0
1163      * Used by some WAV based audio codecs.
1164      */
1165     int block_align;
1166
1167     int parse_only; /* - decoding only: If true, only parsing is done
1168                        (function avcodec_parse_frame()). The frame
1169                        data is returned. Only MPEG codecs support this now. */
1170
1171     /**
1172      * 0-> h263 quant 1-> mpeg quant
1173      * - encoding: Set by user.
1174      * - decoding: unused
1175      */
1176     int mpeg_quant;
1177
1178     /**
1179      * pass1 encoding statistics output buffer
1180      * - encoding: Set by libavcodec.
1181      * - decoding: unused
1182      */
1183     char *stats_out;
1184
1185     /**
1186      * pass2 encoding statistics input buffer
1187      * Concatenated stuff from stats_out of pass1 should be placed here.
1188      * - encoding: Allocated/set/freed by user.
1189      * - decoding: unused
1190      */
1191     char *stats_in;
1192
1193     /**
1194      * ratecontrol qmin qmax limiting method
1195      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1196      * - encoding: Set by user.
1197      * - decoding: unused
1198      */
1199     float rc_qsquish;
1200
1201     float rc_qmod_amp;
1202     int rc_qmod_freq;
1203
1204     /**
1205      * ratecontrol override, see RcOverride
1206      * - encoding: Allocated/set/freed by user.
1207      * - decoding: unused
1208      */
1209     RcOverride *rc_override;
1210     int rc_override_count;
1211
1212     /**
1213      * rate control equation
1214      * - encoding: Set by user
1215      * - decoding: unused
1216      */
1217     const char *rc_eq;
1218
1219     /**
1220      * maximum bitrate
1221      * - encoding: Set by user.
1222      * - decoding: unused
1223      */
1224     int rc_max_rate;
1225
1226     /**
1227      * minimum bitrate
1228      * - encoding: Set by user.
1229      * - decoding: unused
1230      */
1231     int rc_min_rate;
1232
1233     /**
1234      * decoder bitstream buffer size
1235      * - encoding: Set by user.
1236      * - decoding: unused
1237      */
1238     int rc_buffer_size;
1239     float rc_buffer_aggressivity;
1240
1241     /**
1242      * qscale factor between P and I-frames
1243      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1244      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1245      * - encoding: Set by user.
1246      * - decoding: unused
1247      */
1248     float i_quant_factor;
1249
1250     /**
1251      * qscale offset between P and I-frames
1252      * - encoding: Set by user.
1253      * - decoding: unused
1254      */
1255     float i_quant_offset;
1256
1257     /**
1258      * initial complexity for pass1 ratecontrol
1259      * - encoding: Set by user.
1260      * - decoding: unused
1261      */
1262     float rc_initial_cplx;
1263
1264     /**
1265      * DCT algorithm, see FF_DCT_* below
1266      * - encoding: Set by user.
1267      * - decoding: unused
1268      */
1269     int dct_algo;
1270 #define FF_DCT_AUTO    0
1271 #define FF_DCT_FASTINT 1
1272 #define FF_DCT_INT     2
1273 #define FF_DCT_MMX     3
1274 #define FF_DCT_MLIB    4
1275 #define FF_DCT_ALTIVEC 5
1276 #define FF_DCT_FAAN    6
1277
1278     /**
1279      * luminance masking (0-> disabled)
1280      * - encoding: Set by user.
1281      * - decoding: unused
1282      */
1283     float lumi_masking;
1284
1285     /**
1286      * temporary complexity masking (0-> disabled)
1287      * - encoding: Set by user.
1288      * - decoding: unused
1289      */
1290     float temporal_cplx_masking;
1291
1292     /**
1293      * spatial complexity masking (0-> disabled)
1294      * - encoding: Set by user.
1295      * - decoding: unused
1296      */
1297     float spatial_cplx_masking;
1298
1299     /**
1300      * p block masking (0-> disabled)
1301      * - encoding: Set by user.
1302      * - decoding: unused
1303      */
1304     float p_masking;
1305
1306     /**
1307      * darkness masking (0-> disabled)
1308      * - encoding: Set by user.
1309      * - decoding: unused
1310      */
1311     float dark_masking;
1312
1313
1314 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1315     /* for binary compatibility */
1316     int unused;
1317 #endif
1318
1319     /**
1320      * IDCT algorithm, see FF_IDCT_* below.
1321      * - encoding: Set by user.
1322      * - decoding: Set by user.
1323      */
1324     int idct_algo;
1325 #define FF_IDCT_AUTO          0
1326 #define FF_IDCT_INT           1
1327 #define FF_IDCT_SIMPLE        2
1328 #define FF_IDCT_SIMPLEMMX     3
1329 #define FF_IDCT_LIBMPEG2MMX   4
1330 #define FF_IDCT_PS2           5
1331 #define FF_IDCT_MLIB          6
1332 #define FF_IDCT_ARM           7
1333 #define FF_IDCT_ALTIVEC       8
1334 #define FF_IDCT_SH4           9
1335 #define FF_IDCT_SIMPLEARM     10
1336 #define FF_IDCT_H264          11
1337 #define FF_IDCT_VP3           12
1338 #define FF_IDCT_IPP           13
1339 #define FF_IDCT_XVIDMMX       14
1340 #define FF_IDCT_CAVS          15
1341 #define FF_IDCT_SIMPLEARMV5TE 16
1342 #define FF_IDCT_SIMPLEARMV6   17
1343 #define FF_IDCT_SIMPLEVIS     18
1344 #define FF_IDCT_WMV2          19
1345 #define FF_IDCT_FAAN          20
1346
1347     /**
1348      * slice count
1349      * - encoding: Set by libavcodec.
1350      * - decoding: Set by user (or 0).
1351      */
1352     int slice_count;
1353     /**
1354      * slice offsets in the frame in bytes
1355      * - encoding: Set/allocated by libavcodec.
1356      * - decoding: Set/allocated by user (or NULL).
1357      */
1358     int *slice_offset;
1359
1360     /**
1361      * error concealment flags
1362      * - encoding: unused
1363      * - decoding: Set by user.
1364      */
1365     int error_concealment;
1366 #define FF_EC_GUESS_MVS   1
1367 #define FF_EC_DEBLOCK     2
1368
1369     /**
1370      * dsp_mask could be add used to disable unwanted CPU features
1371      * CPU features (i.e. MMX, SSE. ...)
1372      *
1373      * With the FORCE flag you may instead enable given CPU features.
1374      * (Dangerous: Usable in case of misdetection, improper usage however will
1375      * result into program crash.)
1376      */
1377     unsigned dsp_mask;
1378 #define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1379     /* lower 16 bits - CPU features */
1380 #define FF_MM_MMX      0x0001 ///< standard MMX
1381 #define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1382 #define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1383 #define FF_MM_SSE      0x0008 ///< SSE functions
1384 #define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1385 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1386 #define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1387 #define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1388 #define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1389
1390     /**
1391      * bits per sample/pixel from the demuxer (needed for huffyuv).
1392      * - encoding: Set by libavcodec.
1393      * - decoding: Set by user.
1394      */
1395      int bits_per_sample;
1396
1397     /**
1398      * prediction method (needed for huffyuv)
1399      * - encoding: Set by user.
1400      * - decoding: unused
1401      */
1402      int prediction_method;
1403 #define FF_PRED_LEFT   0
1404 #define FF_PRED_PLANE  1
1405 #define FF_PRED_MEDIAN 2
1406
1407     /**
1408      * sample aspect ratio (0 if unknown)
1409      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1410      * - encoding: Set by user.
1411      * - decoding: Set by libavcodec.
1412      */
1413     AVRational sample_aspect_ratio;
1414
1415     /**
1416      * the picture in the bitstream
1417      * - encoding: Set by libavcodec.
1418      * - decoding: Set by libavcodec.
1419      */
1420     AVFrame *coded_frame;
1421
1422     /**
1423      * debug
1424      * - encoding: Set by user.
1425      * - decoding: Set by user.
1426      */
1427     int debug;
1428 #define FF_DEBUG_PICT_INFO   1
1429 #define FF_DEBUG_RC          2
1430 #define FF_DEBUG_BITSTREAM   4
1431 #define FF_DEBUG_MB_TYPE     8
1432 #define FF_DEBUG_QP          16
1433 #define FF_DEBUG_MV          32
1434 #define FF_DEBUG_DCT_COEFF   0x00000040
1435 #define FF_DEBUG_SKIP        0x00000080
1436 #define FF_DEBUG_STARTCODE   0x00000100
1437 #define FF_DEBUG_PTS         0x00000200
1438 #define FF_DEBUG_ER          0x00000400
1439 #define FF_DEBUG_MMCO        0x00000800
1440 #define FF_DEBUG_BUGS        0x00001000
1441 #define FF_DEBUG_VIS_QP      0x00002000
1442 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1443
1444     /**
1445      * debug
1446      * - encoding: Set by user.
1447      * - decoding: Set by user.
1448      */
1449     int debug_mv;
1450 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1451 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1452 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1453
1454     /**
1455      * error
1456      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1457      * - decoding: unused
1458      */
1459     uint64_t error[4];
1460
1461     /**
1462      * minimum MB quantizer
1463      * - encoding: unused
1464      * - decoding: unused
1465      */
1466     int mb_qmin;
1467
1468     /**
1469      * maximum MB quantizer
1470      * - encoding: unused
1471      * - decoding: unused
1472      */
1473     int mb_qmax;
1474
1475     /**
1476      * motion estimation comparison function
1477      * - encoding: Set by user.
1478      * - decoding: unused
1479      */
1480     int me_cmp;
1481     /**
1482      * subpixel motion estimation comparison function
1483      * - encoding: Set by user.
1484      * - decoding: unused
1485      */
1486     int me_sub_cmp;
1487     /**
1488      * macroblock comparison function (not supported yet)
1489      * - encoding: Set by user.
1490      * - decoding: unused
1491      */
1492     int mb_cmp;
1493     /**
1494      * interlaced DCT comparison function
1495      * - encoding: Set by user.
1496      * - decoding: unused
1497      */
1498     int ildct_cmp;
1499 #define FF_CMP_SAD    0
1500 #define FF_CMP_SSE    1
1501 #define FF_CMP_SATD   2
1502 #define FF_CMP_DCT    3
1503 #define FF_CMP_PSNR   4
1504 #define FF_CMP_BIT    5
1505 #define FF_CMP_RD     6
1506 #define FF_CMP_ZERO   7
1507 #define FF_CMP_VSAD   8
1508 #define FF_CMP_VSSE   9
1509 #define FF_CMP_NSSE   10
1510 #define FF_CMP_W53    11
1511 #define FF_CMP_W97    12
1512 #define FF_CMP_DCTMAX 13
1513 #define FF_CMP_DCT264 14
1514 #define FF_CMP_CHROMA 256
1515
1516     /**
1517      * ME diamond size & shape
1518      * - encoding: Set by user.
1519      * - decoding: unused
1520      */
1521     int dia_size;
1522
1523     /**
1524      * amount of previous MV predictors (2a+1 x 2a+1 square)
1525      * - encoding: Set by user.
1526      * - decoding: unused
1527      */
1528     int last_predictor_count;
1529
1530     /**
1531      * prepass for motion estimation
1532      * - encoding: Set by user.
1533      * - decoding: unused
1534      */
1535     int pre_me;
1536
1537     /**
1538      * motion estimation prepass comparison function
1539      * - encoding: Set by user.
1540      * - decoding: unused
1541      */
1542     int me_pre_cmp;
1543
1544     /**
1545      * ME prepass diamond size & shape
1546      * - encoding: Set by user.
1547      * - decoding: unused
1548      */
1549     int pre_dia_size;
1550
1551     /**
1552      * subpel ME quality
1553      * - encoding: Set by user.
1554      * - decoding: unused
1555      */
1556     int me_subpel_quality;
1557
1558     /**
1559      * callback to negotiate the pixelFormat
1560      * @param fmt is the list of formats which are supported by the codec,
1561      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1562      * The first is always the native one.
1563      * @return the chosen format
1564      * - encoding: unused
1565      * - decoding: Set by user, if not set the native format will be chosen.
1566      */
1567     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1568
1569     /**
1570      * DTG active format information (additional aspect ratio
1571      * information only used in DVB MPEG-2 transport streams)
1572      * 0 if not set.
1573      *
1574      * - encoding: unused
1575      * - decoding: Set by decoder.
1576      */
1577     int dtg_active_format;
1578 #define FF_DTG_AFD_SAME         8
1579 #define FF_DTG_AFD_4_3          9
1580 #define FF_DTG_AFD_16_9         10
1581 #define FF_DTG_AFD_14_9         11
1582 #define FF_DTG_AFD_4_3_SP_14_9  13
1583 #define FF_DTG_AFD_16_9_SP_14_9 14
1584 #define FF_DTG_AFD_SP_4_3       15
1585
1586     /**
1587      * maximum motion estimation search range in subpel units
1588      * If 0 then no limit.
1589      *
1590      * - encoding: Set by user.
1591      * - decoding: unused
1592      */
1593     int me_range;
1594
1595     /**
1596      * intra quantizer bias
1597      * - encoding: Set by user.
1598      * - decoding: unused
1599      */
1600     int intra_quant_bias;
1601 #define FF_DEFAULT_QUANT_BIAS 999999
1602
1603     /**
1604      * inter quantizer bias
1605      * - encoding: Set by user.
1606      * - decoding: unused
1607      */
1608     int inter_quant_bias;
1609
1610     /**
1611      * color table ID
1612      * - encoding: unused
1613      * - decoding: Which clrtable should be used for 8bit RGB images.
1614      *             Tables have to be stored somewhere. FIXME
1615      */
1616     int color_table_id;
1617
1618     /**
1619      * internal_buffer count
1620      * Don't touch, used by libavcodec default_get_buffer().
1621      */
1622     int internal_buffer_count;
1623
1624     /**
1625      * internal_buffers
1626      * Don't touch, used by libavcodec default_get_buffer().
1627      */
1628     void *internal_buffer;
1629
1630 #define FF_LAMBDA_SHIFT 7
1631 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1632 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1633 #define FF_LAMBDA_MAX (256*128-1)
1634
1635 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1636     /**
1637      * Global quality for codecs which cannot change it per frame.
1638      * This should be proportional to MPEG-1/2/4 qscale.
1639      * - encoding: Set by user.
1640      * - decoding: unused
1641      */
1642     int global_quality;
1643
1644 #define FF_CODER_TYPE_VLC       0
1645 #define FF_CODER_TYPE_AC        1
1646 #define FF_CODER_TYPE_RAW       2
1647 #define FF_CODER_TYPE_RLE       3
1648 #define FF_CODER_TYPE_DEFLATE   4
1649     /**
1650      * coder type
1651      * - encoding: Set by user.
1652      * - decoding: unused
1653      */
1654     int coder_type;
1655
1656     /**
1657      * context model
1658      * - encoding: Set by user.
1659      * - decoding: unused
1660      */
1661     int context_model;
1662 #if 0
1663     /**
1664      *
1665      * - encoding: unused
1666      * - decoding: Set by user.
1667      */
1668     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1669 #endif
1670
1671     /**
1672      * slice flags
1673      * - encoding: unused
1674      * - decoding: Set by user.
1675      */
1676     int slice_flags;
1677 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1678 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1679 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1680
1681     /**
1682      * XVideo Motion Acceleration
1683      * - encoding: forbidden
1684      * - decoding: set by decoder
1685      */
1686     int xvmc_acceleration;
1687
1688     /**
1689      * macroblock decision mode
1690      * - encoding: Set by user.
1691      * - decoding: unused
1692      */
1693     int mb_decision;
1694 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1695 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1696 #define FF_MB_DECISION_RD     2        ///< rate distoration
1697
1698     /**
1699      * custom intra quantization matrix
1700      * - encoding: Set by user, can be NULL.
1701      * - decoding: Set by libavcodec.
1702      */
1703     uint16_t *intra_matrix;
1704
1705     /**
1706      * custom inter quantization matrix
1707      * - encoding: Set by user, can be NULL.
1708      * - decoding: Set by libavcodec.
1709      */
1710     uint16_t *inter_matrix;
1711
1712     /**
1713      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1714      * This is used to work around some encoder bugs.
1715      * - encoding: unused
1716      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1717      */
1718     unsigned int stream_codec_tag;
1719
1720     /**
1721      * scene change detection threshold
1722      * 0 is default, larger means fewer detected scene changes.
1723      * - encoding: Set by user.
1724      * - decoding: unused
1725      */
1726     int scenechange_threshold;
1727
1728     /**
1729      * minimum Lagrange multipler
1730      * - encoding: Set by user.
1731      * - decoding: unused
1732      */
1733     int lmin;
1734
1735     /**
1736      * maximum Lagrange multipler
1737      * - encoding: Set by user.
1738      * - decoding: unused
1739      */
1740     int lmax;
1741
1742     /**
1743      * palette control structure
1744      * - encoding: ??? (no palette-enabled encoder yet)
1745      * - decoding: Set by user.
1746      */
1747     struct AVPaletteControl *palctrl;
1748
1749     /**
1750      * noise reduction strength
1751      * - encoding: Set by user.
1752      * - decoding: unused
1753      */
1754     int noise_reduction;
1755
1756     /**
1757      * Called at the beginning of a frame to get cr buffer for it.
1758      * Buffer type (size, hints) must be the same. libavcodec won't check it.
1759      * libavcodec will pass previous buffer in pic, function should return
1760      * same buffer or new buffer with old frame "painted" into it.
1761      * If pic.data[0] == NULL must behave like get_buffer().
1762      * - encoding: unused
1763      * - decoding: Set by libavcodec., user can override
1764      */
1765     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1766
1767     /**
1768      * Number of bits which should be loaded into the rc buffer before decoding starts.
1769      * - encoding: Set by user.
1770      * - decoding: unused
1771      */
1772     int rc_initial_buffer_occupancy;
1773
1774     /**
1775      *
1776      * - encoding: Set by user.
1777      * - decoding: unused
1778      */
1779     int inter_threshold;
1780
1781     /**
1782      * CODEC_FLAG2_*
1783      * - encoding: Set by user.
1784      * - decoding: Set by user.
1785      */
1786     int flags2;
1787
1788     /**
1789      * Simulates errors in the bitstream to test error concealment.
1790      * - encoding: Set by user.
1791      * - decoding: unused
1792      */
1793     int error_rate;
1794
1795     /**
1796      * MP3 antialias algorithm, see FF_AA_* below.
1797      * - encoding: unused
1798      * - decoding: Set by user.
1799      */
1800     int antialias_algo;
1801 #define FF_AA_AUTO    0
1802 #define FF_AA_FASTINT 1 //not implemented yet
1803 #define FF_AA_INT     2
1804 #define FF_AA_FLOAT   3
1805     /**
1806      * quantizer noise shaping
1807      * - encoding: Set by user.
1808      * - decoding: unused
1809      */
1810     int quantizer_noise_shaping;
1811
1812     /**
1813      * thread count
1814      * is used to decide how many independent tasks should be passed to execute()
1815      * - encoding: Set by user.
1816      * - decoding: Set by user.
1817      */
1818     int thread_count;
1819
1820     /**
1821      * The codec may call this to execute several independent things.
1822      * It will return only after finishing all tasks.
1823      * The user may replace this with some multithreaded implementation,
1824      * the default implementation will execute the parts serially.
1825      * @param count the number of things to execute
1826      * - encoding: Set by libavcodec, user can override.
1827      * - decoding: Set by libavcodec, user can override.
1828      */
1829     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1830
1831     /**
1832      * thread opaque
1833      * Can be used by execute() to store some per AVCodecContext stuff.
1834      * - encoding: set by execute()
1835      * - decoding: set by execute()
1836      */
1837     void *thread_opaque;
1838
1839     /**
1840      * Motion estimation threshold below which no motion estimation is
1841      * performed, but instead the user specified motion vectors are used.
1842      *
1843      * - encoding: Set by user.
1844      * - decoding: unused
1845      */
1846      int me_threshold;
1847
1848     /**
1849      * Macroblock threshold below which the user specified macroblock types will be used.
1850      * - encoding: Set by user.
1851      * - decoding: unused
1852      */
1853      int mb_threshold;
1854
1855     /**
1856      * precision of the intra DC coefficient - 8
1857      * - encoding: Set by user.
1858      * - decoding: unused
1859      */
1860      int intra_dc_precision;
1861
1862     /**
1863      * noise vs. sse weight for the nsse comparsion function
1864      * - encoding: Set by user.
1865      * - decoding: unused
1866      */
1867      int nsse_weight;
1868
1869     /**
1870      * Number of macroblock rows at the top which are skipped.
1871      * - encoding: unused
1872      * - decoding: Set by user.
1873      */
1874      int skip_top;
1875
1876     /**
1877      * Number of macroblock rows at the bottom which are skipped.
1878      * - encoding: unused
1879      * - decoding: Set by user.
1880      */
1881      int skip_bottom;
1882
1883     /**
1884      * profile
1885      * - encoding: Set by user.
1886      * - decoding: Set by libavcodec.
1887      */
1888      int profile;
1889 #define FF_PROFILE_UNKNOWN -99
1890 #define FF_PROFILE_AAC_MAIN 0
1891 #define FF_PROFILE_AAC_LOW  1
1892 #define FF_PROFILE_AAC_SSR  2
1893 #define FF_PROFILE_AAC_LTP  3
1894
1895     /**
1896      * level
1897      * - encoding: Set by user.
1898      * - decoding: Set by libavcodec.
1899      */
1900      int level;
1901 #define FF_LEVEL_UNKNOWN -99
1902
1903     /**
1904      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1905      * - encoding: unused
1906      * - decoding: Set by user.
1907      */
1908      int lowres;
1909
1910     /**
1911      * Bitstream width / height, may be different from width/height if lowres
1912      * or other things are used.
1913      * - encoding: unused
1914      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1915      */
1916     int coded_width, coded_height;
1917
1918     /**
1919      * frame skip threshold
1920      * - encoding: Set by user.
1921      * - decoding: unused
1922      */
1923     int frame_skip_threshold;
1924
1925     /**
1926      * frame skip factor
1927      * - encoding: Set by user.
1928      * - decoding: unused
1929      */
1930     int frame_skip_factor;
1931
1932     /**
1933      * frame skip exponent
1934      * - encoding: Set by user.
1935      * - decoding: unused
1936      */
1937     int frame_skip_exp;
1938
1939     /**
1940      * frame skip comparison function
1941      * - encoding: Set by user.
1942      * - decoding: unused
1943      */
1944     int frame_skip_cmp;
1945
1946     /**
1947      * Border processing masking, raises the quantizer for mbs on the borders
1948      * of the picture.
1949      * - encoding: Set by user.
1950      * - decoding: unused
1951      */
1952     float border_masking;
1953
1954     /**
1955      * minimum MB lagrange multipler
1956      * - encoding: Set by user.
1957      * - decoding: unused
1958      */
1959     int mb_lmin;
1960
1961     /**
1962      * maximum MB lagrange multipler
1963      * - encoding: Set by user.
1964      * - decoding: unused
1965      */
1966     int mb_lmax;
1967
1968     /**
1969      *
1970      * - encoding: Set by user.
1971      * - decoding: unused
1972      */
1973     int me_penalty_compensation;
1974
1975     /**
1976      *
1977      * - encoding: unused
1978      * - decoding: Set by user.
1979      */
1980     enum AVDiscard skip_loop_filter;
1981
1982     /**
1983      *
1984      * - encoding: unused
1985      * - decoding: Set by user.
1986      */
1987     enum AVDiscard skip_idct;
1988
1989     /**
1990      *
1991      * - encoding: unused
1992      * - decoding: Set by user.
1993      */
1994     enum AVDiscard skip_frame;
1995
1996     /**
1997      *
1998      * - encoding: Set by user.
1999      * - decoding: unused
2000      */
2001     int bidir_refine;
2002
2003     /**
2004      *
2005      * - encoding: Set by user.
2006      * - decoding: unused
2007      */
2008     int brd_scale;
2009
2010     /**
2011      * constant rate factor - quality-based VBR - values ~correspond to qps
2012      * - encoding: Set by user.
2013      * - decoding: unused
2014      */
2015     float crf;
2016
2017     /**
2018      * constant quantization parameter rate control method
2019      * - encoding: Set by user.
2020      * - decoding: unused
2021      */
2022     int cqp;
2023
2024     /**
2025      * minimum GOP size
2026      * - encoding: Set by user.
2027      * - decoding: unused
2028      */
2029     int keyint_min;
2030
2031     /**
2032      * number of reference frames
2033      * - encoding: Set by user.
2034      * - decoding: unused
2035      */
2036     int refs;
2037
2038     /**
2039      * chroma qp offset from luma
2040      * - encoding: Set by user.
2041      * - decoding: unused
2042      */
2043     int chromaoffset;
2044
2045     /**
2046      * Influences how often B-frames are used.
2047      * - encoding: Set by user.
2048      * - decoding: unused
2049      */
2050     int bframebias;
2051
2052     /**
2053      * trellis RD quantization
2054      * - encoding: Set by user.
2055      * - decoding: unused
2056      */
2057     int trellis;
2058
2059     /**
2060      * Reduce fluctuations in qp (before curve compression).
2061      * - encoding: Set by user.
2062      * - decoding: unused
2063      */
2064     float complexityblur;
2065
2066     /**
2067      * in-loop deblocking filter alphac0 parameter
2068      * alpha is in the range -6...6
2069      * - encoding: Set by user.
2070      * - decoding: unused
2071      */
2072     int deblockalpha;
2073
2074     /**
2075      * in-loop deblocking filter beta parameter
2076      * beta is in the range -6...6
2077      * - encoding: Set by user.
2078      * - decoding: unused
2079      */
2080     int deblockbeta;
2081
2082     /**
2083      * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2084      * - encoding: Set by user.
2085      * - decoding: unused
2086      */
2087     int partitions;
2088 #define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2089 #define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2090 #define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2091 #define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2092 #define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2093
2094     /**
2095      * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2096      * - encoding: Set by user.
2097      * - decoding: unused
2098      */
2099     int directpred;
2100
2101     /**
2102      * Audio cutoff bandwidth (0 means "automatic")
2103      * - encoding: Set by user.
2104      * - decoding: unused
2105      */
2106     int cutoff;
2107
2108     /**
2109      * Multiplied by qscale for each frame and added to scene_change_score.
2110      * - encoding: Set by user.
2111      * - decoding: unused
2112      */
2113     int scenechange_factor;
2114
2115     /**
2116      *
2117      * Note: Value depends upon the compare function used for fullpel ME.
2118      * - encoding: Set by user.
2119      * - decoding: unused
2120      */
2121     int mv0_threshold;
2122
2123     /**
2124      * Adjusts sensitivity of b_frame_strategy 1.
2125      * - encoding: Set by user.
2126      * - decoding: unused
2127      */
2128     int b_sensitivity;
2129
2130     /**
2131      * - encoding: Set by user.
2132      * - decoding: unused
2133      */
2134     int compression_level;
2135 #define FF_COMPRESSION_DEFAULT -1
2136
2137     /**
2138      * Sets whether to use LPC mode - used by FLAC encoder.
2139      * - encoding: Set by user.
2140      * - decoding: unused
2141      */
2142     int use_lpc;
2143
2144     /**
2145      * LPC coefficient precision - used by FLAC encoder
2146      * - encoding: Set by user.
2147      * - decoding: unused
2148      */
2149     int lpc_coeff_precision;
2150
2151     /**
2152      * - encoding: Set by user.
2153      * - decoding: unused
2154      */
2155     int min_prediction_order;
2156
2157     /**
2158      * - encoding: Set by user.
2159      * - decoding: unused
2160      */
2161     int max_prediction_order;
2162
2163     /**
2164      * search method for selecting prediction order
2165      * - encoding: Set by user.
2166      * - decoding: unused
2167      */
2168     int prediction_order_method;
2169
2170     /**
2171      * - encoding: Set by user.
2172      * - decoding: unused
2173      */
2174     int min_partition_order;
2175
2176     /**
2177      * - encoding: Set by user.
2178      * - decoding: unused
2179      */
2180     int max_partition_order;
2181
2182     /**
2183      * GOP timecode frame start number, in non drop frame format
2184      * - encoding: Set by user.
2185      * - decoding: unused
2186      */
2187     int64_t timecode_frame_start;
2188
2189     /**
2190      * Decoder should decode to this many channels if it can (0 for default)
2191      * - encoding: unused
2192      * - decoding: Set by user.
2193      */
2194     int request_channels;
2195
2196     /**
2197      * Percentage of dynamic range compression to be applied by the decoder.
2198      * The default value is 1.0, corresponding to full compression.
2199      * - encoding: unused
2200      * - decoding: Set by user.
2201      */
2202     float drc_scale;
2203 } AVCodecContext;
2204
2205 /**
2206  * AVCodec.
2207  */
2208 typedef struct AVCodec {
2209     /**
2210      * Name of the codec implementation.
2211      * The name is globally unique among encoders and among decoders (but an
2212      * encoder and a decoder can share the same name).
2213      * This is the primary way to find a codec from the user perspective.
2214      */
2215     const char *name;
2216     enum CodecType type;
2217     enum CodecID id;
2218     int priv_data_size;
2219     int (*init)(AVCodecContext *);
2220     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2221     int (*close)(AVCodecContext *);
2222     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2223                   const uint8_t *buf, int buf_size);
2224     /**
2225      * Codec capabilities.
2226      * see CODEC_CAP_*
2227      */
2228     int capabilities;
2229     struct AVCodec *next;
2230     /**
2231      * Flush buffers.
2232      * Will be called when seeking
2233      */
2234     void (*flush)(AVCodecContext *);
2235     const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2236     const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2237 } AVCodec;
2238
2239 /**
2240  * four components are given, that's all.
2241  * the last component is alpha
2242  */
2243 typedef struct AVPicture {
2244     uint8_t *data[4];
2245     int linesize[4];       ///< number of bytes per line
2246 } AVPicture;
2247
2248 /**
2249  * AVPaletteControl
2250  * This structure defines a method for communicating palette changes
2251  * between and demuxer and a decoder.
2252  *
2253  * @deprecated Use AVPacket to send palette changes instead.
2254  * This is totally broken.
2255  */
2256 #define AVPALETTE_SIZE 1024
2257 #define AVPALETTE_COUNT 256
2258 typedef struct AVPaletteControl {
2259
2260     /* Demuxer sets this to 1 to indicate the palette has changed;
2261      * decoder resets to 0. */
2262     int palette_changed;
2263
2264     /* 4-byte ARGB palette entries, stored in native byte order; note that
2265      * the individual palette components should be on a 8-bit scale; if
2266      * the palette data comes from an IBM VGA native format, the component
2267      * data is probably 6 bits in size and needs to be scaled. */
2268     unsigned int palette[AVPALETTE_COUNT];
2269
2270 } AVPaletteControl attribute_deprecated;
2271
2272 typedef struct AVSubtitleRect {
2273     uint16_t x;
2274     uint16_t y;
2275     uint16_t w;
2276     uint16_t h;
2277     uint16_t nb_colors;
2278     int linesize;
2279     uint32_t *rgba_palette;
2280     uint8_t *bitmap;
2281 } AVSubtitleRect;
2282
2283 typedef struct AVSubtitle {
2284     uint16_t format; /* 0 = graphics */
2285     uint32_t start_display_time; /* relative to packet pts, in ms */
2286     uint32_t end_display_time; /* relative to packet pts, in ms */
2287     uint32_t num_rects;
2288     AVSubtitleRect *rects;
2289 } AVSubtitle;
2290
2291
2292 /* resample.c */
2293
2294 struct ReSampleContext;
2295 struct AVResampleContext;
2296
2297 typedef struct ReSampleContext ReSampleContext;
2298
2299 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2300                                      int output_rate, int input_rate);
2301 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2302 void audio_resample_close(ReSampleContext *s);
2303
2304 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2305 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2306 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2307 void av_resample_close(struct AVResampleContext *c);
2308
2309 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2310 /* YUV420 format is assumed ! */
2311
2312 /**
2313  * @deprecated Use the software scaler (swscale) instead.
2314  */
2315 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2316
2317 /**
2318  * @deprecated Use the software scaler (swscale) instead.
2319  */
2320 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2321                                       int input_width, int input_height);
2322
2323 /**
2324  * @deprecated Use the software scaler (swscale) instead.
2325  */
2326 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2327                                       int iwidth, int iheight,
2328                                       int topBand, int bottomBand,
2329                                       int leftBand, int rightBand,
2330                                       int padtop, int padbottom,
2331                                       int padleft, int padright);
2332
2333 /**
2334  * @deprecated Use the software scaler (swscale) instead.
2335  */
2336 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2337                   AVPicture *output, const AVPicture *input);
2338
2339 /**
2340  * @deprecated Use the software scaler (swscale) instead.
2341  */
2342 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2343
2344 #endif
2345
2346 /**
2347  * Allocate memory for a picture.  Call avpicture_free to free it.
2348  *
2349  * @param picture the picture to be filled in
2350  * @param pix_fmt the format of the picture
2351  * @param width the width of the picture
2352  * @param height the height of the picture
2353  * @return zero if successful, a negative value if not
2354  */
2355 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2356
2357 /**
2358  * Free a picture previously allocated by avpicture_alloc().
2359  *
2360  * @param picture the AVPicture to be freed
2361  */
2362 void avpicture_free(AVPicture *picture);
2363
2364 /**
2365  * Fill in the AVPicture fields.
2366  * The fields of the given AVPicture are filled in by using the 'ptr' address
2367  * which points to the image data buffer. Depending on the specified picture
2368  * format, one or multiple image data pointers and line sizes will be set.
2369  * If a planar format is specified, several pointers will be set pointing to
2370  * the different picture planes and the line sizes of the different planes
2371  * will be stored in the lines_sizes array.
2372  *
2373  * @param picture AVPicture whose fields are to be filled in
2374  * @param ptr Buffer which will contain or contains the actual image data
2375  * @param pix_fmt The format in which the picture data is stored.
2376  * @param width the width of the image in pixels
2377  * @param height the height of the image in pixels
2378  * @return size of the image data in bytes
2379  */
2380 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2381                    int pix_fmt, int width, int height);
2382 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2383                      unsigned char *dest, int dest_size);
2384
2385 /**
2386  * Calculate the size in bytes that a picture of the given width and height
2387  * would occupy if stored in the given picture format.
2388  *
2389  * @param pix_fmt the given picture format
2390  * @param width the width of the image
2391  * @param height the height of the image
2392  * @return Image data size in bytes
2393  */
2394 int avpicture_get_size(int pix_fmt, int width, int height);
2395 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2396 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2397 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2398 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2399 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2400
2401 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2402 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2403 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2404 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2405 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2406 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2407
2408 /**
2409  * Computes what kind of losses will occur when converting from one specific
2410  * pixel format to another.
2411  * When converting from one pixel format to another, information loss may occur.
2412  * For example, when converting from RGB24 to GRAY, the color information will
2413  * be lost. Similarly, other losses occur when converting from some formats to
2414  * other formats. These losses can involve loss of chroma, but also loss of
2415  * resolution, loss of color depth, loss due to the color space conversion, loss
2416  * of the alpha bits or loss due to color quantization.
2417  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2418  * which will occur when converting from one pixel format to another.
2419  *
2420  * @param[in] dst_pix_fmt destination pixel format
2421  * @param[in] src_pix_fmt source pixel format
2422  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2423  * @return Combination of flags informing you what kind of losses will occur.
2424  */
2425 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2426                              int has_alpha);
2427
2428 /**
2429  * Finds the best pixel format to convert to given a certain source pixel
2430  * format.  When converting from one pixel format to another, information loss
2431  * may occur.  For example, when converting from RGB24 to GRAY, the color
2432  * information will be lost. Similarly, other losses occur when converting from
2433  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2434  * the given pixel formats should be used to suffer the least amount of loss.
2435  * The pixel formats from which it chooses one, are determined by the
2436  * \p pix_fmt_mask parameter.
2437  *
2438  * @code
2439  * src_pix_fmt = PIX_FMT_YUV420P;
2440  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2441  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2442  * @endcode
2443  *
2444  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2445  * @param[in] src_pix_fmt source pixel format
2446  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2447  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2448  * @return The best pixel format to convert to or -1 if none was found.
2449  */
2450 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2451                               int has_alpha, int *loss_ptr);
2452
2453
2454 /**
2455  * Print in buf the string corresponding to the pixel format with
2456  * number pix_fmt, or an header if pix_fmt is negative.
2457  *
2458  * @param[in] buf the buffer where to write the string
2459  * @param[in] buf_size the size of buf
2460  * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2461  * a negative value to print the corresponding header.
2462  * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2463  */
2464 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2465
2466 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2467 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2468
2469 /**
2470  * Tell if an image really has transparent alpha values.
2471  * @return ored mask of FF_ALPHA_xxx constants
2472  */
2473 int img_get_alpha_info(const AVPicture *src,
2474                        int pix_fmt, int width, int height);
2475
2476 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2477 /**
2478  * convert among pixel formats
2479  * @deprecated Use the software scaler (swscale) instead.
2480  */
2481 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2482                 const AVPicture *src, int pix_fmt,
2483                 int width, int height);
2484 #endif
2485
2486 /* deinterlace a picture */
2487 /* deinterlace - if not supported return -1 */
2488 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2489                           int pix_fmt, int width, int height);
2490
2491 /* external high level API */
2492
2493 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2494 extern AVCodec *first_avcodec;
2495 #endif
2496 AVCodec *av_codec_next(AVCodec *c);
2497
2498 /* returns LIBAVCODEC_VERSION_INT constant */
2499 unsigned avcodec_version(void);
2500 /* returns LIBAVCODEC_BUILD constant */
2501 unsigned avcodec_build(void);
2502
2503 /**
2504  * Initializes libavcodec.
2505  *
2506  * @warning This function \e must be called before any other libavcodec
2507  * function.
2508  */
2509 void avcodec_init(void);
2510
2511 void register_avcodec(AVCodec *format);
2512
2513 /**
2514  * Finds a registered encoder with a matching codec ID.
2515  *
2516  * @param id CodecID of the requested encoder
2517  * @return An encoder if one was found, NULL otherwise.
2518  */
2519 AVCodec *avcodec_find_encoder(enum CodecID id);
2520
2521 /**
2522  * Finds a registered encoder with the specified name.
2523  *
2524  * @param name name of the requested encoder
2525  * @return An encoder if one was found, NULL otherwise.
2526  */
2527 AVCodec *avcodec_find_encoder_by_name(const char *name);
2528
2529 /**
2530  * Finds a registered decoder with a matching codec ID.
2531  *
2532  * @param id CodecID of the requested decoder
2533  * @return A decoder if one was found, NULL otherwise.
2534  */
2535 AVCodec *avcodec_find_decoder(enum CodecID id);
2536
2537 /**
2538  * Finds a registered decoder with the specified name.
2539  *
2540  * @param name name of the requested decoder
2541  * @return A decoder if one was found, NULL otherwise.
2542  */
2543 AVCodec *avcodec_find_decoder_by_name(const char *name);
2544 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2545
2546 /**
2547  * Sets the fields of the given AVCodecContext to default values.
2548  *
2549  * @param s The AVCodecContext of which the fields should be set to default values.
2550  */
2551 void avcodec_get_context_defaults(AVCodecContext *s);
2552
2553 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2554  *  we WILL change its arguments and name a few times! */
2555 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2556
2557 /**
2558  * Allocates an AVCodecContext and sets its fields to default values.  The
2559  * resulting struct can be deallocated by simply calling av_free().
2560  *
2561  * @return An AVCodecContext filled with default values or NULL on failure.
2562  * @see avcodec_get_context_defaults
2563  */
2564 AVCodecContext *avcodec_alloc_context(void);
2565
2566 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2567  *  we WILL change its arguments and name a few times! */
2568 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2569
2570 /**
2571  * Sets the fields of the given AVFrame to default values.
2572  *
2573  * @param pic The AVFrame of which the fields should be set to default values.
2574  */
2575 void avcodec_get_frame_defaults(AVFrame *pic);
2576
2577 /**
2578  * Allocates an AVFrame and sets its fields to default values.  The resulting
2579  * struct can be deallocated by simply calling av_free().
2580  *
2581  * @return An AVFrame filled with default values or NULL on failure.
2582  * @see avcodec_get_frame_defaults
2583  */
2584 AVFrame *avcodec_alloc_frame(void);
2585
2586 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2587 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2588 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2589 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2590
2591 /**
2592  * Checks if the given dimension of a picture is valid, meaning that all
2593  * bytes of the picture can be addressed with a signed int.
2594  *
2595  * @param[in] w Width of the picture.
2596  * @param[in] h Height of the picture.
2597  * @return Zero if valid, a negative value if invalid.
2598  */
2599 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2600 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2601
2602 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2603 void avcodec_thread_free(AVCodecContext *s);
2604 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2605 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2606 //FIXME func typedef
2607
2608 /**
2609  * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2610  * function the context has to be allocated.
2611  *
2612  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2613  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2614  * retrieving a codec.
2615  *
2616  * @warning This function is not thread safe!
2617  *
2618  * @code
2619  * avcodec_register_all();
2620  * codec = avcodec_find_decoder(CODEC_ID_H264);
2621  * if (!codec)
2622  *     exit(1);
2623  *
2624  * context = avcodec_alloc_context();
2625  *
2626  * if (avcodec_open(context, codec) < 0)
2627  *     exit(1);
2628  * @endcode
2629  *
2630  * @param avctx The context which will be set up to use the given codec.
2631  * @param codec The codec to use within the context.
2632  * @return zero on success, a negative value on error
2633  * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2634  */
2635 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2636
2637 /**
2638  * @deprecated Use avcodec_decode_audio2() instead.
2639  */
2640 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2641                          int *frame_size_ptr,
2642                          const uint8_t *buf, int buf_size);
2643
2644 /**
2645  * Decodes an audio frame from \p buf into \p samples.
2646  * The avcodec_decode_audio2() function decodes an audio frame from the input
2647  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2648  * audio codec which was coupled with \p avctx using avcodec_open(). The
2649  * resulting decoded frame is stored in output buffer \p samples.  If no frame
2650  * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2651  * decompressed frame size in \e bytes.
2652  *
2653  * @warning You \e must set \p frame_size_ptr to the allocated size of the
2654  * output buffer before calling avcodec_decode_audio2().
2655  *
2656  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2657  * the actual read bytes because some optimized bitstream readers read 32 or 64
2658  * bits at once and could read over the end.
2659  *
2660  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2661  * no overreading happens for damaged MPEG streams.
2662  *
2663  * @note You might have to align the input buffer \p buf and output buffer \p
2664  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2665  * necessary at all, on others it won't work at all if not aligned and on others
2666  * it will work but it will have an impact on performance. In practice, the
2667  * bitstream should have 4 byte alignment at minimum and all sample data should
2668  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2669  * the linesize is not a multiple of 16 then there's no sense in aligning the
2670  * start of the buffer to 16.
2671  *
2672  * @param avctx the codec context
2673  * @param[out] samples the output buffer
2674  * @param[in,out] frame_size_ptr the output buffer size in bytes
2675  * @param[in] buf the input buffer
2676  * @param[in] buf_size the input buffer size in bytes
2677  * @return On error a negative value is returned, otherwise the number of bytes
2678  * used or zero if no frame could be decompressed.
2679  */
2680 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2681                          int *frame_size_ptr,
2682                          const uint8_t *buf, int buf_size);
2683
2684 /**
2685  * Decodes a video frame from \p buf into \p picture.
2686  * The avcodec_decode_video() function decodes a video frame from the input
2687  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2688  * video codec which was coupled with \p avctx using avcodec_open(). The
2689  * resulting decoded frame is stored in \p picture.
2690  *
2691  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2692  * the actual read bytes because some optimized bitstream readers read 32 or 64
2693  * bits at once and could read over the end.
2694  *
2695  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2696  * no overreading happens for damaged MPEG streams.
2697  *
2698  * @note You might have to align the input buffer \p buf and output buffer \p
2699  * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2700  * necessary at all, on others it won't work at all if not aligned and on others
2701  * it will work but it will have an impact on performance. In practice, the
2702  * bitstream should have 4 byte alignment at minimum and all sample data should
2703  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2704  * the linesize is not a multiple of 16 then there's no sense in aligning the
2705  * start of the buffer to 16.
2706  *
2707  * @param avctx the codec context
2708  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2709  * @param[in] buf the input buffer
2710  * @param[in] buf_size the size of the input buffer in bytes
2711  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2712  * @return On error a negative value is returned, otherwise the number of bytes
2713  * used or zero if no frame could be decompressed.
2714  */
2715 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2716                          int *got_picture_ptr,
2717                          const uint8_t *buf, int buf_size);
2718
2719 /* Decode a subtitle message. Return -1 if error, otherwise return the
2720  * number of bytes used. If no subtitle could be decompressed,
2721  * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2722 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2723                             int *got_sub_ptr,
2724                             const uint8_t *buf, int buf_size);
2725 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2726                         int *data_size_ptr,
2727                         uint8_t *buf, int buf_size);
2728
2729 /**
2730  * Encodes an audio frame from \p samples into \p buf.
2731  * The avcodec_encode_audio() function encodes an audio frame from the input
2732  * buffer \p samples. To encode it, it makes use of the audio codec which was
2733  * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2734  * stored in output buffer \p buf.
2735  *
2736  * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2737  *
2738  * @param avctx the codec context
2739  * @param[out] buf the output buffer
2740  * @param[in] buf_size the output buffer size
2741  * @param[in] samples the input buffer containing the samples
2742  * The number of samples read from this buffer is frame_size*channels,
2743  * both of which are defined in \p avctx.
2744  * @return On error a negative value is returned, on success zero or the number
2745  * of bytes used to encode the data read from the input buffer.
2746  */
2747 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2748                          const short *samples);
2749
2750 /**
2751  * Encodes a video frame from \p pict into \p buf.
2752  * The avcodec_encode_video() function encodes a video frame from the input
2753  * \p pict. To encode it, it makes use of the video codec which was coupled with
2754  * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2755  * frame are stored in the output buffer \p buf. The input picture should be
2756  * stored using a specific format, namely \c avctx.pix_fmt.
2757  *
2758  * @param avctx the codec context
2759  * @param[out] buf the output buffer for the bitstream of encoded frame
2760  * @param[in] buf_size the size of the output buffer in bytes
2761  * @param[in] pict the input picture to encode
2762  * @return On error a negative value is returned, on success zero or the number
2763  * of bytes used from the input buffer.
2764  */
2765 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2766                          const AVFrame *pict);
2767 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2768                             const AVSubtitle *sub);
2769
2770 int avcodec_close(AVCodecContext *avctx);
2771
2772 void avcodec_register_all(void);
2773
2774 /**
2775  * Flush buffers, should be called when seeking or when switching to a different stream.
2776  */
2777 void avcodec_flush_buffers(AVCodecContext *avctx);
2778
2779 void avcodec_default_free_buffers(AVCodecContext *s);
2780
2781 /* misc useful functions */
2782
2783 /**
2784  * Returns a single letter to describe the given picture type \p pict_type.
2785  *
2786  * @param[in] pict_type the picture type
2787  * @return A single character representing the picture type.
2788  */
2789 char av_get_pict_type_char(int pict_type);
2790
2791 /**
2792  * Returns codec bits per sample.
2793  *
2794  * @param[in] codec_id the codec
2795  * @return Number of bits per sample or zero if unknown for the given codec.
2796  */
2797 int av_get_bits_per_sample(enum CodecID codec_id);
2798
2799 /**
2800  * Returns sample format bits per sample.
2801  *
2802  * @param[in] sample_fmt the sample format
2803  * @return Number of bits per sample or zero if unknown for the given sample format.
2804  */
2805 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2806
2807 /* frame parsing */
2808 typedef struct AVCodecParserContext {
2809     void *priv_data;
2810     struct AVCodecParser *parser;
2811     int64_t frame_offset; /* offset of the current frame */
2812     int64_t cur_offset; /* current offset
2813                            (incremented by each av_parser_parse()) */
2814     int64_t last_frame_offset; /* offset of the last frame */
2815     /* video info */
2816     int pict_type; /* XXX: Put it back in AVCodecContext. */
2817     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2818     int64_t pts;     /* pts of the current frame */
2819     int64_t dts;     /* dts of the current frame */
2820
2821     /* private data */
2822     int64_t last_pts;
2823     int64_t last_dts;
2824     int fetch_timestamp;
2825
2826 #define AV_PARSER_PTS_NB 4
2827     int cur_frame_start_index;
2828     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2829     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2830     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2831
2832     int flags;
2833 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2834
2835     int64_t offset;      ///< byte offset from starting packet start
2836     int64_t last_offset;
2837 } AVCodecParserContext;
2838
2839 typedef struct AVCodecParser {
2840     int codec_ids[5]; /* several codec IDs are permitted */
2841     int priv_data_size;
2842     int (*parser_init)(AVCodecParserContext *s);
2843     int (*parser_parse)(AVCodecParserContext *s,
2844                         AVCodecContext *avctx,
2845                         const uint8_t **poutbuf, int *poutbuf_size,
2846                         const uint8_t *buf, int buf_size);
2847     void (*parser_close)(AVCodecParserContext *s);
2848     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2849     struct AVCodecParser *next;
2850 } AVCodecParser;
2851
2852 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2853 extern AVCodecParser *av_first_parser;
2854 #endif
2855 AVCodecParser *av_parser_next(AVCodecParser *c);
2856
2857 void av_register_codec_parser(AVCodecParser *parser);
2858 AVCodecParserContext *av_parser_init(int codec_id);
2859 int av_parser_parse(AVCodecParserContext *s,
2860                     AVCodecContext *avctx,
2861                     uint8_t **poutbuf, int *poutbuf_size,
2862                     const uint8_t *buf, int buf_size,
2863                     int64_t pts, int64_t dts);
2864 int av_parser_change(AVCodecParserContext *s,
2865                      AVCodecContext *avctx,
2866                      uint8_t **poutbuf, int *poutbuf_size,
2867                      const uint8_t *buf, int buf_size, int keyframe);
2868 void av_parser_close(AVCodecParserContext *s);
2869
2870
2871 typedef struct AVBitStreamFilterContext {
2872     void *priv_data;
2873     struct AVBitStreamFilter *filter;
2874     AVCodecParserContext *parser;
2875     struct AVBitStreamFilterContext *next;
2876 } AVBitStreamFilterContext;
2877
2878
2879 typedef struct AVBitStreamFilter {
2880     const char *name;
2881     int priv_data_size;
2882     int (*filter)(AVBitStreamFilterContext *bsfc,
2883                   AVCodecContext *avctx, const char *args,
2884                   uint8_t **poutbuf, int *poutbuf_size,
2885                   const uint8_t *buf, int buf_size, int keyframe);
2886     void (*close)(AVBitStreamFilterContext *bsfc);
2887     struct AVBitStreamFilter *next;
2888 } AVBitStreamFilter;
2889
2890 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2891 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2892 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2893                                AVCodecContext *avctx, const char *args,
2894                                uint8_t **poutbuf, int *poutbuf_size,
2895                                const uint8_t *buf, int buf_size, int keyframe);
2896 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2897
2898 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2899
2900 /* memory */
2901
2902 /**
2903  * Reallocates the given block if it is not large enough, otherwise it
2904  * does nothing.
2905  *
2906  * @see av_realloc
2907  */
2908 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2909
2910 /* for static data only */
2911
2912 /**
2913  * Frees all static arrays and resets their pointers to 0.
2914  * Call this function to release all statically allocated tables.
2915  *
2916  * @deprecated. Code which uses av_free_static is broken/misdesigned
2917  * and should correctly use static arrays
2918  *
2919  */
2920 attribute_deprecated void av_free_static(void);
2921
2922 /**
2923  * Allocation of static arrays.
2924  *
2925  * @warning Do not use for normal allocation.
2926  *
2927  * @param[in] size The amount of memory you need in bytes.
2928  * @return block of memory of the requested size
2929  * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2930  * and should correctly use static arrays
2931  */
2932 attribute_deprecated av_malloc_attrib av_alloc_size(1)
2933 void *av_mallocz_static(unsigned int size);
2934
2935 /**
2936  * Copy image 'src' to 'dst'.
2937  */
2938 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2939               int pix_fmt, int width, int height);
2940
2941 /**
2942  * Crop image top and left side.
2943  */
2944 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2945              int pix_fmt, int top_band, int left_band);
2946
2947 /**
2948  * Pad image.
2949  */
2950 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2951             int padtop, int padbottom, int padleft, int padright, int *color);
2952
2953 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2954 /**
2955  * @deprecated Use the software scaler (swscale) instead.
2956  */
2957 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2958               int pix_fmt, int width, int height);
2959
2960 /**
2961  * @deprecated Use the software scaler (swscale) instead.
2962  */
2963 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2964              int pix_fmt, int top_band, int left_band);
2965
2966 /**
2967  * @deprecated Use the software scaler (swscale) instead.
2968  */
2969 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2970             int padtop, int padbottom, int padleft, int padright, int *color);
2971 #endif
2972
2973 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2974
2975 /**
2976  * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2977  *
2978  * @return 0 in case of a successful parsing, a negative value otherwise
2979  * @param[in] str the string to parse: it has to be a string in the format
2980  * <width>x<height> or a valid video frame size abbreviation.
2981  * @param[in,out] width_ptr pointer to the variable which will contain the detected
2982  * frame width value
2983  * @param[in,out] height_ptr pointer to the variable which will contain the detected
2984  * frame height value
2985  */
2986 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2987
2988 /**
2989  * Parses \p str and put in \p frame_rate the detected values.
2990  *
2991  * @return 0 in case of a successful parsing, a negative value otherwise
2992  * @param[in] str the string to parse: it has to be a string in the format
2993  * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2994  * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2995  * frame rate
2996  */
2997 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2998
2999 /* error handling */
3000 #if EINVAL > 0
3001 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3002 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3003 #else
3004 /* Some platforms have E* and errno already negated. */
3005 #define AVERROR(e) (e)
3006 #define AVUNERROR(e) (e)
3007 #endif
3008 #define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3009 #define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3010 #define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3011 #define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3012 #define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3013 #define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3014 #define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3015 #define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3016 #define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3017
3018 #endif /* FFMPEG_AVCODEC_H */