1 |
/***************************************************************************** |
/***************************************************************************** |
2 |
* |
* |
3 |
* XVID MPEG-4 VIDEO CODEC |
* XVID MPEG-4 VIDEO CODEC |
4 |
* - XviD Main header file - |
* - Xvid Main header file - |
5 |
* |
* |
6 |
* Copyright(C) 2001-2003 Peter Ross <pross@xvid.org> |
* Copyright(C) 2001-2004 Peter Ross <pross@xvid.org> |
7 |
* |
* |
8 |
* This program is free software ; you can redistribute it and/or modify |
* This program is free software ; you can redistribute it and/or modify |
9 |
* it under the terms of the GNU General Public License as published by |
* it under the terms of the GNU General Public License as published by |
57 |
#define XVID_API_MAJOR(a) (((a)>>16) & 0xff) |
#define XVID_API_MAJOR(a) (((a)>>16) & 0xff) |
58 |
#define XVID_API_MINOR(a) (((a)>> 0) & 0xff) |
#define XVID_API_MINOR(a) (((a)>> 0) & 0xff) |
59 |
|
|
60 |
#define XVID_VERSION XVID_MAKE_VERSION(1,0,-127) |
#define XVID_VERSION XVID_MAKE_VERSION(1,3,-127) |
61 |
#define XVID_API XVID_MAKE_API(4, 0) |
#define XVID_API XVID_MAKE_API(4, 3) |
62 |
|
|
63 |
#define XVID_UNSTABLE |
#define XVID_UNSTABLE |
64 |
|
|
73 |
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
74 |
* future |
* future |
75 |
*/ |
*/ |
76 |
#define XVID_BS_VERSION "0023" |
#define XVID_BS_VERSION 57 |
|
|
|
77 |
|
|
78 |
/***************************************************************************** |
/***************************************************************************** |
79 |
* error codes |
* error codes |
95 |
|
|
96 |
/* colorspace values */ |
/* colorspace values */ |
97 |
|
|
98 |
#define XVID_CSP_USER (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */ |
#define XVID_CSP_PLANAR (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */ |
99 |
|
#define XVID_CSP_USER XVID_CSP_PLANAR |
100 |
#define XVID_CSP_I420 (1<< 1) /* 4:2:0 planar */ |
#define XVID_CSP_I420 (1<< 1) /* 4:2:0 planar */ |
101 |
#define XVID_CSP_YV12 (1<< 2) /* 4:2:0 planar */ |
#define XVID_CSP_YV12 (1<< 2) /* 4:2:0 planar */ |
102 |
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
103 |
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
104 |
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
105 |
|
#define XVID_CSP_RGB (1<<16) /* 24-bit rgb packed */ |
106 |
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
107 |
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
108 |
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
109 |
|
#define XVID_CSP_ARGB (1<<15) /* 32-bit argb packed */ |
110 |
#define XVID_CSP_BGR (1<< 9) /* 24-bit bgr packed */ |
#define XVID_CSP_BGR (1<< 9) /* 24-bit bgr packed */ |
111 |
#define XVID_CSP_RGB555 (1<<10) /* 16-bit rgb555 packed */ |
#define XVID_CSP_RGB555 (1<<10) /* 16-bit rgb555 packed */ |
112 |
#define XVID_CSP_RGB565 (1<<11) /* 16-bit rgb565 packed */ |
#define XVID_CSP_RGB565 (1<<11) /* 16-bit rgb565 packed */ |
140 |
#define XVID_PROFILE_AS_L4 0xf4 |
#define XVID_PROFILE_AS_L4 0xf4 |
141 |
|
|
142 |
/* aspect ratios */ |
/* aspect ratios */ |
143 |
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if AR is not precised (ie: ==0) */ |
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if supplied PAR is not a valid value */ |
144 |
#define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ |
#define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ |
145 |
#define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ |
#define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ |
146 |
#define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ |
#define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ |
170 |
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
171 |
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
172 |
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
173 |
|
#define XVID_CPU_SSE3 (1<< 8) /* sse3 : pentium4, athlon64 */ |
174 |
|
#define XVID_CPU_SSE41 (1<< 9) /* sse41: penryn */ |
175 |
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
176 |
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
177 |
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
222 |
#define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ |
#define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ |
223 |
#define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ |
#define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ |
224 |
|
|
225 |
int xvid_global(void *handle, int opt, void *param1, void *param2); |
extern int xvid_global(void *handle, int opt, void *param1, void *param2); |
226 |
|
|
227 |
|
|
228 |
/***************************************************************************** |
/***************************************************************************** |
233 |
#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ |
#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ |
234 |
#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ |
#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ |
235 |
|
|
236 |
int xvid_decore(void *handle, int opt, void *param1, void *param2); |
extern int xvid_decore(void *handle, int opt, void *param1, void *param2); |
237 |
|
|
238 |
/* XVID_DEC_CREATE param 1 |
/* XVID_DEC_CREATE param 1 |
239 |
image width & height may be specified here when the dimensions are |
image width & height as well as FourCC code may be specified |
240 |
known in advance. */ |
here when known in advance (e.g. being read from container) */ |
241 |
typedef struct { |
typedef struct { |
242 |
int version; |
int version; |
243 |
int width; /* [in:opt] image width */ |
int width; /* [in:opt] image width */ |
244 |
int height; /* [in:opt] image width */ |
int height; /* [in:opt] image width */ |
245 |
void * handle; /* [out] decore context handle */ |
void * handle; /* [out] decore context handle */ |
246 |
|
int fourcc; /* [in:opt] fourcc of the video */ |
247 |
} xvid_dec_create_t; |
} xvid_dec_create_t; |
248 |
|
|
249 |
|
|
253 |
#define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ |
#define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ |
254 |
#define XVID_DEBLOCKY (1<<2) /* perform luma deblocking */ |
#define XVID_DEBLOCKY (1<<2) /* perform luma deblocking */ |
255 |
#define XVID_DEBLOCKUV (1<<3) /* perform chroma deblocking */ |
#define XVID_DEBLOCKUV (1<<3) /* perform chroma deblocking */ |
256 |
|
#define XVID_FILMEFFECT (1<<4) /* adds film grain */ |
257 |
|
#define XVID_DERINGUV (1<<5) /* perform chroma deringing, requires deblocking to work */ |
258 |
|
#define XVID_DERINGY (1<<6) /* perform luma deringing, requires deblocking to work */ |
259 |
|
|
260 |
|
#define XVID_DEC_FAST (1<<29) /* disable postprocessing to decrease cpu usage *todo* */ |
261 |
|
#define XVID_DEC_DROP (1<<30) /* drop bframes to decrease cpu usage *todo* */ |
262 |
|
#define XVID_DEC_PREROLL (1<<31) /* decode as fast as you can, don't even show output *todo* */ |
263 |
|
|
264 |
typedef struct { |
typedef struct { |
265 |
int version; |
int version; |
267 |
void *bitstream; /* [in] bitstream (read from)*/ |
void *bitstream; /* [in] bitstream (read from)*/ |
268 |
int length; /* [in] bitstream length */ |
int length; /* [in] bitstream length */ |
269 |
xvid_image_t output; /* [in] output image (written to) */ |
xvid_image_t output; /* [in] output image (written to) */ |
270 |
|
/* ------- v1.1.x ------- */ |
271 |
|
int brightness; /* [in] brightness offset (0=none) */ |
272 |
} xvid_dec_frame_t; |
} xvid_dec_frame_t; |
273 |
|
|
274 |
|
|
294 |
int width; /* [out] width */ |
int width; /* [out] width */ |
295 |
int height; /* [out] height */ |
int height; /* [out] height */ |
296 |
int par; /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
int par; /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
297 |
int par_width; /* [out] aspect ratio width */ |
int par_width; /* [out] aspect ratio width [1..255] */ |
298 |
int par_height; /* [out] aspect ratio height */ |
int par_height; /* [out] aspect ratio height [1..255] */ |
299 |
} vol; |
} vol; |
300 |
} data; |
} data; |
301 |
} xvid_dec_stats_t; |
} xvid_dec_stats_t; |
302 |
|
|
|
|
|
|
|
|
303 |
#define XVID_ZONE_QUANT (1<<0) |
#define XVID_ZONE_QUANT (1<<0) |
304 |
#define XVID_ZONE_WEIGHT (1<<1) |
#define XVID_ZONE_WEIGHT (1<<1) |
305 |
|
|
312 |
} xvid_enc_zone_t; |
} xvid_enc_zone_t; |
313 |
|
|
314 |
|
|
315 |
|
/*---------------------------------------------------------------------------- |
316 |
|
* xvid_enc_stats_t structure |
317 |
|
* |
318 |
|
* Used in: |
319 |
|
* - xvid_plg_data_t structure |
320 |
|
* - optional parameter in xvid_encore() function |
321 |
|
* |
322 |
|
* .coding_type = XVID_TYPE_NOTHING if the stats are not given |
323 |
|
*--------------------------------------------------------------------------*/ |
324 |
|
|
325 |
|
typedef struct { |
326 |
|
int version; |
327 |
|
|
328 |
|
/* encoding parameters */ |
329 |
|
int type; /* [out] coding type */ |
330 |
|
int quant; /* [out] frame quantizer */ |
331 |
|
int vol_flags; /* [out] vol flags (see above) */ |
332 |
|
int vop_flags; /* [out] vop flags (see above) */ |
333 |
|
|
334 |
|
/* bitrate */ |
335 |
|
int length; /* [out] frame length */ |
336 |
|
|
337 |
|
int hlength; /* [out] header length (bytes) */ |
338 |
|
int kblks; /* [out] number of blocks compressed as Intra */ |
339 |
|
int mblks; /* [out] number of blocks compressed as Inter */ |
340 |
|
int ublks; /* [out] number of blocks marked as not_coded */ |
341 |
|
|
342 |
|
int sse_y; /* [out] Y plane's sse */ |
343 |
|
int sse_u; /* [out] U plane's sse */ |
344 |
|
int sse_v; /* [out] V plane's sse */ |
345 |
|
} xvid_enc_stats_t; |
346 |
|
|
347 |
/***************************************************************************** |
/***************************************************************************** |
348 |
xvid plugin system -- internals |
xvid plugin system -- internals |
365 |
#define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
#define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
366 |
#define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ |
#define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ |
367 |
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
368 |
|
#define XVID_REQLAMBDA (1<<3) /* plugin requires access to the lambda table */ |
369 |
|
|
370 |
|
|
371 |
typedef struct |
typedef struct |
400 |
int num_frames; /* [out] total frame encoded */ |
int num_frames; /* [out] total frame encoded */ |
401 |
} xvid_plg_destroy_t; |
} xvid_plg_destroy_t; |
402 |
|
|
|
|
|
403 |
typedef struct |
typedef struct |
404 |
{ |
{ |
405 |
int version; |
int version; |
431 |
int vol_flags; /* [in,out] */ |
int vol_flags; /* [in,out] */ |
432 |
int motion_flags; /* [in,out] */ |
int motion_flags; /* [in,out] */ |
433 |
|
|
434 |
|
/* Lambda table for HVSPlugins */ |
435 |
|
float * lambda; /* [in,out] six floats for each macroblock. read, multiply, write back */ |
436 |
|
|
437 |
|
/* Deprecated, use the stats field instead. |
438 |
|
* Will disapear before 1.0 */ |
439 |
int length; /* [out] after: length of encoded frame */ |
int length; /* [out] after: length of encoded frame */ |
440 |
int kblks; /* [out] number of blocks compressed as Intra */ |
int kblks; /* [out] number of blocks compressed as Intra */ |
441 |
int mblks; /* [out] number of blocks compressed as Inter */ |
int mblks; /* [out] number of blocks compressed as Inter */ |
443 |
int sse_y; /* [out] Y plane's sse */ |
int sse_y; /* [out] Y plane's sse */ |
444 |
int sse_u; /* [out] U plane's sse */ |
int sse_u; /* [out] U plane's sse */ |
445 |
int sse_v; /* [out] V plane's sse */ |
int sse_v; /* [out] V plane's sse */ |
446 |
|
/* End of duplicated data, kept only for binary compatibility */ |
447 |
|
|
448 |
int bquant_ratio; /* [in] */ |
int bquant_ratio; /* [in] */ |
449 |
int bquant_offset; /* [in] */ |
int bquant_offset; /* [in] */ |
|
} xvid_plg_data_t; |
|
450 |
|
|
451 |
|
xvid_enc_stats_t stats; /* [out] frame statistics */ |
452 |
|
} xvid_plg_data_t; |
453 |
|
|
454 |
/***************************************************************************** |
/***************************************************************************** |
455 |
xvid plugin system -- external |
xvid plugin system -- external |
480 |
} xvid_enc_plugin_t; |
} xvid_enc_plugin_t; |
481 |
|
|
482 |
|
|
483 |
xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
extern xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
484 |
xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ |
extern xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ |
485 |
xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ |
extern xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ |
486 |
|
|
487 |
|
extern xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
488 |
|
|
489 |
xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
extern xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
490 |
|
extern xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
491 |
|
|
492 |
xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
extern xvid_plugin_func xvid_plugin_ssim; /*write ssim values to stdout*/ |
|
xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
|
493 |
|
|
494 |
|
|
495 |
/* single pass rate control |
/* single pass rate control |
518 |
typedef struct { |
typedef struct { |
519 |
int version; |
int version; |
520 |
|
|
521 |
int bitrate; /* [in] bits per second */ |
int bitrate; /* [in] target bitrate (bits per second) */ |
522 |
char * filename; /* [in] first pass stats filename */ |
char * filename; /* [in] first pass stats filename */ |
523 |
|
|
524 |
int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
535 |
* 0 for 1<distance<kfthreshold */ |
* 0 for 1<distance<kfthreshold */ |
536 |
|
|
537 |
int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
538 |
|
|
539 |
|
/* ------- v1.1.x ------- */ |
540 |
|
int vbv_size; /* [in] buffer size (bits) */ |
541 |
|
int vbv_initial; /* [in] initial buffer occupancy (bits) */ |
542 |
|
int vbv_maxrate; /* [in] max processing bitrate (bits per second) */ |
543 |
|
int vbv_peakrate; /* [in:opt] max average bitrate over 3 seconds (bits per second) */ |
544 |
|
|
545 |
}xvid_plugin_2pass2_t; |
}xvid_plugin_2pass2_t; |
546 |
|
|
547 |
|
|
548 |
|
typedef struct{ |
549 |
|
/*stat output*/ |
550 |
|
int b_printstat; |
551 |
|
char* stat_path; |
552 |
|
|
553 |
|
/*visualize*/ |
554 |
|
int b_visualize; |
555 |
|
|
556 |
|
/*accuracy 0 very accurate 4 very fast*/ |
557 |
|
int acc; |
558 |
|
|
559 |
|
int cpu_flags; /* XVID_CPU_XXX flags */ |
560 |
|
|
561 |
|
} xvid_plugin_ssim_t; |
562 |
|
|
563 |
|
typedef struct { |
564 |
|
int version; |
565 |
|
|
566 |
|
int method; /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */ |
567 |
|
} xvid_plugin_lumimasking_t; |
568 |
|
|
569 |
/***************************************************************************** |
/***************************************************************************** |
570 |
* xvid_encore() |
* ENCODER API |
571 |
****************************************************************************/ |
****************************************************************************/ |
572 |
|
|
573 |
/* Encoder options */ |
/*---------------------------------------------------------------------------- |
574 |
|
* Encoder operations |
575 |
|
*--------------------------------------------------------------------------*/ |
576 |
|
|
577 |
#define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
#define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
578 |
#define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ |
#define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ |
579 |
#define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes |
#define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes |
580 |
* 0 means this frame should not be written (ie. encoder lag) */ |
* 0 means this frame should not be written (ie. encoder lag) */ |
581 |
|
|
582 |
int xvid_encore(void *handle, int opt, void *param1, void *param2); |
|
583 |
|
/*---------------------------------------------------------------------------- |
584 |
|
* Encoder entry point |
585 |
|
*--------------------------------------------------------------------------*/ |
586 |
|
|
587 |
|
extern int xvid_encore(void *handle, int opt, void *param1, void *param2); |
588 |
|
|
589 |
|
/* Quick API reference |
590 |
|
* |
591 |
|
* XVID_ENC_CREATE operation |
592 |
|
* - handle: ignored |
593 |
|
* - opt: XVID_ENC_CREATE |
594 |
|
* - param1: address of a xvid_enc_create_t structure |
595 |
|
* - param2: ignored |
596 |
|
* |
597 |
|
* XVID_ENC_ENCODE operation |
598 |
|
* - handle: an instance returned by a CREATE op |
599 |
|
* - opt: XVID_ENC_ENCODE |
600 |
|
* - param1: address of a xvid_enc_frame_t structure |
601 |
|
* - param2: address of a xvid_enc_stats_t structure (optional) |
602 |
|
* its return value is asynchronous to what is written to the buffer |
603 |
|
* depending on the delay introduced by bvop use. It's display |
604 |
|
* ordered. |
605 |
|
* |
606 |
|
* XVID_ENC_DESTROY operation |
607 |
|
* - handle: an instance returned by a CREATE op |
608 |
|
* - opt: XVID_ENC_DESTROY |
609 |
|
* - param1: ignored |
610 |
|
* - param2: ignored |
611 |
|
*/ |
612 |
|
|
613 |
|
|
614 |
|
/*---------------------------------------------------------------------------- |
615 |
|
* "Global" flags |
616 |
|
* |
617 |
|
* These flags are used for xvid_enc_create_t->global field during instance |
618 |
|
* creation (operation XVID_ENC_CREATE) |
619 |
|
*--------------------------------------------------------------------------*/ |
620 |
|
|
|
/* Global Flags */ |
|
621 |
#define XVID_GLOBAL_PACKED (1<<0) /* packed bitstream */ |
#define XVID_GLOBAL_PACKED (1<<0) /* packed bitstream */ |
622 |
#define XVID_GLOBAL_CLOSED_GOP (1<<1) /* closed_gop: was DX50BVOP dx50 bvop compatibility */ |
#define XVID_GLOBAL_CLOSED_GOP (1<<1) /* closed_gop: was DX50BVOP dx50 bvop compatibility */ |
623 |
#define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2) |
#define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2) |
625 |
#define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ |
#define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ |
626 |
#define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ |
#define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ |
627 |
#endif |
#endif |
628 |
|
#define XVID_GLOBAL_DIVX5_USERDATA (1<<5) /* write divx5 userdata string |
629 |
|
this is implied if XVID_GLOBAL_PACKED is set */ |
630 |
|
|
631 |
|
/*---------------------------------------------------------------------------- |
632 |
|
* "VOL" flags |
633 |
|
* |
634 |
|
* These flags are used for xvid_enc_frame_t->vol_flags field during frame |
635 |
|
* encoding (operation XVID_ENC_ENCODE) |
636 |
|
*--------------------------------------------------------------------------*/ |
637 |
|
|
|
/* XVID_ENC_ENCODE param1 */ |
|
|
/* vol-based flags */ |
|
638 |
#define XVID_VOL_MPEGQUANT (1<<0) /* enable MPEG type quantization */ |
#define XVID_VOL_MPEGQUANT (1<<0) /* enable MPEG type quantization */ |
639 |
#define XVID_VOL_EXTRASTATS (1<<1) /* enable plane sse stats */ |
#define XVID_VOL_EXTRASTATS (1<<1) /* enable plane sse stats */ |
640 |
#define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ |
#define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ |
641 |
#define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ |
#define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ |
642 |
#define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
#define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
643 |
|
/* NOTE: the reduced resolution feature is not supported anymore. This flag will have no effect! */ |
644 |
#define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ |
#define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ |
645 |
|
|
646 |
|
|
647 |
|
/*---------------------------------------------------------------------------- |
648 |
|
* "VOP" flags |
649 |
|
* |
650 |
|
* These flags are used for xvid_enc_frame_t->vop_flags field during frame |
651 |
|
* encoding (operation XVID_ENC_ENCODE) |
652 |
|
*--------------------------------------------------------------------------*/ |
653 |
|
|
654 |
/* vop based flags */ |
/* Always valid */ |
655 |
#define XVID_VOP_DEBUG (1<< 0) |
#define XVID_VOP_DEBUG (1<< 0) /* print debug messages in frames */ |
656 |
#define XVID_VOP_HALFPEL (1<< 1) /* use halfpel interpolation */ |
#define XVID_VOP_HALFPEL (1<< 1) /* use halfpel interpolation */ |
657 |
#define XVID_VOP_INTER4V (1<< 2) |
#define XVID_VOP_INTER4V (1<< 2) /* use 4 motion vectors per MB */ |
658 |
#define XVID_VOP_TRELLISQUANT (1<< 3) /* use trellis based R-D "optimal" quantization */ |
#define XVID_VOP_TRELLISQUANT (1<< 3) /* use trellis based R-D "optimal" quantization */ |
659 |
#define XVID_VOP_CHROMAOPT (1<< 4) /* enable chroma optimization pre-filter */ |
#define XVID_VOP_CHROMAOPT (1<< 4) /* enable chroma optimization pre-filter */ |
660 |
#define XVID_VOP_CARTOON (1<< 5) /* use 'cartoon mode' */ |
#define XVID_VOP_CARTOON (1<< 5) /* use 'cartoon mode' */ |
661 |
#define XVID_VOP_GREYSCALE (1<< 6) /* enable greyscale only mode (even for color input material chroma is ignored) */ |
#define XVID_VOP_GREYSCALE (1<< 6) /* enable greyscale only mode (even for color input material chroma is ignored) */ |
662 |
#define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ |
#define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ |
663 |
#define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ |
#define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ |
664 |
/* only valid for vol_flags|=XVID_VOL_INTERLACING */ |
#define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */ |
665 |
|
#define XVID_VOP_RD_BVOP (1<<13) /* enable rate-distortion mode decision in b-frames */ |
666 |
|
|
667 |
|
/* Only valid for vol_flags|=XVID_VOL_INTERLACING */ |
668 |
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
669 |
#define XVID_VOP_ALTERNATESCAN (1<<10) /* set alternate vertical scan flag */ |
#define XVID_VOP_ALTERNATESCAN (1<<10) /* set alternate vertical scan flag */ |
670 |
|
|
671 |
/* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
/* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
672 |
#define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ |
#define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ |
673 |
|
/* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */ |
674 |
|
|
675 |
#define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */ |
/*---------------------------------------------------------------------------- |
676 |
|
* "Motion" flags |
677 |
|
* |
678 |
|
* These flags are used for xvid_enc_frame_t->motion field during frame |
679 |
|
* encoding (operation XVID_ENC_ENCODE) |
680 |
|
*--------------------------------------------------------------------------*/ |
681 |
|
|
682 |
/* Motion based flags */ |
/* Motion Estimation Search Patterns */ |
683 |
#define XVID_ME_ADVANCEDDIAMOND16 (1<< 0) /* use advdiamonds instead of diamonds as search pattern */ |
#define XVID_ME_ADVANCEDDIAMOND16 (1<< 0) /* use advdiamonds instead of diamonds as search pattern */ |
684 |
#define XVID_ME_ADVANCEDDIAMOND8 (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */ |
#define XVID_ME_ADVANCEDDIAMOND8 (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */ |
685 |
#define XVID_ME_USESQUARES16 (1<< 2) /* use squares instead of diamonds as search pattern */ |
#define XVID_ME_USESQUARES16 (1<< 2) /* use squares instead of diamonds as search pattern */ |
686 |
#define XVID_ME_USESQUARES8 (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */ |
#define XVID_ME_USESQUARES8 (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */ |
687 |
|
|
688 |
|
/* SAD operator based flags */ |
689 |
#define XVID_ME_HALFPELREFINE16 (1<< 4) |
#define XVID_ME_HALFPELREFINE16 (1<< 4) |
690 |
#define XVID_ME_HALFPELREFINE8 (1<< 6) |
#define XVID_ME_HALFPELREFINE8 (1<< 6) |
691 |
#define XVID_ME_QUARTERPELREFINE16 (1<< 7) |
#define XVID_ME_QUARTERPELREFINE16 (1<< 7) |
695 |
#define XVID_ME_EXTSEARCH8 (1<<11) /* use diamond/square for extended 8x8 search */ |
#define XVID_ME_EXTSEARCH8 (1<<11) /* use diamond/square for extended 8x8 search */ |
696 |
#define XVID_ME_CHROMA_PVOP (1<<12) /* also use chroma for P_VOP/S_VOP ME */ |
#define XVID_ME_CHROMA_PVOP (1<<12) /* also use chroma for P_VOP/S_VOP ME */ |
697 |
#define XVID_ME_CHROMA_BVOP (1<<13) /* also use chroma for B_VOP ME */ |
#define XVID_ME_CHROMA_BVOP (1<<13) /* also use chroma for B_VOP ME */ |
698 |
|
#define XVID_ME_FASTREFINE16 (1<<25) /* use low-complexity refinement functions */ |
699 |
|
#define XVID_ME_FASTREFINE8 (1<<29) /* low-complexity 8x8 sub-block refinement */ |
700 |
|
|
701 |
/* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */ |
/* Rate Distortion based flags |
702 |
|
* Valid when XVID_VOP_MODEDECISION_RD is enabled */ |
703 |
#define XVID_ME_HALFPELREFINE16_RD (1<<14) /* perform RD-based halfpel refinement */ |
#define XVID_ME_HALFPELREFINE16_RD (1<<14) /* perform RD-based halfpel refinement */ |
704 |
#define XVID_ME_HALFPELREFINE8_RD (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */ |
#define XVID_ME_HALFPELREFINE8_RD (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */ |
705 |
#define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */ |
#define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */ |
707 |
#define XVID_ME_EXTSEARCH_RD (1<<18) /* perform RD-based search using square pattern enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */ |
#define XVID_ME_EXTSEARCH_RD (1<<18) /* perform RD-based search using square pattern enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */ |
708 |
#define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */ |
#define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */ |
709 |
|
|
710 |
|
/* Other */ |
711 |
|
#define XVID_ME_DETECT_STATIC_MOTION (1<<24) /* speed-up ME by detecting stationary scenes */ |
712 |
|
#define XVID_ME_SKIP_DELTASEARCH (1<<26) /* speed-up by skipping b-frame delta search */ |
713 |
|
#define XVID_ME_FAST_MODEINTERPOLATE (1<<27) /* speed-up by partly skipping interpolate mode */ |
714 |
|
#define XVID_ME_BFRAME_EARLYSTOP (1<<28) /* speed-up by early exiting b-search */ |
715 |
|
|
716 |
|
/* Unused */ |
717 |
#define XVID_ME_UNRESTRICTED16 (1<<20) /* unrestricted ME, not implemented */ |
#define XVID_ME_UNRESTRICTED16 (1<<20) /* unrestricted ME, not implemented */ |
718 |
#define XVID_ME_OVERLAPPING16 (1<<21) /* overlapping ME, not implemented */ |
#define XVID_ME_OVERLAPPING16 (1<<21) /* overlapping ME, not implemented */ |
719 |
#define XVID_ME_UNRESTRICTED8 (1<<22) /* unrestricted ME, not implemented */ |
#define XVID_ME_UNRESTRICTED8 (1<<22) /* unrestricted ME, not implemented */ |
720 |
#define XVID_ME_OVERLAPPING8 (1<<23) /* overlapping ME, not implemented */ |
#define XVID_ME_OVERLAPPING8 (1<<23) /* overlapping ME, not implemented */ |
721 |
|
|
|
#define XVID_ME_DETECT_STATIC_MOTION (1<<24) /* speed-up ME by detecting stationary scenes */ |
|
|
#define XVID_ME_FASTREFINE16 (1<<25) /* use low-complexity refinement functions */ |
|
722 |
|
|
723 |
/* XVID_ENC_CREATE param1 */ |
/*---------------------------------------------------------------------------- |
724 |
|
* xvid_enc_create_t structure definition |
725 |
|
* |
726 |
|
* This structure is passed as param1 during an instance creation (operation |
727 |
|
* XVID_ENC_CREATE) |
728 |
|
*--------------------------------------------------------------------------*/ |
729 |
|
|
730 |
typedef struct { |
typedef struct { |
731 |
int version; |
int version; |
732 |
|
|
763 |
/* ---------------------------------------------- */ |
/* ---------------------------------------------- */ |
764 |
|
|
765 |
void *handle; /* [out] encoder instance handle */ |
void *handle; /* [out] encoder instance handle */ |
766 |
} |
|
767 |
xvid_enc_create_t; |
/* ------- v1.3.x ------- */ |
768 |
|
int start_frame_num; /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */ |
769 |
|
} xvid_enc_create_t; |
770 |
|
|
771 |
|
|
772 |
|
/*---------------------------------------------------------------------------- |
773 |
|
* xvid_enc_frame_t structure definition |
774 |
|
* |
775 |
|
* This structure is passed as param1 during a frame encoding (operation |
776 |
|
* XVID_ENC_ENCODE) |
777 |
|
*--------------------------------------------------------------------------*/ |
778 |
|
|
779 |
|
/* out value for the frame structure->type field |
780 |
|
* unlike stats output in param2, this field is not asynchronous and tells |
781 |
|
* the client app, if the frame written into the stream buffer is an ivop |
782 |
|
* usually used for indexing purpose in the container */ |
783 |
#define XVID_KEYFRAME (1<<1) |
#define XVID_KEYFRAME (1<<1) |
784 |
|
|
785 |
|
/* The structure */ |
786 |
typedef struct { |
typedef struct { |
787 |
int version; |
int version; |
788 |
|
|
789 |
/* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any changes here until the next VOL (keyframe). */ |
/* VOL related stuff |
790 |
|
* unless XVID_FORCEVOL is set, the encoder will not react to any changes |
791 |
|
* here until the next VOL (keyframe). */ |
792 |
|
|
793 |
int vol_flags; /* [in] vol flags */ |
int vol_flags; /* [in] vol flags */ |
794 |
unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */ |
unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */ |
795 |
unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */ |
unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */ |
797 |
int par; /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
int par; /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
798 |
int par_width; /* [in:opt] aspect ratio width */ |
int par_width; /* [in:opt] aspect ratio width */ |
799 |
int par_height; /* [in:opt] aspect ratio height */ |
int par_height; /* [in:opt] aspect ratio height */ |
800 |
/* ---------------------------------------------- */ |
|
801 |
|
/* Other fields that can change on a frame base */ |
802 |
|
|
803 |
int fincr; /* [in:opt] framerate increment, for variable framerate only */ |
int fincr; /* [in:opt] framerate increment, for variable framerate only */ |
804 |
int vop_flags; /* [in] (general)vop-based flags */ |
int vop_flags; /* [in] (general)vop-based flags */ |
816 |
int out_flags; /* [out] bitstream output flags */ |
int out_flags; /* [out] bitstream output flags */ |
817 |
} xvid_enc_frame_t; |
} xvid_enc_frame_t; |
818 |
|
|
|
|
|
|
/* XVID_ENC_ENCODE param2 (optional) |
|
|
xvid_enc_stats_t describes individual frame details |
|
|
|
|
|
coding_type==XVID_TYPE_NOTHING if the stats are not given |
|
|
*/ |
|
|
typedef struct { |
|
|
int version; |
|
|
|
|
|
/* encoding parameters */ |
|
|
int type; /* [out] coding type */ |
|
|
int quant; /* [out] frame quantizer */ |
|
|
int vol_flags; /* [out] vol flags (see above) */ |
|
|
int vop_flags; /* [out] vop flags (see above) */ |
|
|
|
|
|
/* bitrate */ |
|
|
int length; /* [out] frame length */ |
|
|
|
|
|
int hlength; /* [out] header length (bytes) */ |
|
|
int kblks; /* [out] number of blocks compressed as Intra */ |
|
|
int mblks; /* [out] number of blocks compressed as Inter */ |
|
|
int ublks; /* [out] number of blocks marked as not_coded */ |
|
|
|
|
|
int sse_y; /* [out] Y plane's sse */ |
|
|
int sse_u; /* [out] U plane's sse */ |
|
|
int sse_v; /* [out] V plane's sse */ |
|
|
} xvid_enc_stats_t; |
|
|
|
|
819 |
#ifdef __cplusplus |
#ifdef __cplusplus |
820 |
} |
} |
821 |
#endif |
#endif |
822 |
|
|
|
|
|
823 |
#endif |
#endif |