cvsroot/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, up to 22).
 */
#ifndef HLOG
# define HLOG 16
#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 preferred 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.
 * Unaligned accesses are not safe even on x86, so disable by default.
 */
#ifndef STRICT_ALIGN
# define STRICT_ALIGN 0 /* was: # !(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 1
#endif

/*
 * 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. Avoiding errno has no speed impact.
 */
#ifndef AVOID_ERRNO
# define AVOID_ERRNO 0
#endif

/*
 * 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 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

/*
 * Whether the target CPU has a slow multiplication. This affects
 * the default hash function for the compressor, and enables a slightly
 * worse hash function that needs only shifts.
 */
#ifndef MULTIPLICATION_IS_SLOW
# define MULTIPLICATION_IS_SLOW 0
#endif

/*
 * If defined, then this data type will be used for storing offsets.
 * This can be useful if you want to use a huge hashtable, want to
 * conserve memory, or both, and your data fits into e.g. 64kb.
 * If instead you want to compress data > 4GB, then it's better to
 * to "#define LZF_USE_OFFSETS 0" instead.
 */
/*#define LZF_HSLOT unsigned short*/

/*
 * Whether to store pointers or offsets inside the hash table. On
 * 64 bit architetcures, pointers take up twice as much space,
 * and might also be slower. Default is to autodetect.
 */
/*#define LZF_USE_OFFSETS autodetect */

/*
 * Whether to optimise code for size, at the expense of speed. Use
 * this when you are extremely tight on memory, perhaps in combination
 * with AVOID_ERRNO 1 and CHECK_INPUT 0.
 */
#ifndef OPTIMISE_SIZE
# ifdef __OPTIMIZE_SIZE__
#  define OPTIMISE_SIZE 1
# else
#  define OPTIMISE_SIZE 0
# endif
#endif

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

#ifdef __cplusplus
# include <cstring>
# include <climits>
using namespace std;
#else
# include <string.h>
# include <limits.h>
#endif

#if ULTRA_FAST
# undef VERY_FAST
#endif

#ifndef LZF_USE_OFFSETS
# ifdef _WIN32
#  define LZF_USE_OFFSETS defined(_M_X64)
# else
#  if __cplusplus > 199711L
#   include <cstdint>
#  else
#   include <stdint.h>
#  endif
#  define LZF_USE_OFFSETS (UINTPTR_MAX > 0xffffffffU)
# endif
#endif

typedef unsigned char u8;

#ifdef LZF_HSLOT
# define LZF_HSLOT_BIAS ((const u8 *)in_data)
#else
# if LZF_USE_OFFSETS
#  define LZF_HSLOT_BIAS ((const u8 *)in_data)
   typedef unsigned int LZF_HSLOT;
# else
#  define LZF_HSLOT_BIAS 0
   typedef const u8 *LZF_HSLOT;
# endif
#endif

#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

#define LZF_MAX_LIT (1 <<  5)
#define LZF_MAX_OFF (1 << 13)
#define LZF_MAX_REF ((1 << 8) + (1 << 3))

typedef LZF_HSLOT LZF_STATE[1 << (HLOG)];

typedef struct
{
  const u8 *first [1 << (6+8)]; /* most recent occurance of a match */
  u16 prev [LZF_MAX_OFF]; /* how many bytes to go backwards for the next match */
} LZF_STATE_BEST[1];

#endif

