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