| 1 | /** @file
|
|---|
| 2 | * IPRT - Compression.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2010 Oracle Corporation
|
|---|
| 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 |
|
|---|
| 26 | #ifndef ___iprt_zip_h
|
|---|
| 27 | #define ___iprt_zip_h
|
|---|
| 28 |
|
|---|
| 29 | #include <iprt/cdefs.h>
|
|---|
| 30 | #include <iprt/types.h>
|
|---|
| 31 |
|
|---|
| 32 | RT_C_DECLS_BEGIN
|
|---|
| 33 |
|
|---|
| 34 | /** @defgroup grp_rt_zip RTZip - Compression
|
|---|
| 35 | * @ingroup grp_rt
|
|---|
| 36 | * @{
|
|---|
| 37 | */
|
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 |
|
|---|
| 41 | /**
|
|---|
| 42 | * Callback function for consuming compressed data during compression.
|
|---|
| 43 | *
|
|---|
| 44 | * @returns iprt status code.
|
|---|
| 45 | * @param pvUser User argument.
|
|---|
| 46 | * @param pvBuf Compressed data.
|
|---|
| 47 | * @param cbBuf Size of the compressed data.
|
|---|
| 48 | */
|
|---|
| 49 | typedef DECLCALLBACK(int) FNRTZIPOUT(void *pvUser, const void *pvBuf, size_t cbBuf);
|
|---|
| 50 | /** Pointer to FNRTZIPOUT() function. */
|
|---|
| 51 | typedef FNRTZIPOUT *PFNRTZIPOUT;
|
|---|
| 52 |
|
|---|
| 53 | /**
|
|---|
| 54 | * Callback function for supplying compressed data during decompression.
|
|---|
| 55 | *
|
|---|
| 56 | * @returns iprt status code.
|
|---|
| 57 | * @param pvUser User argument.
|
|---|
| 58 | * @param pvBuf Where to store the compressed data.
|
|---|
| 59 | * @param cbBuf Size of the buffer.
|
|---|
| 60 | * @param pcbBuf Number of bytes actually stored in the buffer.
|
|---|
| 61 | */
|
|---|
| 62 | typedef DECLCALLBACK(int) FNRTZIPIN(void *pvUser, void *pvBuf, size_t cbBuf, size_t *pcbBuf);
|
|---|
| 63 | /** Pointer to FNRTZIPIN() function. */
|
|---|
| 64 | typedef FNRTZIPIN *PFNRTZIPIN;
|
|---|
| 65 |
|
|---|
| 66 | /**
|
|---|
| 67 | * Compression type.
|
|---|
| 68 | * (Be careful with these they are stored in files!)
|
|---|
| 69 | */
|
|---|
| 70 | typedef enum RTZIPTYPE
|
|---|
| 71 | {
|
|---|
| 72 | /** Invalid. */
|
|---|
| 73 | RTZIPTYPE_INVALID = 0,
|
|---|
| 74 | /** Choose best fitting one. */
|
|---|
| 75 | RTZIPTYPE_AUTO,
|
|---|
| 76 | /** Store the data. */
|
|---|
| 77 | RTZIPTYPE_STORE,
|
|---|
| 78 | /** Zlib compression the data. */
|
|---|
| 79 | RTZIPTYPE_ZLIB,
|
|---|
| 80 | /** BZlib compress. */
|
|---|
| 81 | RTZIPTYPE_BZLIB,
|
|---|
| 82 | /** libLZF compress. */
|
|---|
| 83 | RTZIPTYPE_LZF,
|
|---|
| 84 | /** Lempel-Ziv-Jeff-Bonwick compression. */
|
|---|
| 85 | RTZIPTYPE_LZJB,
|
|---|
| 86 | /** Lempel-Ziv-Oberhumer compression. */
|
|---|
| 87 | RTZIPTYPE_LZO,
|
|---|
| 88 | /** End of valid the valid compression types. */
|
|---|
| 89 | RTZIPTYPE_END
|
|---|
| 90 | } RTZIPTYPE;
|
|---|
| 91 |
|
|---|
| 92 | /**
|
|---|
| 93 | * Compression level.
|
|---|
| 94 | */
|
|---|
| 95 | typedef enum RTZIPLEVEL
|
|---|
| 96 | {
|
|---|
| 97 | /** Store, don't compress. */
|
|---|
| 98 | RTZIPLEVEL_STORE = 0,
|
|---|
| 99 | /** Fast compression. */
|
|---|
| 100 | RTZIPLEVEL_FAST,
|
|---|
| 101 | /** Default compression. */
|
|---|
| 102 | RTZIPLEVEL_DEFAULT,
|
|---|
| 103 | /** Maximal compression. */
|
|---|
| 104 | RTZIPLEVEL_MAX
|
|---|
| 105 | } RTZIPLEVEL;
|
|---|
| 106 |
|
|---|
| 107 |
|
|---|
| 108 | /**
|
|---|
| 109 | * Create a stream compressor instance.
|
|---|
| 110 | *
|
|---|
| 111 | * @returns iprt status code.
|
|---|
| 112 | * @param ppZip Where to store the instance handle.
|
|---|
| 113 | * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
|
|---|
| 114 | * @param pfnOut Callback for consuming output of compression.
|
|---|
| 115 | * @param enmType Type of compressor to create.
|
|---|
| 116 | * @param enmLevel Compression level.
|
|---|
| 117 | */
|
|---|
| 118 | RTDECL(int) RTZipCompCreate(PRTZIPCOMP *ppZip, void *pvUser, PFNRTZIPOUT pfnOut, RTZIPTYPE enmType, RTZIPLEVEL enmLevel);
|
|---|
| 119 |
|
|---|
| 120 | /**
|
|---|
| 121 | * Compresses a chunk of memory.
|
|---|
| 122 | *
|
|---|
| 123 | * @returns iprt status code.
|
|---|
| 124 | * @param pZip The compressor instance.
|
|---|
| 125 | * @param pvBuf Pointer to buffer containing the bits to compress.
|
|---|
| 126 | * @param cbBuf Number of bytes to compress.
|
|---|
| 127 | */
|
|---|
| 128 | RTDECL(int) RTZipCompress(PRTZIPCOMP pZip, const void *pvBuf, size_t cbBuf);
|
|---|
| 129 |
|
|---|
| 130 | /**
|
|---|
| 131 | * Finishes the compression.
|
|---|
| 132 | * This will flush all data and terminate the compression data stream.
|
|---|
| 133 | *
|
|---|
| 134 | * @returns iprt status code.
|
|---|
| 135 | * @param pZip The stream compressor instance.
|
|---|
| 136 | */
|
|---|
| 137 | RTDECL(int) RTZipCompFinish(PRTZIPCOMP pZip);
|
|---|
| 138 |
|
|---|
| 139 | /**
|
|---|
| 140 | * Destroys the stream compressor instance.
|
|---|
| 141 | *
|
|---|
| 142 | * @returns iprt status code.
|
|---|
| 143 | * @param pZip The compressor instance.
|
|---|
| 144 | */
|
|---|
| 145 | RTDECL(int) RTZipCompDestroy(PRTZIPCOMP pZip);
|
|---|
| 146 |
|
|---|
| 147 |
|
|---|
| 148 | /**
|
|---|
| 149 | * Create a stream decompressor instance.
|
|---|
| 150 | *
|
|---|
| 151 | * @returns iprt status code.
|
|---|
| 152 | * @param ppZip Where to store the instance handle.
|
|---|
| 153 | * @param pvUser User argument which will be passed on to pfnOut and pfnIn.
|
|---|
| 154 | * @param pfnIn Callback for producing input for decompression.
|
|---|
| 155 | */
|
|---|
| 156 | RTDECL(int) RTZipDecompCreate(PRTZIPDECOMP *ppZip, void *pvUser, PFNRTZIPIN pfnIn);
|
|---|
| 157 |
|
|---|
| 158 | /**
|
|---|
| 159 | * Decompresses a chunk of memory.
|
|---|
| 160 | *
|
|---|
| 161 | * @returns iprt status code.
|
|---|
| 162 | * @param pZip The stream decompressor instance.
|
|---|
| 163 | * @param pvBuf Where to store the decompressed data.
|
|---|
| 164 | * @param cbBuf Number of bytes to produce. If pcbWritten is set
|
|---|
| 165 | * any number of bytes up to cbBuf might be returned.
|
|---|
| 166 | * @param pcbWritten Number of bytes actually written to the buffer. If NULL
|
|---|
| 167 | * cbBuf number of bytes must be written.
|
|---|
| 168 | */
|
|---|
| 169 | RTDECL(int) RTZipDecompress(PRTZIPDECOMP pZip, void *pvBuf, size_t cbBuf, size_t *pcbWritten);
|
|---|
| 170 |
|
|---|
| 171 | /**
|
|---|
| 172 | * Destroys the stream decompressor instance.
|
|---|
| 173 | *
|
|---|
| 174 | * @returns iprt status code.
|
|---|
| 175 | * @param pZip The decompressor instance.
|
|---|
| 176 | */
|
|---|
| 177 | RTDECL(int) RTZipDecompDestroy(PRTZIPDECOMP pZip);
|
|---|
| 178 |
|
|---|
| 179 |
|
|---|
| 180 | /**
|
|---|
| 181 | * Compress a chunk of memory into a block.
|
|---|
| 182 | *
|
|---|
| 183 | * @returns IPRT status code.
|
|---|
| 184 | *
|
|---|
| 185 | * @param enmType The compression type.
|
|---|
| 186 | * @param enmLevel The compression level.
|
|---|
| 187 | * @param fFlags Flags reserved for future extensions, MBZ.
|
|---|
| 188 | * @param pvSrc Pointer to the input block.
|
|---|
| 189 | * @param cbSrc Size of the input block.
|
|---|
| 190 | * @param pvDst Pointer to the output buffer.
|
|---|
| 191 | * @param cbDst The size of the output buffer.
|
|---|
| 192 | * @param pcbDstActual Where to return the compressed size.
|
|---|
| 193 | */
|
|---|
| 194 | RTDECL(int) RTZipBlockCompress(RTZIPTYPE enmType, RTZIPLEVEL enmLevel, uint32_t fFlags,
|
|---|
| 195 | void const *pvSrc, size_t cbSrc,
|
|---|
| 196 | void *pvDst, size_t cbDst, size_t *pcbDstActual) RT_NO_THROW;
|
|---|
| 197 |
|
|---|
| 198 |
|
|---|
| 199 | /**
|
|---|
| 200 | * Decompress a block.
|
|---|
| 201 | *
|
|---|
| 202 | * @returns IPRT status code.
|
|---|
| 203 | *
|
|---|
| 204 | * @param enmType The compression type.
|
|---|
| 205 | * @param fFlags Flags reserved for future extensions, MBZ.
|
|---|
| 206 | * @param pvSrc Pointer to the input block.
|
|---|
| 207 | * @param cbSrc Size of the input block.
|
|---|
| 208 | * @param pcbSrcActual Where to return the compressed size.
|
|---|
| 209 | * @param pvDst Pointer to the output buffer.
|
|---|
| 210 | * @param cbDst The size of the output buffer.
|
|---|
| 211 | * @param pcbDstActual Where to return the decompressed size.
|
|---|
| 212 | */
|
|---|
| 213 | RTDECL(int) RTZipBlockDecompress(RTZIPTYPE enmType, uint32_t fFlags,
|
|---|
| 214 | void const *pvSrc, size_t cbSrc, size_t *pcbSrcActual,
|
|---|
| 215 | void *pvDst, size_t cbDst, size_t *pcbDstActual) RT_NO_THROW;
|
|---|
| 216 |
|
|---|
| 217 |
|
|---|
| 218 | /**
|
|---|
| 219 | * Opens a gzip decompression I/O stream.
|
|---|
| 220 | *
|
|---|
| 221 | * @returns IPRT status code.
|
|---|
| 222 | *
|
|---|
| 223 | * @param hVfsIosIn The compressed input stream (must be readable).
|
|---|
| 224 | * The reference is not consumed, instead another
|
|---|
| 225 | * one is retained.
|
|---|
| 226 | * @param fFlags Flags, MBZ.
|
|---|
| 227 | * @param phVfsIosGunzip Where to return the handle to the gunzipped I/O
|
|---|
| 228 | * stream (read).
|
|---|
| 229 | */
|
|---|
| 230 | RTDECL(int) RTZipGzipDecompressIoStream(RTVFSIOSTREAM hVfsIosIn, uint32_t fFlags, PRTVFSIOSTREAM phVfsIosGunzip);
|
|---|
| 231 |
|
|---|
| 232 | /**
|
|---|
| 233 | * Opens a gzip decompression I/O stream.
|
|---|
| 234 | *
|
|---|
| 235 | * @returns IPRT status code.
|
|---|
| 236 | *
|
|---|
| 237 | * @param hVfsIosDst The compressed output stream (must be writable).
|
|---|
| 238 | * The reference is not consumed, instead another
|
|---|
| 239 | * one is retained.
|
|---|
| 240 | * @param fFlags Flags, MBZ.
|
|---|
| 241 | * @param uLevel The gzip compression level, 1 thru 9.
|
|---|
| 242 | * @param phVfsIosGzip Where to return the gzip input I/O stream handle
|
|---|
| 243 | * (you write to this).
|
|---|
| 244 | */
|
|---|
| 245 | RTDECL(int) RTZipGzipCompressIoStream(RTVFSIOSTREAM hVfsIosDst, uint32_t fFlags, uint8_t uLevel, PRTVFSIOSTREAM phVfsIosGzip);
|
|---|
| 246 |
|
|---|
| 247 | /**
|
|---|
| 248 | * Opens a TAR filesystem stream.
|
|---|
| 249 | *
|
|---|
| 250 | * This is used to extract, list or check a TAR archive.
|
|---|
| 251 | *
|
|---|
| 252 | * @returns IPRT status code.
|
|---|
| 253 | *
|
|---|
| 254 | * @param hVfsIosIn The compressed input stream. The reference is
|
|---|
| 255 | * not consumed, instead another one is retained.
|
|---|
| 256 | * @param fFlags Flags, MBZ.
|
|---|
| 257 | * @param phVfsFss Where to return the handle to the TAR
|
|---|
| 258 | * filesystem stream.
|
|---|
| 259 | */
|
|---|
| 260 | RTDECL(int) RTZipTarFsStreamFromIoStream(RTVFSIOSTREAM hVfsIosIn, uint32_t fFlags, PRTVFSFSSTREAM phVfsFss);
|
|---|
| 261 |
|
|---|
| 262 | /**
|
|---|
| 263 | * A mini TAR program.
|
|---|
| 264 | *
|
|---|
| 265 | * @returns Program exit code.
|
|---|
| 266 | *
|
|---|
| 267 | * @param cArgs The number of arguments.
|
|---|
| 268 | * @param papszArgs The argument vector. (Note that this may be
|
|---|
| 269 | * reordered, so the memory must be writable.)
|
|---|
| 270 | */
|
|---|
| 271 | RTDECL(RTEXITCODE) RTZipTarCmd(unsigned cArgs, char **papszArgs);
|
|---|
| 272 |
|
|---|
| 273 | /** @} */
|
|---|
| 274 |
|
|---|
| 275 | RT_C_DECLS_END
|
|---|
| 276 |
|
|---|
| 277 | #endif
|
|---|
| 278 |
|
|---|
