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

/*
 * 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).
 *
 * lzf_compress might use different algorithms on different systems and
 * 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 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.6
Committed:	Thu Jan 29 18:57:50 2004 UTC (22 years, 1 month ago) by pcg
Content type:	text/plain
Branch:	MAIN
Changes since 1.5:	+1 -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 LZF_H
30	#define LZF_H
31
32	/***********************************************************************
33	**
34	** lzf -- an extremely fast/free compression/decompression-method
35	** http://liblzf.plan9.de/
36	**
37	** This algorithm is believed to be patent-free.
38	**
39	***********************************************************************/
40
41	/*
42	* Compress in_len bytes stored at the memory block starting at
43	* in_data and write the result to out_data, up to a maximum length
44	* of out_len bytes.
45	*
46	* If the output buffer is not large enough or any error occurs
47	* return 0, otherwise return the number of bytes used (which might
48	* be considerably larger than in_len, so it makes sense to always
49	* use out_len == in_len).
50	*
51	* lzf_compress might use different algorithms on different systems and
52	* thus might result in different compressed strings depending on the
53	* phase of the moon or similar factors. However, all these strings are
54	* architecture-independent and will result in the original data when
55	* decompressed using lzf_decompress.
56	*
57	* The buffers must not be overlapping.
58	*
59	* If the option LZF_STATE_ARG is enabled, an extra argument must be
60	* supplied which is not reflected in this header file. Refer to lzf_c.c.
61	*
62	*/
63	unsigned int
64	lzf_compress (const void *const in_data, unsigned int in_len,
65	void *out_data, unsigned int out_len);
66
67	/*
68	* Decompress data compressed with some version of the lzf_compress
69	* function and stored at location in_data and length in_len. The result
70	* will be stored at out_data up to a maximum of out_len characters.
71	*
72	* If the output buffer is not large enough to hold the decompressed
73	* data, a 0 is returned and errno is set to E2BIG. Otherwise the number
74	* of decompressed bytes (i.e. the original length of the data) is
75	* returned.
76	*
77	* If an error in the compressed data is detected, a zero is returned and
78	* errno is set to EINVAL.
79	*
80	* This function is very fast, about as fast as a copying loop.
81	*/
82	unsigned int
83	lzf_decompress (const void *const in_data, unsigned int in_len,
84	void *out_data, unsigned int out_len);
85
86	#endif
87