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