liblzf/lzfP.h

/*
 * Copyright (c) 2000-2007 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.
 * 
 * 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 ("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 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

/*
 * 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 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 INIT_HTAB
# ifdef __cplusplus
#  include <cstring>
# else
#  include <string.h>
# endif
#endif

#endif

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