Compress-LZF/lzfP.h

/*
 * Copyright (c) 2000-2005 Marc Alexander Lehmann <schmorp@schmorp.de>
 * 
 * Redistribution and use in source and binary forms, with or without modifica-
 * tion, are permitted provided that the following conditions are met:
 * 
 *   1.  Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 * 
 *   2.  Redistributions in binary form must reproduce the above copyright
 *       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
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * 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 version 2 (the "GPL"), 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 1 /* at the moment, this is ok. */

#ifndef STANDALONE
# include "lzf.h"
#endif

/*
 * 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 usually a bit faster).
 * For a low-memory/faster configuration, use HLOG == 13;
 * For best compression, use 15 or 16 (or more).
 */
#ifndef HLOG
# define HLOG 15
#endif

/*
 * 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 preferable mode of operation.
 */

#ifndef VERY_FAST
# define VERY_FAST 1
#endif

/*
 * 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 ULTRA_FAST
# define ULTRA_FAST 0
#endif

/*
 * Unconditionally aligning does not cost very much, so do it if unsure
 */
#ifndef STRICT_ALIGN
# define STRICT_ALIGN !(defined(__i386) || defined (__amd64))
#endif

/*
 * Use string functions to copy memory.
 * this is usually a loss, even with glibc's optimized memcpy
 */
#ifndef USE_MEMCPY
# define USE_MEMCPY 0
#endif

/*
 * You may choose to pre-set the hash table (might be faster on some
 * modern cpus and large (>>64k) blocks)
 */
#ifndef INIT_HTAB
# define INIT_HTAB 0
#endif

/*
 * Avoid assigning values to errno variable? for some embedding purposes
 * (linux kernel for example), this is neccessary. 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 1.
 * NOTE: this breaks the prototype in lzf.h.
 */
#ifndef LZF_STATE_ARG
# define LZF_STATE_ARG 0
#endif

/*
 * Wether 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 noticable on modern hardware
 * (<1% slowdown), but might slow down older cpus considerably.
 */
#ifndef CHECK_INPUT
# define CHECK_INPUT 1
#endif

/*****************************************************************************/
/* nothing should be changed below */

typedef unsigned char u8;

typedef const u8 *LZF_STATE[1 << (HLOG)];

#if !STRICT_ALIGN
/* for unaligned accesses we need a 16 bit datatype. */
# include <limits.h>
# if USHRT_MAX == 65535
    typedef unsigned short u16;
# elif UINT_MAX == 65535
    typedef unsigned int u16;
# else
#  undef STRICT_ALIGN
#  define STRICT_ALIGN 1
# endif
#endif

#if ULTRA_FAST
# if defined(VERY_FAST)
#  undef VERY_FAST
# endif
#endif

#if USE_MEMCPY || INIT_HTAB
# ifdef __cplusplus
#  include <cstring>
# else
#  include <string.h>
# endif
#endif

#endif

