ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/liblzf/lzf.h
(Generate patch)

Comparing liblzf/lzf.h (file contents):
Revision 1.3 by root, Fri Jun 6 20:49:48 2003 UTC vs.
Revision 1.10 by root, Tue Mar 8 19:59:52 2005 UTC

1/* 1/*
2 * Copyright (c) 2000-2002 Marc Alexander Lehmann <pcg@goof.com> 2 * Copyright (c) 2000-2005 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,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- 24 * 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 25 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE. 26 * OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * 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
30 * provisions of the GPL are applicable instead of the above. If you wish to
31 * allow the use of your version of this file only under the terms of the
32 * GPL and not to allow others to use your version of this file under the
33 * BSD license, indicate your decision by deleting the provisions above and
34 * replace them with the notice and other provisions required by the GPL. If
35 * you do not delete the provisions above, a recipient may use your version
36 * of this file under either the BSD or the GPL.
27 */ 37 */
28 38
29#ifndef LZF_H 39#ifndef LZF_H
30#define LZF_H 40#define LZF_H
31 41
36** 46**
37** This algorithm is believed to be patent-free. 47** This algorithm is believed to be patent-free.
38** 48**
39***********************************************************************/ 49***********************************************************************/
40 50
51#define LZF_VERSION 0x0105 /* 1.5 */
52
41/* 53/*
42 * Compress in_len bytes stored at the memory block starting at 54 * Compress in_len bytes stored at the memory block starting at
43 * in_data and write the result to out_data, up to a maximum length 55 * in_data and write the result to out_data, up to a maximum length
44 * of out_len bytes. 56 * of out_len bytes.
45 * 57 *
46 * If the output buffer is not large enough or any error occurs 58 * If the output buffer is not large enough or any error occurs
47 * return 0, otherwise return the number of bytes used (which might 59 * return 0, otherwise return the number of bytes used (which might
48 * be considerably larger than in_len, so it makes sense to always 60 * be considerably larger than in_len, so it makes sense to always
49 * use out_len == in_len). 61 * use out_len == in_len - 1), to ensure _some_ compression, and store
62 * the data uncompressed otherwise.
50 * 63 *
51 * lzf_compress might use different algorithms on different systems and 64 * lzf_compress might use different algorithms on different systems and
52 * thus might result in different compressed strings depending on the 65 * even diferent runs, thus might result in different compressed strings
53 * phase of the moon or similar factors. However, all these strings are 66 * depending on the phase of the moon or similar factors. However, all
54 * architecture-independent and will result in the original data when 67 * these strings are architecture-independent and will result in the
55 * decompressed using lzf_decompress. 68 * original data when decompressed using lzf_decompress.
56 * 69 *
57 * The buffers must not be overlapping. 70 * The buffers must not be overlapping.
71 *
72 * 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
74 * and lzf_c.c.
58 * 75 *
59 */ 76 */
60unsigned int 77unsigned int
61lzf_compress (const void *const in_data, unsigned int in_len, 78lzf_compress (const void *const in_data, unsigned int in_len,
62 void *out_data, unsigned int out_len); 79 void *out_data, unsigned int out_len);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines