VirtualBox

source: vbox/trunk/include/iprt/zip.h@ 22509

Last change on this file since 22509 was 21814, checked in by vboxsync, 15 years ago

IPRT: RTZipBlock for block compression.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.2 KB
Line 
1/** @file
2 * IPRT - Compression.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___iprt_zip_h
31#define ___iprt_zip_h
32
33#include <iprt/cdefs.h>
34#include <iprt/types.h>
35
36
37RT_C_DECLS_BEGIN
38
39/** @defgroup grp_rt_zip RTZip - Compression
40 * @ingroup grp_rt
41 * @{
42 */
43
44
45
46/**
47 * Callback function for consuming compressed data during compression.
48 *
49 * @returns iprt status code.
50 * @param pvUser User argument.
51 * @param pvBuf Compressed data.
52 * @param cbBuf Size of the compressed data.
53 */
54typedef DECLCALLBACK(int) FNRTZIPOUT(void *pvUser, const void *pvBuf, size_t cbBuf);
55/** Pointer to FNRTZIPOUT() function. */
56typedef FNRTZIPOUT *PFNRTZIPOUT;
57
58/**
59 * Callback function for supplying compressed data during decompression.
60 *
61 * @returns iprt status code.
62 * @param pvUser User argument.
63 * @param pvBuf Where to store the compressed data.
64 * @param cbBuf Size of the buffer.
65 * @param pcbBuf Number of bytes actually stored in the buffer.
66 */
67typedef DECLCALLBACK(int) FNRTZIPIN(void *pvUser, void *pvBuf, size_t cbBuf, size_t *pcbBuf);
68/** Pointer to FNRTZIPIN() function. */
69typedef FNRTZIPIN *PFNRTZIPIN;
70
71/**
72 * Compression type.
73 * (Be careful with these they are stored in files!)
74 */
75typedef enum RTZIPTYPE
76{
77 /** Invalid. */
78 RTZIPTYPE_INVALID = 0,
79 /** Choose best fitting one. */
80 RTZIPTYPE_AUTO,
81 /** Store the data. */
82 RTZIPTYPE_STORE,
83 /** Zlib compression the data. */
84 RTZIPTYPE_ZLIB,
85 /** BZlib compress. */
86 RTZIPTYPE_BZLIB,
87 /** libLZF compress. */
88 RTZIPTYPE_LZF,
89 /** Lempel-Ziv-Jeff-Bonwick compression. */
90 RTZIPTYPE_LZJB,
91 /** Lempel-Ziv-Oberhumer compression. */
92 RTZIPTYPE_LZO,
93 /** End of valid the valid compression types. */
94 RTZIPTYPE_END
95} RTZIPTYPE;
96
97/**
98 * Compression level.
99 */
100typedef enum RTZIPLEVEL
101{
102 /** Store, don't compress. */
103 RTZIPLEVEL_STORE = 0,
104 /** Fast compression. */
105 RTZIPLEVEL_FAST,
106 /** Default compression. */
107 RTZIPLEVEL_DEFAULT,
108 /** Maximal compression. */
109 RTZIPLEVEL_MAX
110} RTZIPLEVEL;
111
112
113/**
114 * Create a stream compressor instance.
115 *
116 * @returns iprt status code.
117 * @param ppZip Where to store the instance handle.
118 * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
119 * @param pfnOut Callback for consuming output of compression.
120 * @param enmType Type of compressor to create.
121 * @param enmLevel Compression level.
122 */
123RTDECL(int) RTZipCompCreate(PRTZIPCOMP *ppZip, void *pvUser, PFNRTZIPOUT pfnOut, RTZIPTYPE enmType, RTZIPLEVEL enmLevel);
124
125/**
126 * Compresses a chunk of memory.
127 *
128 * @returns iprt status code.
129 * @param pZip The compressor instance.
130 * @param pvBuf Pointer to buffer containing the bits to compress.
131 * @param cbBuf Number of bytes to compress.
132 */
133RTDECL(int) RTZipCompress(PRTZIPCOMP pZip, const void *pvBuf, size_t cbBuf);
134
135/**
136 * Finishes the compression.
137 * This will flush all data and terminate the compression data stream.
138 *
139 * @returns iprt status code.
140 * @param pZip The stream compressor instance.
141 */
142RTDECL(int) RTZipCompFinish(PRTZIPCOMP pZip);
143
144/**
145 * Destroys the stream compressor instance.
146 *
147 * @returns iprt status code.
148 * @param pZip The compressor instance.
149 */
150RTDECL(int) RTZipCompDestroy(PRTZIPCOMP pZip);
151
152
153/**
154 * Create a stream decompressor instance.
155 *
156 * @returns iprt status code.
157 * @param ppZip Where to store the instance handle.
158 * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
159 * @param pfnIn Callback for producing input for decompression.
160 */
161RTDECL(int) RTZipDecompCreate(PRTZIPDECOMP *ppZip, void *pvUser, PFNRTZIPIN pfnIn);
162
163/**
164 * Decompresses a chunk of memory.
165 *
166 * @returns iprt status code.
167 * @param pZip The stream decompressor instance.
168 * @param pvBuf Where to store the decompressed data.
169 * @param cbBuf Number of bytes to produce. If pcbWritten is set
170 * any number of bytes up to cbBuf might be returned.
171 * @param pcbWritten Number of bytes actually written to the buffer. If NULL
172 * cbBuf number of bytes must be written.
173 */
174RTDECL(int) RTZipDecompress(PRTZIPDECOMP pZip, void *pvBuf, size_t cbBuf, size_t *pcbWritten);
175
176/**
177 * Destroys the stream decompressor instance.
178 *
179 * @returns iprt status code.
180 * @param pZip The decompressor instance.
181 */
182RTDECL(int) RTZipDecompDestroy(PRTZIPDECOMP pZip);
183
184
185/**
186 * Compress a chunk of memory into a block.
187 *
188 * @returns IPRT status code.
189 *
190 * @param enmType The compression type.
191 * @param enmLevel The compression level.
192 * @param fFlags Flags reserved for future extensions, MBZ.
193 * @param pvSrc Pointer to the input block.
194 * @param cbSrc Size of the input block.
195 * @param pvDst Pointer to the output buffer.
196 * @param cbDst The size of the output buffer.
197 * @param pcbDstActual Where to return the compressed size.
198 */
199RTDECL(int) RTZipBlockCompress(RTZIPTYPE enmType, RTZIPLEVEL enmLevel, uint32_t fFlags,
200 void const *pvSrc, size_t cbSrc,
201 void *pvDst, size_t cbDst, size_t *pcbDstActual) RT_NO_THROW;
202
203
204/**
205 * Decompress a block.
206 *
207 * @returns IPRT status code.
208 *
209 * @param enmType The compression type.
210 * @param fFlags Flags reserved for future extensions, MBZ.
211 * @param pvSrc Pointer to the input block.
212 * @param cbSrc Size of the input block.
213 * @param pcbSrcActual Where to return the compressed size.
214 * @param pvDst Pointer to the output buffer.
215 * @param cbDst The size of the output buffer.
216 * @param pcbDstActual Where to return the decompressed size.
217 */
218RTDECL(int) RTZipBlockDecompress(RTZIPTYPE enmType, uint32_t fFlags,
219 void const *pvSrc, size_t cbSrc, size_t *pcbSrcActual,
220 void *pvDst, size_t cbDst, size_t *pcbDstActual) RT_NO_THROW;
221
222
223/** @} */
224
225RT_C_DECLS_END
226
227#endif
228
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette