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