Revision:	1.5
Committed:	Fri Jul 7 15:47:10 2006 UTC (20 years, 2 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-1_71, rel-1_8, rel-1_7
Changes since 1.4:	+21 -9 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	/*
2	pcg	1.3	* Copyright (c) 2000-2005 Marc Alexander Lehmann <schmorp@schmorp.de>
3	root	1.1	*
4			* Redistribution and use in source and binary forms, with or without modifica-
5			* tion, are permitted provided that the following conditions are met:
6			*
7			* 1. Redistributions of source code must retain the above copyright notice,
8			* this list of conditions and the following disclaimer.
9			*
10			* 2. Redistributions in binary form must reproduce the above copyright
11			* notice, this list of conditions and the following disclaimer in the
12			* documentation and/or other materials provided with the distribution.
13			*
14			* 3. The name of the author may not be used to endorse or promote products
15			* derived from this software without specific prior written permission.
16			*
17			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18			* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19			* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20			* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21			* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22			* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23			* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24			* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25			* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26			* OF THE POSSIBILITY OF SUCH DAMAGE.
27	pcg	1.2	*
28			* Alternatively, the contents of this file may be used under the terms of
29			* the GNU General Public License version 2 (the "GPL"), in which case the
30			* provisions of the GPL are applicable instead of the above. If you wish to
31			* allow the use of your version of this file only under the terms of the
32			* GPL and not to allow others to use your version of this file under the
33			* BSD license, indicate your decision by deleting the provisions above and
34			* replace them with the notice and other provisions required by the GPL. If
35			* you do not delete the provisions above, a recipient may use your version
36			* of this file under either the BSD or the GPL.
37	root	1.1	*/
38
39			#ifndef LZFP_h
40			#define LZFP_h
41
42	root	1.4	#define STANDALONE 1 /* at the moment, this is ok. */
43	root	1.1
44			#ifndef STANDALONE
45			# include "lzf.h"
46			#endif
47
48			/*
49	root	1.5	* Size of hashtable is (1 << HLOG) * sizeof (char *)
50	root	1.1	* decompression is independent of the hash table size
51			* the difference between 15 and 14 is very small
52	root	1.5	* for small blocks (and 14 is usually a bit faster).
53	root	1.4	* For a low-memory/faster configuration, use HLOG == 13;
54			* For best compression, use 15 or 16 (or more).
55	root	1.1	*/
56			#ifndef HLOG
57	root	1.5	# define HLOG 15
58	root	1.1	#endif
59
60			/*
61	root	1.5	* Sacrifice very little compression quality in favour of compression speed.
62	root	1.4	* This gives almost the same compression as the default code, and is
63			* (very roughly) 15% faster. This is the preferable mode of operation.
64			*/
65
66			#ifndef VERY_FAST
67			# define VERY_FAST 1
68			#endif
69
70			/*
71	root	1.5	* Sacrifice some more compression quality in favour of compression speed.
72	root	1.1	* (roughly 1-2% worse compression for large blocks and
73	pcg	1.2	* 9-10% for small, redundant, blocks and >>20% better speed in both cases)
74	root	1.4	* In short: when in need for speed, enable this for binary data,
75			* possibly disable this for text data.
76	root	1.1	*/
77			#ifndef ULTRA_FAST
78	root	1.4	# define ULTRA_FAST 0
79	root	1.1	#endif
80
81			/*
82	root	1.5	* Unconditionally aligning does not cost very much, so do it if unsure
83	root	1.1	*/
84			#ifndef STRICT_ALIGN
85	root	1.4	# define STRICT_ALIGN !(defined(__i386) \|\| defined (__amd64))
86	root	1.1	#endif
87
88			/*
89	root	1.5	* Use string functions to copy memory.
90	root	1.1	* this is usually a loss, even with glibc's optimized memcpy
91			*/
92			#ifndef USE_MEMCPY
93			# define USE_MEMCPY 0
94			#endif
95
96			/*
97	root	1.5	* You may choose to pre-set the hash table (might be faster on some
98	root	1.4	* modern cpus and large (>>64k) blocks)
99	root	1.1	*/
100			#ifndef INIT_HTAB
101			# define INIT_HTAB 0
102			#endif
103
104	pcg	1.2	/*
105	root	1.5	* Avoid assigning values to errno variable? for some embedding purposes
106	pcg	1.2	* (linux kernel for example), this is neccessary. NOTE: this breaks
107			* the documentation in lzf.h.
108			*/
109			#ifndef AVOID_ERRNO
110			# define AVOID_ERRNO 0
111			#endif
112
113			/*
114			* Wether to pass the LZF_STATE variable as argument, or allocate it
115			* on the stack. For small-stack environments, define this to 1.
116			* NOTE: this breaks the prototype in lzf.h.
117			*/
118			#ifndef LZF_STATE_ARG
119			# define LZF_STATE_ARG 0
120			#endif
121
122	root	1.5	/*
123			* Wether to add extra checks for input validity in lzf_decompress
124			* and return EINVAL if the input stream has been corrupted. This
125			* only shields against overflowing the input buffer and will not
126			* detect most corrupted streams.
127			* This check is not normally noticable on modern hardware
128			* (<1% slowdown), but might slow down older cpus considerably.
129			*/
130			#ifndef CHECK_INPUT
131			# define CHECK_INPUT 1
132			#endif
133
134	root	1.1	/*****************************************************************************/
135			/* nothing should be changed below */
136
137			typedef unsigned char u8;
138
139	pcg	1.2	typedef const u8 *LZF_STATE[1 << (HLOG)];
140
141	root	1.1	#if !STRICT_ALIGN
142			/* for unaligned accesses we need a 16 bit datatype. */
143			# include <limits.h>
144			# if USHRT_MAX == 65535
145			typedef unsigned short u16;
146			# elif UINT_MAX == 65535
147			typedef unsigned int u16;
148			# else
149			# undef STRICT_ALIGN
150			# define STRICT_ALIGN 1
151			# endif
152			#endif
153
154	root	1.4	#if ULTRA_FAST
155			# if defined(VERY_FAST)
156			# undef VERY_FAST
157			# endif
158			#endif
159
160	root	1.1	#if USE_MEMCPY \|\| INIT_HTAB
161	pcg	1.3	# ifdef __cplusplus
162			# include <cstring>
163			# else
164			# include <string.h>
165			# endif
166	root	1.1	#endif
167
168			#endif
169