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) 2008 Markus Franz Xaver Johannes Oberhumer
6   Copyright (C) 2007 Markus Franz Xaver Johannes Oberhumer
7   Copyright (C) 2006 Markus Franz Xaver Johannes Oberhumer
8   Copyright (C) 2005 Markus Franz Xaver Johannes Oberhumer
9   Copyright (C) 2004 Markus Franz Xaver Johannes Oberhumer
10   Copyright (C) 2003 Markus Franz Xaver Johannes Oberhumer
11   Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
12   Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
13   Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
14   Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
15   Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
16   Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
17   Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
18   All Rights Reserved.
19
20   The LZO library is free software; you can redistribute it and/or
21   modify it under the terms of the GNU General Public License as
22   published by the Free Software Foundation; either version 2 of
23   the License, or (at your option) any later version.
24
25   The LZO library is distributed in the hope that it will be useful,
26   but WITHOUT ANY WARRANTY; without even the implied warranty of
27   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28   GNU General Public License for more details.
29
30   You should have received a copy of the GNU General Public License
31   along with the LZO library; see the file COPYING.
32   If not, write to the Free Software Foundation, Inc.,
33   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
34
35   Markus F.X.J. Oberhumer
36   <markus@oberhumer.com>
37   http://www.oberhumer.com/opensource/lzo/
38 */
39
40
41#ifndef __LZO1Z_H_INCLUDED
42#define __LZO1Z_H_INCLUDED
43
44#ifndef __LZOCONF_H_INCLUDED
45#include "lzoconf.h"
46#endif
47
48#ifdef __cplusplus
49extern "C" {
50#endif
51
52
53/***********************************************************************
54//
55************************************************************************/
56
57/* Memory required for the wrkmem parameter.
58 * When the required size is 0, you can also pass a NULL pointer.
59 */
60
61#define LZO1Z_MEM_COMPRESS      ((lzo_uint32) (16384L * lzo_sizeof_dict_t))
62#define LZO1Z_MEM_DECOMPRESS    (0)
63#define LZO1Z_MEM_OPTIMIZE      (0)
64
65
66/* decompression */
67LZO_EXTERN(int)
68lzo1z_decompress        ( const lzo_bytep src, lzo_uint  src_len,
69                                lzo_bytep dst, lzo_uintp dst_len,
70                                lzo_voidp wrkmem /* NOT USED */ );
71
72/* safe decompression with overrun testing */
73LZO_EXTERN(int)
74lzo1z_decompress_safe   ( const lzo_bytep src, lzo_uint  src_len,
75                                lzo_bytep dst, lzo_uintp dst_len,
76                                lzo_voidp wrkmem /* NOT USED */ );
77
78
79/***********************************************************************
80//
81************************************************************************/
82
83#if 0
84/* not yet implemented */
85LZO_EXTERN(int)
86lzo1z_1_compress        ( const lzo_bytep src, lzo_uint  src_len,
87                                lzo_bytep dst, lzo_uintp dst_len,
88                                lzo_voidp wrkmem );
89#endif
90
91
92/***********************************************************************
93// better compression ratio at the cost of more memory and time
94************************************************************************/
95
96#define LZO1Z_999_MEM_COMPRESS  ((lzo_uint32) (14 * 16384L * sizeof(short)))
97
98LZO_EXTERN(int)
99lzo1z_999_compress      ( const lzo_bytep src, lzo_uint  src_len,
100                                lzo_bytep dst, lzo_uintp dst_len,
101                                lzo_voidp wrkmem );
102
103
104/***********************************************************************
105//
106************************************************************************/
107
108LZO_EXTERN(int)
109lzo1z_999_compress_dict     ( const lzo_bytep in , lzo_uint  in_len,
110                                    lzo_bytep out, lzo_uintp out_len,
111                                    lzo_voidp wrkmem,
112                              const lzo_bytep dict, lzo_uint dict_len );
113
114LZO_EXTERN(int)
115lzo1z_999_compress_level    ( const lzo_bytep in , lzo_uint  in_len,
116                                    lzo_bytep out, lzo_uintp out_len,
117                                    lzo_voidp wrkmem,
118                              const lzo_bytep dict, lzo_uint dict_len,
119                                    lzo_callback_p cb,
120                                    int compression_level );
121
122LZO_EXTERN(int)
123lzo1z_decompress_dict_safe ( const lzo_bytep in,  lzo_uint  in_len,
124                                   lzo_bytep out, lzo_uintp out_len,
125                                   lzo_voidp wrkmem /* NOT USED */,
126                             const lzo_bytep dict, lzo_uint dict_len );
127
128
129/***********************************************************************
130// optimize a compressed data block
131************************************************************************/
132
133#if 0
134/* not yet implemented */
135LZO_EXTERN(int)
136lzo1z_optimize          (       lzo_bytep in , lzo_uint  in_len,
137                                lzo_bytep out, lzo_uintp out_len,
138                                lzo_voidp wrkmem /* NOT USED */ );
139#endif
140
141
142
143#ifdef __cplusplus
144} /* extern "C" */
145#endif
146
147#endif /* already included */
148
149
150/* vim:set ts=4 et: */
151