1 | /* |
---|
2 | FastLZ - lightning-fast lossless compression library |
---|
3 | |
---|
4 | Copyright (C) 2007 Ariya Hidayat (ariya@kde.org) |
---|
5 | Copyright (C) 2006 Ariya Hidayat (ariya@kde.org) |
---|
6 | Copyright (C) 2005 Ariya Hidayat (ariya@kde.org) |
---|
7 | |
---|
8 | Permission is hereby granted, free of charge, to any person obtaining a copy |
---|
9 | of this software and associated documentation files (the "Software"), to deal |
---|
10 | in the Software without restriction, including without limitation the rights |
---|
11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
---|
12 | copies of the Software, and to permit persons to whom the Software is |
---|
13 | furnished to do so, subject to the following conditions: |
---|
14 | |
---|
15 | The above copyright notice and this permission notice shall be included in |
---|
16 | all copies or substantial portions of the Software. |
---|
17 | |
---|
18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
---|
21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
---|
22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
---|
23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
---|
24 | THE SOFTWARE. |
---|
25 | */ |
---|
26 | |
---|
27 | #ifndef FASTLZ_H |
---|
28 | #define FASTLZ_H |
---|
29 | |
---|
30 | #define FASTLZ_VERSION 0x000100 |
---|
31 | |
---|
32 | #define FASTLZ_VERSION_MAJOR 0 |
---|
33 | #define FASTLZ_VERSION_MINOR 0 |
---|
34 | #define FASTLZ_VERSION_REVISION 0 |
---|
35 | |
---|
36 | #define FASTLZ_VERSION_STRING "0.1.0" |
---|
37 | |
---|
38 | #if defined (__cplusplus) |
---|
39 | extern "C" { |
---|
40 | #endif |
---|
41 | |
---|
42 | /** |
---|
43 | Compress a block of data in the input buffer and returns the size of |
---|
44 | compressed block. The size of input buffer is specified by length. The |
---|
45 | minimum input buffer size is 16. |
---|
46 | |
---|
47 | The output buffer must be at least 5% larger than the input buffer |
---|
48 | and can not be smaller than 66 bytes. |
---|
49 | |
---|
50 | If the input is not compressible, the return value might be larger than |
---|
51 | length (input buffer size). |
---|
52 | |
---|
53 | The input buffer and the output buffer can not overlap. |
---|
54 | */ |
---|
55 | |
---|
56 | int fastlz_compress(const void* input, int length, void* output); |
---|
57 | |
---|
58 | /** |
---|
59 | Decompress a block of compressed data and returns the size of the |
---|
60 | decompressed block. If error occurs, e.g. the compressed data is |
---|
61 | corrupted or the output buffer is not large enough, then 0 (zero) |
---|
62 | will be returned instead. |
---|
63 | |
---|
64 | The input buffer and the output buffer can not overlap. |
---|
65 | |
---|
66 | Decompression is memory safe and guaranteed not to write the output buffer |
---|
67 | more than what is specified in maxout. |
---|
68 | */ |
---|
69 | |
---|
70 | int fastlz_decompress(const void* input, int length, void* output, int maxout); |
---|
71 | |
---|
72 | /** |
---|
73 | Compress a block of data in the input buffer and returns the size of |
---|
74 | compressed block. The size of input buffer is specified by length. The |
---|
75 | minimum input buffer size is 16. |
---|
76 | |
---|
77 | The output buffer must be at least 5% larger than the input buffer |
---|
78 | and can not be smaller than 66 bytes. |
---|
79 | |
---|
80 | If the input is not compressible, the return value might be larger than |
---|
81 | length (input buffer size). |
---|
82 | |
---|
83 | The input buffer and the output buffer can not overlap. |
---|
84 | |
---|
85 | Compression level can be specified in parameter level. At the moment, |
---|
86 | only level 1 and level 2 are supported. |
---|
87 | Level 1 is the fastest compression and generally useful for short data. |
---|
88 | Level 2 is slightly slower but it gives better compression ratio. |
---|
89 | |
---|
90 | Note that the compressed data, regardless of the level, can always be |
---|
91 | decompressed using the function fastlz_decompress above. |
---|
92 | */ |
---|
93 | |
---|
94 | int fastlz_compress_level(int level, const void* input, int length, void* output); |
---|
95 | |
---|
96 | #if defined (__cplusplus) |
---|
97 | } |
---|
98 | #endif |
---|
99 | |
---|
100 | #endif /* FASTLZ_H */ |
---|