--- liblzf/lzfP.h 2003/12/23 04:52:00 1.5 +++ liblzf/lzfP.h 2010/02/04 21:31:17 1.20 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000-2003 Marc Alexander Lehmann + * Copyright (c) 2000-2007 Marc Alexander Lehmann * * Redistribution and use in source and binary forms, with or without modifica- * tion, are permitted provided that the following conditions are met: @@ -11,9 +11,6 @@ * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * - * 3. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO @@ -24,76 +21,104 @@ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Alternatively, the contents of this file may be used under the terms of + * the GNU General Public License ("GPL") version 2 or any later version, + * in which case the provisions of the GPL are applicable instead of + * the above. If you wish to allow the use of your version of this file + * only under the terms of the GPL and not to allow others to use your + * version of this file under the BSD license, indicate your decision + * by deleting the provisions above and replace them with the notice + * and other provisions required by the GPL. If you do not delete the + * provisions above, a recipient may use your version of this file under + * either the BSD or the GPL. */ #ifndef LZFP_h #define LZFP_h -#define STANDALONE /* at the moment, this is ok. */ +#define STANDALONE 1 /* at the moment, this is ok. */ #ifndef STANDALONE # include "lzf.h" #endif /* - * size of hashtable is (1 << HLOG) * sizeof (char *) + * Size of hashtable is (1 << HLOG) * sizeof (char *) * decompression is independent of the hash table size * the difference between 15 and 14 is very small - * for small blocks (and 14 is also faster). - * For a low-memory configuration, use HLOG == 13; - * For best compression, use 15 or 16. + * for small blocks (and 14 is usually a bit faster). + * For a low-memory/faster configuration, use HLOG == 13; + * For best compression, use 15 or 16 (or more, up to 23). */ #ifndef HLOG -# define HLOG 14 +# define HLOG 16 #endif /* - * sacrifice some compression quality in favour of compression speed. - * (roughly 1-2% worse compression for large blocks and - * 9-10% for small, redundant, blocks and >>20% better speed in both cases) - * In short: enable this for binary data, disable this for text data. + * Sacrifice very little compression quality in favour of compression speed. + * This gives almost the same compression as the default code, and is + * (very roughly) 15% faster. This is the preferred mode of operation. */ -#ifndef ULTRA_FAST -# define ULTRA_FAST 1 +#ifndef VERY_FAST +# define VERY_FAST 1 #endif /* - * unconditionally aligning does not cost very much, so do it if unsure + * Sacrifice some more compression quality in favour of compression speed. + * (roughly 1-2% worse compression for large blocks and + * 9-10% for small, redundant, blocks and >>20% better speed in both cases) + * In short: when in need for speed, enable this for binary data, + * possibly disable this for text data. */ -#ifndef STRICT_ALIGN -# define STRICT_ALIGN !defined(__i386) +#ifndef ULTRA_FAST +# define ULTRA_FAST 0 #endif /* - * use string functions to copy memory. - * this is usually a loss, even with glibc's optimized memcpy + * Unconditionally aligning does not cost very much, so do it if unsure */ -#ifndef USE_MEMCPY -# define USE_MEMCPY 0 +#ifndef STRICT_ALIGN +# define STRICT_ALIGN !(defined(__i386) || defined (__amd64)) #endif /* - * you may choose to pre-set the hash table (might be faster on modern cpus - * and large (>>64k) blocks) + * You may choose to pre-set the hash table (might be faster on some + * modern cpus and large (>>64k) blocks, and also makes compression + * deterministic/repeatable when the configuration otherwise is the same). */ #ifndef INIT_HTAB # define INIT_HTAB 0 #endif /* - * avoid assigning values to errno variable? for some embedding purposes - * (linux kernel for example), this is not + * Avoid assigning values to errno variable? for some embedding purposes + * (linux kernel for example), this is necessary. NOTE: this breaks + * the documentation in lzf.h. */ #ifndef AVOID_ERRNO # define AVOID_ERRNO 0 #endif /* - * Wether to pass the LZF_STATE variable as argument, or allocate it - * on the stack. For small-stack environments, define this to zero. + * Whether to pass the LZF_STATE variable as argument, or allocate it + * on the stack. For small-stack environments, define this to 1. + * NOTE: this breaks the prototype in lzf.h. */ #ifndef LZF_STATE_ARG -# define LZF_STATE_ARG 1 +# define LZF_STATE_ARG 0 +#endif + +/* + * Whether to add extra checks for input validity in lzf_decompress + * and return EINVAL if the input stream has been corrupted. This + * only shields against overflowing the input buffer and will not + * detect most corrupted streams. + * This check is not normally noticeable on modern hardware + * (<1% slowdown), but might slow down older cpus considerably. + */ +#ifndef CHECK_INPUT +# define CHECK_INPUT 1 #endif /*****************************************************************************/ @@ -116,8 +141,18 @@ # endif #endif -#if USE_MEMCPY || INIT_HTAB -# include +#if ULTRA_FAST +# if defined(VERY_FAST) +# undef VERY_FAST +# endif +#endif + +#if INIT_HTAB +# ifdef __cplusplus +# include +# else +# include +# endif #endif #endif