src/lzo/lzo1x.h

/* lzo1x.h -- public interface of the LZO1X compression algorithm

   This file is part of the LZO real-time data compression library.

   Copyright (C) 2008 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2007 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2006 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2005 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2004 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2003 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
   All Rights Reserved.

   The LZO library is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of
   the License, or (at your option) any later version.

   The LZO library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with the LZO library; see the file COPYING.
   If not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

   Markus F.X.J. Oberhumer
   <markus@oberhumer.com>
   http://www.oberhumer.com/opensource/lzo/
 */


#ifndef __LZO1X_H_INCLUDED
#define __LZO1X_H_INCLUDED

#ifndef __LZOCONF_H_INCLUDED
#include "lzoconf.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif


/***********************************************************************
//
************************************************************************/

/* Memory required for the wrkmem parameter.
 * When the required size is 0, you can also pass a NULL pointer.
 */

#define LZO1X_MEM_COMPRESS      LZO1X_1_MEM_COMPRESS
#define LZO1X_MEM_DECOMPRESS    (0)
#define LZO1X_MEM_OPTIMIZE      (0)


/* decompression */
LZO_EXTERN(int)
lzo1x_decompress        ( const lzo_bytep src, lzo_uint  src_len,
                                lzo_bytep dst, lzo_uintp dst_len,
                                lzo_voidp wrkmem /* NOT USED */ );

/* safe decompression with overrun testing */
LZO_EXTERN(int)
lzo1x_decompress_safe   ( const lzo_bytep src, lzo_uint  src_len,
                                lzo_bytep dst, lzo_uintp dst_len,
                                lzo_voidp wrkmem /* NOT USED */ );


/***********************************************************************
//
************************************************************************/

#define LZO1X_1_MEM_COMPRESS    ((lzo_uint32) (16384L * lzo_sizeof_dict_t))

LZO_EXTERN(int)
lzo1x_1_compress        ( const lzo_bytep src, lzo_uint  src_len,
                                lzo_bytep dst, lzo_uintp dst_len,
                                lzo_voidp wrkmem );


/***********************************************************************
// special compressor versions
************************************************************************/

/* this version needs only 8 kB work memory */
#define LZO1X_1_11_MEM_COMPRESS ((lzo_uint32) (2048L * lzo_sizeof_dict_t))

LZO_EXTERN(int)
lzo1x_1_11_compress     ( const lzo_bytep src, lzo_uint  src_len,
                                lzo_bytep dst, lzo_uintp dst_len,
                                lzo_voidp wrkmem );


/* this version needs 16 kB work memory */
#define LZO1X_1_12_MEM_COMPRESS ((lzo_uint32) (4096L * lzo_sizeof_dict_t))

LZO_EXTERN(int)
lzo1x_1_12_compress     ( const lzo_bytep src, lzo_uint  src_len,
                                lzo_bytep dst, lzo_uintp dst_len,
                                lzo_voidp wrkmem );


/* use this version if you need a little more compression speed */
#define LZO1X_1_15_MEM_COMPRESS ((lzo_uint32) (32768L * lzo_sizeof_dict_t))

LZO_EXTERN(int)
lzo1x_1_15_compress     ( const lzo_bytep src, lzo_uint  src_len,
                                lzo_bytep dst, lzo_uintp dst_len,
                                lzo_voidp wrkmem );


/***********************************************************************
// better compression ratio at the cost of more memory and time
************************************************************************/

#define LZO1X_999_MEM_COMPRESS  ((lzo_uint32) (14 * 16384L * sizeof(short)))

LZO_EXTERN(int)
lzo1x_999_compress      ( const lzo_bytep src, lzo_uint  src_len,
                                lzo_bytep dst, lzo_uintp dst_len,
                                lzo_voidp wrkmem );


/***********************************************************************
//
************************************************************************/

LZO_EXTERN(int)
lzo1x_999_compress_dict     ( const lzo_bytep in , lzo_uint  in_len,
                                    lzo_bytep out, lzo_uintp out_len,
                                    lzo_voidp wrkmem,
                              const lzo_bytep dict, lzo_uint dict_len );

LZO_EXTERN(int)
lzo1x_999_compress_level    ( const lzo_bytep in , lzo_uint  in_len,
                                    lzo_bytep out, lzo_uintp out_len,
                                    lzo_voidp wrkmem,
                              const lzo_bytep dict, lzo_uint dict_len,
                                    lzo_callback_p cb,
                                    int compression_level );

LZO_EXTERN(int)
lzo1x_decompress_dict_safe ( const lzo_bytep in,  lzo_uint  in_len,
                                   lzo_bytep out, lzo_uintp out_len,
                                   lzo_voidp wrkmem /* NOT USED */,
                             const lzo_bytep dict, lzo_uint dict_len );


/***********************************************************************
// optimize a compressed data block
************************************************************************/

LZO_EXTERN(int)
lzo1x_optimize          (       lzo_bytep in , lzo_uint  in_len,
                                lzo_bytep out, lzo_uintp out_len,
                                lzo_voidp wrkmem /* NOT USED */ );


#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* already included */


