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

Comparing liblzf/lzf.h (file contents):
Revision 1.1 by root, Sun Jun 9 22:41:34 2002 UTC vs.
Revision 1.9 by root, Thu Mar 3 17:06:44 2005 UTC

1/* 1/*
2 * Copyright (c) 2000 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
32/*********************************************************************** 42/***********************************************************************
33** 43**
34** lzf -- an extremely fast/free compression/decompression-method 44** lzf -- an extremely fast/free compression/decompression-method
35** http://liblzf.plan9.de/ 45** http://liblzf.plan9.de/
36**
37** Based on ideas by Hermann Vogt, but liblzf is a total
38** re-implementation of LZV that is not compatible to the
39** original lzv code.
40** 46**
41** This algorithm is believed to be patent-free. 47** This algorithm is believed to be patent-free.
42** 48**
43***********************************************************************/ 49***********************************************************************/
44 50
… …
48 * of out_len bytes. 54 * of out_len bytes.
49 * 55 *
50 * 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
51 * return 0, otherwise return the number of bytes used (which might 57 * return 0, otherwise return the number of bytes used (which might
52 * be considerably larger than in_len, so it makes sense to always 58 * be considerably larger than in_len, so it makes sense to always
53 * use out_len == in_len). 59 * use out_len == in_len - 1), to ensure _some_ compression, and store
60 * the data uncompressed otherwise.
54 * 61 *
55 * lzf_compress might use different algorithms on different systems and 62 * lzf_compress might use different algorithms on different systems and
56 * thus might result in different compressed strings depending on the 63 * thus might result in different compressed strings depending on the
57 * phase of the moon or similar factors. However, all these strings are 64 * phase of the moon or similar factors. However, all these strings are
58 * architecture-independent and will result in the original data when 65 * architecture-independent and will result in the original data when
59 * decompressed using lzf_decompress. 66 * decompressed using lzf_decompress.
60 * 67 *
61 * The buffers must not be overlapping. 68 * The buffers must not be overlapping.
69 *
70 * 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.
62 * 72 *
63 */ 73 */
64unsigned int 74unsigned int
65lzf_compress (const void *const in_data, unsigned int in_len, 75lzf_compress (const void *const in_data, unsigned int in_len,
66 void *out_data, unsigned int out_len); 76 void *out_data, unsigned int out_len);
… …
68/* 78/*
69 * Decompress data compressed with some version of the lzf_compress 79 * Decompress data compressed with some version of the lzf_compress
70 * function and stored at location in_data and length in_len. The result 80 * function and stored at location in_data and length in_len. The result
71 * will be stored at out_data up to a maximum of out_len characters. 81 * will be stored at out_data up to a maximum of out_len characters.
72 * 82 *
73 * If * the output buffer is not large enough to hold the decompressed 83 * If the output buffer is not large enough to hold the decompressed
74 * data, a 0 is returned and errno is set to E2BIG. Otherwise the number 84 * data, a 0 is returned and errno is set to E2BIG. Otherwise the number
75 * of decompressed bytes (i.e. the original length of the data) is 85 * of decompressed bytes (i.e. the original length of the data) is
76 * returned. 86 * returned.
77 * 87 *
78 * If an error in the compressed data is detected, a zero is returned and 88 * If an error in the compressed data is detected, a zero is returned and

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines