1/* lzo1z.h -- public interface of the LZO1Z 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 __LZO1Z_H_INCLUDED
45#define __LZO1Z_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 LZO1Z_MEM_COMPRESS      ((lzo_uint32) (16384L * lzo_sizeof_dict_t))
65#define LZO1Z_MEM_DECOMPRESS    (0)
66#define LZO1Z_MEM_OPTIMIZE      (0)
67
68
69/* decompression */
70LZO_EXTERN(int)
71lzo1z_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)
77lzo1z_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#if 0
87/* not yet implemented */
88LZO_EXTERN(int)
89lzo1z_1_compress        ( const lzo_bytep src, lzo_uint  src_len,
90                                lzo_bytep dst, lzo_uintp dst_len,
91                                lzo_voidp wrkmem );
92#endif
93
94
95/***********************************************************************
96// better compression ratio at the cost of more memory and time
97************************************************************************/
98
99#define LZO1Z_999_MEM_COMPRESS  ((lzo_uint32) (14 * 16384L * sizeof(short)))
100
101LZO_EXTERN(int)
102lzo1z_999_compress      ( const lzo_bytep src, lzo_uint  src_len,
103                                lzo_bytep dst, lzo_uintp dst_len,
104                                lzo_voidp wrkmem );
105
106
107/***********************************************************************
108//
109************************************************************************/
110
111LZO_EXTERN(int)
112lzo1z_999_compress_dict     ( const lzo_bytep src, lzo_uint  src_len,
113                                    lzo_bytep dst, lzo_uintp dst_len,
114                                    lzo_voidp wrkmem,
115                              const lzo_bytep dict, lzo_uint dict_len );
116
117LZO_EXTERN(int)
118lzo1z_999_compress_level    ( const lzo_bytep src, lzo_uint  src_len,
119                                    lzo_bytep dst, lzo_uintp dst_len,
120                                    lzo_voidp wrkmem,
121                              const lzo_bytep dict, lzo_uint dict_len,
122                                    lzo_callback_p cb,
123                                    int compression_level );
124
125LZO_EXTERN(int)
126lzo1z_decompress_dict_safe ( const lzo_bytep src, lzo_uint  src_len,
127                                   lzo_bytep dst, lzo_uintp dst_len,
128                                   lzo_voidp wrkmem /* NOT USED */,
129                             const lzo_bytep dict, lzo_uint dict_len );
130
131
132/***********************************************************************
133// optimize a compressed data block
134************************************************************************/
135
136#if 0
137/* not yet implemented */
138LZO_EXTERN(int)
139lzo1z_optimize          (       lzo_bytep src, lzo_uint  src_len,
140                                lzo_bytep dst, lzo_uintp dst_len,
141                                lzo_voidp wrkmem /* NOT USED */ );
142#endif
143
144
145
146#ifdef __cplusplus
147} /* extern "C" */
148#endif
149
150#endif /* already included */
151
152
153/* vim:set ts=4 et: */
154