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

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

#endif

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