source: extensions/gsdl-video/trunk/installed/cmdline/include/ffmpeg/avcodec.h@ 18425

Last change on this file since 18425 was 18425, checked in by davidb, 15 years ago

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