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