1/* lzo1b.h -- public interface of the LZO1B 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 __LZO1B_H_INCLUDED
42#define __LZO1B_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 LZO1B_MEM_COMPRESS      ((lzo_uint32) (16384L * lzo_sizeof_dict_t))
62#define LZO1B_MEM_DECOMPRESS    (0)
63
64
65/* compression levels */
66#define LZO1B_BEST_SPEED             1
67#define LZO1B_BEST_COMPRESSION       9
68#define LZO1B_DEFAULT_COMPRESSION  (-1)     /* fastest by default */
69
70
71LZO_EXTERN(int)
72lzo1b_compress          ( const lzo_bytep src, lzo_uint  src_len,
73                                lzo_bytep dst, lzo_uintp dst_len,
74                                lzo_voidp wrkmem,
75                                int compression_level );
76
77/* decompression */
78LZO_EXTERN(int)
79lzo1b_decompress        ( const lzo_bytep src, lzo_uint  src_len,
80                                lzo_bytep dst, lzo_uintp dst_len,
81                                lzo_voidp wrkmem /* NOT USED */ );
82
83/* safe decompression with overrun testing */
84LZO_EXTERN(int)
85lzo1b_decompress_safe   ( const lzo_bytep src, lzo_uint  src_len,
86                                lzo_bytep dst, lzo_uintp dst_len,
87                                lzo_voidp wrkmem /* NOT USED */ );
88
89
90/***********************************************************************
91//
92************************************************************************/
93
94LZO_EXTERN(int)
95lzo1b_1_compress        ( const lzo_bytep src, lzo_uint  src_len,
96                                lzo_bytep dst, lzo_uintp dst_len,
97                                lzo_voidp wrkmem );
98LZO_EXTERN(int)
99lzo1b_2_compress        ( const lzo_bytep src, lzo_uint  src_len,
100                                lzo_bytep dst, lzo_uintp dst_len,
101                                lzo_voidp wrkmem );
102LZO_EXTERN(int)
103lzo1b_3_compress        ( const lzo_bytep src, lzo_uint  src_len,
104                                lzo_bytep dst, lzo_uintp dst_len,
105                                lzo_voidp wrkmem );
106LZO_EXTERN(int)
107lzo1b_4_compress        ( const lzo_bytep src, lzo_uint  src_len,
108                                lzo_bytep dst, lzo_uintp dst_len,
109                                lzo_voidp wrkmem );
110LZO_EXTERN(int)
111lzo1b_5_compress        ( const lzo_bytep src, lzo_uint  src_len,
112                                lzo_bytep dst, lzo_uintp dst_len,
113                                lzo_voidp wrkmem );
114LZO_EXTERN(int)
115lzo1b_6_compress        ( const lzo_bytep src, lzo_uint  src_len,
116                                lzo_bytep dst, lzo_uintp dst_len,
117                                lzo_voidp wrkmem );
118LZO_EXTERN(int)
119lzo1b_7_compress        ( const lzo_bytep src, lzo_uint  src_len,
120                                lzo_bytep dst, lzo_uintp dst_len,
121                                lzo_voidp wrkmem );
122LZO_EXTERN(int)
123lzo1b_8_compress        ( const lzo_bytep src, lzo_uint  src_len,
124                                lzo_bytep dst, lzo_uintp dst_len,
125                                lzo_voidp wrkmem );
126LZO_EXTERN(int)
127lzo1b_9_compress        ( const lzo_bytep src, lzo_uint  src_len,
128                                lzo_bytep dst, lzo_uintp dst_len,
129                                lzo_voidp wrkmem );
130
131
132/***********************************************************************
133// better compression ratio at the cost of more memory and time
134************************************************************************/
135
136#define LZO1B_99_MEM_COMPRESS   ((lzo_uint32) (65536L * lzo_sizeof_dict_t))
137
138LZO_EXTERN(int)
139lzo1b_99_compress       ( const lzo_bytep src, lzo_uint  src_len,
140                                lzo_bytep dst, lzo_uintp dst_len,
141                                lzo_voidp wrkmem );
142
143
144#define LZO1B_999_MEM_COMPRESS  ((lzo_uint32) (3 * 65536L * sizeof(lzo_xint)))
145
146LZO_EXTERN(int)
147lzo1b_999_compress      ( const lzo_bytep src, lzo_uint  src_len,
148                                lzo_bytep dst, lzo_uintp dst_len,
149                                lzo_voidp wrkmem );
150
151
152
153#ifdef __cplusplus
154} /* extern "C" */
155#endif
156
157#endif /* already included */
158
159
160/* vim:set ts=4 et: */
161