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