VirtualBox

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

Last change on this file since 3251 was 2981, checked in by vboxsync, 17 years ago

InnoTek -> innotek: all the headers and comments.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.9 KB
Line 
1/** @file
2 *
3 * innotek Portable Runtime - Compression.
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License as published by the Free Software Foundation,
13 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14 * distribution. VirtualBox OSE is distributed in the hope that it will
15 * be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * If you received this file as part of a commercial VirtualBox
18 * distribution, then only the terms of your commercial VirtualBox
19 * license agreement apply instead of the previous paragraph.
20 */
21
22#ifndef __iprt_zip_h__
23#define __iprt_zip_h__
24
25
26#include <iprt/cdefs.h>
27#include <iprt/types.h>
28
29
30__BEGIN_DECLS
31
32/** @defgroup grp_rt_zip RTZip - Compression
33 * @ingroup grp_rt
34 * @{
35 */
36
37
38
39/**
40 * Callback function for consuming compressed data during compression.
41 *
42 * @returns iprt status code.
43 * @param pvUser User argument.
44 * @param pvBuf Compressed data.
45 * @param cbBuf Size of the compressed data.
46 */
47typedef DECLCALLBACK(int) FNRTZIPOUT(void *pvUser, const void *pvBuf, size_t cbBuf);
48/** Pointer to FNRTZIPOUT() function. */
49typedef FNRTZIPOUT *PFNRTZIPOUT;
50
51/**
52 * Callback function for supplying compressed data during decompression.
53 *
54 * @returns iprt status code.
55 * @param pvUser User argument.
56 * @param pvBuf Where to store the compressed data.
57 * @param cbBuf Size of the buffer.
58 * @param pcbBuf Number of bytes actually stored in the buffer.
59 */
60typedef DECLCALLBACK(int) FNRTZIPIN(void *pvUser, void *pvBuf, size_t cbBuf, size_t *pcbBuf);
61/** Pointer to FNRTZIPIN() function. */
62typedef FNRTZIPIN *PFNRTZIPIN;
63
64/**
65 * Compression type.
66 * (Be careful with these they are stored in files!)
67 */
68typedef enum RTZIPTYPE
69{
70 /** Invalid. */
71 RTZIPTYPE_INVALID = 0,
72 /** Choose best fitting one. */
73 RTZIPTYPE_AUTO,
74 /** Store the data. */
75 RTZIPTYPE_STORE,
76 /** Zlib compression the data. */
77 RTZIPTYPE_ZLIB,
78 /** BZlib compress. */
79 RTZIPTYPE_BZLIB,
80 /** libLZF compress. */
81 RTZIPTYPE_LZF
82} RTZIPTYPE;
83
84/**
85 * Compression level.
86 */
87typedef enum RTZIPLEVEL
88{
89 /** Store, don't compress. */
90 RTZIPLEVEL_STORE = 0,
91 /** Fast compression. */
92 RTZIPLEVEL_FAST,
93 /** Default compression. */
94 RTZIPLEVEL_DEFAULT,
95 /** Maximal compression. */
96 RTZIPLEVEL_MAX
97} RTZIPLEVEL;
98
99
100/**
101 * Create a compressor instance.
102 *
103 * @returns iprt status code.
104 * @param ppZip Where to store the instance handle.
105 * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
106 * @param pfnOut Callback for consuming output of compression.
107 * @param enmType Type of compressor to create.
108 * @param enmLevel Compression level.
109 */
110RTDECL(int) RTZipCompCreate(PRTZIPCOMP *ppZip, void *pvUser, PFNRTZIPOUT pfnOut, RTZIPTYPE enmType, RTZIPLEVEL enmLevel);
111
112/**
113 * Compresses a chunk of memory.
114 *
115 * @returns iprt status code.
116 * @param pZip The compressor instance.
117 * @param pvBuf Pointer to buffer containing the bits to compress.
118 * @param cbBuf Number of bytes to compress.
119 */
120RTDECL(int) RTZipCompress(PRTZIPCOMP pZip, const void *pvBuf, size_t cbBuf);
121
122/**
123 * Finishes the compression.
124 * This will flush all data and terminate the compression data stream.
125 *
126 * @returns iprt status code.
127 * @param pZip The compressor instance.
128 */
129RTDECL(int) RTZipCompFinish(PRTZIPCOMP pZip);
130
131/**
132 * Destroys the compressor instance.
133 *
134 * @returns iprt status code.
135 * @param pZip The compressor instance.
136 */
137RTDECL(int) RTZipCompDestroy(PRTZIPCOMP pZip);
138
139
140/**
141 * Create a decompressor instance.
142 *
143 * @returns iprt status code.
144 * @param ppZip Where to store the instance handle.
145 * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
146 * @param pfnIn Callback for producing input for decompression.
147 */
148RTDECL(int) RTZipDecompCreate(PRTZIPDECOMP *ppZip, void *pvUser, PFNRTZIPIN pfnIn);
149
150/**
151 * Decompresses a chunk of memory.
152 *
153 * @returns iprt status code.
154 * @param pZip The decompressor instance.
155 * @param pvBuf Where to store the decompressed data.
156 * @param cbBuf Number of bytes to produce. If pcbWritten is set
157 * any number of bytes up to cbBuf might be returned.
158 * @param pcbWritten Number of bytes actually written to the buffer. If NULL
159 * cbBuf number of bytes must be written.
160 */
161RTDECL(int) RTZipDecompress(PRTZIPDECOMP pZip, void *pvBuf, size_t cbBuf, size_t *pcbWritten);
162
163/**
164 * Destroys the decompressor instance.
165 *
166 * @returns iprt status code.
167 * @param pZip The decompressor instance.
168 */
169RTDECL(int) RTZipDecompDestroy(PRTZIPDECOMP pZip);
170
171
172/** @} */
173
174__END_DECLS
175
176#endif
177
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