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

Comparing liblzf/lzf.h (file contents):
Revision 1.14 by root, Mon Aug 25 01:40:31 2008 UTC vs.
Revision 1.17 by root, Mon Dec 10 20:46:06 2012 UTC

1/* 1/*
2 * Copyright (c) 2000-2008 Marc Alexander Lehmann <schmorp@schmorp.de> 2 * Copyright (c) 2000-2008 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,
8 * this list of conditions and the following disclaimer. 8 * this list of conditions and the following disclaimer.
9 * 9 *
10 * 2. Redistributions in binary form must reproduce the above copyright 10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the 11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution. 12 * documentation and/or other materials provided with the distribution.
13 * 13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 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- 15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
16 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 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- 17 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
18 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 18 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
… …
44** 44**
45** This algorithm is believed to be patent-free. 45** This algorithm is believed to be patent-free.
46** 46**
47***********************************************************************/ 47***********************************************************************/
48 48
49#define LZF_VERSION 0x0105 /* 1.5, API version */ 49/* API version (major * 256 + minor)
50 * major API version gets bumped on incompatible changes.
51 * minor API version gets bumped on compatible changes.
52 * 1.5 => 1.6: add LZF_MAX_COMPRESSED_SIZE
53 */
54#define LZF_VERSION 0x0106
50 55
51/* 56/*
52 * Compress in_len bytes stored at the memory block starting at 57 * 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 58 * in_data and write the result to out_data, up to a maximum length
54 * of out_len bytes. 59 * of out_len bytes.
55 * 60 *
56 * If the output buffer is not large enough or any error occurs return 0, 61 * If the output buffer is not large enough or any error occurs return 0,
57 * otherwise return the number of bytes used, which might be considerably 62 * otherwise return the number of bytes used, which might be considerably
58 * more than in_len (but less than 104% of the original size), so it 63 * more than in_len (but less than 1 + 104% of the original size), so it
59 * makes sense to always use out_len == in_len - 1), to ensure _some_ 64 * makes sense to always use out_len == in_len - 1), to ensure _some_
60 * compression, and store the data uncompressed otherwise (with a flag, of 65 * compression, and store the data uncompressed otherwise (with a flag, of
61 * course. 66 * course.
62 * 67 *
63 * lzf_compress might use different algorithms on different systems and 68 * lzf_compress might use different algorithms on different systems and
… …
71 * If the option LZF_STATE_ARG is enabled, an extra argument must be 76 * If the option LZF_STATE_ARG is enabled, an extra argument must be
72 * supplied which is not reflected in this header file. Refer to lzfP.h 77 * supplied which is not reflected in this header file. Refer to lzfP.h
73 * and lzf_c.c. 78 * and lzf_c.c.
74 * 79 *
75 */ 80 */
76unsigned int 81unsigned int
77lzf_compress (const void *const in_data, unsigned int in_len, 82lzf_compress (const void *const in_data, unsigned int in_len,
78 void *out_data, unsigned int out_len); 83 void *out_data, unsigned int out_len);
84
85/*
86 * The maximum out_len that needs to be allocated to make sure
87 * any input data can be compressed without overflowing the output
88 * buffer, i.e. maximum out_len = LZF_MAX_COMPRESSED_SIZE (in_len).
89 * This is useful if you don't want to bother with the case of
90 * incompressible data and just want to provide a buffer that is
91 * guaranteeed to be big enough.
92 * This macro can be used at preprocessing time.
93 */
94#define LZF_MAX_COMPRESSED_SIZE(n) ((n) * 33 / 32 + 1)
79 95
80/* 96/*
81 * Decompress data compressed with some version of the lzf_compress 97 * Decompress data compressed with some version of the lzf_compress
82 * function and stored at location in_data and length in_len. The result 98 * function and stored at location in_data and length in_len. The result
83 * will be stored at out_data up to a maximum of out_len characters. 99 * will be stored at out_data up to a maximum of out_len characters.
… …
90 * If an error in the compressed data is detected, a zero is returned and 106 * If an error in the compressed data is detected, a zero is returned and
91 * errno is set to EINVAL. 107 * errno is set to EINVAL.
92 * 108 *
93 * This function is very fast, about as fast as a copying loop. 109 * This function is very fast, about as fast as a copying loop.
94 */ 110 */
95unsigned int 111unsigned int
96lzf_decompress (const void *const in_data, unsigned int in_len, 112lzf_decompress (const void *const in_data, unsigned int in_len,
97 void *out_data, unsigned int out_len); 113 void *out_data, unsigned int out_len);
98 114
99#endif 115#endif
100 116

Diff Legend

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