1 | /* |
1 | /* |
2 | * Copyright (c) 2000 Marc Alexander Lehmann <pcg@goof.com> |
2 | * Copyright (c) 2000-2007 Marc Alexander Lehmann <schmorp@schmorp.de> |
3 | * |
3 | * |
4 | * Redistribution and use in source and binary forms, with or without modifica- |
4 | * Redistribution and use in source and binary forms, with or without modifica- |
5 | * tion, are permitted provided that the following conditions are met: |
5 | * tion, are permitted provided that the following conditions are met: |
6 | * |
6 | * |
7 | * 1. Redistributions of source code must retain the above copyright notice, |
7 | * 1. Redistributions of source code must retain the above copyright notice, |
… | |
… | |
9 | * |
9 | * |
10 | * 2. Redistributions in binary form must reproduce the above copyright |
10 | * 2. Redistributions in binary form must reproduce the above copyright |
11 | * notice, this list of conditions and the following disclaimer in the |
11 | * notice, this list of conditions and the following disclaimer in the |
12 | * documentation and/or other materials provided with the distribution. |
12 | * documentation and/or other materials provided with the distribution. |
13 | * |
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 |
14 | * 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- |
15 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
19 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
16 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
20 | * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- |
17 | * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- |
21 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
18 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
22 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
19 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
23 | * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
20 | * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
24 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
21 | * 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 |
22 | * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
26 | * OF THE POSSIBILITY OF SUCH DAMAGE. |
23 | * OF THE POSSIBILITY OF SUCH DAMAGE. |
|
|
24 | * |
|
|
25 | * Alternatively, the contents of this file may be used under the terms of |
|
|
26 | * the GNU General Public License ("GPL") version 2 or any later version, |
|
|
27 | * in which case the provisions of the GPL are applicable instead of |
|
|
28 | * the above. If you wish to allow the use of your version of this file |
|
|
29 | * only under the terms of the GPL and not to allow others to use your |
|
|
30 | * version of this file under the BSD license, indicate your decision |
|
|
31 | * by deleting the provisions above and replace them with the notice |
|
|
32 | * and other provisions required by the GPL. If you do not delete the |
|
|
33 | * provisions above, a recipient may use your version of this file under |
|
|
34 | * either the BSD or the GPL. |
27 | */ |
35 | */ |
28 | |
36 | |
29 | #ifndef LZF_H |
37 | #ifndef LZF_H |
30 | #define LZF_H |
38 | #define LZF_H |
31 | |
39 | |
32 | /*********************************************************************** |
40 | /*********************************************************************** |
33 | ** |
41 | ** |
34 | ** lzf -- an extremely fast/free compression/decompression-method |
42 | ** lzf -- an extremely fast/free compression/decompression-method |
35 | ** http://liblzf.plan9.de/ |
43 | ** http://liblzf.plan9.de/ |
36 | ** |
44 | ** |
37 | ** Based on ideas by Hermann Vogt, but liblzf is a total |
|
|
38 | ** re-implementation of LZV that is not compatible to the |
|
|
39 | ** original lzv code. |
|
|
40 | ** |
|
|
41 | ** This algorithm is believed to be patent-free. |
45 | ** This algorithm is believed to be patent-free. |
42 | ** |
46 | ** |
43 | ***********************************************************************/ |
47 | ***********************************************************************/ |
|
|
48 | |
|
|
49 | #define LZF_VERSION 0x0105 /* 1.5 */ |
44 | |
50 | |
45 | /* |
51 | /* |
46 | * Compress in_len bytes stored at the memory block starting at |
52 | * Compress in_len bytes stored at the memory block starting at |
47 | * in_data and write the result to out_data, up to a maximum length |
53 | * in_data and write the result to out_data, up to a maximum length |
48 | * of out_len bytes. |
54 | * of out_len bytes. |
49 | * |
55 | * |
50 | * If the output buffer is not large enough or any error occurs |
56 | * If the output buffer is not large enough or any error occurs |
51 | * return 0, otherwise return the number of bytes used (which might |
57 | * return 0, otherwise return the number of bytes used (which might |
52 | * be considerably larger than in_len, so it makes sense to always |
58 | * be considerably larger than in_len, so it makes sense to always |
53 | * use out_len == in_len). |
59 | * use out_len == in_len - 1), to ensure _some_ compression, and store |
|
|
60 | * the data uncompressed otherwise. |
54 | * |
61 | * |
55 | * lzf_compress might use different algorithms on different systems and |
62 | * lzf_compress might use different algorithms on different systems and |
56 | * thus might result in different compressed strings depending on the |
63 | * even diferent runs, thus might result in different compressed strings |
57 | * phase of the moon or similar factors. However, all these strings are |
64 | * depending on the phase of the moon or similar factors. However, all |
58 | * architecture-independent and will result in the original data when |
65 | * these strings are architecture-independent and will result in the |
59 | * decompressed using lzf_decompress. |
66 | * original data when decompressed using lzf_decompress. |
60 | * |
67 | * |
61 | * The buffers must not be overlapping. |
68 | * The buffers must not be overlapping. |
|
|
69 | * |
|
|
70 | * If the option LZF_STATE_ARG is enabled, an extra argument must be |
|
|
71 | * supplied which is not reflected in this header file. Refer to lzfP.h |
|
|
72 | * and lzf_c.c. |
62 | * |
73 | * |
63 | */ |
74 | */ |
64 | unsigned int |
75 | unsigned int |
65 | lzf_compress (const void *const in_data, unsigned int in_len, |
76 | lzf_compress (const void *const in_data, unsigned int in_len, |
66 | void *out_data, unsigned int out_len); |
77 | void *out_data, unsigned int out_len); |
… | |
… | |
68 | /* |
79 | /* |
69 | * Decompress data compressed with some version of the lzf_compress |
80 | * Decompress data compressed with some version of the lzf_compress |
70 | * function and stored at location in_data and length in_len. The result |
81 | * function and stored at location in_data and length in_len. The result |
71 | * will be stored at out_data up to a maximum of out_len characters. |
82 | * will be stored at out_data up to a maximum of out_len characters. |
72 | * |
83 | * |
73 | * If * the output buffer is not large enough to hold the decompressed |
84 | * If the output buffer is not large enough to hold the decompressed |
74 | * data, a 0 is returned and errno is set to E2BIG. Otherwise the number |
85 | * data, a 0 is returned and errno is set to E2BIG. Otherwise the number |
75 | * of decompressed bytes (i.e. the original length of the data) is |
86 | * of decompressed bytes (i.e. the original length of the data) is |
76 | * returned. |
87 | * returned. |
77 | * |
88 | * |
78 | * If an error in the compressed data is detected, a zero is returned and |
89 | * If an error in the compressed data is detected, a zero is returned and |