1 |
root |
1.1 |
/* |
2 |
root |
1.9 |
* Copyright (c) 2000-2005 Marc Alexander Lehmann <schmorp@schmorp.de> |
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.7 |
* |
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 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 |
|
|
/* |
52 |
|
|
* Compress in_len bytes stored at the memory block starting at |
53 |
|
|
* in_data and write the result to out_data, up to a maximum length |
54 |
|
|
* of out_len bytes. |
55 |
|
|
* |
56 |
|
|
* If the output buffer is not large enough or any error occurs |
57 |
|
|
* return 0, otherwise return the number of bytes used (which might |
58 |
|
|
* be considerably larger than in_len, so it makes sense to always |
59 |
root |
1.8 |
* use out_len == in_len - 1), to ensure _some_ compression, and store |
60 |
|
|
* the data uncompressed otherwise. |
61 |
root |
1.1 |
* |
62 |
|
|
* lzf_compress might use different algorithms on different systems and |
63 |
|
|
* thus might result in different compressed strings depending on the |
64 |
|
|
* phase of the moon or similar factors. However, all these strings are |
65 |
|
|
* architecture-independent and will result in the original data when |
66 |
|
|
* decompressed using lzf_decompress. |
67 |
|
|
* |
68 |
|
|
* The buffers must not be overlapping. |
69 |
|
|
* |
70 |
pcg |
1.6 |
* If the option LZF_STATE_ARG is enabled, an extra argument must be |
71 |
pcg |
1.5 |
* supplied which is not reflected in this header file. Refer to lzf_c.c. |
72 |
|
|
* |
73 |
root |
1.1 |
*/ |
74 |
|
|
unsigned int |
75 |
|
|
lzf_compress (const void *const in_data, unsigned int in_len, |
76 |
|
|
void *out_data, unsigned int out_len); |
77 |
|
|
|
78 |
|
|
/* |
79 |
|
|
* Decompress data compressed with some version of the lzf_compress |
80 |
|
|
* function and stored at location in_data and length in_len. The result |
81 |
|
|
* will be stored at out_data up to a maximum of out_len characters. |
82 |
|
|
* |
83 |
root |
1.3 |
* If the output buffer is not large enough to hold the decompressed |
84 |
root |
1.1 |
* data, a 0 is returned and errno is set to E2BIG. Otherwise the number |
85 |
|
|
* of decompressed bytes (i.e. the original length of the data) is |
86 |
|
|
* returned. |
87 |
|
|
* |
88 |
|
|
* If an error in the compressed data is detected, a zero is returned and |
89 |
|
|
* errno is set to EINVAL. |
90 |
|
|
* |
91 |
|
|
* This function is very fast, about as fast as a copying loop. |
92 |
|
|
*/ |
93 |
|
|
unsigned int |
94 |
|
|
lzf_decompress (const void *const in_data, unsigned int in_len, |
95 |
|
|
void *out_data, unsigned int out_len); |
96 |
|
|
|
97 |
|
|
#endif |
98 |
|
|
|