ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/liblzf/lzf.h
Revision: 1.13
Committed: Tue Nov 13 10:41:52 2007 UTC (16 years, 11 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-3_1, rel-3_0
Changes since 1.12: +1 -1 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 /*
2 root 1.11 * Copyright (c) 2000-2007 Marc Alexander Lehmann <schmorp@schmorp.de>
3 root 1.1 *
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     * 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-
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-
18     * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
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
23     * OF THE POSSIBILITY OF SUCH DAMAGE.
24 pcg 1.7 *
25     * Alternatively, the contents of this file may be used under the terms of
26 root 1.12 * the GNU General Public License ("GPL") version 2 or any later version,
27     * in which case the provisions of the GPL are applicable instead of
28     * the above. If you wish to allow the use of your version of this file
29     * only under the terms of the GPL and not to allow others to use your
30     * version of this file under the BSD license, indicate your decision
31     * by deleting the provisions above and replace them with the notice
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
34     * either the BSD or the GPL.
35 root 1.1 */
36    
37     #ifndef LZF_H
38     #define LZF_H
39    
40     /***********************************************************************
41     **
42     ** lzf -- an extremely fast/free compression/decompression-method
43     ** http://liblzf.plan9.de/
44     **
45     ** This algorithm is believed to be patent-free.
46     **
47     ***********************************************************************/
48    
49 root 1.10 #define LZF_VERSION 0x0105 /* 1.5 */
50    
51 root 1.1 /*
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
54     * of out_len bytes.
55     *
56     * If the output buffer is not large enough or any error occurs
57     * return 0, otherwise return the number of bytes used (which might
58     * be considerably larger than in_len, so it makes sense to always
59 root 1.8 * use out_len == in_len - 1), to ensure _some_ compression, and store
60     * the data uncompressed otherwise.
61 root 1.1 *
62     * lzf_compress might use different algorithms on different systems and
63 root 1.13 * even different runs, thus might result in different compressed strings
64 root 1.10 * depending on the phase of the moon or similar factors. However, all
65     * these strings are architecture-independent and will result in the
66     * original data when decompressed using lzf_decompress.
67 root 1.1 *
68     * The buffers must not be overlapping.
69     *
70 pcg 1.6 * If the option LZF_STATE_ARG is enabled, an extra argument must be
71 root 1.10 * supplied which is not reflected in this header file. Refer to lzfP.h
72     * and lzf_c.c.
73 pcg 1.5 *
74 root 1.1 */
75     unsigned int
76     lzf_compress (const void *const in_data, unsigned int in_len,
77     void *out_data, unsigned int out_len);
78    
79     /*
80     * Decompress data compressed with some version of the lzf_compress
81     * function and stored at location in_data and length in_len. The result
82     * will be stored at out_data up to a maximum of out_len characters.
83     *
84 root 1.3 * If the output buffer is not large enough to hold the decompressed
85 root 1.1 * data, a 0 is returned and errno is set to E2BIG. Otherwise the number
86     * of decompressed bytes (i.e. the original length of the data) is
87     * returned.
88     *
89     * If an error in the compressed data is detected, a zero is returned and
90     * errno is set to EINVAL.
91     *
92     * This function is very fast, about as fast as a copying loop.
93     */
94     unsigned int
95     lzf_decompress (const void *const in_data, unsigned int in_len,
96     void *out_data, unsigned int out_len);
97    
98     #endif
99