1/* lzo1y.h -- public interface of the LZO1Y 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 __LZO1Y_H_INCLUDED
42#define __LZO1Y_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 LZO1Y_MEM_COMPRESS      ((lzo_uint32) (16384L * lzo_sizeof_dict_t))
62#define LZO1Y_MEM_DECOMPRESS    (0)
63#define LZO1Y_MEM_OPTIMIZE      (0)
64
65
66/* decompression */
67LZO_EXTERN(int)
68lzo1y_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)
74lzo1y_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
83LZO_EXTERN(int)
84lzo1y_1_compress        ( const lzo_bytep src, lzo_uint  src_len,
85                                lzo_bytep dst, lzo_uintp dst_len,
86                                lzo_voidp wrkmem );
87
88
89/***********************************************************************
90// better compression ratio at the cost of more memory and time
91************************************************************************/
92
93#define LZO1Y_999_MEM_COMPRESS  ((lzo_uint32) (14 * 16384L * sizeof(short)))
94
95LZO_EXTERN(int)
96lzo1y_999_compress      ( const lzo_bytep src, lzo_uint  src_len,
97                                lzo_bytep dst, lzo_uintp dst_len,
98                                lzo_voidp wrkmem );
99
100
101
102/***********************************************************************
103//
104************************************************************************/
105
106LZO_EXTERN(int)
107lzo1y_999_compress_dict     ( const lzo_bytep in , lzo_uint  in_len,
108                                    lzo_bytep out, lzo_uintp out_len,
109                                    lzo_voidp wrkmem,
110                              const lzo_bytep dict, lzo_uint dict_len );
111
112LZO_EXTERN(int)
113lzo1y_999_compress_level    ( const lzo_bytep in , lzo_uint  in_len,
114                                    lzo_bytep out, lzo_uintp out_len,
115                                    lzo_voidp wrkmem,
116                              const lzo_bytep dict, lzo_uint dict_len,
117                                    lzo_callback_p cb,
118                                    int compression_level );
119
120LZO_EXTERN(int)
121lzo1y_decompress_dict_safe ( const lzo_bytep in,  lzo_uint  in_len,
122                                   lzo_bytep out, lzo_uintp out_len,
123                                   lzo_voidp wrkmem /* NOT USED */,
124                             const lzo_bytep dict, lzo_uint dict_len );
125
126
127/***********************************************************************
128// optimize a compressed data block
129************************************************************************/
130
131LZO_EXTERN(int)
132lzo1y_optimize          (       lzo_bytep in , lzo_uint  in_len,
133                                lzo_bytep out, lzo_uintp out_len,
134                                lzo_voidp wrkmem /* NOT USED */ );
135
136
137
138#ifdef __cplusplus
139} /* extern "C" */
140#endif
141
142#endif /* already included */
143
144
145/* vim:set ts=4 et: */
146