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, |
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 | * 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 |
15 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
15 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
16 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
16 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
17 | * 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- |
18 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
18 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
… | |
… | |
44 | ** |
44 | ** |
45 | ** This algorithm is believed to be patent-free. |
45 | ** This algorithm is believed to be patent-free. |
46 | ** |
46 | ** |
47 | ***********************************************************************/ |
47 | ***********************************************************************/ |
48 | |
48 | |
49 | #define LZF_VERSION 0x0105 /* 1.5 */ |
49 | #define LZF_VERSION 0x0105 /* 1.5, API version */ |
50 | |
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 | * even diferent runs, thus might result in different compressed strings |
64 | * even different runs, thus might result in different compressed strings |
64 | * 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 |
65 | * these strings are architecture-independent and will result in the |
66 | * these strings are architecture-independent and will result in the |
66 | * original data when 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. |
… | |
… | |
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 lzfP.h |
72 | * supplied which is not reflected in this header file. Refer to lzfP.h |
72 | * and lzf_c.c. |
73 | * and lzf_c.c. |
73 | * |
74 | * |
74 | */ |
75 | */ |
75 | unsigned int |
76 | unsigned int |
76 | lzf_compress (const void *const in_data, unsigned int in_len, |
77 | lzf_compress (const void *const in_data, unsigned int in_len, |
77 | void *out_data, unsigned int out_len); |
78 | void *out_data, unsigned int out_len); |
78 | |
79 | |
79 | /* |
80 | /* |
80 | * Decompress data compressed with some version of the lzf_compress |
81 | * Decompress data compressed with some version of the lzf_compress |
… | |
… | |
89 | * 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 |
90 | * errno is set to EINVAL. |
91 | * errno is set to EINVAL. |
91 | * |
92 | * |
92 | * 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. |
93 | */ |
94 | */ |
94 | unsigned int |
95 | unsigned int |
95 | lzf_decompress (const void *const in_data, unsigned int in_len, |
96 | lzf_decompress (const void *const in_data, unsigned int in_len, |
96 | void *out_data, unsigned int out_len); |
97 | void *out_data, unsigned int out_len); |
97 | |
98 | |
98 | #endif |
99 | #endif |
99 | |
100 | |