time_base description by Rich Felker | dalias, aerifal cx
[libav.git] / libavcodec / avcodec.h
1 #ifndef AVCODEC_H
2 #define AVCODEC_H
3
4 /**
5 * @file avcodec.h
6 * external api header.
7 */
8
9
10 #ifdef __cplusplus
11 extern "C" {
12 #endif
13
14 #include "avutil.h"
15 #include <sys/types.h> /* size_t */
16
17 //FIXME the following 2 really dont belong in here
18 #define FFMPEG_VERSION_INT 0x000409
19 #define FFMPEG_VERSION "CVS"
20
21 #define AV_STRINGIFY(s) AV_TOSTRING(s)
22 #define AV_TOSTRING(s) #s
23
24 #define LIBAVCODEC_VERSION_INT ((49<<16)+(0<<8)+2)
25 #define LIBAVCODEC_VERSION 49.0.2
26 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
27
28 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
29
30 #define AV_NOPTS_VALUE int64_t_C(0x8000000000000000)
31 #define AV_TIME_BASE 1000000
32 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
33
34 enum CodecID {
35 CODEC_ID_NONE,
36 CODEC_ID_MPEG1VIDEO,
37 CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
38 CODEC_ID_MPEG2VIDEO_XVMC,
39 CODEC_ID_H261,
40 CODEC_ID_H263,
41 CODEC_ID_RV10,
42 CODEC_ID_RV20,
43 CODEC_ID_MJPEG,
44 CODEC_ID_MJPEGB,
45 CODEC_ID_LJPEG,
46 CODEC_ID_SP5X,
47 CODEC_ID_MPEG4,
48 CODEC_ID_RAWVIDEO,
49 CODEC_ID_MSMPEG4V1,
50 CODEC_ID_MSMPEG4V2,
51 CODEC_ID_MSMPEG4V3,
52 CODEC_ID_WMV1,
53 CODEC_ID_WMV2,
54 CODEC_ID_H263P,
55 CODEC_ID_H263I,
56 CODEC_ID_FLV1,
57 CODEC_ID_SVQ1,
58 CODEC_ID_SVQ3,
59 CODEC_ID_DVVIDEO,
60 CODEC_ID_HUFFYUV,
61 CODEC_ID_CYUV,
62 CODEC_ID_H264,
63 CODEC_ID_INDEO3,
64 CODEC_ID_VP3,
65 CODEC_ID_THEORA,
66 CODEC_ID_ASV1,
67 CODEC_ID_ASV2,
68 CODEC_ID_FFV1,
69 CODEC_ID_4XM,
70 CODEC_ID_VCR1,
71 CODEC_ID_CLJR,
72 CODEC_ID_MDEC,
73 CODEC_ID_ROQ,
74 CODEC_ID_INTERPLAY_VIDEO,
75 CODEC_ID_XAN_WC3,
76 CODEC_ID_XAN_WC4,
77 CODEC_ID_RPZA,
78 CODEC_ID_CINEPAK,
79 CODEC_ID_WS_VQA,
80 CODEC_ID_MSRLE,
81 CODEC_ID_MSVIDEO1,
82 CODEC_ID_IDCIN,
83 CODEC_ID_8BPS,
84 CODEC_ID_SMC,
85 CODEC_ID_FLIC,
86 CODEC_ID_TRUEMOTION1,
87 CODEC_ID_VMDVIDEO,
88 CODEC_ID_MSZH,
89 CODEC_ID_ZLIB,
90 CODEC_ID_QTRLE,
91 CODEC_ID_SNOW,
92 CODEC_ID_TSCC,
93 CODEC_ID_ULTI,
94 CODEC_ID_QDRAW,
95 CODEC_ID_VIXL,
96 CODEC_ID_QPEG,
97 CODEC_ID_XVID,
98 CODEC_ID_PNG,
99 CODEC_ID_PPM,
100 CODEC_ID_PBM,
101 CODEC_ID_PGM,
102 CODEC_ID_PGMYUV,
103 CODEC_ID_PAM,
104 CODEC_ID_FFVHUFF,
105 CODEC_ID_RV30,
106 CODEC_ID_RV40,
107 CODEC_ID_VC9,
108 CODEC_ID_WMV3,
109 CODEC_ID_LOCO,
110 CODEC_ID_WNV1,
111 CODEC_ID_AASC,
112 CODEC_ID_INDEO2,
113 CODEC_ID_FRAPS,
114
115 /* various pcm "codecs" */
116 CODEC_ID_PCM_S16LE= 0x10000,
117 CODEC_ID_PCM_S16BE,
118 CODEC_ID_PCM_U16LE,
119 CODEC_ID_PCM_U16BE,
120 CODEC_ID_PCM_S8,
121 CODEC_ID_PCM_U8,
122 CODEC_ID_PCM_MULAW,
123 CODEC_ID_PCM_ALAW,
124
125 /* various adpcm codecs */
126 CODEC_ID_ADPCM_IMA_QT= 0x11000,
127 CODEC_ID_ADPCM_IMA_WAV,
128 CODEC_ID_ADPCM_IMA_DK3,
129 CODEC_ID_ADPCM_IMA_DK4,
130 CODEC_ID_ADPCM_IMA_WS,
131 CODEC_ID_ADPCM_IMA_SMJPEG,
132 CODEC_ID_ADPCM_MS,
133 CODEC_ID_ADPCM_4XM,
134 CODEC_ID_ADPCM_XA,
135 CODEC_ID_ADPCM_ADX,
136 CODEC_ID_ADPCM_EA,
137 CODEC_ID_ADPCM_G726,
138 CODEC_ID_ADPCM_CT,
139 CODEC_ID_ADPCM_SWF,
140 CODEC_ID_ADPCM_YAMAHA,
141
142 /* AMR */
143 CODEC_ID_AMR_NB= 0x12000,
144 CODEC_ID_AMR_WB,
145
146 /* RealAudio codecs*/
147 CODEC_ID_RA_144= 0x13000,
148 CODEC_ID_RA_288,
149
150 /* various DPCM codecs */
151 CODEC_ID_ROQ_DPCM= 0x14000,
152 CODEC_ID_INTERPLAY_DPCM,
153 CODEC_ID_XAN_DPCM,
154 CODEC_ID_SOL_DPCM,
155
156 CODEC_ID_MP2= 0x15000,
157 CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
158 CODEC_ID_AAC,
159 CODEC_ID_MPEG4AAC,
160 CODEC_ID_AC3,
161 CODEC_ID_DTS,
162 CODEC_ID_VORBIS,
163 CODEC_ID_DVAUDIO,
164 CODEC_ID_WMAV1,
165 CODEC_ID_WMAV2,
166 CODEC_ID_MACE3,
167 CODEC_ID_MACE6,
168 CODEC_ID_VMDAUDIO,
169 CODEC_ID_SONIC,
170 CODEC_ID_SONIC_LS,
171 CODEC_ID_FLAC,
172 CODEC_ID_MP3ADU,
173 CODEC_ID_MP3ON4,
174 CODEC_ID_SHORTEN,
175 CODEC_ID_ALAC,
176 CODEC_ID_WESTWOOD_SND1,
177 CODEC_ID_GSM,
178
179 CODEC_ID_OGGTHEORA= 0x16000,
180
181 /* subtitle codecs */
182 CODEC_ID_DVD_SUBTITLE= 0x17000,
183 CODEC_ID_DVB_SUBTITLE,
184
185 CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
186 stream (only used by libavformat) */
187 };
188
189 /* CODEC_ID_MP3LAME is absolete */
190 #define CODEC_ID_MP3LAME CODEC_ID_MP3
191
192 enum CodecType {
193 CODEC_TYPE_UNKNOWN = -1,
194 CODEC_TYPE_VIDEO,
195 CODEC_TYPE_AUDIO,
196 CODEC_TYPE_DATA,
197 CODEC_TYPE_SUBTITLE,
198 };
199
200 /**
201 * Pixel format. Notes:
202 *
203 * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
204 * color is put together as:
205 * (A << 24) | (R << 16) | (G << 8) | B
206 * This is stored as BGRA on little endian CPU architectures and ARGB on
207 * big endian CPUs.
208 *
209 * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
210 * image data is stored in AVFrame.data[0]. The palette is transported in
211 * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
212 * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
213 * also endian-specific). Note also that the individual RGB palette
214 * components stored in AVFrame.data[1] should be in the range 0..255.
215 * This is important as many custom PAL8 video codecs that were designed
216 * to run on the IBM VGA graphics adapter use 6-bit palette components.
217 */
218 enum PixelFormat {
219 PIX_FMT_NONE= -1,
220 PIX_FMT_YUV420P, ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
221 PIX_FMT_YUV422, ///< Packed pixel, Y0 Cb Y1 Cr
222 PIX_FMT_RGB24, ///< Packed pixel, 3 bytes per pixel, RGBRGB...
223 PIX_FMT_BGR24, ///< Packed pixel, 3 bytes per pixel, BGRBGR...
224 PIX_FMT_YUV422P, ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
225 PIX_FMT_YUV444P, ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
226 PIX_FMT_RGBA32, ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
227 PIX_FMT_YUV410P, ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
228 PIX_FMT_YUV411P, ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
229 PIX_FMT_RGB565, ///< always stored in cpu endianness
230 PIX_FMT_RGB555, ///< always stored in cpu endianness, most significant bit to 1
231 PIX_FMT_GRAY8,
232 PIX_FMT_MONOWHITE, ///< 0 is white
233 PIX_FMT_MONOBLACK, ///< 0 is black
234 PIX_FMT_PAL8, ///< 8 bit with RGBA palette
235 PIX_FMT_YUVJ420P, ///< Planar YUV 4:2:0 full scale (jpeg)
236 PIX_FMT_YUVJ422P, ///< Planar YUV 4:2:2 full scale (jpeg)
237 PIX_FMT_YUVJ444P, ///< Planar YUV 4:4:4 full scale (jpeg)
238 PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
239 PIX_FMT_XVMC_MPEG2_IDCT,
240 PIX_FMT_UYVY422, ///< Packed pixel, Cb Y0 Cr Y1
241 PIX_FMT_UYVY411, ///< Packed pixel, Cb Y0 Y1 Cr Y2 Y3
242 PIX_FMT_NB,
243 };
244
245 /* currently unused, may be used if 24/32 bits samples ever supported */
246 enum SampleFormat {
247 SAMPLE_FMT_S16 = 0, ///< signed 16 bits
248 SAMPLE_FMT_S32, ///< signed 32 bits
249 SAMPLE_FMT_FLT, ///< float
250 SAMPLE_FMT_DBL, ///< double
251 };
252
253 /* in bytes */
254 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
255
256 /**
257 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
258 * this is mainly needed because some optimized bitstream readers read
259 * 32 or 64 bit at once and could read over the end<br>
260 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
261 * MPEG bitstreams could cause overread and segfault
262 */
263 #define FF_INPUT_BUFFER_PADDING_SIZE 8
264
265 /**
266 * minimum encoding buffer size.
267 * used to avoid some checks during header writing
268 */
269 #define FF_MIN_BUFFER_SIZE 16384
270
271 /* motion estimation type, EPZS by default */
272 enum Motion_Est_ID {
273 ME_ZERO = 1,
274 ME_FULL,
275 ME_LOG,
276 ME_PHODS,
277 ME_EPZS,
278 ME_X1
279 };
280
281 enum AVDiscard{
282 //we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
283 AVDISCARD_NONE =-16, ///< discard nothing
284 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
285 AVDISCARD_NONREF = 8, ///< discard all non reference
286 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
287 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
288 AVDISCARD_ALL = 48, ///< discard all
289 };
290
291 typedef struct RcOverride{
292 int start_frame;
293 int end_frame;
294 int qscale; // if this is 0 then quality_factor will be used instead
295 float quality_factor;
296 } RcOverride;
297
298 /* only for ME compatiblity with old apps */
299 extern int motion_estimation_method;
300
301 #define FF_MAX_B_FRAMES 8
302
303 /* encoding support
304 these flags can be passed in AVCodecContext.flags before initing
305 Note: not everything is supported yet.
306 */
307
308 #define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
309 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / Advanced prediction for H263
310 #define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
311 #define CODEC_FLAG_GMC 0x0020 ///< use GMC
312 #define CODEC_FLAG_MV0 0x0040 ///< always try a MB with MV=<0,0>
313 #define CODEC_FLAG_PART 0x0080 ///< use data partitioning
314 /* parent program gurantees that the input for b-frame containing streams is not written to
315 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
316 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
317 #define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
318 #define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
319 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
320 #define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
321 #define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
322 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
323 #define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
324 of only at frame boundaries */
325 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
326 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
327 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay
328 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
329 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
330 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
331 #define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
332 /* Fx : Flag for h263+ extra options */
333 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
334 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
335 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
336 #define CODEC_FLAG_CBP_RD 0x04000000 ///< use rate distortion optimization for cbp
337 #define CODEC_FLAG_QP_RD 0x08000000 ///< use rate distortion optimization for qp selectioon
338 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H263 Alternative inter vlc
339 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
340 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
341 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
342 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
343 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
344 #define CODEC_FLAG_CLOSED_GOP 0x80000000
345 #define CODEC_FLAG2_FAST 0x00000001 ///< allow non spec compliant speedup tricks
346 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< strictly enforce GOP size
347 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< skip bitstream encoding
348 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< place global headers at every keyframe instead of in extradata
349
350 /* Unsupported options :
351 * Syntax Arithmetic coding (SAC)
352 * Reference Picture Selection
353 * Independant Segment Decoding */
354 /* /Fx */
355 /* codec capabilities */
356
357 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
358 /**
359 * Codec uses get_buffer() for allocating buffers.
360 * direct rendering method 1
361 */
362 #define CODEC_CAP_DR1 0x0002
363 /* if 'parse_only' field is true, then avcodec_parse_frame() can be
364 used */
365 #define CODEC_CAP_PARSE_ONLY 0x0004
366 #define CODEC_CAP_TRUNCATED 0x0008
367 /* codec can export data for HW decoding (XvMC) */
368 #define CODEC_CAP_HWACCEL 0x0010
369 /**
370 * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
371 * if this is not set, the codec is guranteed to never be feeded with NULL data
372 */
373 #define CODEC_CAP_DELAY 0x0020
374
375 //the following defines may change, don't expect compatibility if you use them
376 #define MB_TYPE_INTRA4x4 0x0001
377 #define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
378 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME h264 specific
379 #define MB_TYPE_16x16 0x0008
380 #define MB_TYPE_16x8 0x0010
381 #define MB_TYPE_8x16 0x0020
382 #define MB_TYPE_8x8 0x0040
383 #define MB_TYPE_INTERLACED 0x0080
384 #define MB_TYPE_DIRECT2 0x0100 //FIXME
385 #define MB_TYPE_ACPRED 0x0200
386 #define MB_TYPE_GMC 0x0400
387 #define MB_TYPE_SKIP 0x0800
388 #define MB_TYPE_P0L0 0x1000
389 #define MB_TYPE_P1L0 0x2000
390 #define MB_TYPE_P0L1 0x4000
391 #define MB_TYPE_P1L1 0x8000
392 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
393 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
394 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
395 #define MB_TYPE_QUANT 0x00010000
396 #define MB_TYPE_CBP 0x00020000
397 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
398
399 /**
400 * Pan Scan area.
401 * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
402 */
403 typedef struct AVPanScan{
404 /**
405 * id.
406 * - encoding: set by user.
407 * - decoding: set by lavc
408 */
409 int id;
410
411 /**
412 * width and height in 1/16 pel
413 * - encoding: set by user.
414 * - decoding: set by lavc
415 */
416 int width;
417 int height;
418
419 /**
420 * position of the top left corner in 1/16 pel for up to 3 fields/frames.
421 * - encoding: set by user.
422 * - decoding: set by lavc
423 */
424 int16_t position[3][2];
425 }AVPanScan;
426
427 #define FF_COMMON_FRAME \
428 /**\
429 * pointer to the picture planes.\
430 * this might be different from the first allocated byte\
431 * - encoding: \
432 * - decoding: \
433 */\
434 uint8_t *data[4];\
435 int linesize[4];\
436 /**\
437 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
438 * this isn't used by lavc unless the default get/release_buffer() is used\
439 * - encoding: \
440 * - decoding: \
441 */\
442 uint8_t *base[4];\
443 /**\
444 * 1 -> keyframe, 0-> not\
445 * - encoding: set by lavc\
446 * - decoding: set by lavc\
447 */\
448 int key_frame;\
449 \
450 /**\
451 * picture type of the frame, see ?_TYPE below.\
452 * - encoding: set by lavc for coded_picture (and set by user for input)\
453 * - decoding: set by lavc\
454 */\
455 int pict_type;\
456 \
457 /**\
458 * presentation timestamp in time_base units (time when frame should be shown to user)\
459 * if AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed\
460 * - encoding: MUST be set by user\
461 * - decoding: set by lavc\
462 */\
463 int64_t pts;\
464 \
465 /**\
466 * picture number in bitstream order.\
467 * - encoding: set by\
468 * - decoding: set by lavc\
469 */\
470 int coded_picture_number;\
471 /**\
472 * picture number in display order.\
473 * - encoding: set by\
474 * - decoding: set by lavc\
475 */\
476 int display_picture_number;\
477 \
478 /**\
479 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
480 * - encoding: set by lavc for coded_picture (and set by user for input)\
481 * - decoding: set by lavc\
482 */\
483 int quality; \
484 \
485 /**\
486 * buffer age (1->was last buffer and dint change, 2->..., ...).\
487 * set to INT_MAX if the buffer has not been used yet \
488 * - encoding: unused\
489 * - decoding: MUST be set by get_buffer()\
490 */\
491 int age;\
492 \
493 /**\
494 * is this picture used as reference\
495 * - encoding: unused\
496 * - decoding: set by lavc (before get_buffer() call))\
497 */\
498 int reference;\
499 \
500 /**\
501 * QP table\
502 * - encoding: unused\
503 * - decoding: set by lavc\
504 */\
505 int8_t *qscale_table;\
506 /**\
507 * QP store stride\
508 * - encoding: unused\
509 * - decoding: set by lavc\
510 */\
511 int qstride;\
512 \
513 /**\
514 * mbskip_table[mb]>=1 if MB didnt change\
515 * stride= mb_width = (width+15)>>4\
516 * - encoding: unused\
517 * - decoding: set by lavc\
518 */\
519 uint8_t *mbskip_table;\
520 \
521 /**\
522 * Motion vector table.\
523 * @code\
524 * example:\
525 * int mv_sample_log2= 4 - motion_subsample_log2;\
526 * int mb_width= (width+15)>>4;\
527 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
528 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
529 * @endcode\
530 * - encoding: set by user\
531 * - decoding: set by lavc\
532 */\
533 int16_t (*motion_val[2])[2];\
534 \
535 /**\
536 * Macroblock type table\
537 * mb_type_base + mb_width + 2\
538 * - encoding: set by user\
539 * - decoding: set by lavc\
540 */\
541 uint32_t *mb_type;\
542 \
543 /**\
544 * log2 of the size of the block which a single vector in motion_val represents: \
545 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
546 * - encoding: unused\
547 * - decoding: set by lavc\
548 */\
549 uint8_t motion_subsample_log2;\
550 \
551 /**\
552 * for some private data of the user\
553 * - encoding: unused\
554 * - decoding: set by user\
555 */\
556 void *opaque;\
557 \
558 /**\
559 * error\
560 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
561 * - decoding: unused\
562 */\
563 uint64_t error[4];\
564 \
565 /**\
566 * type of the buffer (to keep track of who has to dealloc data[*])\
567 * - encoding: set by the one who allocs it\
568 * - decoding: set by the one who allocs it\
569 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
570 */\
571 int type;\
572 \
573 /**\
574 * when decoding, this signal how much the picture must be delayed.\
575 * extra_delay = repeat_pict / (2*fps)\
576 * - encoding: unused\
577 * - decoding: set by lavc\
578 */\
579 int repeat_pict;\
580 \
581 /**\
582 * \
583 */\
584 int qscale_type;\
585 \
586 /**\
587 * The content of the picture is interlaced.\
588 * - encoding: set by user\
589 * - decoding: set by lavc (default 0)\
590 */\
591 int interlaced_frame;\
592 \
593 /**\
594 * if the content is interlaced, is top field displayed first.\
595 * - encoding: set by user\
596 * - decoding: set by lavc\
597 */\
598 int top_field_first;\
599 \
600 /**\
601 * Pan scan.\
602 * - encoding: set by user\
603 * - decoding: set by lavc\
604 */\
605 AVPanScan *pan_scan;\
606 \
607 /**\
608 * tell user application that palette has changed from previous frame.\
609 * - encoding: ??? (no palette-enabled encoder yet)\
610 * - decoding: set by lavc (default 0)\
611 */\
612 int palette_has_changed;\
613 \
614 /**\
615 * Codec suggestion on buffer type if != 0\
616 * - encoding: unused\
617 * - decoding: set by lavc (before get_buffer() call))\
618 */\
619 int buffer_hints;\
620 \
621 /**\
622 * DCT coeffitients\
623 * - encoding: unused\
624 * - decoding: set by lavc\
625 */\
626 short *dct_coeff;\
627 \
628 /**\
629 * Motion referece frame index\
630 * - encoding: set by user\
631 * - decoding: set by lavc\
632 */\
633 int8_t *ref_index[2];
634
635 #define FF_QSCALE_TYPE_MPEG1 0
636 #define FF_QSCALE_TYPE_MPEG2 1
637
638 #define FF_BUFFER_TYPE_INTERNAL 1
639 #define FF_BUFFER_TYPE_USER 2 ///< Direct rendering buffers (image is (de)allocated by user)
640 #define FF_BUFFER_TYPE_SHARED 4 ///< buffer from somewhere else, don't dealloc image (data/base), all other tables are not shared
641 #define FF_BUFFER_TYPE_COPY 8 ///< just a (modified) copy of some other buffer, don't dealloc anything
642
643
644 #define FF_I_TYPE 1 // Intra
645 #define FF_P_TYPE 2 // Predicted
646 #define FF_B_TYPE 3 // Bi-dir predicted
647 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
648 #define FF_SI_TYPE 5
649 #define FF_SP_TYPE 6
650
651 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore)
652 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer
653 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content
654 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update)
655
656 /**
657 * Audio Video Frame.
658 */
659 typedef struct AVFrame {
660 FF_COMMON_FRAME
661 } AVFrame;
662
663 #define DEFAULT_FRAME_RATE_BASE 1001000
664
665 /**
666 * Used by av_log
667 */
668 typedef struct AVCLASS AVClass;
669 struct AVCLASS {
670 const char* class_name;
671 const char* (*item_name)(void*); /* actually passing a pointer to an AVCodecContext
672 or AVFormatContext, which begin with an AVClass.
673 Needed because av_log is in libavcodec and has no visibility
674 of AVIn/OutputFormat */
675 };
676
677 /**
678 * main external api structure.
679 */
680 typedef struct AVCodecContext {
681 /**
682 * Info on struct for av_log
683 * - set by avcodec_alloc_context
684 */
685 AVClass *av_class;
686 /**
687 * the average bitrate.
688 * - encoding: set by user. unused for constant quantizer encoding
689 * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
690 */
691 int bit_rate;
692
693 /**
694 * number of bits the bitstream is allowed to diverge from the reference.
695 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
696 * - encoding: set by user. unused for constant quantizer encoding
697 * - decoding: unused
698 */
699 int bit_rate_tolerance;
700
701 /**
702 * CODEC_FLAG_*.
703 * - encoding: set by user.
704 * - decoding: set by user.
705 */
706 int flags;
707
708 /**
709 * some codecs needs additionnal format info. It is stored here
710 * - encoding: set by user.
711 * - decoding: set by lavc. (FIXME is this ok?)
712 */
713 int sub_id;
714
715 /**
716 * motion estimation algorithm used for video coding.
717 * - encoding: MUST be set by user.
718 * - decoding: unused
719 */
720 int me_method;
721
722 /**
723 * some codecs need / can use extra-data like huffman tables.
724 * mjpeg: huffman tables
725 * rv10: additional flags
726 * mpeg4: global headers (they can be in the bitstream or here)
727 * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
728 * then extradata_size to avoid prolems if its read with the bitstream reader
729 * - encoding: set/allocated/freed by lavc.
730 * - decoding: set/allocated/freed by user.
731 */
732 void *extradata;
733 int extradata_size;
734
735 /**
736 * this is the fundamental unit of time (in seconds) in terms
737 * of which frame timestamps are represented. for fixed-fps content,
738 * timebase should be 1/framerate and timestamp increments should be
739 * identically 1.
740 * - encoding: MUST be set by user
741 * - decoding: set by lavc.
742 */
743 AVRational time_base;
744
745 /* video only */
746 /**
747 * picture width / height.
748 * - encoding: MUST be set by user.
749 * - decoding: set by lavc.
750 * Note, for compatibility its possible to set this instead of
751 * coded_width/height before decoding
752 */
753 int width, height;
754
755 #define FF_ASPECT_EXTENDED 15
756
757 /**
758 * the number of pictures in a group of pitures, or 0 for intra_only.
759 * - encoding: set by user.
760 * - decoding: unused
761 */
762 int gop_size;
763
764 /**
765 * pixel format, see PIX_FMT_xxx.
766 * - encoding: set by user.
767 * - decoding: set by lavc.
768 */
769 enum PixelFormat pix_fmt;
770
771 /**
772 * Frame rate emulation. If not zero lower layer (i.e. format handler)
773 * has to read frames at native frame rate.
774 * - encoding: set by user.
775 * - decoding: unused.
776 */
777 int rate_emu;
778
779 /**
780 * if non NULL, 'draw_horiz_band' is called by the libavcodec
781 * decoder to draw an horizontal band. It improve cache usage. Not
782 * all codecs can do that. You must check the codec capabilities
783 * before
784 * - encoding: unused
785 * - decoding: set by user.
786 * @param height the height of the slice
787 * @param y the y position of the slice
788 * @param type 1->top field, 2->bottom field, 3->frame
789 * @param offset offset into the AVFrame.data from which the slice should be read
790 */
791 void (*draw_horiz_band)(struct AVCodecContext *s,
792 const AVFrame *src, int offset[4],
793 int y, int type, int height);
794
795 /* audio only */
796 int sample_rate; ///< samples per sec
797 int channels;
798
799 /**
800 * audio sample format.
801 * - encoding: set by user.
802 * - decoding: set by lavc.
803 */
804 enum SampleFormat sample_fmt; ///< sample format, currenly unused
805
806 /* the following data should not be initialized */
807 /**
808 * samples per packet. initialized when calling 'init'
809 */
810 int frame_size;
811 int frame_number; ///< audio or video frame number
812 int real_pict_num; ///< returns the real picture number of previous encoded frame
813
814 /**
815 * number of frames the decoded output will be delayed relative to
816 * the encoded input.
817 * - encoding: set by lavc.
818 * - decoding: unused
819 */
820 int delay;
821
822 /* - encoding parameters */
823 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
824 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
825
826 /**
827 * minimum quantizer.
828 * - encoding: set by user.
829 * - decoding: unused
830 */
831 int qmin;
832
833 /**
834 * maximum quantizer.
835 * - encoding: set by user.
836 * - decoding: unused
837 */
838 int qmax;
839
840 /**
841 * maximum quantizer difference etween frames.
842 * - encoding: set by user.
843 * - decoding: unused
844 */
845 int max_qdiff;
846
847 /**
848 * maximum number of b frames between non b frames.
849 * note: the output will be delayed by max_b_frames+1 relative to the input
850 * - encoding: set by user.
851 * - decoding: unused
852 */
853 int max_b_frames;
854
855 /**
856 * qscale factor between ip and b frames.
857 * - encoding: set by user.
858 * - decoding: unused
859 */
860 float b_quant_factor;
861
862 /** obsolete FIXME remove */
863 int rc_strategy;
864 int b_frame_strategy;
865
866 /**
867 * hurry up amount.
868 * deprecated in favor of skip_idct and skip_frame
869 * - encoding: unused
870 * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
871 */
872 int hurry_up;
873
874 struct AVCodec *codec;
875
876 void *priv_data;
877
878 /* unused, FIXME remove*/
879 int rtp_mode;
880
881 int rtp_payload_size; /* The size of the RTP payload: the coder will */
882 /* do it's best to deliver a chunk with size */
883 /* below rtp_payload_size, the chunk will start */
884 /* with a start code on some codecs like H.263 */
885 /* This doesn't take account of any particular */
886 /* headers inside the transmited RTP payload */
887
888
889 /* The RTP callback: This function is called */
890 /* every time the encoder has a packet to send */
891 /* Depends on the encoder if the data starts */
892 /* with a Start Code (it should) H.263 does. */
893 /* mb_nb contains the number of macroblocks */
894 /* encoded in the RTP payload */
895 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
896
897 /* statistics, used for 2-pass encoding */
898 int mv_bits;
899 int header_bits;
900 int i_tex_bits;
901 int p_tex_bits;
902 int i_count;
903 int p_count;
904 int skip_count;
905 int misc_bits;
906
907 /**
908 * number of bits used for the previously encoded frame.
909 * - encoding: set by lavc
910 * - decoding: unused
911 */
912 int frame_bits;
913
914 /**
915 * private data of the user, can be used to carry app specific stuff.
916 * - encoding: set by user
917 * - decoding: set by user
918 */
919 void *opaque;
920
921 char codec_name[32];
922 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
923 enum CodecID codec_id; /* see CODEC_ID_xxx */
924
925 /**
926 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
927 * this is used to workaround some encoder bugs
928 * - encoding: set by user, if not then the default based on codec_id will be used
929 * - decoding: set by user, will be converted to upper case by lavc during init
930 */
931 unsigned int codec_tag;
932
933 /**
934 * workaround bugs in encoders which sometimes cannot be detected automatically.
935 * - encoding: set by user
936 * - decoding: set by user
937 */
938 int workaround_bugs;
939 #define FF_BUG_AUTODETECT 1 ///< autodetection
940 #define FF_BUG_OLD_MSMPEG4 2
941 #define FF_BUG_XVID_ILACE 4
942 #define FF_BUG_UMP4 8
943 #define FF_BUG_NO_PADDING 16
944 #define FF_BUG_AMV 32
945 #define FF_BUG_AC_VLC 0 ///< will be removed, libavcodec can now handle these non compliant files by default
946 #define FF_BUG_QPEL_CHROMA 64
947 #define FF_BUG_STD_QPEL 128
948 #define FF_BUG_QPEL_CHROMA2 256
949 #define FF_BUG_DIRECT_BLOCKSIZE 512
950 #define FF_BUG_EDGE 1024
951 #define FF_BUG_HPEL_CHROMA 2048
952 #define FF_BUG_DC_CLIP 4096
953 #define FF_BUG_MS 8192 ///< workaround various bugs in microsofts broken decoders
954 //#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
955
956 /**
957 * luma single coeff elimination threshold.
958 * - encoding: set by user
959 * - decoding: unused
960 */
961 int luma_elim_threshold;
962
963 /**
964 * chroma single coeff elimination threshold.
965 * - encoding: set by user
966 * - decoding: unused
967 */
968 int chroma_elim_threshold;
969
970 /**
971 * strictly follow the std (MPEG4, ...).
972 * - encoding: set by user
973 * - decoding: unused
974 */
975 int strict_std_compliance;
976 #define FF_COMPLIANCE_VERY_STRICT 2 ///< strictly conform to a older more strict version of the spec or reference software
977 #define FF_COMPLIANCE_STRICT 1 ///< strictly conform to all the things in the spec no matter what consequences
978 #define FF_COMPLIANCE_NORMAL 0
979 #define FF_COMPLIANCE_INOFFICIAL -1 ///< allow inofficial extensions
980 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< allow non standarized experimental things
981
982 /**
983 * qscale offset between ip and b frames.
984 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
985 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
986 * - encoding: set by user.
987 * - decoding: unused
988 */
989 float b_quant_offset;
990
991 /**
992 * error resilience higher values will detect more errors but may missdetect
993 * some more or less valid parts as errors.
994 * - encoding: unused
995 * - decoding: set by user
996 */
997 int error_resilience;
998 #define FF_ER_CAREFULL 1
999 #define FF_ER_COMPLIANT 2
1000 #define FF_ER_AGGRESSIVE 3
1001 #define FF_ER_VERY_AGGRESSIVE 4
1002
1003 /**
1004 * called at the beginning of each frame to get a buffer for it.
1005 * if pic.reference is set then the frame will be read later by lavc
1006 * avcodec_align_dimensions() should be used to find the required width and
1007 * height, as they normally need to be rounded up to the next multiple of 16
1008 * - encoding: unused
1009 * - decoding: set by lavc, user can override
1010 */
1011 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1012
1013 /**
1014 * called to release buffers which where allocated with get_buffer.
1015 * a released buffer can be reused in get_buffer()
1016 * pic.data[*] must be set to NULL
1017 * - encoding: unused
1018 * - decoding: set by lavc, user can override
1019 */
1020 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1021
1022 /**
1023 * if 1 the stream has a 1 frame delay during decoding.
1024 * - encoding: set by lavc
1025 * - decoding: set by lavc
1026 */
1027 int has_b_frames;
1028
1029 /**
1030 * number of bytes per packet if constant and known or 0
1031 * used by some WAV based audio codecs
1032 */
1033 int block_align;
1034
1035 int parse_only; /* - decoding only: if true, only parsing is done
1036 (function avcodec_parse_frame()). The frame
1037 data is returned. Only MPEG codecs support this now. */
1038
1039 /**
1040 * 0-> h263 quant 1-> mpeg quant.
1041 * - encoding: set by user.
1042 * - decoding: unused
1043 */
1044 int mpeg_quant;
1045
1046 /**
1047 * pass1 encoding statistics output buffer.
1048 * - encoding: set by lavc
1049 * - decoding: unused
1050 */
1051 char *stats_out;
1052
1053 /**
1054 * pass2 encoding statistics input buffer.
1055 * concatenated stuff from stats_out of pass1 should be placed here
1056 * - encoding: allocated/set/freed by user
1057 * - decoding: unused
1058 */
1059 char *stats_in;
1060
1061 /**
1062 * ratecontrol qmin qmax limiting method.
1063 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1064 * - encoding: set by user.
1065 * - decoding: unused
1066 */
1067 float rc_qsquish;
1068
1069 float rc_qmod_amp;
1070 int rc_qmod_freq;
1071
1072 /**
1073 * ratecontrol override, see RcOverride.
1074 * - encoding: allocated/set/freed by user.
1075 * - decoding: unused
1076 */
1077 RcOverride *rc_override;
1078 int rc_override_count;
1079
1080 /**
1081 * rate control equation.
1082 * - encoding: set by user
1083 * - decoding: unused
1084 */
1085 char *rc_eq;
1086
1087 /**
1088 * maximum bitrate.
1089 * - encoding: set by user.
1090 * - decoding: unused
1091 */
1092 int rc_max_rate;
1093
1094 /**
1095 * minimum bitrate.
1096 * - encoding: set by user.
1097 * - decoding: unused
1098 */
1099 int rc_min_rate;
1100
1101 /**
1102 * decoder bitstream buffer size.
1103 * - encoding: set by user.
1104 * - decoding: unused
1105 */
1106 int rc_buffer_size;
1107 float rc_buffer_aggressivity;
1108
1109 /**
1110 * qscale factor between p and i frames.
1111 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
1112 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
1113 * - encoding: set by user.
1114 * - decoding: unused
1115 */
1116 float i_quant_factor;
1117
1118 /**
1119 * qscale offset between p and i frames.
1120 * - encoding: set by user.
1121 * - decoding: unused
1122 */
1123 float i_quant_offset;
1124
1125 /**
1126 * initial complexity for pass1 ratecontrol.
1127 * - encoding: set by user.
1128 * - decoding: unused
1129 */
1130 float rc_initial_cplx;
1131
1132 /**
1133 * dct algorithm, see FF_DCT_* below.
1134 * - encoding: set by user
1135 * - decoding: unused
1136 */
1137 int dct_algo;
1138 #define FF_DCT_AUTO 0
1139 #define FF_DCT_FASTINT 1
1140 #define FF_DCT_INT 2
1141 #define FF_DCT_MMX 3
1142 #define FF_DCT_MLIB 4
1143 #define FF_DCT_ALTIVEC 5
1144 #define FF_DCT_FAAN 6
1145
1146 /**
1147 * luminance masking (0-> disabled).
1148 * - encoding: set by user
1149 * - decoding: unused
1150 */
1151 float lumi_masking;
1152
1153 /**
1154 * temporary complexity masking (0-> disabled).
1155 * - encoding: set by user
1156 * - decoding: unused
1157 */
1158 float temporal_cplx_masking;
1159
1160 /**
1161 * spatial complexity masking (0-> disabled).
1162 * - encoding: set by user
1163 * - decoding: unused
1164 */
1165 float spatial_cplx_masking;
1166
1167 /**
1168 * p block masking (0-> disabled).
1169 * - encoding: set by user
1170 * - decoding: unused
1171 */
1172 float p_masking;
1173
1174 /**
1175 * darkness masking (0-> disabled).
1176 * - encoding: set by user
1177 * - decoding: unused
1178 */
1179 float dark_masking;
1180
1181
1182 /* for binary compatibility */
1183 int unused;
1184
1185 /**
1186 * idct algorithm, see FF_IDCT_* below.
1187 * - encoding: set by user
1188 * - decoding: set by user
1189 */
1190 int idct_algo;
1191 #define FF_IDCT_AUTO 0
1192 #define FF_IDCT_INT 1
1193 #define FF_IDCT_SIMPLE 2
1194 #define FF_IDCT_SIMPLEMMX 3
1195 #define FF_IDCT_LIBMPEG2MMX 4
1196 #define FF_IDCT_PS2 5
1197 #define FF_IDCT_MLIB 6
1198 #define FF_IDCT_ARM 7
1199 #define FF_IDCT_ALTIVEC 8
1200 #define FF_IDCT_SH4 9
1201 #define FF_IDCT_SIMPLEARM 10
1202 #define FF_IDCT_H264 11
1203 #define FF_IDCT_VP3 12
1204 #define FF_IDCT_IPP 13
1205
1206 /**
1207 * slice count.
1208 * - encoding: set by lavc
1209 * - decoding: set by user (or 0)
1210 */
1211 int slice_count;
1212 /**
1213 * slice offsets in the frame in bytes.
1214 * - encoding: set/allocated by lavc
1215 * - decoding: set/allocated by user (or NULL)
1216 */
1217 int *slice_offset;
1218
1219 /**
1220 * error concealment flags.
1221 * - encoding: unused
1222 * - decoding: set by user
1223 */
1224 int error_concealment;
1225 #define FF_EC_GUESS_MVS 1
1226 #define FF_EC_DEBLOCK 2
1227
1228 /**
1229 * dsp_mask could be add used to disable unwanted CPU features
1230 * CPU features (i.e. MMX, SSE. ...)
1231 *
1232 * with FORCE flag you may instead enable given CPU features
1233 * (Dangerous: usable in case of misdetection, improper usage however will
1234 * result into program crash)
1235 */
1236 unsigned dsp_mask;
1237 #define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
1238 /* lower 16 bits - CPU features */
1239 #ifdef HAVE_MMX
1240 #define FF_MM_MMX 0x0001 /* standard MMX */
1241 #define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1242 #define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1243 #define FF_MM_SSE 0x0008 /* SSE functions */
1244 #define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1245 #define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1246 #endif /* HAVE_MMX */
1247 #ifdef HAVE_IWMMXT
1248 #define FF_MM_IWMMXT 0x0100 /* XScale IWMMXT */
1249 #endif /* HAVE_IWMMXT */
1250
1251 /**
1252 * bits per sample/pixel from the demuxer (needed for huffyuv).
1253 * - encoding: set by lavc
1254 * - decoding: set by user
1255 */
1256 int bits_per_sample;
1257
1258 /**
1259 * prediction method (needed for huffyuv).
1260 * - encoding: set by user
1261 * - decoding: unused
1262 */
1263 int prediction_method;
1264 #define FF_PRED_LEFT 0
1265 #define FF_PRED_PLANE 1
1266 #define FF_PRED_MEDIAN 2
1267
1268 /**
1269 * sample aspect ratio (0 if unknown).
1270 * numerator and denominator must be relative prime and smaller then 256 for some video standards
1271 * - encoding: set by user.
1272 * - decoding: set by lavc.
1273 */
1274 AVRational sample_aspect_ratio;
1275
1276 /**
1277 * the picture in the bitstream.
1278 * - encoding: set by lavc
1279 * - decoding: set by lavc
1280 */
1281 AVFrame *coded_frame;
1282
1283 /**
1284 * debug.
1285 * - encoding: set by user.
1286 * - decoding: set by user.
1287 */
1288 int debug;
1289 #define FF_DEBUG_PICT_INFO 1
1290 #define FF_DEBUG_RC 2
1291 #define FF_DEBUG_BITSTREAM 4
1292 #define FF_DEBUG_MB_TYPE 8
1293 #define FF_DEBUG_QP 16
1294 #define FF_DEBUG_MV 32
1295 #define FF_DEBUG_DCT_COEFF 0x00000040
1296 #define FF_DEBUG_SKIP 0x00000080
1297 #define FF_DEBUG_STARTCODE 0x00000100
1298 #define FF_DEBUG_PTS 0x00000200
1299 #define FF_DEBUG_ER 0x00000400
1300 #define FF_DEBUG_MMCO 0x00000800
1301 #define FF_DEBUG_BUGS 0x00001000
1302 #define FF_DEBUG_VIS_QP 0x00002000
1303 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1304
1305 /**
1306 * debug.
1307 * - encoding: set by user.
1308 * - decoding: set by user.
1309 */
1310 int debug_mv;
1311 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1312 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1313 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1314
1315 /**
1316 * error.
1317 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
1318 * - decoding: unused
1319 */
1320 uint64_t error[4];
1321
1322 /**
1323 * minimum MB quantizer.
1324 * - encoding: unused
1325 * - decoding: unused
1326 */
1327 int mb_qmin;
1328
1329 /**
1330 * maximum MB quantizer.
1331 * - encoding: unused
1332 * - decoding: unused
1333 */
1334 int mb_qmax;
1335
1336 /**
1337 * motion estimation compare function.
1338 * - encoding: set by user.
1339 * - decoding: unused
1340 */
1341 int me_cmp;
1342 /**
1343 * subpixel motion estimation compare function.
1344 * - encoding: set by user.
1345 * - decoding: unused
1346 */
1347 int me_sub_cmp;
1348 /**
1349 * macroblock compare function (not supported yet).
1350 * - encoding: set by user.
1351 * - decoding: unused
1352 */
1353 int mb_cmp;
1354 /**
1355 * interlaced dct compare function
1356 * - encoding: set by user.
1357 * - decoding: unused
1358 */
1359 int ildct_cmp;
1360 #define FF_CMP_SAD 0
1361 #define FF_CMP_SSE 1
1362 #define FF_CMP_SATD 2
1363 #define FF_CMP_DCT 3
1364 #define FF_CMP_PSNR 4
1365 #define FF_CMP_BIT 5
1366 #define FF_CMP_RD 6
1367 #define FF_CMP_ZERO 7
1368 #define FF_CMP_VSAD 8
1369 #define FF_CMP_VSSE 9
1370 #define FF_CMP_NSSE 10
1371 #define FF_CMP_W53 11
1372 #define FF_CMP_W97 12
1373 #define FF_CMP_DCTMAX 13
1374 #define FF_CMP_CHROMA 256
1375
1376 /**
1377 * ME diamond size & shape.
1378 * - encoding: set by user.
1379 * - decoding: unused
1380 */
1381 int dia_size;
1382
1383 /**
1384 * amount of previous MV predictors (2a+1 x 2a+1 square).
1385 * - encoding: set by user.
1386 * - decoding: unused
1387 */
1388 int last_predictor_count;
1389
1390 /**
1391 * pre pass for motion estimation.
1392 * - encoding: set by user.
1393 * - decoding: unused
1394 */
1395 int pre_me;
1396
1397 /**
1398 * motion estimation pre pass compare function.
1399 * - encoding: set by user.
1400 * - decoding: unused
1401 */
1402 int me_pre_cmp;
1403
1404 /**
1405 * ME pre pass diamond size & shape.
1406 * - encoding: set by user.
1407 * - decoding: unused
1408 */
1409 int pre_dia_size;
1410
1411 /**
1412 * subpel ME quality.
1413 * - encoding: set by user.
1414 * - decoding: unused
1415 */
1416 int me_subpel_quality;
1417
1418 /**
1419 * callback to negotiate the pixelFormat.
1420 * @param fmt is the list of formats which are supported by the codec,
1421 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1422 * the first is allways the native one
1423 * @return the choosen format
1424 * - encoding: unused
1425 * - decoding: set by user, if not set then the native format will always be choosen
1426 */
1427 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1428
1429 /**
1430 * DTG active format information (additionnal aspect ratio
1431 * information only used in DVB MPEG2 transport streams). 0 if
1432 * not set.
1433 *
1434 * - encoding: unused.
1435 * - decoding: set by decoder
1436 */
1437 int dtg_active_format;
1438 #define FF_DTG_AFD_SAME 8
1439 #define FF_DTG_AFD_4_3 9
1440 #define FF_DTG_AFD_16_9 10
1441 #define FF_DTG_AFD_14_9 11
1442 #define FF_DTG_AFD_4_3_SP_14_9 13
1443 #define FF_DTG_AFD_16_9_SP_14_9 14
1444 #define FF_DTG_AFD_SP_4_3 15
1445
1446 /**
1447 * Maximum motion estimation search range in subpel units.
1448 * if 0 then no limit
1449 *
1450 * - encoding: set by user.
1451 * - decoding: unused.
1452 */
1453 int me_range;
1454
1455 /**
1456 * intra quantizer bias.
1457 * - encoding: set by user.
1458 * - decoding: unused
1459 */
1460 int intra_quant_bias;
1461 #define FF_DEFAULT_QUANT_BIAS 999999
1462
1463 /**
1464 * inter quantizer bias.
1465 * - encoding: set by user.
1466 * - decoding: unused
1467 */
1468 int inter_quant_bias;
1469
1470 /**
1471 * color table ID.
1472 * - encoding: unused.
1473 * - decoding: which clrtable should be used for 8bit RGB images
1474 * table have to be stored somewhere FIXME
1475 */
1476 int color_table_id;
1477
1478 /**
1479 * internal_buffer count.
1480 * Don't touch, used by lavc default_get_buffer()
1481 */
1482 int internal_buffer_count;
1483
1484 /**
1485 * internal_buffers.
1486 * Don't touch, used by lavc default_get_buffer()
1487 */
1488 void *internal_buffer;
1489
1490 #define FF_LAMBDA_SHIFT 7
1491 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1492 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1493 #define FF_LAMBDA_MAX (256*128-1)
1494
1495 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1496 /**
1497 * global quality for codecs which cannot change it per frame.
1498 * this should be proportional to MPEG1/2/4 qscale.
1499 * - encoding: set by user.
1500 * - decoding: unused
1501 */
1502 int global_quality;
1503
1504 #define FF_CODER_TYPE_VLC 0
1505 #define FF_CODER_TYPE_AC 1
1506 /**
1507 * coder type
1508 * - encoding: set by user.
1509 * - decoding: unused
1510 */
1511 int coder_type;
1512
1513 /**
1514 * context model
1515 * - encoding: set by user.
1516 * - decoding: unused
1517 */
1518 int context_model;
1519
1520 /**
1521 * slice flags
1522 * - encoding: unused
1523 * - decoding: set by user.
1524 */
1525 int slice_flags;
1526 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1527 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1528 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1529
1530 /**
1531 * XVideo Motion Acceleration
1532 * - encoding: forbidden
1533 * - decoding: set by decoder
1534 */
1535 int xvmc_acceleration;
1536
1537 /**
1538 * macroblock decision mode
1539 * - encoding: set by user.
1540 * - decoding: unused
1541 */
1542 int mb_decision;
1543 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1544 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1545 #define FF_MB_DECISION_RD 2 ///< rate distoration
1546
1547 /**
1548 * custom intra quantization matrix
1549 * - encoding: set by user, can be NULL
1550 * - decoding: set by lavc
1551 */
1552 uint16_t *intra_matrix;
1553
1554 /**
1555 * custom inter quantization matrix
1556 * - encoding: set by user, can be NULL
1557 * - decoding: set by lavc
1558 */
1559 uint16_t *inter_matrix;
1560
1561 /**
1562 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1563 * this is used to workaround some encoder bugs
1564 * - encoding: unused
1565 * - decoding: set by user, will be converted to upper case by lavc during init
1566 */
1567 unsigned int stream_codec_tag;
1568
1569 /**
1570 * scene change detection threshold.
1571 * 0 is default, larger means fewer detected scene changes
1572 * - encoding: set by user.
1573 * - decoding: unused
1574 */
1575 int scenechange_threshold;
1576
1577 /**
1578 * minimum lagrange multipler
1579 * - encoding: set by user.
1580 * - decoding: unused
1581 */
1582 int lmin;
1583
1584 /**
1585 * maximum lagrange multipler
1586 * - encoding: set by user.
1587 * - decoding: unused
1588 */
1589 int lmax;
1590
1591 /**
1592 * Palette control structure
1593 * - encoding: ??? (no palette-enabled encoder yet)
1594 * - decoding: set by user.
1595 */
1596 struct AVPaletteControl *palctrl;
1597
1598 /**
1599 * noise reduction strength
1600 * - encoding: set by user.
1601 * - decoding: unused
1602 */
1603 int noise_reduction;
1604
1605 /**
1606 * called at the beginning of a frame to get cr buffer for it.
1607 * buffer type (size, hints) must be the same. lavc won't check it.
1608 * lavc will pass previous buffer in pic, function should return
1609 * same buffer or new buffer with old frame "painted" into it.
1610 * if pic.data[0] == NULL must behave like get_buffer().
1611 * - encoding: unused
1612 * - decoding: set by lavc, user can override
1613 */
1614 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1615
1616 /**
1617 * number of bits which should be loaded into the rc buffer before decoding starts
1618 * - encoding: set by user.
1619 * - decoding: unused
1620 */
1621 int rc_initial_buffer_occupancy;
1622
1623 /**
1624 *
1625 * - encoding: set by user.
1626 * - decoding: unused
1627 */
1628 int inter_threshold;
1629
1630 /**
1631 * CODEC_FLAG2_*.
1632 * - encoding: set by user.
1633 * - decoding: set by user.
1634 */
1635 int flags2;
1636
1637 /**
1638 * simulates errors in the bitstream to test error concealment.
1639 * - encoding: set by user.
1640 * - decoding: unused.
1641 */
1642 int error_rate;
1643
1644 /**
1645 * MP3 antialias algorithm, see FF_AA_* below.
1646 * - encoding: unused
1647 * - decoding: set by user
1648 */
1649 int antialias_algo;
1650 #define FF_AA_AUTO 0
1651 #define FF_AA_FASTINT 1 //not implemented yet
1652 #define FF_AA_INT 2
1653 #define FF_AA_FLOAT 3
1654 /**
1655 * Quantizer noise shaping.
1656 * - encoding: set by user
1657 * - decoding: unused
1658 */
1659 int quantizer_noise_shaping;
1660
1661 /**
1662 * Thread count.
1663 * is used to decide how many independant tasks should be passed to execute()
1664 * - encoding: set by user
1665 * - decoding: set by user
1666 */
1667 int thread_count;
1668
1669 /**
1670 * the codec may call this to execute several independant things. it will return only after
1671 * finishing all tasks, the user may replace this with some multithreaded implementation, the
1672 * default implementation will execute the parts serially
1673 * @param count the number of things to execute
1674 * - encoding: set by lavc, user can override
1675 * - decoding: set by lavc, user can override
1676 */
1677 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1678
1679 /**
1680 * Thread opaque.
1681 * can be used by execute() to store some per AVCodecContext stuff.
1682 * - encoding: set by execute()
1683 * - decoding: set by execute()
1684 */
1685 void *thread_opaque;
1686
1687 /**
1688 * Motion estimation threshold. under which no motion estimation is
1689 * performed, but instead the user specified motion vectors are used
1690 *
1691 * - encoding: set by user
1692 * - decoding: unused
1693 */
1694 int me_threshold;
1695
1696 /**
1697 * Macroblock threshold. under which the user specified macroblock types will be used
1698 * - encoding: set by user
1699 * - decoding: unused
1700 */
1701 int mb_threshold;
1702
1703 /**
1704 * precision of the intra dc coefficient - 8.
1705 * - encoding: set by user
1706 * - decoding: unused
1707 */
1708 int intra_dc_precision;
1709
1710 /**
1711 * noise vs. sse weight for the nsse comparsion function.
1712 * - encoding: set by user
1713 * - decoding: unused
1714 */
1715 int nsse_weight;
1716
1717 /**
1718 * number of macroblock rows at the top which are skipped.
1719 * - encoding: unused
1720 * - decoding: set by user
1721 */
1722 int skip_top;
1723
1724 /**
1725 * number of macroblock rows at the bottom which are skipped.
1726 * - encoding: unused
1727 * - decoding: set by user
1728 */
1729 int skip_bottom;
1730
1731 /**
1732 * profile
1733 * - encoding: set by user
1734 * - decoding: set by lavc
1735 */
1736 int profile;
1737 #define FF_PROFILE_UNKNOWN -99
1738
1739 /**
1740 * level
1741 * - encoding: set by user
1742 * - decoding: set by lavc
1743 */
1744 int level;
1745 #define FF_LEVEL_UNKNOWN -99
1746
1747 /**
1748 * low resolution decoding. 1-> 1/2 size, 2->1/4 size
1749 * - encoding: unused
1750 * - decoding: set by user
1751 */
1752 int lowres;
1753
1754 /**
1755 * bitsream width / height. may be different from width/height if lowres
1756 * or other things are used
1757 * - encoding: unused
1758 * - decoding: set by user before init if known, codec should override / dynamically change if needed
1759 */
1760 int coded_width, coded_height;
1761
1762 /**
1763 * frame skip threshold
1764 * - encoding: set by user
1765 * - decoding: unused
1766 */
1767 int frame_skip_threshold;
1768
1769 /**
1770 * frame skip factor
1771 * - encoding: set by user
1772 * - decoding: unused
1773 */
1774 int frame_skip_factor;
1775
1776 /**
1777 * frame skip exponent
1778 * - encoding: set by user
1779 * - decoding: unused
1780 */
1781 int frame_skip_exp;
1782
1783 /**
1784 * frame skip comparission function
1785 * - encoding: set by user.
1786 * - decoding: unused
1787 */
1788 int frame_skip_cmp;
1789
1790 /**
1791 * border processing masking. raises the quantizer for mbs on the borders
1792 * of the picture.
1793 * - encoding: set by user
1794 * - decoding: unused
1795 */
1796 float border_masking;
1797
1798 /**
1799 * minimum MB lagrange multipler.
1800 * - encoding: set by user.
1801 * - decoding: unused
1802 */
1803 int mb_lmin;
1804
1805 /**
1806 * maximum MB lagrange multipler.
1807 * - encoding: set by user.
1808 * - decoding: unused
1809 */
1810 int mb_lmax;
1811
1812 /**
1813 *
1814 * - encoding: set by user.
1815 * - decoding: unused
1816 */
1817 int me_penalty_compensation;
1818
1819 /**
1820 *
1821 * - encoding: unused
1822 * - decoding: set by user.
1823 */
1824 enum AVDiscard skip_loop_filter;
1825
1826 /**
1827 *
1828 * - encoding: unused
1829 * - decoding: set by user.
1830 */
1831 enum AVDiscard skip_idct;
1832
1833 /**
1834 *
1835 * - encoding: unused
1836 * - decoding: set by user.
1837 */
1838 enum AVDiscard skip_frame;
1839 } AVCodecContext;
1840
1841
1842 /**
1843 * AVOption.
1844 */
1845 typedef struct AVOption {
1846 /** options' name */
1847 const char *name; /* if name is NULL, it indicates a link to next */
1848 /** short English text help or const struct AVOption* subpointer */
1849 const char *help; // const struct AVOption* sub;
1850 /** offset to context structure where the parsed value should be stored */
1851 int offset;
1852 /** options' type */
1853 int type;
1854 #define FF_OPT_TYPE_BOOL 1 ///< boolean - true,1,on (or simply presence)
1855 #define FF_OPT_TYPE_DOUBLE 2 ///< double
1856 #define FF_OPT_TYPE_INT 3 ///< integer
1857 #define FF_OPT_TYPE_STRING 4 ///< string (finished with \0)
1858 #define FF_OPT_TYPE_MASK 0x1f ///< mask for types - upper bits are various flags
1859 //#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1860 #define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1861 #define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1862 /** min value (min == max -> no limits) */
1863 double min;
1864 /** maximum value for double/int */
1865 double max;
1866 /** default boo [0,1]l/double/int value */
1867 double defval;
1868 /**
1869 * default string value (with optional semicolon delimited extra option-list
1870 * i.e. option1;option2;option3
1871 * defval might select other then first argument as default
1872 */
1873 const char *defstr;
1874 #define FF_OPT_MAX_DEPTH 10
1875 } AVOption;
1876
1877 /**
1878 * AVCodec.
1879 */
1880 typedef struct AVCodec {
1881 const char *name;
1882 enum CodecType type;
1883 enum CodecID id;
1884 int priv_data_size;
1885 int (*init)(AVCodecContext *);
1886 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
1887 int (*close)(AVCodecContext *);
1888 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1889 uint8_t *buf, int buf_size);
1890 int capabilities;
1891 #if LIBAVCODEC_VERSION_INT < ((50<<16)+(0<<8)+0)
1892 void *dummy; // FIXME remove next time we break binary compatibility
1893 #endif
1894 struct AVCodec *next;
1895 void (*flush)(AVCodecContext *);
1896 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
1897 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
1898 } AVCodec;
1899
1900 /**
1901 * four components are given, that's all.
1902 * the last component is alpha
1903 */
1904 typedef struct AVPicture {
1905 uint8_t *data[4];
1906 int linesize[4]; ///< number of bytes per line
1907 } AVPicture;
1908
1909 /**
1910 * AVPaletteControl
1911 * This structure defines a method for communicating palette changes
1912 * between and demuxer and a decoder.
1913 */
1914 #define AVPALETTE_SIZE 1024
1915 #define AVPALETTE_COUNT 256
1916 typedef struct AVPaletteControl {
1917
1918 /* demuxer sets this to 1 to indicate the palette has changed;
1919 * decoder resets to 0 */
1920 int palette_changed;
1921
1922 /* 4-byte ARGB palette entries, stored in native byte order; note that
1923 * the individual palette components should be on a 8-bit scale; if
1924 * the palette data comes from a IBM VGA native format, the component
1925 * data is probably 6 bits in size and needs to be scaled */
1926 unsigned int palette[AVPALETTE_COUNT];
1927
1928 } AVPaletteControl;
1929
1930 typedef struct AVSubtitleRect {
1931 uint16_t x;
1932 uint16_t y;
1933 uint16_t w;
1934 uint16_t h;
1935 uint16_t nb_colors;
1936 int linesize;
1937 uint32_t *rgba_palette;
1938 uint8_t *bitmap;
1939 } AVSubtitleRect;
1940
1941 typedef struct AVSubtitle {
1942 uint16_t format; /* 0 = graphics */
1943 uint32_t start_display_time; /* relative to packet pts, in ms */
1944 uint32_t end_display_time; /* relative to packet pts, in ms */
1945 uint32_t num_rects;
1946 AVSubtitleRect *rects;
1947 } AVSubtitle;
1948
1949 extern AVCodec ac3_encoder;
1950 extern AVCodec mp2_encoder;
1951 extern AVCodec mp3lame_encoder;
1952 extern AVCodec oggvorbis_encoder;
1953 extern AVCodec oggtheora_encoder;
1954 extern AVCodec faac_encoder;
1955 extern AVCodec xvid_encoder;
1956 extern AVCodec mpeg1video_encoder;
1957 extern AVCodec mpeg2video_encoder;
1958 extern AVCodec h261_encoder;
1959 extern AVCodec h263_encoder;
1960 extern AVCodec h263p_encoder;
1961 extern AVCodec flv_encoder;
1962 extern AVCodec rv10_encoder;
1963 extern AVCodec rv20_encoder;
1964 extern AVCodec dvvideo_encoder;
1965 extern AVCodec mjpeg_encoder;
1966 extern AVCodec ljpeg_encoder;
1967 extern AVCodec png_encoder;
1968 extern AVCodec ppm_encoder;
1969 extern AVCodec pgm_encoder;
1970 extern AVCodec pgmyuv_encoder;
1971 extern AVCodec pbm_encoder;
1972 extern AVCodec pam_encoder;
1973 extern AVCodec mpeg4_encoder;
1974 extern AVCodec msmpeg4v1_encoder;
1975 extern AVCodec msmpeg4v2_encoder;
1976 extern AVCodec msmpeg4v3_encoder;
1977 extern AVCodec wmv1_encoder;
1978 extern AVCodec wmv2_encoder;
1979 extern AVCodec huffyuv_encoder;
1980 extern AVCodec ffvhuff_encoder;
1981 extern AVCodec h264_encoder;
1982 extern AVCodec asv1_encoder;
1983 extern AVCodec asv2_encoder;
1984 extern AVCodec vcr1_encoder;
1985 extern AVCodec ffv1_encoder;
1986 extern AVCodec snow_encoder;
1987 extern AVCodec mdec_encoder;
1988 extern AVCodec zlib_encoder;
1989 extern AVCodec sonic_encoder;
1990 extern AVCodec sonic_ls_encoder;
1991 extern AVCodec svq1_encoder;
1992 extern AVCodec x264_encoder;
1993
1994 extern AVCodec h263_decoder;
1995 extern AVCodec h261_decoder;
1996 extern AVCodec mpeg4_decoder;
1997 extern AVCodec msmpeg4v1_decoder;
1998 extern AVCodec msmpeg4v2_decoder;
1999 extern AVCodec msmpeg4v3_decoder;
2000 extern AVCodec wmv1_decoder;
2001 extern AVCodec wmv2_decoder;
2002 extern AVCodec vc9_decoder;
2003 extern AVCodec wmv3_decoder;
2004 extern AVCodec mpeg1video_decoder;
2005 extern AVCodec mpeg2video_decoder;
2006 extern AVCodec mpegvideo_decoder;
2007 extern AVCodec mpeg_xvmc_decoder;
2008 extern AVCodec h263i_decoder;
2009 extern AVCodec flv_decoder;
2010 extern AVCodec rv10_decoder;
2011 extern AVCodec rv20_decoder;
2012 extern AVCodec rv30_decoder;
2013 extern AVCodec rv40_decoder;
2014 extern AVCodec svq1_decoder;
2015 extern AVCodec svq3_decoder;
2016 extern AVCodec dvvideo_decoder;
2017 extern AVCodec wmav1_decoder;
2018 extern AVCodec wmav2_decoder;
2019 extern AVCodec mjpeg_decoder;
2020 extern AVCodec mjpegb_decoder;
2021 extern AVCodec sp5x_decoder;
2022 extern AVCodec png_decoder;
2023 extern AVCodec mp2_decoder;
2024 extern AVCodec mp3_decoder;
2025 extern AVCodec mp3adu_decoder;
2026 extern AVCodec mp3on4_decoder;
2027 extern AVCodec mace3_decoder;
2028 extern AVCodec mace6_decoder;
2029 extern AVCodec huffyuv_decoder;
2030 extern AVCodec ffvhuff_decoder;
2031 extern AVCodec oggvorbis_decoder;
2032 extern AVCodec oggtheora_decoder;
2033 extern AVCodec cyuv_decoder;
2034 extern AVCodec h264_decoder;
2035 extern AVCodec indeo3_decoder;
2036 extern AVCodec vp3_decoder;
2037 extern AVCodec theora_decoder;
2038 extern AVCodec amr_nb_decoder;
2039 extern AVCodec amr_nb_encoder;
2040 extern AVCodec amr_wb_encoder;
2041 extern AVCodec amr_wb_decoder;
2042 extern AVCodec aac_decoder;
2043 extern AVCodec mpeg4aac_decoder;
2044 extern AVCodec asv1_decoder;
2045 extern AVCodec asv2_decoder;
2046 extern AVCodec vcr1_decoder;
2047 extern AVCodec cljr_decoder;
2048 extern AVCodec ffv1_decoder;
2049 extern AVCodec snow_decoder;
2050 extern AVCodec fourxm_decoder;
2051 extern AVCodec mdec_decoder;
2052 extern AVCodec roq_decoder;
2053 extern AVCodec interplay_video_decoder;
2054 extern AVCodec xan_wc3_decoder;
2055 extern AVCodec rpza_decoder;
2056 extern AVCodec cinepak_decoder;
2057 extern AVCodec msrle_decoder;
2058 extern AVCodec msvideo1_decoder;
2059 extern AVCodec vqa_decoder;
2060 extern AVCodec idcin_decoder;
2061 extern AVCodec eightbps_decoder;
2062 extern AVCodec smc_decoder;
2063 extern AVCodec flic_decoder;
2064 extern AVCodec vmdvideo_decoder;
2065 extern AVCodec vmdaudio_decoder;
2066 extern AVCodec truemotion1_decoder;
2067 extern AVCodec mszh_decoder;
2068 extern AVCodec zlib_decoder;
2069 extern AVCodec ra_144_decoder;
2070 extern AVCodec ra_288_decoder;
2071 extern AVCodec roq_dpcm_decoder;
2072 extern AVCodec interplay_dpcm_decoder;
2073 extern AVCodec xan_dpcm_decoder;
2074 extern AVCodec sol_dpcm_decoder;
2075 extern AVCodec sonic_decoder;
2076 extern AVCodec qtrle_decoder;
2077 extern AVCodec flac_decoder;
2078 extern AVCodec tscc_decoder;
2079 extern AVCodec ulti_decoder;
2080 extern AVCodec qdraw_decoder;
2081 extern AVCodec xl_decoder;
2082 extern AVCodec qpeg_decoder;
2083 extern AVCodec shorten_decoder;
2084 extern AVCodec loco_decoder;
2085 extern AVCodec wnv1_decoder;
2086 extern AVCodec aasc_decoder;
2087 extern AVCodec alac_decoder;
2088 extern AVCodec ws_snd1_decoder;
2089 extern AVCodec indeo2_decoder;
2090 extern AVCodec vorbis_decoder;
2091 extern AVCodec fraps_decoder;
2092 extern AVCodec libgsm_encoder;
2093 extern AVCodec libgsm_decoder;
2094
2095 /* pcm codecs */
2096 #define PCM_CODEC(id, name) \
2097 extern AVCodec name ## _decoder; \
2098 extern AVCodec name ## _encoder
2099
2100 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
2101 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
2102 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
2103 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
2104 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
2105 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
2106 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
2107 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
2108
2109 /* adpcm codecs */
2110
2111 PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
2112 PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
2113 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
2114 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2115 PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
2116 PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
2117 PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
2118 PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
2119 PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
2120 PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
2121 PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
2122 PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
2123 PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
2124 PCM_CODEC(CODEC_ID_ADPCM_SWF, adpcm_swf);
2125 PCM_CODEC(CODEC_ID_ADPCM_YAMAHA, adpcm_yamaha);
2126
2127 #undef PCM_CODEC
2128
2129 /* dummy raw video codec */
2130 extern AVCodec rawvideo_encoder;
2131 extern AVCodec rawvideo_decoder;
2132
2133 /* the following codecs use external GPL libs */
2134 extern AVCodec ac3_decoder;
2135 extern AVCodec dts_decoder;
2136
2137 /* subtitles */
2138 extern AVCodec dvdsub_decoder;
2139 extern AVCodec dvbsub_encoder;
2140 extern AVCodec dvbsub_decoder;
2141
2142 /* resample.c */
2143
2144 struct ReSampleContext;
2145 struct AVResampleContext;
2146
2147 typedef struct ReSampleContext ReSampleContext;
2148
2149 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2150 int output_rate, int input_rate);
2151 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2152 void audio_resample_close(ReSampleContext *s);
2153
2154 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2155 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2156 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2157 void av_resample_close(struct AVResampleContext *c);
2158
2159 /* YUV420 format is assumed ! */
2160
2161 struct ImgReSampleContext;
2162
2163 typedef struct ImgReSampleContext ImgReSampleContext;
2164
2165 ImgReSampleContext *img_resample_init(int output_width, int output_height,
2166 int input_width, int input_height);
2167
2168 ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2169 int iwidth, int iheight,
2170 int topBand, int bottomBand,
2171 int leftBand, int rightBand,
2172 int padtop, int padbottom,
2173 int padleft, int padright);
2174
2175
2176 void img_resample(ImgReSampleContext *s,
2177 AVPicture *output, const AVPicture *input);
2178
2179 void img_resample_close(ImgReSampleContext *s);
2180
2181 /**
2182 * Allocate memory for a picture. Call avpicture_free to free it.
2183 *
2184 * @param picture the picture to be filled in.
2185 * @param pix_fmt the format of the picture.
2186 * @param width the width of the picture.
2187 * @param height the height of the picture.
2188 * @return 0 if successful, -1 if not.
2189 */
2190 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2191
2192 /* Free a picture previously allocated by avpicture_alloc. */
2193 void avpicture_free(AVPicture *picture);
2194
2195 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2196 int pix_fmt, int width, int height);
2197 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2198 unsigned char *dest, int dest_size);
2199 int avpicture_get_size(int pix_fmt, int width, int height);
2200 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2201 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2202 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2203 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2204 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2205
2206 #define FF_LOSS_RESOLUTION 0x0001 /* loss due to resolution change */
2207 #define FF_LOSS_DEPTH 0x0002 /* loss due to color depth change */
2208 #define FF_LOSS_COLORSPACE 0x0004 /* loss due to color space conversion */
2209 #define FF_LOSS_ALPHA 0x0008 /* loss of alpha bits */
2210 #define FF_LOSS_COLORQUANT 0x0010 /* loss due to color quantization */
2211 #define FF_LOSS_CHROMA 0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
2212
2213 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2214 int has_alpha);
2215 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2216 int has_alpha, int *loss_ptr);
2217
2218 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2219 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2220 int img_get_alpha_info(const AVPicture *src,
2221 int pix_fmt, int width, int height);
2222
2223 /* convert among pixel formats */
2224 int img_convert(AVPicture *dst, int dst_pix_fmt,
2225 const AVPicture *src, int pix_fmt,
2226 int width, int height);
2227
2228 /* deinterlace a picture */
2229 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2230 int pix_fmt, int width, int height);
2231
2232 /* external high level API */
2233
2234 extern AVCodec *first_avcodec;
2235
2236 /* returns LIBAVCODEC_VERSION_INT constant */
2237 unsigned avcodec_version(void);
2238 /* returns LIBAVCODEC_BUILD constant */
2239 unsigned avcodec_build(void);
2240 void avcodec_init(void);
2241
2242 void register_avcodec(AVCodec *format);
2243 AVCodec *avcodec_find_encoder(enum CodecID id);
2244 AVCodec *avcodec_find_encoder_by_name(const char *name);
2245 AVCodec *avcodec_find_decoder(enum CodecID id);
2246 AVCodec *avcodec_find_decoder_by_name(const char *name);
2247 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2248
2249 void avcodec_get_context_defaults(AVCodecContext *s);
2250 AVCodecContext *avcodec_alloc_context(void);
2251 void avcodec_get_frame_defaults(AVFrame *pic);
2252 AVFrame *avcodec_alloc_frame(void);
2253
2254 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2255 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2256 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2257 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2258 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2259 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2260
2261 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2262 void avcodec_thread_free(AVCodecContext *s);
2263 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2264 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2265 //FIXME func typedef
2266
2267 /**
2268 * opens / inits the AVCodecContext.
2269 * not thread save!
2270 */
2271 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2272
2273 int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2274 int *frame_size_ptr,
2275 uint8_t *buf, int buf_size);
2276 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2277 int *got_picture_ptr,
2278 uint8_t *buf, int buf_size);
2279 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2280 int *got_sub_ptr,
2281 const uint8_t *buf, int buf_size);
2282 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2283 int *data_size_ptr,
2284 uint8_t *buf, int buf_size);
2285 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2286 const short *samples);
2287 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2288 const AVFrame *pict);
2289 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2290 const AVSubtitle *sub);
2291
2292 int avcodec_close(AVCodecContext *avctx);
2293
2294 void avcodec_register_all(void);
2295
2296 void avcodec_flush_buffers(AVCodecContext *avctx);
2297
2298 void avcodec_default_free_buffers(AVCodecContext *s);
2299
2300 /* misc usefull functions */
2301
2302 /**
2303 * returns a single letter to describe the picture type
2304 */
2305 char av_get_pict_type_char(int pict_type);
2306
2307
2308 /* frame parsing */
2309 typedef struct AVCodecParserContext {
2310 void *priv_data;
2311 struct AVCodecParser *parser;
2312 int64_t frame_offset; /* offset of the current frame */
2313 int64_t cur_offset; /* current offset
2314 (incremented by each av_parser_parse()) */
2315 int64_t last_frame_offset; /* offset of the last frame */
2316 /* video info */
2317 int pict_type; /* XXX: put it back in AVCodecContext */
2318 int repeat_pict; /* XXX: put it back in AVCodecContext */
2319 int64_t pts; /* pts of the current frame */
2320 int64_t dts; /* dts of the current frame */
2321
2322 /* private data */
2323 int64_t last_pts;
2324 int64_t last_dts;
2325 int fetch_timestamp;
2326
2327 #define AV_PARSER_PTS_NB 4
2328 int cur_frame_start_index;
2329 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2330 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2331 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2332
2333 int flags;
2334 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2335 } AVCodecParserContext;
2336
2337 typedef struct AVCodecParser {
2338 int codec_ids[5]; /* several codec IDs are permitted */
2339 int priv_data_size;
2340 int (*parser_init)(AVCodecParserContext *s);
2341 int (*parser_parse)(AVCodecParserContext *s,
2342 AVCodecContext *avctx,
2343 uint8_t **poutbuf, int *poutbuf_size,
2344 const uint8_t *buf, int buf_size);
2345 void (*parser_close)(AVCodecParserContext *s);
2346 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2347 struct AVCodecParser *next;
2348 } AVCodecParser;
2349
2350 extern AVCodecParser *av_first_parser;
2351
2352 void av_register_codec_parser(AVCodecParser *parser);
2353 AVCodecParserContext *av_parser_init(int codec_id);
2354 int av_parser_parse(AVCodecParserContext *s,
2355 AVCodecContext *avctx,
2356 uint8_t **poutbuf, int *poutbuf_size,
2357 const uint8_t *buf, int buf_size,
2358 int64_t pts, int64_t dts);
2359 int av_parser_change(AVCodecParserContext *s,
2360 AVCodecContext *avctx,
2361 uint8_t **poutbuf, int *poutbuf_size,
2362 const uint8_t *buf, int buf_size, int keyframe);
2363 void av_parser_close(AVCodecParserContext *s);
2364
2365 extern AVCodecParser mpegvideo_parser;
2366 extern AVCodecParser mpeg4video_parser;
2367 extern AVCodecParser h261_parser;
2368 extern AVCodecParser h263_parser;
2369 extern AVCodecParser h264_parser;
2370 extern AVCodecParser mjpeg_parser;
2371 extern AVCodecParser pnm_parser;
2372 extern AVCodecParser mpegaudio_parser;
2373 extern AVCodecParser ac3_parser;
2374 extern AVCodecParser dvdsub_parser;
2375 extern AVCodecParser dvbsub_parser;
2376
2377 /* memory */
2378 void *av_malloc(unsigned int size);
2379 void *av_mallocz(unsigned int size);
2380 void *av_realloc(void *ptr, unsigned int size);
2381 void av_free(void *ptr);
2382 char *av_strdup(const char *s);
2383 void av_freep(void *ptr);
2384 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2385 /* for static data only */
2386 /* call av_free_static to release all staticaly allocated tables */
2387 void av_free_static(void);
2388 void *av_mallocz_static(unsigned int size);
2389 void *av_realloc_static(void *ptr, unsigned int size);
2390
2391 /* add by bero : in adx.c */
2392 int is_adx(const unsigned char *buf,size_t bufsize);
2393
2394 void img_copy(AVPicture *dst, const AVPicture *src,
2395 int pix_fmt, int width, int height);
2396
2397 /* av_log API */
2398
2399 #include <stdarg.h>
2400
2401 #define AV_LOG_QUIET -1
2402 #define AV_LOG_ERROR 0
2403 #define AV_LOG_INFO 1
2404 #define AV_LOG_DEBUG 2
2405
2406 #ifdef __GNUC__
2407 extern void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
2408 #else
2409 extern void av_log(void*, int level, const char *fmt, ...);
2410 #endif
2411
2412 extern void av_vlog(void*, int level, const char *fmt, va_list);
2413 extern int av_log_get_level(void);
2414 extern void av_log_set_level(int);
2415 extern void av_log_set_callback(void (*)(void*, int, const char*, va_list));
2416
2417 /* endian macros */
2418 #if !defined(BE_16) || !defined(BE_32) || !defined(LE_16) || !defined(LE_32)
2419 #define BE_16(x) ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
2420 #define BE_32(x) ((((uint8_t*)(x))[0] << 24) | \
2421 (((uint8_t*)(x))[1] << 16) | \
2422 (((uint8_t*)(x))[2] << 8) | \
2423 ((uint8_t*)(x))[3])
2424 #define LE_16(x) ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
2425 #define LE_32(x) ((((uint8_t*)(x))[3] << 24) | \
2426 (((uint8_t*)(x))[2] << 16) | \
2427 (((uint8_t*)(x))[1] << 8) | \
2428 ((uint8_t*)(x))[0])
2429 #endif
2430
2431 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2432
2433 #ifdef __cplusplus
2434 }
2435 #endif
2436
2437 #endif /* AVCODEC_H */