liblzf/lzf.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 LZF_H
#define LZF_H

/***********************************************************************
**
**      lzf -- an extremely fast/free compression/decompression-method
**      http://liblzf.plan9.de/
**
**      This algorithm is believed to be patent-free.
**
***********************************************************************/

#define LZF_VERSION 0x0105 /* 1.5 */

/*
 * Compress in_len bytes stored at the memory block starting at
 * in_data and write the result to out_data, up to a maximum length
 * of out_len bytes.
 *
 * If the output buffer is not large enough or any error occurs
 * return 0, otherwise return the number of bytes used (which might
 * be considerably larger than in_len, so it makes sense to always
 * use out_len == in_len - 1), to ensure _some_ compression, and store
 * the data uncompressed otherwise.
 *
 * lzf_compress might use different algorithms on different systems and
 * even diferent runs, thus might result in different compressed strings
 * depending on the phase of the moon or similar factors. However, all
 * these strings are architecture-independent and will result in the
 * original data when decompressed using lzf_decompress.
 *
 * The buffers must not be overlapping.
 *
 * If the option LZF_STATE_ARG is enabled, an extra argument must be
 * supplied which is not reflected in this header file. Refer to lzfP.h
 * and lzf_c.c.
 *
 */
unsigned int 
lzf_compress (const void *const in_data,  unsigned int in_len,
              void             *out_data, unsigned int out_len);

/*
 * Decompress data compressed with some version of the lzf_compress
 * function and stored at location in_data and length in_len. The result
 * will be stored at out_data up to a maximum of out_len characters.
 *
 * If the output buffer is not large enough to hold the decompressed
 * data, a 0 is returned and errno is set to E2BIG. Otherwise the number
 * of decompressed bytes (i.e. the original length of the data) is
 * returned.
 *
 * If an error in the compressed data is detected, a zero is returned and
 * errno is set to EINVAL.
 *
 * This function is very fast, about as fast as a copying loop.
 */
unsigned int 
lzf_decompress (const void *const in_data,  unsigned int in_len,
                void             *out_data, unsigned int out_len);

#endif

Revision:	1.10
Committed:	Tue Mar 8 19:59:52 2005 UTC (19 years, 2 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-1_5, rel-2_0, rel-1_7, rel-1_51, rel-1_6
Changes since 1.9:	+8 -5 lines
Log Message:	* empty log message *
#	Content
1	/*
2	* Copyright (c) 2000-2005 Marc Alexander Lehmann <schmorp@schmorp.de>
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	* 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	*/
38
39	#ifndef LZF_H
40	#define LZF_H
41
42	/***********************************************************************
43	**
44	** lzf -- an extremely fast/free compression/decompression-method
45	** http://liblzf.plan9.de/
46	**
47	** This algorithm is believed to be patent-free.
48	**
49	***********************************************************************/
50
51	#define LZF_VERSION 0x0105 /* 1.5 */
52
53	/*
54	* Compress in_len bytes stored at the memory block starting at
55	* in_data and write the result to out_data, up to a maximum length
56	* of out_len bytes.
57	*
58	* If the output buffer is not large enough or any error occurs
59	* return 0, otherwise return the number of bytes used (which might
60	* be considerably larger than in_len, so it makes sense to always
61	* use out_len == in_len - 1), to ensure _some_ compression, and store
62	* the data uncompressed otherwise.
63	*
64	* lzf_compress might use different algorithms on different systems and
65	* even diferent runs, thus might result in different compressed strings
66	* depending on the phase of the moon or similar factors. However, all
67	* these strings are architecture-independent and will result in the
68	* original data when decompressed using lzf_decompress.
69	*
70	* The buffers must not be overlapping.
71	*
72	* If the option LZF_STATE_ARG is enabled, an extra argument must be
73	* supplied which is not reflected in this header file. Refer to lzfP.h
74	* and lzf_c.c.
75	*
76	*/
77	unsigned int
78	lzf_compress (const void *const in_data, unsigned int in_len,
79	void *out_data, unsigned int out_len);
80
81	/*
82	* Decompress data compressed with some version of the lzf_compress
83	* function and stored at location in_data and length in_len. The result
84	* will be stored at out_data up to a maximum of out_len characters.
85	*
86	* If the output buffer is not large enough to hold the decompressed
87	* data, a 0 is returned and errno is set to E2BIG. Otherwise the number
88	* of decompressed bytes (i.e. the original length of the data) is
89	* returned.
90	*
91	* If an error in the compressed data is detected, a zero is returned and
92	* errno is set to EINVAL.
93	*
94	* This function is very fast, about as fast as a copying loop.
95	*/
96	unsigned int
97	lzf_decompress (const void *const in_data, unsigned int in_len,
98	void *out_data, unsigned int out_len);
99
100	#endif
101