Revision:	1.32
Committed:	Tue Nov 12 12:46:28 2024 UTC (22 months, 3 weeks ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.31:	+3 -2 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.29	*
4	root	1.1	* Redistribution and use in source and binary forms, with or without modifica-
5			* tion, are permitted provided that the following conditions are met:
6	root	1.29	*
7	root	1.1	* 1. Redistributions of source code must retain the above copyright notice,
8			* this list of conditions and the following disclaimer.
9	root	1.29	*
10	root	1.1	* 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	root	1.29	*
14	root	1.1	* 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	root	1.24	* For best compression, use 15 or 16 (or more, up to 22).
53	root	1.1	*/
54			#ifndef HLOG
55	root	1.19	# define HLOG 16
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	root	1.18	* (very roughly) 15% faster. This is the preferred mode of operation.
62	root	1.11	*/
63			#ifndef VERY_FAST
64			# define VERY_FAST 1
65			#endif
66
67			/*
68	root	1.12	* Sacrifice some more compression quality in favour of compression speed.
69	root	1.1	* (roughly 1-2% worse compression for large blocks and
70	root	1.2	* 9-10% for small, redundant, blocks and >>20% better speed in both cases)
71	root	1.11	* In short: when in need for speed, enable this for binary data,
72			* possibly disable this for text data.
73	root	1.1	*/
74			#ifndef ULTRA_FAST
75	root	1.11	# define ULTRA_FAST 0
76	root	1.1	#endif
77
78			/*
79	root	1.32	* Unconditionally aligning does not cost very much, so do it if unsure.
80			* Unaligned accesses are not safe even on x86, so disable by default.
81	root	1.1	*/
82			#ifndef STRICT_ALIGN
83	root	1.32	# define STRICT_ALIGN 0 /* was: # !(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	root	1.26	# define INIT_HTAB 1
93	root	1.1	#endif
94
95	pcg	1.5	/*
96	root	1.12	* Avoid assigning values to errno variable? for some embedding purposes
97	root	1.20	* (linux kernel for example), this is necessary. NOTE: this breaks
98	root	1.21	* the documentation in lzf.h. Avoiding errno has no speed impact.
99	pcg	1.5	*/
100			#ifndef AVOID_ERRNO
101			# define AVOID_ERRNO 0
102			#endif
103
104			/*
105	root	1.20	* Whether 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	root	1.20	* Whether to add extra checks for input validity in lzf_decompress
115	root	1.12	* 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	root	1.20	* This check is not normally noticeable on modern hardware
119	root	1.12	* (<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.22	/*
126	root	1.26	* Whether the target CPU has a slow multiplication. This affects
127			* the default hash function for the compressor, and enables a slightly
128			* worse hash function that needs only shifts.
129			*/
130			#ifndef MULTIPLICATION_IS_SLOW
131			# define MULTIPLICATION_IS_SLOW 0
132			#endif
133
134			/*
135			* If defined, then this data type will be used for storing offsets.
136			* This can be useful if you want to use a huge hashtable, want to
137			* conserve memory, or both, and your data fits into e.g. 64kb.
138			* If instead you want to compress data > 4GB, then it's better to
139			* to "#define LZF_USE_OFFSETS 0" instead.
140			*/
141			/#define LZF_HSLOT unsigned short/
142
143			/*
144	root	1.22	* Whether to store pointers or offsets inside the hash table. On
145			* 64 bit architetcures, pointers take up twice as much space,
146			* and might also be slower. Default is to autodetect.
147			*/
148	root	1.26	/#define LZF_USE_OFFSETS autodetect /
149	root	1.22
150	root	1.30	/*
151			* Whether to optimise code for size, at the expense of speed. Use
152			* this when you are extremely tight on memory, perhaps in combination
153			* with AVOID_ERRNO 1 and CHECK_INPUT 0.
154			*/
155			#ifndef OPTIMISE_SIZE
156			# ifdef __OPTIMIZE_SIZE__
157			# define OPTIMISE_SIZE 1
158			# else
159			# define OPTIMISE_SIZE 0
160			# endif
161			#endif
162
163	root	1.1	/*****************************************************************************/
164			/* nothing should be changed below */
165
166	root	1.21	#ifdef __cplusplus
167			# include <cstring>
168	root	1.22	# include <climits>
169	root	1.21	using namespace std;
170			#else
171			# include <string.h>
172	root	1.22	# include <limits.h>
173			#endif
174
175	root	1.31	#if ULTRA_FAST
176			# undef VERY_FAST
177			#endif
178
179	root	1.22	#ifndef LZF_USE_OFFSETS
180	root	1.28	# ifdef _WIN32
181	root	1.22	# define LZF_USE_OFFSETS defined(_M_X64)
182			# else
183	root	1.23	# if __cplusplus > 199711L
184	root	1.22	# include <cstdint>
185			# else
186			# include <stdint.h>
187			# endif
188			# define LZF_USE_OFFSETS (UINTPTR_MAX > 0xffffffffU)
189			# endif
190	root	1.21	#endif
191
192	root	1.1	typedef unsigned char u8;
193	pcg	1.5
194	root	1.26	#ifdef LZF_HSLOT
195	root	1.22	# define LZF_HSLOT_BIAS ((const u8 *)in_data)
196			#else
197	root	1.26	# if LZF_USE_OFFSETS
198			# define LZF_HSLOT_BIAS ((const u8 *)in_data)
199			typedef unsigned int LZF_HSLOT;
200			# else
201			# define LZF_HSLOT_BIAS 0
202			typedef const u8 *LZF_HSLOT;
203			# endif
204	root	1.22	#endif
205
206	root	1.27	#if USHRT_MAX == 65535
207			typedef unsigned short u16;
208			#elif UINT_MAX == 65535
209			typedef unsigned int u16;
210			#else
211			# undef STRICT_ALIGN
212			# define STRICT_ALIGN 1
213	root	1.1	#endif
214
215	root	1.31	#define LZF_MAX_LIT (1 << 5)
216			#define LZF_MAX_OFF (1 << 13)
217			#define LZF_MAX_REF ((1 << 8) + (1 << 3))
218
219			typedef LZF_HSLOT LZF_STATE[1 << (HLOG)];
220
221			typedef struct
222			{
223			const u8 first [1 << (6+8)]; / most recent occurance of a match */
224			u16 prev [LZF_MAX_OFF]; /* how many bytes to go backwards for the next match */
225			} LZF_STATE_BEST[1];
226	root	1.1
227			#endif
228