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 | /* API version (major * 256 + minor) |
|
|
50 | * major API version gets bumped on incompatible changes. |
|
|
51 | * minor API version gets bumped on compatible changes. |
|
|
52 | * 1.5 => 1.6: add LZF_MAX_COMPRESSED_SIZE |
|
|
53 | */ |
51 | #define LZF_VERSION 0x0105 /* 1.5 */ |
54 | #define LZF_VERSION 0x0106 |
52 | |
55 | |
53 | /* |
56 | /* |
54 | * Compress in_len bytes stored at the memory block starting at |
57 | * 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 |
58 | * in_data and write the result to out_data, up to a maximum length |
56 | * of out_len bytes. |
59 | * of out_len bytes. |
57 | * |
60 | * |
58 | * If the output buffer is not large enough or any error occurs |
61 | * If the output buffer is not large enough or any error occurs return 0, |
59 | * return 0, otherwise return the number of bytes used (which might |
62 | * otherwise return the number of bytes used, which might be considerably |
60 | * be considerably larger than in_len, so it makes sense to always |
63 | * more than in_len (but less than 1 + 104% of the original size), so it |
61 | * use out_len == in_len - 1), to ensure _some_ compression, and store |
64 | * makes sense to always use out_len == in_len - 1), to ensure _some_ |
62 | * the data uncompressed otherwise. |
65 | * compression, and store the data uncompressed otherwise (with a flag, of |
|
|
66 | * course. |
63 | * |
67 | * |
64 | * lzf_compress might use different algorithms on different systems and |
68 | * lzf_compress might use different algorithms on different systems and |
65 | * even diferent runs, thus might result in different compressed strings |
69 | * even different runs, thus might result in different compressed strings |
66 | * depending on the phase of the moon or similar factors. However, all |
70 | * depending on the phase of the moon or similar factors. However, all |
67 | * these strings are architecture-independent and will result in the |
71 | * these strings are architecture-independent and will result in the |
68 | * original data when decompressed using lzf_decompress. |
72 | * original data when decompressed using lzf_decompress. |
69 | * |
73 | * |
70 | * The buffers must not be overlapping. |
74 | * The buffers must not be overlapping. |
… | |
… | |
72 | * If the option LZF_STATE_ARG is enabled, an extra argument must be |
76 | * 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 |
77 | * supplied which is not reflected in this header file. Refer to lzfP.h |
74 | * and lzf_c.c. |
78 | * and lzf_c.c. |
75 | * |
79 | * |
76 | */ |
80 | */ |
77 | unsigned int |
81 | unsigned int |
78 | lzf_compress (const void *const in_data, unsigned int in_len, |
82 | lzf_compress (const void *const in_data, unsigned int in_len, |
79 | void *out_data, unsigned int out_len); |
83 | void *out_data, unsigned int out_len); |
|
|
84 | |
|
|
85 | /* |
|
|
86 | * The maximum out_len that needs to be allocated to make sure |
|
|
87 | * any input data can be compressed without overflowing the output |
|
|
88 | * buffer, i.e. maximum out_len = LZF_MAX_COMPRESSED_SIZE (in_len). |
|
|
89 | * This is useful if you don't want to bother with the case of |
|
|
90 | * incompressible data and just want to provide a buffer that is |
|
|
91 | * guaranteeed to be big enough. |
|
|
92 | * This macro can be used at preprocessing time. |
|
|
93 | */ |
|
|
94 | #define LZF_MAX_COMPRESSED_SIZE(n) ((((n) * 33) >> 5 ) + 1) |
80 | |
95 | |
81 | /* |
96 | /* |
82 | * Decompress data compressed with some version of the lzf_compress |
97 | * Decompress data compressed with some version of the lzf_compress |
83 | * function and stored at location in_data and length in_len. The result |
98 | * 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. |
99 | * will be stored at out_data up to a maximum of out_len characters. |
… | |
… | |
91 | * If an error in the compressed data is detected, a zero is returned and |
106 | * If an error in the compressed data is detected, a zero is returned and |
92 | * errno is set to EINVAL. |
107 | * errno is set to EINVAL. |
93 | * |
108 | * |
94 | * This function is very fast, about as fast as a copying loop. |
109 | * This function is very fast, about as fast as a copying loop. |
95 | */ |
110 | */ |
96 | unsigned int |
111 | unsigned int |
97 | lzf_decompress (const void *const in_data, unsigned int in_len, |
112 | lzf_decompress (const void *const in_data, unsigned int in_len, |
98 | void *out_data, unsigned int out_len); |
113 | void *out_data, unsigned int out_len); |
99 | |
114 | |
100 | #endif |
115 | #endif |
101 | |
116 | |