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