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