1 | /* |
1 | /* |
2 | * Copyright (c) 2000-2005 Marc Alexander Lehmann <schmorp@schmorp.de> |
2 | * Copyright (c) 2000-2008 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, |
8 | * this list of conditions and the following disclaimer. |
8 | * this list of conditions and the following disclaimer. |
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, |
… | |
… | |
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. |
27 | * |
24 | * |
28 | * Alternatively, the contents of this file may be used under the terms of |
25 | * 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 |
26 | * the GNU General Public License ("GPL") version 2 or any later version, |
30 | * provisions of the GPL are applicable instead of the above. If you wish to |
27 | * in which case the provisions of the GPL are applicable instead of |
31 | * allow the use of your version of this file only under the terms of the |
28 | * the above. If you wish to allow the use of your version of this file |
32 | * GPL and not to allow others to use your version of this file under the |
29 | * only under the terms of the GPL and not to allow others to use your |
33 | * BSD license, indicate your decision by deleting the provisions above and |
30 | * version of this file under the BSD license, indicate your decision |
34 | * replace them with the notice and other provisions required by the GPL. If |
31 | * by deleting the provisions above and replace them with the notice |
35 | * you do not delete the provisions above, a recipient may use your version |
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 |
36 | * of this file under either the BSD or the GPL. |
34 | * either the BSD or the GPL. |
37 | */ |
35 | */ |
38 | |
36 | |
39 | #ifndef LZF_H |
37 | #ifndef LZF_H |
40 | #define LZF_H |
38 | #define LZF_H |
41 | |
39 | |
… | |
… | |
46 | ** |
44 | ** |
47 | ** This algorithm is believed to be patent-free. |
45 | ** This algorithm is believed to be patent-free. |
48 | ** |
46 | ** |
49 | ***********************************************************************/ |
47 | ***********************************************************************/ |
50 | |
48 | |
|
|
49 | #define LZF_VERSION 0x0105 /* 1.5, API version */ |
|
|
50 | |
51 | /* |
51 | /* |
52 | * Compress in_len bytes stored at the memory block starting at |
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 |
53 | * in_data and write the result to out_data, up to a maximum length |
54 | * of out_len bytes. |
54 | * of out_len bytes. |
55 | * |
55 | * |
56 | * 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 return 0, |
57 | * return 0, otherwise return the number of bytes used (which might |
57 | * otherwise return the number of bytes used, which might be considerably |
58 | * be considerably larger than in_len, so it makes sense to always |
58 | * more than in_len (but less than 104% of the original size), so it |
59 | * use out_len == in_len - 1), to ensure _some_ compression, and store |
59 | * makes sense to always use out_len == in_len - 1), to ensure _some_ |
60 | * the data uncompressed otherwise. |
60 | * compression, and store the data uncompressed otherwise (with a flag, of |
|
|
61 | * course. |
61 | * |
62 | * |
62 | * lzf_compress might use different algorithms on different systems and |
63 | * lzf_compress might use different algorithms on different systems and |
63 | * thus might result in different compressed strings depending on the |
64 | * even different runs, thus might result in different compressed strings |
64 | * phase of the moon or similar factors. However, all these strings are |
65 | * depending on the phase of the moon or similar factors. However, all |
65 | * architecture-independent and will result in the original data when |
66 | * these strings are architecture-independent and will result in the |
66 | * decompressed using lzf_decompress. |
67 | * original data when decompressed using lzf_decompress. |
67 | * |
68 | * |
68 | * The buffers must not be overlapping. |
69 | * The buffers must not be overlapping. |
69 | * |
70 | * |
70 | * If the option LZF_STATE_ARG is enabled, an extra argument must be |
71 | * 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 lzf_c.c. |
72 | * supplied which is not reflected in this header file. Refer to lzfP.h |
|
|
73 | * and lzf_c.c. |
72 | * |
74 | * |
73 | */ |
75 | */ |
74 | unsigned int |
76 | unsigned int |
75 | lzf_compress (const void *const in_data, unsigned int in_len, |
77 | lzf_compress (const void *const in_data, unsigned int in_len, |
76 | void *out_data, unsigned int out_len); |
78 | void *out_data, unsigned int out_len); |
77 | |
79 | |
78 | /* |
80 | /* |
79 | * Decompress data compressed with some version of the lzf_compress |
81 | * Decompress data compressed with some version of the lzf_compress |
… | |
… | |
88 | * If an error in the compressed data is detected, a zero is returned and |
90 | * If an error in the compressed data is detected, a zero is returned and |
89 | * errno is set to EINVAL. |
91 | * errno is set to EINVAL. |
90 | * |
92 | * |
91 | * This function is very fast, about as fast as a copying loop. |
93 | * This function is very fast, about as fast as a copying loop. |
92 | */ |
94 | */ |
93 | unsigned int |
95 | unsigned int |
94 | lzf_decompress (const void *const in_data, unsigned int in_len, |
96 | lzf_decompress (const void *const in_data, unsigned int in_len, |
95 | void *out_data, unsigned int out_len); |
97 | void *out_data, unsigned int out_len); |
96 | |
98 | |
97 | #endif |
99 | #endif |
98 | |
100 | |