liblzf/lzfP.h

/*
 * Copyright (c) 2000-2003 Marc Alexander Lehmann <pcg@goof.com>
 * 
 * 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 /* 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 also faster).
 * For a low-memory configuration, use HLOG == 13;
 * For best compression, use 15 or 16.
 */
#ifndef HLOG
# define HLOG 14
#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.
 */
#ifndef ULTRA_FAST
# define ULTRA_FAST 1
#endif

/*
 * unconditionally aligning does not cost very much, so do it if unsure
 */
#ifndef STRICT_ALIGN
# define STRICT_ALIGN !defined(__i386)
#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 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

/*****************************************************************************/
/* 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 USE_MEMCPY || INIT_HTAB
# include <string.h>
#endif

#endif

Revision:	1.8
Committed:	Tue Apr 20 18:11:57 2004 UTC (20 years, 1 month ago) by pcg
Content type:	text/plain
Branch:	MAIN
Changes since 1.7:	+10 -0 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	/*
2	pcg	1.5	* Copyright (c) 2000-2003 Marc Alexander Lehmann <pcg@goof.com>
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.8	*
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			#define STANDALONE /* at the moment, this is ok. */
43
44			#ifndef STANDALONE
45			# include "lzf.h"
46			#endif
47
48			/*
49			* size of hashtable is (1 << HLOG) * sizeof (char *)
50			* decompression is independent of the hash table size
51			* the difference between 15 and 14 is very small
52			* for small blocks (and 14 is also faster).
53			* For a low-memory configuration, use HLOG == 13;
54			* For best compression, use 15 or 16.
55			*/
56			#ifndef HLOG
57			# define HLOG 14
58			#endif
59
60			/*
61			* sacrifice some compression quality in favour of compression speed.
62			* (roughly 1-2% worse compression for large blocks and
63	root	1.2	* 9-10% for small, redundant, blocks and >>20% better speed in both cases)
64	root	1.1	* In short: enable this for binary data, disable this for text data.
65			*/
66			#ifndef ULTRA_FAST
67			# define ULTRA_FAST 1
68			#endif
69
70			/*
71			* unconditionally aligning does not cost very much, so do it if unsure
72			*/
73			#ifndef STRICT_ALIGN
74			# define STRICT_ALIGN !defined(__i386)
75			#endif
76
77			/*
78			* use string functions to copy memory.
79			* this is usually a loss, even with glibc's optimized memcpy
80			*/
81			#ifndef USE_MEMCPY
82			# define USE_MEMCPY 0
83			#endif
84
85			/*
86			* you may choose to pre-set the hash table (might be faster on modern cpus
87			* and large (>>64k) blocks)
88			*/
89			#ifndef INIT_HTAB
90			# define INIT_HTAB 0
91			#endif
92
93	pcg	1.5	/*
94			* avoid assigning values to errno variable? for some embedding purposes
95	pcg	1.6	* (linux kernel for example), this is neccessary. NOTE: this breaks
96			* the documentation in lzf.h.
97	pcg	1.5	*/
98			#ifndef AVOID_ERRNO
99			# define AVOID_ERRNO 0
100			#endif
101
102			/*
103			* Wether to pass the LZF_STATE variable as argument, or allocate it
104	pcg	1.7	* on the stack. For small-stack environments, define this to 1.
105	pcg	1.6	* NOTE: this breaks the prototype in lzf.h.
106	pcg	1.5	*/
107			#ifndef LZF_STATE_ARG
108	pcg	1.7	# define LZF_STATE_ARG 0
109	pcg	1.5	#endif
110
111	root	1.1	/*****************************************************************************/
112			/* nothing should be changed below */
113
114			typedef unsigned char u8;
115	pcg	1.5
116			typedef const u8 *LZF_STATE[1 << (HLOG)];
117	root	1.1
118			#if !STRICT_ALIGN
119			/* for unaligned accesses we need a 16 bit datatype. */
120			# include <limits.h>
121			# if USHRT_MAX == 65535
122			typedef unsigned short u16;
123			# elif UINT_MAX == 65535
124			typedef unsigned int u16;
125			# else
126			# undef STRICT_ALIGN
127			# define STRICT_ALIGN 1
128			# endif
129			#endif
130
131			#if USE_MEMCPY \|\| INIT_HTAB
132			# include <string.h>
133			#endif
134
135			#endif
136