| 1 | /* |
1 | /* |
| 2 | * Copyright (c) 2000-2007 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, |
| … | |
… | |
| 21 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
21 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
| 22 | * 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 |
| 23 | * OF THE POSSIBILITY OF SUCH DAMAGE. |
23 | * OF THE POSSIBILITY OF SUCH DAMAGE. |
| 24 | * |
24 | * |
| 25 | * 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 |
| 26 | * 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, |
| 27 | * 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 |
| 28 | * 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 |
| 29 | * 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 |
| 30 | * BSD license, indicate your decision by deleting the provisions above and |
30 | * version of this file under the BSD license, indicate your decision |
| 31 | * 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 |
| 32 | * 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 |
| 33 | * of this file under either the BSD or the GPL. |
34 | * either the BSD or the GPL. |
| 34 | */ |
35 | */ |
| 35 | |
36 | |
| 36 | #ifndef LZF_H |
37 | #ifndef LZF_H |
| 37 | #define LZF_H |
38 | #define LZF_H |
| 38 | |
39 | |
| … | |
… | |
| 43 | ** |
44 | ** |
| 44 | ** This algorithm is believed to be patent-free. |
45 | ** This algorithm is believed to be patent-free. |
| 45 | ** |
46 | ** |
| 46 | ***********************************************************************/ |
47 | ***********************************************************************/ |
| 47 | |
48 | |
| 48 | #define LZF_VERSION 0x0105 /* 1.5 */ |
49 | #define LZF_VERSION 0x0105 /* 1.5, API version */ |
| 49 | |
50 | |
| 50 | /* |
51 | /* |
| 51 | * Compress in_len bytes stored at the memory block starting at |
52 | * Compress in_len bytes stored at the memory block starting at |
| 52 | * 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 |
| 53 | * of out_len bytes. |
54 | * of out_len bytes. |
| 54 | * |
55 | * |
| 55 | * 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, |
| 56 | * return 0, otherwise return the number of bytes used (which might |
57 | * otherwise return the number of bytes used, which might be considerably |
| 57 | * 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 |
| 58 | * 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_ |
| 59 | * the data uncompressed otherwise. |
60 | * compression, and store the data uncompressed otherwise (with a flag, of |
|
|
61 | * course. |
| 60 | * |
62 | * |
| 61 | * lzf_compress might use different algorithms on different systems and |
63 | * lzf_compress might use different algorithms on different systems and |
| 62 | * even diferent runs, thus might result in different compressed strings |
64 | * even different runs, thus might result in different compressed strings |
| 63 | * depending on the phase of the moon or similar factors. However, all |
65 | * depending on the phase of the moon or similar factors. However, all |
| 64 | * these strings are architecture-independent and will result in the |
66 | * these strings are architecture-independent and will result in the |
| 65 | * original data when decompressed using lzf_decompress. |
67 | * original data when decompressed using lzf_decompress. |
| 66 | * |
68 | * |
| 67 | * The buffers must not be overlapping. |
69 | * The buffers must not be overlapping. |
