VirtualBox

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

Last change on this file since 19896 was 8245, checked in by vboxsync, 17 years ago

rebranding: IPRT files again.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.3 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
37__BEGIN_DECLS
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} RTZIPTYPE;
90
91/**
92 * Compression level.
93 */
94typedef enum RTZIPLEVEL
95{
96 /** Store, don't compress. */
97 RTZIPLEVEL_STORE = 0,
98 /** Fast compression. */
99 RTZIPLEVEL_FAST,
100 /** Default compression. */
101 RTZIPLEVEL_DEFAULT,
102 /** Maximal compression. */
103 RTZIPLEVEL_MAX
104} RTZIPLEVEL;
105
106
107/**
108 * Create a compressor instance.
109 *
110 * @returns iprt status code.
111 * @param ppZip Where to store the instance handle.
112 * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
113 * @param pfnOut Callback for consuming output of compression.
114 * @param enmType Type of compressor to create.
115 * @param enmLevel Compression level.
116 */
117RTDECL(int) RTZipCompCreate(PRTZIPCOMP *ppZip, void *pvUser, PFNRTZIPOUT pfnOut, RTZIPTYPE enmType, RTZIPLEVEL enmLevel);
118
119/**
120 * Compresses a chunk of memory.
121 *
122 * @returns iprt status code.
123 * @param pZip The compressor instance.
124 * @param pvBuf Pointer to buffer containing the bits to compress.
125 * @param cbBuf Number of bytes to compress.
126 */
127RTDECL(int) RTZipCompress(PRTZIPCOMP pZip, const void *pvBuf, size_t cbBuf);
128
129/**
130 * Finishes the compression.
131 * This will flush all data and terminate the compression data stream.
132 *
133 * @returns iprt status code.
134 * @param pZip The compressor instance.
135 */
136RTDECL(int) RTZipCompFinish(PRTZIPCOMP pZip);
137
138/**
139 * Destroys the compressor instance.
140 *
141 * @returns iprt status code.
142 * @param pZip The compressor instance.
143 */
144RTDECL(int) RTZipCompDestroy(PRTZIPCOMP pZip);
145
146
147/**
148 * Create a decompressor instance.
149 *
150 * @returns iprt status code.
151 * @param ppZip Where to store the instance handle.
152 * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
153 * @param pfnIn Callback for producing input for decompression.
154 */
155RTDECL(int) RTZipDecompCreate(PRTZIPDECOMP *ppZip, void *pvUser, PFNRTZIPIN pfnIn);
156
157/**
158 * Decompresses a chunk of memory.
159 *
160 * @returns iprt status code.
161 * @param pZip The decompressor instance.
162 * @param pvBuf Where to store the decompressed data.
163 * @param cbBuf Number of bytes to produce. If pcbWritten is set
164 * any number of bytes up to cbBuf might be returned.
165 * @param pcbWritten Number of bytes actually written to the buffer. If NULL
166 * cbBuf number of bytes must be written.
167 */
168RTDECL(int) RTZipDecompress(PRTZIPDECOMP pZip, void *pvBuf, size_t cbBuf, size_t *pcbWritten);
169
170/**
171 * Destroys the decompressor instance.
172 *
173 * @returns iprt status code.
174 * @param pZip The decompressor instance.
175 */
176RTDECL(int) RTZipDecompDestroy(PRTZIPDECOMP pZip);
177
178
179/** @} */
180
181__END_DECLS
182
183#endif
184
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