/* vim:set ts=4 et: */
Revision:	1.1
Committed:	Tue Feb 24 11:56:45 2009 UTC (16 years, 2 months ago) by loizides
Content type:	text/plain
Branch:	MAIN
CVS Tags:	Mit_032, Mit_031, Mit_025c_branch2, Mit_025c_branch1, Mit_030, Mit_029c, Mit_030_pre1, Mit_029a, Mit_029, Mit_029_pre1, Mit_028a, Mit_025c_branch0, Mit_028, Mit_027a, Mit_027, Mit_026, Mit_025e, Mit_025d, Mit_025c, Mit_025b, Mit_025a, Mit_025, Mit_025pre2, Mit_024b, Mit_025pre1, Mit_024a, Mit_024, Mit_023, Mit_022a, Mit_022, Mit_020d, TMit_020d, Mit_020c, Mit_021, Mit_021pre2, Mit_021pre1, Mit_020b, Mit_020a, Mit_020, Mit_020pre1, Mit_018, Mit_017, Mit_017pre3, Mit_017pre2, Mit_017pre1, V07-05-00, Mit_016, Mit_015b, Mit_015a, Mit_015, Mit_014e, Mit_014d, Mit_014c, Mit_014b, ConvRejection-10-06-09, Mit_014a, Mit_014, Mit_014pre3, Mit_014pre2, Mit_014pre1, Mit_013d, Mit_013c, Mit_013b, Mit_013a, Mit_013, Mit_013pre1, Mit_012i, Mit_012g, Mit_012f, Mit_012e, Mit_012d, Mit_012c, Mit_012b, Mit_012a, Mit_012, Mit_011a, Mit_011, Mit_010a, Mit_010, Mit_009c, Mit_009b, Mit_009a, Mit_009, Mit_008, Mit_008pre2, Mit_008pre1, HEAD
Branch point for:	Mit_025c_branch
Log Message:	Preload lib for compression improvements.
#	User	Rev	Content
1	loizides	1.1	/* lzo1x.h -- public interface of the LZO1X 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 __LZO1X_H_INCLUDED
42			#define __LZO1X_H_INCLUDED
43
44			#ifndef __LZOCONF_H_INCLUDED
45			#include "lzoconf.h"
46			#endif
47
48			#ifdef __cplusplus
49			extern "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 LZO1X_MEM_COMPRESS LZO1X_1_MEM_COMPRESS
62			#define LZO1X_MEM_DECOMPRESS (0)
63			#define LZO1X_MEM_OPTIMIZE (0)
64
65
66			/* decompression */
67			LZO_EXTERN(int)
68			lzo1x_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 */
73			LZO_EXTERN(int)
74			lzo1x_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			#define LZO1X_1_MEM_COMPRESS ((lzo_uint32) (16384L * lzo_sizeof_dict_t))
84
85			LZO_EXTERN(int)
86			lzo1x_1_compress ( const lzo_bytep src, lzo_uint src_len,
87			lzo_bytep dst, lzo_uintp dst_len,
88			lzo_voidp wrkmem );
89
90
91			/***********************************************************************
92			// special compressor versions
93			************************************************************************/
94
95			/* this version needs only 8 kB work memory */
96			#define LZO1X_1_11_MEM_COMPRESS ((lzo_uint32) (2048L * lzo_sizeof_dict_t))
97
98			LZO_EXTERN(int)
99			lzo1x_1_11_compress ( const lzo_bytep src, lzo_uint src_len,
100			lzo_bytep dst, lzo_uintp dst_len,
101			lzo_voidp wrkmem );
102
103
104			/* this version needs 16 kB work memory */
105			#define LZO1X_1_12_MEM_COMPRESS ((lzo_uint32) (4096L * lzo_sizeof_dict_t))
106
107			LZO_EXTERN(int)
108			lzo1x_1_12_compress ( const lzo_bytep src, lzo_uint src_len,
109			lzo_bytep dst, lzo_uintp dst_len,
110			lzo_voidp wrkmem );
111
112
113			/* use this version if you need a little more compression speed */
114			#define LZO1X_1_15_MEM_COMPRESS ((lzo_uint32) (32768L * lzo_sizeof_dict_t))
115
116			LZO_EXTERN(int)
117			lzo1x_1_15_compress ( const lzo_bytep src, lzo_uint src_len,
118			lzo_bytep dst, lzo_uintp dst_len,
119			lzo_voidp wrkmem );
120
121
122			/***********************************************************************
123			// better compression ratio at the cost of more memory and time
124			************************************************************************/
125
126			#define LZO1X_999_MEM_COMPRESS ((lzo_uint32) (14 * 16384L * sizeof(short)))
127
128			LZO_EXTERN(int)
129			lzo1x_999_compress ( const lzo_bytep src, lzo_uint src_len,
130			lzo_bytep dst, lzo_uintp dst_len,
131			lzo_voidp wrkmem );
132
133
134			/***********************************************************************
135			//
136			************************************************************************/
137
138			LZO_EXTERN(int)
139			lzo1x_999_compress_dict ( const lzo_bytep in , lzo_uint in_len,
140			lzo_bytep out, lzo_uintp out_len,
141			lzo_voidp wrkmem,
142			const lzo_bytep dict, lzo_uint dict_len );
143
144			LZO_EXTERN(int)
145			lzo1x_999_compress_level ( const lzo_bytep in , lzo_uint in_len,
146			lzo_bytep out, lzo_uintp out_len,
147			lzo_voidp wrkmem,
148			const lzo_bytep dict, lzo_uint dict_len,
149			lzo_callback_p cb,
150			int compression_level );
151
152			LZO_EXTERN(int)
153			lzo1x_decompress_dict_safe ( const lzo_bytep in, lzo_uint in_len,
154			lzo_bytep out, lzo_uintp out_len,
155			lzo_voidp wrkmem /* NOT USED */,
156			const lzo_bytep dict, lzo_uint dict_len );
157
158
159			/***********************************************************************
160			// optimize a compressed data block
161			************************************************************************/
162
163			LZO_EXTERN(int)
164			lzo1x_optimize ( lzo_bytep in , lzo_uint in_len,
165			lzo_bytep out, lzo_uintp out_len,
166			lzo_voidp wrkmem /* NOT USED */ );
167
168
169
170			#ifdef __cplusplus
171			} /* extern "C" */
172			#endif
173
174			#endif /* already included */
175
176
177			/* vim:set ts=4 et: */