ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/liblzf/lzf.h
Revision: 1.1
Committed: Sun Jun 9 22:41:34 2002 UTC (22 years, 4 months ago) by root
Content type: text/plain
Branch: MAIN
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 /*
2     * Copyright (c) 2000 Marc Alexander Lehmann <pcg@goof.com>
3     *
4     * Redistribution and use in source and binary forms, with or without modifica-
5     * tion, are permitted provided that the following conditions are met:
6     *
7     * 1. Redistributions of source code must retain the above copyright notice,
8     * this list of conditions and the following disclaimer.
9     *
10     * 2. Redistributions in binary form must reproduce the above copyright
11     * notice, this list of conditions and the following disclaimer in the
12     * documentation and/or other materials provided with the distribution.
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
18     * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19     * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20     * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21     * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
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,
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
26     * OF THE POSSIBILITY OF SUCH DAMAGE.
27     */
28    
29     #ifndef LZF_H
30     #define LZF_H
31    
32     /***********************************************************************
33     **
34     ** lzf -- an extremely fast/free compression/decompression-method
35     ** 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     **
41     ** This algorithm is believed to be patent-free.
42     **
43     ***********************************************************************/
44    
45     /*
46     * Compress in_len bytes stored at the memory block starting at
47     * in_data and write the result to out_data, up to a maximum length
48     * of out_len bytes.
49     *
50     * If the output buffer is not large enough or any error occurs
51     * return 0, otherwise return the number of bytes used (which might
52     * be considerably larger than in_len, so it makes sense to always
53     * use out_len == in_len).
54     *
55     * lzf_compress might use different algorithms on different systems and
56     * thus might result in different compressed strings depending on the
57     * phase of the moon or similar factors. However, all these strings are
58     * architecture-independent and will result in the original data when
59     * decompressed using lzf_decompress.
60     *
61     * The buffers must not be overlapping.
62     *
63     */
64     unsigned int
65     lzf_compress (const void *const in_data, unsigned int in_len,
66     void *out_data, unsigned int out_len);
67    
68     /*
69     * Decompress data compressed with some version of the lzf_compress
70     * 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.
72     *
73     * 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
75     * of decompressed bytes (i.e. the original length of the data) is
76     * returned.
77     *
78     * If an error in the compressed data is detected, a zero is returned and
79     * errno is set to EINVAL.
80     *
81     * This function is very fast, about as fast as a copying loop.
82     */
83     unsigned int
84     lzf_decompress (const void *const in_data, unsigned int in_len,
85     void *out_data, unsigned int out_len);
86    
87     #endif
88