1/* lzo1x.h -- public interface of the LZO1X compression algorithm
2
3   This file is part of the LZO real-time data compression library.
4
5   Copyright (C) 2011 Markus Franz Xaver Johannes Oberhumer
6   Copyright (C) 2010 Markus Franz Xaver Johannes Oberhumer
7   Copyright (C) 2009 Markus Franz Xaver Johannes Oberhumer
8   Copyright (C) 2008 Markus Franz Xaver Johannes Oberhumer
9   Copyright (C) 2007 Markus Franz Xaver Johannes Oberhumer
10   Copyright (C) 2006 Markus Franz Xaver Johannes Oberhumer
11   Copyright (C) 2005 Markus Franz Xaver Johannes Oberhumer
12   Copyright (C) 2004 Markus Franz Xaver Johannes Oberhumer
13   Copyright (C) 2003 Markus Franz Xaver Johannes Oberhumer
14   Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
15   Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
16   Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
17   Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
18   Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
19   Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
20   Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
21   All Rights Reserved.
22
23   The LZO library is free software; you can redistribute it and/or
24   modify it under the terms of the GNU General Public License as
25   published by the Free Software Foundation; either version 2 of
26   the License, or (at your option) any later version.
27
28   The LZO library is distributed in the hope that it will be useful,
29   but WITHOUT ANY WARRANTY; without even the implied warranty of
30   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
31   GNU General Public License for more details.
32
33   You should have received a copy of the GNU General Public License
34   along with the LZO library; see the file COPYING.
35   If not, write to the Free Software Foundation, Inc.,
36   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
37
38   Markus F.X.J. Oberhumer
39   <markus@oberhumer.com>
40   http://www.oberhumer.com/opensource/lzo/
41 */
42
43
44#ifndef __LZO1X_H_INCLUDED
45#define __LZO1X_H_INCLUDED 1
46
47#ifndef __LZOCONF_H_INCLUDED
48#include "lzoconf.h"
49#endif
50
51#ifdef __cplusplus
52extern "C" {
53#endif
54
55
56/***********************************************************************
57//
58************************************************************************/
59
60/* Memory required for the wrkmem parameter.
61 * When the required size is 0, you can also pass a NULL pointer.
62 */
63
64#define LZO1X_MEM_COMPRESS      LZO1X_1_MEM_COMPRESS
65#define LZO1X_MEM_DECOMPRESS    (0)
66#define LZO1X_MEM_OPTIMIZE      (0)
67
68
69/* decompression */
70LZO_EXTERN(int)
71lzo1x_decompress        ( const lzo_bytep src, lzo_uint  src_len,
72                                lzo_bytep dst, lzo_uintp dst_len,
73                                lzo_voidp wrkmem /* NOT USED */ );
74
75/* safe decompression with overrun testing */
76LZO_EXTERN(int)
77lzo1x_decompress_safe   ( const lzo_bytep src, lzo_uint  src_len,
78                                lzo_bytep dst, lzo_uintp dst_len,
79                                lzo_voidp wrkmem /* NOT USED */ );
80
81
82/***********************************************************************
83//
84************************************************************************/
85
86#define LZO1X_1_MEM_COMPRESS    ((lzo_uint32) (16384L * lzo_sizeof_dict_t))
87
88LZO_EXTERN(int)
89lzo1x_1_compress        ( const lzo_bytep src, lzo_uint  src_len,
90                                lzo_bytep dst, lzo_uintp dst_len,
91                                lzo_voidp wrkmem );
92
93
94/***********************************************************************
95// special compressor versions
96************************************************************************/
97
98/* this version needs only 8 KiB work memory */
99#define LZO1X_1_11_MEM_COMPRESS ((lzo_uint32) (2048L * lzo_sizeof_dict_t))
100
101LZO_EXTERN(int)
102lzo1x_1_11_compress     ( const lzo_bytep src, lzo_uint  src_len,
103                                lzo_bytep dst, lzo_uintp dst_len,
104                                lzo_voidp wrkmem );
105
106
107/* this version needs 16 KiB work memory */
108#define LZO1X_1_12_MEM_COMPRESS ((lzo_uint32) (4096L * lzo_sizeof_dict_t))
109
110LZO_EXTERN(int)
111lzo1x_1_12_compress     ( const lzo_bytep src, lzo_uint  src_len,
112                                lzo_bytep dst, lzo_uintp dst_len,
113                                lzo_voidp wrkmem );
114
115
116/* use this version if you need a little more compression speed */
117#define LZO1X_1_15_MEM_COMPRESS ((lzo_uint32) (32768L * lzo_sizeof_dict_t))
118
119LZO_EXTERN(int)
120lzo1x_1_15_compress     ( const lzo_bytep src, lzo_uint  src_len,
121                                lzo_bytep dst, lzo_uintp dst_len,
122                                lzo_voidp wrkmem );
123
124
125/***********************************************************************
126// better compression ratio at the cost of more memory and time
127************************************************************************/
128
129#define LZO1X_999_MEM_COMPRESS  ((lzo_uint32) (14 * 16384L * sizeof(short)))
130
131LZO_EXTERN(int)
132lzo1x_999_compress      ( const lzo_bytep src, lzo_uint  src_len,
133                                lzo_bytep dst, lzo_uintp dst_len,
134                                lzo_voidp wrkmem );
135
136
137/***********************************************************************
138//
139************************************************************************/
140
141LZO_EXTERN(int)
142lzo1x_999_compress_dict     ( const lzo_bytep src, lzo_uint  src_len,
143                                    lzo_bytep dst, lzo_uintp dst_len,
144                                    lzo_voidp wrkmem,
145                              const lzo_bytep dict, lzo_uint dict_len );
146
147LZO_EXTERN(int)
148lzo1x_999_compress_level    ( const lzo_bytep src, lzo_uint  src_len,
149                                    lzo_bytep dst, lzo_uintp dst_len,
150                                    lzo_voidp wrkmem,
151                              const lzo_bytep dict, lzo_uint dict_len,
152                                    lzo_callback_p cb,
153                                    int compression_level );
154
155LZO_EXTERN(int)
156lzo1x_decompress_dict_safe ( const lzo_bytep src, lzo_uint  src_len,
157                                   lzo_bytep dst, lzo_uintp dst_len,
158                                   lzo_voidp wrkmem /* NOT USED */,
159                             const lzo_bytep dict, lzo_uint dict_len );
160
161
162/***********************************************************************
163// optimize a compressed data block
164************************************************************************/
165
166LZO_EXTERN(int)
167lzo1x_optimize          (       lzo_bytep src, lzo_uint  src_len,
168                                lzo_bytep dst, lzo_uintp dst_len,
169                                lzo_voidp wrkmem /* NOT USED */ );
170
171
172
173#ifdef __cplusplus
174} /* extern "C" */
175#endif
176
177#endif /* already included */
178
179
180/* vim:set ts=4 et: */
181