1 /* miniz.c v1.16 beta r1 - public domain deflate/inflate, zlib-subset, ZIP reading/writing/appending, PNG writing 2 See "unlicense" statement at the end of this file. 3 Rich Geldreich <richgel99@gmail.com>, last updated Oct. 13, 2013 4 Implements RFC 1950: http://www.ietf.org/rfc/rfc1950.txt and RFC 1951: http://www.ietf.org/rfc/rfc1951.txt 5 6 Most API's defined in miniz.c are optional. For example, to disable the archive related functions just define 7 MINIZ_NO_ARCHIVE_APIS, or to get rid of all stdio usage define MINIZ_NO_STDIO (see the list below for more macros). 8 9 * Low-level Deflate/Inflate implementation notes: 10 11 Compression: Use the "tdefl" API's. The compressor supports raw, static, and dynamic blocks, lazy or 12 greedy parsing, match length filtering, RLE-only, and Huffman-only streams. It performs and compresses 13 approximately as well as zlib. 14 15 Decompression: Use the "tinfl" API's. The entire decompressor is implemented as a single function 16 coroutine: see tinfl_decompress(). It supports decompression into a 32KB (or larger power of 2) wrapping buffer, or into a memory 17 block large enough to hold the entire file. 18 19 The low-level tdefl/tinfl API's do not make any use of dynamic memory allocation. 20 21 * zlib-style API notes: 22 23 miniz.c implements a fairly large subset of zlib. There's enough functionality present for it to be a drop-in 24 zlib replacement in many apps: 25 The z_stream struct, optional memory allocation callbacks 26 deflateInit/deflateInit2/deflate/deflateReset/deflateEnd/deflateBound 27 inflateInit/inflateInit2/inflate/inflateEnd 28 compress, compress2, compressBound, uncompress 29 CRC-32, Adler-32 - Using modern, minimal code size, CPU cache friendly routines. 30 Supports raw deflate streams or standard zlib streams with adler-32 checking. 31 32 Limitations: 33 The callback API's are not implemented yet. No support for gzip headers or zlib static dictionaries. 34 I've tried to closely emulate zlib's various flavors of stream flushing and return status codes, but 35 there are no guarantees that miniz.c pulls this off perfectly. 36 37 * PNG writing: See the tdefl_write_image_to_png_file_in_memory() function, originally written by 38 Alex Evans. Supports 1-4 bytes/pixel images. 39 40 * ZIP archive API notes: 41 42 The ZIP archive API's where designed with simplicity and efficiency in mind, with just enough abstraction to 43 get the job done with minimal fuss. There are simple API's to retrieve file information, read files from 44 existing archives, create new archives, append new files to existing archives, or clone archive data from 45 one archive to another. It supports archives located in memory or the heap, on disk (using stdio.h), 46 or you can specify custom file read/write callbacks. 47 48 - Archive reading: Just call this function to read a single file from a disk archive: 49 50 void *mz_zip_extract_archive_file_to_heap(const char *pZip_filename, const char *pArchive_name, 51 size_t *pSize, mz_uint zip_flags); 52 53 For more complex cases, use the "mz_zip_reader" functions. Upon opening an archive, the entire central 54 directory is located and read as-is into memory, and subsequent file access only occurs when reading individual files. 55 56 - Archives file scanning: The simple way is to use this function to scan a loaded archive for a specific file: 57 58 int mz_zip_reader_locate_file(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags); 59 60 The locate operation can optionally check file comments too, which (as one example) can be used to identify 61 multiple versions of the same file in an archive. This function uses a simple linear search through the central 62 directory, so it's not very fast. 63 64 Alternately, you can iterate through all the files in an archive (using mz_zip_reader_get_num_files()) and 65 retrieve detailed info on each file by calling mz_zip_reader_file_stat(). 66 67 - Archive creation: Use the "mz_zip_writer" functions. The ZIP writer immediately writes compressed file data 68 to disk and builds an exact image of the central directory in memory. The central directory image is written 69 all at once at the end of the archive file when the archive is finalized. 70 71 The archive writer can optionally align each file's local header and file data to any power of 2 alignment, 72 which can be useful when the archive will be read from optical media. Also, the writer supports placing 73 arbitrary data blobs at the very beginning of ZIP archives. Archives written using either feature are still 74 readable by any ZIP tool. 75 76 - Archive appending: The simple way to add a single file to an archive is to call this function: 77 78 mz_bool mz_zip_add_mem_to_archive_file_in_place(const char *pZip_filename, const char *pArchive_name, 79 const void *pBuf, size_t buf_size, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags); 80 81 The archive will be created if it doesn't already exist, otherwise it'll be appended to. 82 Note the appending is done in-place and is not an atomic operation, so if something goes wrong 83 during the operation it's possible the archive could be left without a central directory (although the local 84 file headers and file data will be fine, so the archive will be recoverable). 85 86 For more complex archive modification scenarios: 87 1. The safest way is to use a mz_zip_reader to read the existing archive, cloning only those bits you want to 88 preserve into a new archive using using the mz_zip_writer_add_from_zip_reader() function (which compiles the 89 compressed file data as-is). When you're done, delete the old archive and rename the newly written archive, and 90 you're done. This is safe but requires a bunch of temporary disk space or heap memory. 91 92 2. Or, you can convert an mz_zip_reader in-place to an mz_zip_writer using mz_zip_writer_init_from_reader(), 93 append new files as needed, then finalize the archive which will write an updated central directory to the 94 original archive. (This is basically what mz_zip_add_mem_to_archive_file_in_place() does.) There's a 95 possibility that the archive's central directory could be lost with this method if anything goes wrong, though. 96 97 - ZIP archive support limitations: 98 No zip64 or spanning support. Extraction functions can only handle unencrypted, stored or deflated files. 99 Requires streams capable of seeking. 100 101 * This is a header file library, like stb_image.c. To get only a header file, either cut and paste the 102 below header, or create miniz.h, #define MINIZ_HEADER_FILE_ONLY, and then include miniz.c from it. 103 104 * Important: For best perf. be sure to customize the below macros for your target platform: 105 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 1 106 #define MINIZ_LITTLE_ENDIAN 1 107 #define MINIZ_HAS_64BIT_REGISTERS 1 108 109 * On platforms using glibc, Be sure to "#define _LARGEFILE64_SOURCE 1" before including miniz.c to ensure miniz 110 uses the 64-bit variants: fopen64(), stat64(), etc. Otherwise you won't be able to process large files 111 (i.e. 32-bit stat() fails for me on files > 0x7FFFFFFF bytes). 112 */ 113 #pragma once 114 115 116 117 118 119 /* Defines to completely disable specific portions of miniz.c: 120 If all macros here are defined the only functionality remaining will be CRC-32, adler-32, tinfl, and tdefl. */ 121 122 /* Define MINIZ_NO_STDIO to disable all usage and any functions which rely on stdio for file I/O. */ 123 /*#define MINIZ_NO_STDIO */ 124 125 /* If MINIZ_NO_TIME is specified then the ZIP archive functions will not be able to get the current time, or */ 126 /* get/set file times, and the C run-time funcs that get/set times won't be called. */ 127 /* The current downside is the times written to your archives will be from 1979. */ 128 /*#define MINIZ_NO_TIME */ 129 130 /* Define MINIZ_NO_ARCHIVE_APIS to disable all ZIP archive API's. */ 131 /*#define MINIZ_NO_ARCHIVE_APIS */ 132 133 /* Define MINIZ_NO_ARCHIVE_WRITING_APIS to disable all writing related ZIP archive API's. */ 134 /*#define MINIZ_NO_ARCHIVE_WRITING_APIS */ 135 136 /* Define MINIZ_NO_ZLIB_APIS to remove all ZLIB-style compression/decompression API's. */ 137 /*#define MINIZ_NO_ZLIB_APIS */ 138 139 /* Define MINIZ_NO_ZLIB_COMPATIBLE_NAME to disable zlib names, to prevent conflicts against stock zlib. */ 140 /*#define MINIZ_NO_ZLIB_COMPATIBLE_NAMES */ 141 142 /* Define MINIZ_NO_MALLOC to disable all calls to malloc, free, and realloc. 143 Note if MINIZ_NO_MALLOC is defined then the user must always provide custom user alloc/free/realloc 144 callbacks to the zlib and archive API's, and a few stand-alone helper API's which don't provide custom user 145 functions (such as tdefl_compress_mem_to_heap() and tinfl_decompress_mem_to_heap()) won't work. */ 146 /*#define MINIZ_NO_MALLOC */ 147 148 #if defined(__TINYC__) && (defined(__linux) || defined(__linux__)) 149 /* TODO: Work around "error: include file 'sys\utime.h' when compiling with tcc on Linux */ 150 #define MINIZ_NO_TIME 151 #endif 152 153 #include <stddef.h> 154 155 #if !defined(MINIZ_NO_TIME) && !defined(MINIZ_NO_ARCHIVE_APIS) 156 #include <time.h> 157 #endif 158 159 #if defined(_M_IX86) || defined(_M_X64) || defined(__i386__) || defined(__i386) || defined(__i486__) || defined(__i486) || defined(i386) || defined(__ia64__) || defined(__x86_64__) 160 /* MINIZ_X86_OR_X64_CPU is only used to help set the below macros. */ 161 #define MINIZ_X86_OR_X64_CPU 1 162 #endif 163 164 #if (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__) || MINIZ_X86_OR_X64_CPU 165 /* Set MINIZ_LITTLE_ENDIAN to 1 if the processor is little endian. */ 166 #define MINIZ_LITTLE_ENDIAN 1 167 #endif 168 169 #if MINIZ_X86_OR_X64_CPU 170 /* Set MINIZ_USE_UNALIGNED_LOADS_AND_STORES to 1 on CPU's that permit efficient integer loads and stores from unaligned addresses. */ 171 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 1 172 #endif 173 174 #if defined(_M_X64) || defined(_WIN64) || defined(__MINGW64__) || defined(_LP64) || defined(__LP64__) || defined(__ia64__) || defined(__x86_64__) 175 /* Set MINIZ_HAS_64BIT_REGISTERS to 1 if operations on 64-bit integers are reasonably fast (and don't involve compiler generated calls to helper functions). */ 176 #define MINIZ_HAS_64BIT_REGISTERS 1 177 #endif 178 179 #ifdef __cplusplus 180 extern "C" { 181 #endif 182 183 /* ------------------- zlib-style API Definitions. */ 184 185 /* For more compatibility with zlib, miniz.c uses unsigned long for some parameters/struct members. Beware: mz_ulong can be either 32 or 64-bits! */ 186 typedef unsigned long mz_ulong; 187 188 /* mz_free() internally uses the MZ_FREE() macro (which by default calls free() unless you've modified the MZ_MALLOC macro) to release a block allocated from the heap. */ 189 void mz_free(void *p); 190 191 #define MZ_ADLER32_INIT (1) 192 /* mz_adler32() returns the initial adler-32 value to use when called with ptr==NULL. */ 193 mz_ulong mz_adler32(mz_ulong adler, const unsigned char *ptr, size_t buf_len); 194 195 #define MZ_CRC32_INIT (0) 196 /* mz_crc32() returns the initial CRC-32 value to use when called with ptr==NULL. */ 197 mz_ulong mz_crc32(mz_ulong crc, const unsigned char *ptr, size_t buf_len); 198 199 /* Compression strategies. */ 200 enum 201 { 202 MZ_DEFAULT_STRATEGY = 0, 203 MZ_FILTERED = 1, 204 MZ_HUFFMAN_ONLY = 2, 205 MZ_RLE = 3, 206 MZ_FIXED = 4 207 }; 208 209 /* Method */ 210 #define MZ_DEFLATED 8 211 212 /* Heap allocation callbacks. 213 Note that mz_alloc_func parameter types purpsosely differ from zlib's: items/size is size_t, not unsigned long. */ 214 typedef void *(*mz_alloc_func)(void *opaque, size_t items, size_t size); 215 typedef void(*mz_free_func)(void *opaque, void *address); 216 typedef void *(*mz_realloc_func)(void *opaque, void *address, size_t items, size_t size); 217 218 /* Compression levels: 0-9 are the standard zlib-style levels, 10 is best possible compression (not zlib compatible, and may be very slow), MZ_DEFAULT_COMPRESSION=MZ_DEFAULT_LEVEL. */ 219 enum 220 { 221 MZ_NO_COMPRESSION = 0, 222 MZ_BEST_SPEED = 1, 223 MZ_BEST_COMPRESSION = 9, 224 MZ_UBER_COMPRESSION = 10, 225 MZ_DEFAULT_LEVEL = 6, 226 MZ_DEFAULT_COMPRESSION = -1 227 }; 228 229 #define MZ_VERSION "10.0.0" 230 #define MZ_VERNUM 0xA000 231 #define MZ_VER_MAJOR 10 232 #define MZ_VER_MINOR 0 233 #define MZ_VER_REVISION 0 234 #define MZ_VER_SUBREVISION 0 235 236 #ifndef MINIZ_NO_ZLIB_APIS 237 238 /* Flush values. For typical usage you only need MZ_NO_FLUSH and MZ_FINISH. The other values are for advanced use (refer to the zlib docs). */ 239 enum 240 { 241 MZ_NO_FLUSH = 0, 242 MZ_PARTIAL_FLUSH = 1, 243 MZ_SYNC_FLUSH = 2, 244 MZ_FULL_FLUSH = 3, 245 MZ_FINISH = 4, 246 MZ_BLOCK = 5 247 }; 248 249 /* Return status codes. MZ_PARAM_ERROR is non-standard. */ 250 enum 251 { 252 MZ_OK = 0, 253 MZ_STREAM_END = 1, 254 MZ_NEED_DICT = 2, 255 MZ_ERRNO = -1, 256 MZ_STREAM_ERROR = -2, 257 MZ_DATA_ERROR = -3, 258 MZ_MEM_ERROR = -4, 259 MZ_BUF_ERROR = -5, 260 MZ_VERSION_ERROR = -6, 261 MZ_PARAM_ERROR = -10000 262 }; 263 264 /* Window bits */ 265 #define MZ_DEFAULT_WINDOW_BITS 15 266 267 struct mz_internal_state; 268 269 /* Compression/decompression stream struct. */ 270 typedef struct mz_stream_s 271 { 272 const unsigned char *next_in; /* pointer to next byte to read */ 273 unsigned int avail_in; /* number of bytes available at next_in */ 274 mz_ulong total_in; /* total number of bytes consumed so far */ 275 276 unsigned char *next_out; /* pointer to next byte to write */ 277 unsigned int avail_out; /* number of bytes that can be written to next_out */ 278 mz_ulong total_out; /* total number of bytes produced so far */ 279 280 char *msg; /* error msg (unused) */ 281 struct mz_internal_state *state; /* internal state, allocated by zalloc/zfree */ 282 283 mz_alloc_func zalloc; /* optional heap allocation function (defaults to malloc) */ 284 mz_free_func zfree; /* optional heap free function (defaults to free) */ 285 void *opaque; /* heap alloc function user pointer */ 286 287 int data_type; /* data_type (unused) */ 288 mz_ulong adler; /* adler32 of the source or uncompressed data */ 289 mz_ulong reserved; /* not used */ 290 } mz_stream; 291 292 typedef mz_stream *mz_streamp; 293 294 /* Returns the version string of miniz.c. */ 295 const char *mz_version(void); 296 297 /* mz_deflateInit() initializes a compressor with default options: */ 298 /* Parameters: */ 299 /* pStream must point to an initialized mz_stream struct. */ 300 /* level must be between [MZ_NO_COMPRESSION, MZ_BEST_COMPRESSION]. */ 301 /* level 1 enables a specially optimized compression function that's been optimized purely for performance, not ratio. */ 302 /* (This special func. is currently only enabled when MINIZ_USE_UNALIGNED_LOADS_AND_STORES and MINIZ_LITTLE_ENDIAN are defined.) */ 303 /* Return values: */ 304 /* MZ_OK on success. */ 305 /* MZ_STREAM_ERROR if the stream is bogus. */ 306 /* MZ_PARAM_ERROR if the input parameters are bogus. */ 307 /* MZ_MEM_ERROR on out of memory. */ 308 int mz_deflateInit(mz_streamp pStream, int level); 309 310 /* mz_deflateInit2() is like mz_deflate(), except with more control: */ 311 /* Additional parameters: */ 312 /* method must be MZ_DEFLATED */ 313 /* window_bits must be MZ_DEFAULT_WINDOW_BITS (to wrap the deflate stream with zlib header/adler-32 footer) or -MZ_DEFAULT_WINDOW_BITS (raw deflate/no header or footer) */ 314 /* mem_level must be between [1, 9] (it's checked but ignored by miniz.c) */ 315 int mz_deflateInit2(mz_streamp pStream, int level, int method, int window_bits, int mem_level, int strategy); 316 317 /* Quickly resets a compressor without having to reallocate anything. Same as calling mz_deflateEnd() followed by mz_deflateInit()/mz_deflateInit2(). */ 318 int mz_deflateReset(mz_streamp pStream); 319 320 /* mz_deflate() compresses the input to output, consuming as much of the input and producing as much output as possible. */ 321 /* Parameters: */ 322 /* pStream is the stream to read from and write to. You must initialize/update the next_in, avail_in, next_out, and avail_out members. */ 323 /* flush may be MZ_NO_FLUSH, MZ_PARTIAL_FLUSH/MZ_SYNC_FLUSH, MZ_FULL_FLUSH, or MZ_FINISH. */ 324 /* Return values: */ 325 /* MZ_OK on success (when flushing, or if more input is needed but not available, and/or there's more output to be written but the output buffer is full). */ 326 /* MZ_STREAM_END if all input has been consumed and all output bytes have been written. Don't call mz_deflate() on the stream anymore. */ 327 /* MZ_STREAM_ERROR if the stream is bogus. */ 328 /* MZ_PARAM_ERROR if one of the parameters is invalid. */ 329 /* MZ_BUF_ERROR if no forward progress is possible because the input and/or output buffers are empty. (Fill up the input buffer or free up some output space and try again.) */ 330 int mz_deflate(mz_streamp pStream, int flush); 331 332 /* mz_deflateEnd() deinitializes a compressor: */ 333 /* Return values: */ 334 /* MZ_OK on success. */ 335 /* MZ_STREAM_ERROR if the stream is bogus. */ 336 int mz_deflateEnd(mz_streamp pStream); 337 338 /* mz_deflateBound() returns a (very) conservative upper bound on the amount of data that could be generated by deflate(), assuming flush is set to only MZ_NO_FLUSH or MZ_FINISH. */ 339 mz_ulong mz_deflateBound(mz_streamp pStream, mz_ulong source_len); 340 341 /* Single-call compression functions mz_compress() and mz_compress2(): */ 342 /* Returns MZ_OK on success, or one of the error codes from mz_deflate() on failure. */ 343 int mz_compress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len); 344 int mz_compress2(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len, int level); 345 346 /* mz_compressBound() returns a (very) conservative upper bound on the amount of data that could be generated by calling mz_compress(). */ 347 mz_ulong mz_compressBound(mz_ulong source_len); 348 349 /* Initializes a decompressor. */ 350 int mz_inflateInit(mz_streamp pStream); 351 352 /* mz_inflateInit2() is like mz_inflateInit() with an additional option that controls the window size and whether or not the stream has been wrapped with a zlib header/footer: */ 353 /* window_bits must be MZ_DEFAULT_WINDOW_BITS (to parse zlib header/footer) or -MZ_DEFAULT_WINDOW_BITS (raw deflate). */ 354 int mz_inflateInit2(mz_streamp pStream, int window_bits); 355 356 /* Decompresses the input stream to the output, consuming only as much of the input as needed, and writing as much to the output as possible. */ 357 /* Parameters: */ 358 /* pStream is the stream to read from and write to. You must initialize/update the next_in, avail_in, next_out, and avail_out members. */ 359 /* flush may be MZ_NO_FLUSH, MZ_SYNC_FLUSH, or MZ_FINISH. */ 360 /* On the first call, if flush is MZ_FINISH it's assumed the input and output buffers are both sized large enough to decompress the entire stream in a single call (this is slightly faster). */ 361 /* MZ_FINISH implies that there are no more source bytes available beside what's already in the input buffer, and that the output buffer is large enough to hold the rest of the decompressed data. */ 362 /* Return values: */ 363 /* MZ_OK on success. Either more input is needed but not available, and/or there's more output to be written but the output buffer is full. */ 364 /* MZ_STREAM_END if all needed input has been consumed and all output bytes have been written. For zlib streams, the adler-32 of the decompressed data has also been verified. */ 365 /* MZ_STREAM_ERROR if the stream is bogus. */ 366 /* MZ_DATA_ERROR if the deflate stream is invalid. */ 367 /* MZ_PARAM_ERROR if one of the parameters is invalid. */ 368 /* MZ_BUF_ERROR if no forward progress is possible because the input buffer is empty but the inflater needs more input to continue, or if the output buffer is not large enough. Call mz_inflate() again */ 369 /* with more input data, or with more room in the output buffer (except when using single call decompression, described above). */ 370 int mz_inflate(mz_streamp pStream, int flush); 371 372 /* Deinitializes a decompressor. */ 373 int mz_inflateEnd(mz_streamp pStream); 374 375 /* Single-call decompression. */ 376 /* Returns MZ_OK on success, or one of the error codes from mz_inflate() on failure. */ 377 int mz_uncompress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len); 378 379 /* Returns a string description of the specified error code, or NULL if the error code is invalid. */ 380 const char *mz_error(int err); 381 382 /* Redefine zlib-compatible names to miniz equivalents, so miniz.c can be used as a drop-in replacement for the subset of zlib that miniz.c supports. */ 383 /* Define MINIZ_NO_ZLIB_COMPATIBLE_NAMES to disable zlib-compatibility if you use zlib in the same project. */ 384 #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES 385 typedef unsigned char Byte; 386 typedef unsigned int uInt; 387 typedef mz_ulong uLong; 388 typedef Byte Bytef; 389 typedef uInt uIntf; 390 typedef char charf; 391 typedef int intf; 392 typedef void *voidpf; 393 typedef uLong uLongf; 394 typedef void *voidp; 395 typedef void *const voidpc; 396 #define Z_NULL 0 397 #define Z_NO_FLUSH MZ_NO_FLUSH 398 #define Z_PARTIAL_FLUSH MZ_PARTIAL_FLUSH 399 #define Z_SYNC_FLUSH MZ_SYNC_FLUSH 400 #define Z_FULL_FLUSH MZ_FULL_FLUSH 401 #define Z_FINISH MZ_FINISH 402 #define Z_BLOCK MZ_BLOCK 403 #define Z_OK MZ_OK 404 #define Z_STREAM_END MZ_STREAM_END 405 #define Z_NEED_DICT MZ_NEED_DICT 406 #define Z_ERRNO MZ_ERRNO 407 #define Z_STREAM_ERROR MZ_STREAM_ERROR 408 #define Z_DATA_ERROR MZ_DATA_ERROR 409 #define Z_MEM_ERROR MZ_MEM_ERROR 410 #define Z_BUF_ERROR MZ_BUF_ERROR 411 #define Z_VERSION_ERROR MZ_VERSION_ERROR 412 #define Z_PARAM_ERROR MZ_PARAM_ERROR 413 #define Z_NO_COMPRESSION MZ_NO_COMPRESSION 414 #define Z_BEST_SPEED MZ_BEST_SPEED 415 #define Z_BEST_COMPRESSION MZ_BEST_COMPRESSION 416 #define Z_DEFAULT_COMPRESSION MZ_DEFAULT_COMPRESSION 417 #define Z_DEFAULT_STRATEGY MZ_DEFAULT_STRATEGY 418 #define Z_FILTERED MZ_FILTERED 419 #define Z_HUFFMAN_ONLY MZ_HUFFMAN_ONLY 420 #define Z_RLE MZ_RLE 421 #define Z_FIXED MZ_FIXED 422 #define Z_DEFLATED MZ_DEFLATED 423 #define Z_DEFAULT_WINDOW_BITS MZ_DEFAULT_WINDOW_BITS 424 #define alloc_func mz_alloc_func 425 #define free_func mz_free_func 426 #define internal_state mz_internal_state 427 #define z_stream mz_stream 428 #define deflateInit mz_deflateInit 429 #define deflateInit2 mz_deflateInit2 430 #define deflateReset mz_deflateReset 431 #define deflate mz_deflate 432 #define deflateEnd mz_deflateEnd 433 #define deflateBound mz_deflateBound 434 #define compress mz_compress 435 #define compress2 mz_compress2 436 #define compressBound mz_compressBound 437 #define inflateInit mz_inflateInit 438 #define inflateInit2 mz_inflateInit2 439 #define inflate mz_inflate 440 #define inflateEnd mz_inflateEnd 441 #define uncompress mz_uncompress 442 #define crc32 mz_crc32 443 #define adler32 mz_adler32 444 #define MAX_WBITS 15 445 #define MAX_MEM_LEVEL 9 446 #define zError mz_error 447 #define ZLIB_VERSION MZ_VERSION 448 #define ZLIB_VERNUM MZ_VERNUM 449 #define ZLIB_VER_MAJOR MZ_VER_MAJOR 450 #define ZLIB_VER_MINOR MZ_VER_MINOR 451 #define ZLIB_VER_REVISION MZ_VER_REVISION 452 #define ZLIB_VER_SUBREVISION MZ_VER_SUBREVISION 453 #define zlibVersion mz_version 454 #define zlib_version mz_version() 455 #endif /* #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES */ 456 457 #endif /* MINIZ_NO_ZLIB_APIS */ 458 459 #ifdef __cplusplus 460 } 461 #endif 462 #pragma once 463 #include <assert.h> 464 #include <stdlib.h> 465 #include <string.h> 466 #include <stdint.h> 467 468 /* ------------------- Types and macros */ 469 typedef unsigned char mz_uint8; 470 typedef signed short mz_int16; 471 typedef unsigned short mz_uint16; 472 typedef unsigned int mz_uint32; 473 typedef unsigned int mz_uint; 474 typedef int64_t mz_int64; 475 typedef uint64_t mz_uint64; 476 typedef int mz_bool; 477 478 #define MZ_FALSE (0) 479 #define MZ_TRUE (1) 480 481 /* Works around MSVC's spammy "warning C4127: conditional expression is constant" message. */ 482 #ifdef _MSC_VER 483 #define MZ_MACRO_END while (0, 0) 484 #else 485 #define MZ_MACRO_END while (0) 486 #endif 487 488 #ifdef MINIZ_NO_STDIO 489 #define MZ_FILE void * 490 #else 491 #include <stdio.h> 492 #define MZ_FILE FILE 493 #endif /* #ifdef MINIZ_NO_STDIO */ 494 495 #ifdef MINIZ_NO_TIME 496 typedef struct mz_dummy_time_t_tag 497 { 498 int m_dummy; 499 } mz_dummy_time_t; 500 #define MZ_TIME_T mz_dummy_time_t 501 #else 502 #define MZ_TIME_T time_t 503 #endif 504 505 #define MZ_ASSERT(x) assert(x) 506 507 #ifdef MINIZ_NO_MALLOC 508 #define MZ_MALLOC(x) NULL 509 #define MZ_FREE(x) (void) x, ((void)0) 510 #define MZ_REALLOC(p, x) NULL 511 #else 512 #define MZ_MALLOC(x) malloc(x) 513 #define MZ_FREE(x) free(x) 514 #define MZ_REALLOC(p, x) realloc(p, x) 515 #endif 516 517 #define MZ_MAX(a, b) (((a) > (b)) ? (a) : (b)) 518 #define MZ_MIN(a, b) (((a) < (b)) ? (a) : (b)) 519 #define MZ_CLEAR_OBJ(obj) memset(&(obj), 0, sizeof(obj)) 520 521 #if MINIZ_USE_UNALIGNED_LOADS_AND_STORES &&MINIZ_LITTLE_ENDIAN 522 #define MZ_READ_LE16(p) *((const mz_uint16 *)(p)) 523 #define MZ_READ_LE32(p) *((const mz_uint32 *)(p)) 524 #else 525 #define MZ_READ_LE16(p) ((mz_uint32)(((const mz_uint8 *)(p))[0]) | ((mz_uint32)(((const mz_uint8 *)(p))[1]) << 8U)) 526 #define MZ_READ_LE32(p) ((mz_uint32)(((const mz_uint8 *)(p))[0]) | ((mz_uint32)(((const mz_uint8 *)(p))[1]) << 8U) | ((mz_uint32)(((const mz_uint8 *)(p))[2]) << 16U) | ((mz_uint32)(((const mz_uint8 *)(p))[3]) << 24U)) 527 #endif 528 529 #define MZ_READ_LE64(p) (((mz_uint64)MZ_READ_LE32(p)) | (((mz_uint64)MZ_READ_LE32((const mz_uint8 *)(p) + sizeof(mz_uint32))) << 32U)) 530 531 #ifdef _MSC_VER 532 #define MZ_FORCEINLINE __forceinline 533 #elif defined(__GNUC__) 534 #define MZ_FORCEINLINE __inline__ __attribute__((__always_inline__)) 535 #else 536 #define MZ_FORCEINLINE inline 537 #endif 538 539 #ifdef __cplusplus 540 extern "C" { 541 #endif 542 543 extern void *miniz_def_alloc_func(void *opaque, size_t items, size_t size); 544 extern void miniz_def_free_func(void *opaque, void *address); 545 extern void *miniz_def_realloc_func(void *opaque, void *address, size_t items, size_t size); 546 547 #define MZ_UINT16_MAX (0xFFFFU) 548 #define MZ_UINT32_MAX (0xFFFFFFFFU) 549 550 #ifdef __cplusplus 551 } 552 #endif 553 #pragma once 554 555 556 #ifdef __cplusplus 557 extern "C" { 558 #endif 559 /* ------------------- Low-level Compression API Definitions */ 560 561 /* Set TDEFL_LESS_MEMORY to 1 to use less memory (compression will be slightly slower, and raw/dynamic blocks will be output more frequently). */ 562 #define TDEFL_LESS_MEMORY 0 563 564 /* tdefl_init() compression flags logically OR'd together (low 12 bits contain the max. number of probes per dictionary search): */ 565 /* TDEFL_DEFAULT_MAX_PROBES: The compressor defaults to 128 dictionary probes per dictionary search. 0=Huffman only, 1=Huffman+LZ (fastest/crap compression), 4095=Huffman+LZ (slowest/best compression). */ 566 enum 567 { 568 TDEFL_HUFFMAN_ONLY = 0, 569 TDEFL_DEFAULT_MAX_PROBES = 128, 570 TDEFL_MAX_PROBES_MASK = 0xFFF 571 }; 572 573 /* TDEFL_WRITE_ZLIB_HEADER: If set, the compressor outputs a zlib header before the deflate data, and the Adler-32 of the source data at the end. Otherwise, you'll get raw deflate data. */ 574 /* TDEFL_COMPUTE_ADLER32: Always compute the adler-32 of the input data (even when not writing zlib headers). */ 575 /* TDEFL_GREEDY_PARSING_FLAG: Set to use faster greedy parsing, instead of more efficient lazy parsing. */ 576 /* TDEFL_NONDETERMINISTIC_PARSING_FLAG: Enable to decrease the compressor's initialization time to the minimum, but the output may vary from run to run given the same input (depending on the contents of memory). */ 577 /* TDEFL_RLE_MATCHES: Only look for RLE matches (matches with a distance of 1) */ 578 /* TDEFL_FILTER_MATCHES: Discards matches <= 5 chars if enabled. */ 579 /* TDEFL_FORCE_ALL_STATIC_BLOCKS: Disable usage of optimized Huffman tables. */ 580 /* TDEFL_FORCE_ALL_RAW_BLOCKS: Only use raw (uncompressed) deflate blocks. */ 581 /* The low 12 bits are reserved to control the max # of hash probes per dictionary lookup (see TDEFL_MAX_PROBES_MASK). */ 582 enum 583 { 584 TDEFL_WRITE_ZLIB_HEADER = 0x01000, 585 TDEFL_COMPUTE_ADLER32 = 0x02000, 586 TDEFL_GREEDY_PARSING_FLAG = 0x04000, 587 TDEFL_NONDETERMINISTIC_PARSING_FLAG = 0x08000, 588 TDEFL_RLE_MATCHES = 0x10000, 589 TDEFL_FILTER_MATCHES = 0x20000, 590 TDEFL_FORCE_ALL_STATIC_BLOCKS = 0x40000, 591 TDEFL_FORCE_ALL_RAW_BLOCKS = 0x80000 592 }; 593 594 /* High level compression functions: */ 595 /* tdefl_compress_mem_to_heap() compresses a block in memory to a heap block allocated via malloc(). */ 596 /* On entry: */ 597 /* pSrc_buf, src_buf_len: Pointer and size of source block to compress. */ 598 /* flags: The max match finder probes (default is 128) logically OR'd against the above flags. Higher probes are slower but improve compression. */ 599 /* On return: */ 600 /* Function returns a pointer to the compressed data, or NULL on failure. */ 601 /* *pOut_len will be set to the compressed data's size, which could be larger than src_buf_len on uncompressible data. */ 602 /* The caller must free() the returned block when it's no longer needed. */ 603 void *tdefl_compress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); 604 605 /* tdefl_compress_mem_to_mem() compresses a block in memory to another block in memory. */ 606 /* Returns 0 on failure. */ 607 size_t tdefl_compress_mem_to_mem(void *pOut_buf, size_t out_buf_len, const void *pSrc_buf, size_t src_buf_len, int flags); 608 609 /* Compresses an image to a compressed PNG file in memory. */ 610 /* On entry: */ 611 /* pImage, w, h, and num_chans describe the image to compress. num_chans may be 1, 2, 3, or 4. */ 612 /* The image pitch in bytes per scanline will be w*num_chans. The leftmost pixel on the top scanline is stored first in memory. */ 613 /* level may range from [0,10], use MZ_NO_COMPRESSION, MZ_BEST_SPEED, MZ_BEST_COMPRESSION, etc. or a decent default is MZ_DEFAULT_LEVEL */ 614 /* If flip is true, the image will be flipped on the Y axis (useful for OpenGL apps). */ 615 /* On return: */ 616 /* Function returns a pointer to the compressed data, or NULL on failure. */ 617 /* *pLen_out will be set to the size of the PNG image file. */ 618 /* The caller must mz_free() the returned heap block (which will typically be larger than *pLen_out) when it's no longer needed. */ 619 void *tdefl_write_image_to_png_file_in_memory_ex(const void *pImage, int w, int h, int num_chans, size_t *pLen_out, mz_uint level, mz_bool flip); 620 void *tdefl_write_image_to_png_file_in_memory(const void *pImage, int w, int h, int num_chans, size_t *pLen_out); 621 622 /* Output stream interface. The compressor uses this interface to write compressed data. It'll typically be called TDEFL_OUT_BUF_SIZE at a time. */ 623 typedef mz_bool (*tdefl_put_buf_func_ptr)(const void *pBuf, int len, void *pUser); 624 625 /* tdefl_compress_mem_to_output() compresses a block to an output stream. The above helpers use this function internally. */ 626 mz_bool tdefl_compress_mem_to_output(const void *pBuf, size_t buf_len, tdefl_put_buf_func_ptr pPut_buf_func, void *pPut_buf_user, int flags); 627 628 enum 629 { 630 TDEFL_MAX_HUFF_TABLES = 3, 631 TDEFL_MAX_HUFF_SYMBOLS_0 = 288, 632 TDEFL_MAX_HUFF_SYMBOLS_1 = 32, 633 TDEFL_MAX_HUFF_SYMBOLS_2 = 19, 634 TDEFL_LZ_DICT_SIZE = 32768, 635 TDEFL_LZ_DICT_SIZE_MASK = TDEFL_LZ_DICT_SIZE - 1, 636 TDEFL_MIN_MATCH_LEN = 3, 637 TDEFL_MAX_MATCH_LEN = 258 638 }; 639 640 /* TDEFL_OUT_BUF_SIZE MUST be large enough to hold a single entire compressed output block (using static/fixed Huffman codes). */ 641 #if TDEFL_LESS_MEMORY 642 enum 643 { 644 TDEFL_LZ_CODE_BUF_SIZE = 24 * 1024, 645 TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13) / 10, 646 TDEFL_MAX_HUFF_SYMBOLS = 288, 647 TDEFL_LZ_HASH_BITS = 12, 648 TDEFL_LEVEL1_HASH_SIZE_MASK = 4095, 649 TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3, 650 TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS 651 }; 652 #else 653 enum 654 { 655 TDEFL_LZ_CODE_BUF_SIZE = 64 * 1024, 656 TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13) / 10, 657 TDEFL_MAX_HUFF_SYMBOLS = 288, 658 TDEFL_LZ_HASH_BITS = 15, 659 TDEFL_LEVEL1_HASH_SIZE_MASK = 4095, 660 TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3, 661 TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS 662 }; 663 #endif 664 665 /* The low-level tdefl functions below may be used directly if the above helper functions aren't flexible enough. The low-level functions don't make any heap allocations, unlike the above helper functions. */ 666 typedef enum 667 { 668 TDEFL_STATUS_BAD_PARAM = -2, 669 TDEFL_STATUS_PUT_BUF_FAILED = -1, 670 TDEFL_STATUS_OKAY = 0, 671 TDEFL_STATUS_DONE = 1 672 } tdefl_status; 673 674 /* Must map to MZ_NO_FLUSH, MZ_SYNC_FLUSH, etc. enums */ 675 typedef enum 676 { 677 TDEFL_NO_FLUSH = 0, 678 TDEFL_SYNC_FLUSH = 2, 679 TDEFL_FULL_FLUSH = 3, 680 TDEFL_FINISH = 4 681 } tdefl_flush; 682 683 /* tdefl's compression state structure. */ 684 typedef struct 685 { 686 tdefl_put_buf_func_ptr m_pPut_buf_func; 687 void *m_pPut_buf_user; 688 mz_uint m_flags, m_max_probes[2]; 689 int m_greedy_parsing; 690 mz_uint m_adler32, m_lookahead_pos, m_lookahead_size, m_dict_size; 691 mz_uint8 *m_pLZ_code_buf, *m_pLZ_flags, *m_pOutput_buf, *m_pOutput_buf_end; 692 mz_uint m_num_flags_left, m_total_lz_bytes, m_lz_code_buf_dict_pos, m_bits_in, m_bit_buffer; 693 mz_uint m_saved_match_dist, m_saved_match_len, m_saved_lit, m_output_flush_ofs, m_output_flush_remaining, m_finished, m_block_index, m_wants_to_finish; 694 tdefl_status m_prev_return_status; 695 const void *m_pIn_buf; 696 void *m_pOut_buf; 697 size_t *m_pIn_buf_size, *m_pOut_buf_size; 698 tdefl_flush m_flush; 699 const mz_uint8 *m_pSrc; 700 size_t m_src_buf_left, m_out_buf_ofs; 701 mz_uint8 m_dict[TDEFL_LZ_DICT_SIZE + TDEFL_MAX_MATCH_LEN - 1]; 702 mz_uint16 m_huff_count[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 703 mz_uint16 m_huff_codes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 704 mz_uint8 m_huff_code_sizes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 705 mz_uint8 m_lz_code_buf[TDEFL_LZ_CODE_BUF_SIZE]; 706 mz_uint16 m_next[TDEFL_LZ_DICT_SIZE]; 707 mz_uint16 m_hash[TDEFL_LZ_HASH_SIZE]; 708 mz_uint8 m_output_buf[TDEFL_OUT_BUF_SIZE]; 709 } tdefl_compressor; 710 711 /* Initializes the compressor. */ 712 /* There is no corresponding deinit() function because the tdefl API's do not dynamically allocate memory. */ 713 /* pBut_buf_func: If NULL, output data will be supplied to the specified callback. In this case, the user should call the tdefl_compress_buffer() API for compression. */ 714 /* If pBut_buf_func is NULL the user should always call the tdefl_compress() API. */ 715 /* flags: See the above enums (TDEFL_HUFFMAN_ONLY, TDEFL_WRITE_ZLIB_HEADER, etc.) */ 716 tdefl_status tdefl_init(tdefl_compressor *d, tdefl_put_buf_func_ptr pPut_buf_func, void *pPut_buf_user, int flags); 717 718 /* Compresses a block of data, consuming as much of the specified input buffer as possible, and writing as much compressed data to the specified output buffer as possible. */ 719 tdefl_status tdefl_compress(tdefl_compressor *d, const void *pIn_buf, size_t *pIn_buf_size, void *pOut_buf, size_t *pOut_buf_size, tdefl_flush flush); 720 721 /* tdefl_compress_buffer() is only usable when the tdefl_init() is called with a non-NULL tdefl_put_buf_func_ptr. */ 722 /* tdefl_compress_buffer() always consumes the entire input buffer. */ 723 tdefl_status tdefl_compress_buffer(tdefl_compressor *d, const void *pIn_buf, size_t in_buf_size, tdefl_flush flush); 724 725 tdefl_status tdefl_get_prev_return_status(tdefl_compressor *d); 726 mz_uint32 tdefl_get_adler32(tdefl_compressor *d); 727 728 /* Create tdefl_compress() flags given zlib-style compression parameters. */ 729 /* level may range from [0,10] (where 10 is absolute max compression, but may be much slower on some files) */ 730 /* window_bits may be -15 (raw deflate) or 15 (zlib) */ 731 /* strategy may be either MZ_DEFAULT_STRATEGY, MZ_FILTERED, MZ_HUFFMAN_ONLY, MZ_RLE, or MZ_FIXED */ 732 mz_uint tdefl_create_comp_flags_from_zip_params(int level, int window_bits, int strategy); 733 734 /* Allocate the tdefl_compressor structure in C so that */ 735 /* non-C language bindings to tdefl_ API don't need to worry about */ 736 /* structure size and allocation mechanism. */ 737 tdefl_compressor *tdefl_compressor_alloc(); 738 void tdefl_compressor_free(tdefl_compressor *pComp); 739 740 #ifdef __cplusplus 741 } 742 #endif 743 #pragma once 744 745 /* ------------------- Low-level Decompression API Definitions */ 746 747 #ifdef __cplusplus 748 extern "C" { 749 #endif 750 /* Decompression flags used by tinfl_decompress(). */ 751 /* TINFL_FLAG_PARSE_ZLIB_HEADER: If set, the input has a valid zlib header and ends with an adler32 checksum (it's a valid zlib stream). Otherwise, the input is a raw deflate stream. */ 752 /* TINFL_FLAG_HAS_MORE_INPUT: If set, there are more input bytes available beyond the end of the supplied input buffer. If clear, the input buffer contains all remaining input. */ 753 /* TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF: If set, the output buffer is large enough to hold the entire decompressed stream. If clear, the output buffer is at least the size of the dictionary (typically 32KB). */ 754 /* TINFL_FLAG_COMPUTE_ADLER32: Force adler-32 checksum computation of the decompressed bytes. */ 755 enum 756 { 757 TINFL_FLAG_PARSE_ZLIB_HEADER = 1, 758 TINFL_FLAG_HAS_MORE_INPUT = 2, 759 TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF = 4, 760 TINFL_FLAG_COMPUTE_ADLER32 = 8 761 }; 762 763 /* High level decompression functions: */ 764 /* tinfl_decompress_mem_to_heap() decompresses a block in memory to a heap block allocated via malloc(). */ 765 /* On entry: */ 766 /* pSrc_buf, src_buf_len: Pointer and size of the Deflate or zlib source data to decompress. */ 767 /* On return: */ 768 /* Function returns a pointer to the decompressed data, or NULL on failure. */ 769 /* *pOut_len will be set to the decompressed data's size, which could be larger than src_buf_len on uncompressible data. */ 770 /* The caller must call mz_free() on the returned block when it's no longer needed. */ 771 void *tinfl_decompress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); 772 773 /* tinfl_decompress_mem_to_mem() decompresses a block in memory to another block in memory. */ 774 /* Returns TINFL_DECOMPRESS_MEM_TO_MEM_FAILED on failure, or the number of bytes written on success. */ 775 #define TINFL_DECOMPRESS_MEM_TO_MEM_FAILED ((size_t)(-1)) 776 size_t tinfl_decompress_mem_to_mem(void *pOut_buf, size_t out_buf_len, const void *pSrc_buf, size_t src_buf_len, int flags); 777 778 /* tinfl_decompress_mem_to_callback() decompresses a block in memory to an internal 32KB buffer, and a user provided callback function will be called to flush the buffer. */ 779 /* Returns 1 on success or 0 on failure. */ 780 typedef int (*tinfl_put_buf_func_ptr)(const void *pBuf, int len, void *pUser); 781 int tinfl_decompress_mem_to_callback(const void *pIn_buf, size_t *pIn_buf_size, tinfl_put_buf_func_ptr pPut_buf_func, void *pPut_buf_user, int flags); 782 783 struct tinfl_decompressor_tag; 784 typedef struct tinfl_decompressor_tag tinfl_decompressor; 785 786 /* Allocate the tinfl_decompressor structure in C so that */ 787 /* non-C language bindings to tinfl_ API don't need to worry about */ 788 /* structure size and allocation mechanism. */ 789 790 tinfl_decompressor *tinfl_decompressor_alloc(); 791 void tinfl_decompressor_free(tinfl_decompressor *pDecomp); 792 793 /* Max size of LZ dictionary. */ 794 #define TINFL_LZ_DICT_SIZE 32768 795 796 /* Return status. */ 797 typedef enum 798 { 799 /* This flags indicates the inflator needs 1 or more input bytes to make forward progress, but the caller is indicating that no more are available. The compressed data */ 800 /* is probably corrupted. If you call the inflator again with more bytes it'll try to continue processing the input but this is a BAD sign (either the data is corrupted or you called it incorrectly). */ 801 /* If you call it again with no input you'll just get TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS again. */ 802 TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS = -4, 803 804 /* This flag indicates that one or more of the input parameters was obviously bogus. (You can try calling it again, but if you get this error the calling code is wrong.) */ 805 TINFL_STATUS_BAD_PARAM = -3, 806 807 /* This flags indicate the inflator is finished but the adler32 check of the uncompressed data didn't match. If you call it again it'll return TINFL_STATUS_DONE. */ 808 TINFL_STATUS_ADLER32_MISMATCH = -2, 809 810 /* This flags indicate the inflator has somehow failed (bad code, corrupted input, etc.). If you call it again without resetting via tinfl_init() it it'll just keep on returning the same status failure code. */ 811 TINFL_STATUS_FAILED = -1, 812 813 /* Any status code less than TINFL_STATUS_DONE must indicate a failure. */ 814 815 /* This flag indicates the inflator has returned every byte of uncompressed data that it can, has consumed every byte that it needed, has successfully reached the end of the deflate stream, and */ 816 /* if zlib headers and adler32 checking enabled that it has successfully checked the uncompressed data's adler32. If you call it again you'll just get TINFL_STATUS_DONE over and over again. */ 817 TINFL_STATUS_DONE = 0, 818 819 /* This flag indicates the inflator MUST have more input data (even 1 byte) before it can make any more forward progress, or you need to clear the TINFL_FLAG_HAS_MORE_INPUT */ 820 /* flag on the next call if you don't have any more source data. If the source data was somehow corrupted it's also possible (but unlikely) for the inflator to keep on demanding input to */ 821 /* proceed, so be sure to properly set the TINFL_FLAG_HAS_MORE_INPUT flag. */ 822 TINFL_STATUS_NEEDS_MORE_INPUT = 1, 823 824 /* This flag indicates the inflator definitely has 1 or more bytes of uncompressed data available, but it cannot write this data into the output buffer. */ 825 /* Note if the source compressed data was corrupted it's possible for the inflator to return a lot of uncompressed data to the caller. I've been assuming you know how much uncompressed data to expect */ 826 /* (either exact or worst case) and will stop calling the inflator and fail after receiving too much. In pure streaming scenarios where you have no idea how many bytes to expect this may not be possible */ 827 /* so I may need to add some code to address this. */ 828 TINFL_STATUS_HAS_MORE_OUTPUT = 2 829 } tinfl_status; 830 831 /* Initializes the decompressor to its initial state. */ 832 #define tinfl_init(r) \ 833 do \ 834 { \ 835 (r)->m_state = 0; \ 836 } \ 837 MZ_MACRO_END 838 #define tinfl_get_adler32(r) (r)->m_check_adler32 839 840 /* Main low-level decompressor coroutine function. This is the only function actually needed for decompression. All the other functions are just high-level helpers for improved usability. */ 841 /* This is a universal API, i.e. it can be used as a building block to build any desired higher level decompression API. In the limit case, it can be called once per every byte input or output. */ 842 tinfl_status tinfl_decompress(tinfl_decompressor *r, const mz_uint8 *pIn_buf_next, size_t *pIn_buf_size, mz_uint8 *pOut_buf_start, mz_uint8 *pOut_buf_next, size_t *pOut_buf_size, const mz_uint32 decomp_flags); 843 844 /* Internal/private bits follow. */ 845 enum 846 { 847 TINFL_MAX_HUFF_TABLES = 3, 848 TINFL_MAX_HUFF_SYMBOLS_0 = 288, 849 TINFL_MAX_HUFF_SYMBOLS_1 = 32, 850 TINFL_MAX_HUFF_SYMBOLS_2 = 19, 851 TINFL_FAST_LOOKUP_BITS = 10, 852 TINFL_FAST_LOOKUP_SIZE = 1 << TINFL_FAST_LOOKUP_BITS 853 }; 854 855 typedef struct 856 { 857 mz_uint8 m_code_size[TINFL_MAX_HUFF_SYMBOLS_0]; 858 mz_int16 m_look_up[TINFL_FAST_LOOKUP_SIZE], m_tree[TINFL_MAX_HUFF_SYMBOLS_0 * 2]; 859 } tinfl_huff_table; 860 861 #if MINIZ_HAS_64BIT_REGISTERS 862 #define TINFL_USE_64BIT_BITBUF 1 863 #endif 864 865 #if TINFL_USE_64BIT_BITBUF 866 typedef mz_uint64 tinfl_bit_buf_t; 867 #define TINFL_BITBUF_SIZE (64) 868 #else 869 typedef mz_uint32 tinfl_bit_buf_t; 870 #define TINFL_BITBUF_SIZE (32) 871 #endif 872 873 struct tinfl_decompressor_tag 874 { 875 mz_uint32 m_state, m_num_bits, m_zhdr0, m_zhdr1, m_z_adler32, m_final, m_type, m_check_adler32, m_dist, m_counter, m_num_extra, m_table_sizes[TINFL_MAX_HUFF_TABLES]; 876 tinfl_bit_buf_t m_bit_buf; 877 size_t m_dist_from_out_buf_start; 878 tinfl_huff_table m_tables[TINFL_MAX_HUFF_TABLES]; 879 mz_uint8 m_raw_header[4], m_len_codes[TINFL_MAX_HUFF_SYMBOLS_0 + TINFL_MAX_HUFF_SYMBOLS_1 + 137]; 880 }; 881 882 #ifdef __cplusplus 883 } 884 #endif 885 886 #pragma once 887 888 889 /* ------------------- ZIP archive reading/writing */ 890 891 #ifndef MINIZ_NO_ARCHIVE_APIS 892 893 #ifdef __cplusplus 894 extern "C" { 895 #endif 896 897 enum 898 { 899 /* Note: These enums can be reduced as needed to save memory or stack space - they are pretty conservative. */ 900 MZ_ZIP_MAX_IO_BUF_SIZE = 64 * 1024, 901 MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE = 512, 902 MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE = 512 903 }; 904 905 typedef struct 906 { 907 /* Central directory file index. */ 908 mz_uint32 m_file_index; 909 910 /* Byte offset of this entry in the archive's central directory. Note we currently only support up to UINT_MAX or less bytes in the central dir. */ 911 mz_uint64 m_central_dir_ofs; 912 913 /* These fields are copied directly from the zip's central dir. */ 914 mz_uint16 m_version_made_by; 915 mz_uint16 m_version_needed; 916 mz_uint16 m_bit_flag; 917 mz_uint16 m_method; 918 919 #ifndef MINIZ_NO_TIME 920 MZ_TIME_T m_time; 921 #endif 922 923 /* CRC-32 of uncompressed data. */ 924 mz_uint32 m_crc32; 925 926 /* File's compressed size. */ 927 mz_uint64 m_comp_size; 928 929 /* File's uncompressed size. Note, I've seen some old archives where directory entries had 512 bytes for their uncompressed sizes, but when you try to unpack them you actually get 0 bytes. */ 930 mz_uint64 m_uncomp_size; 931 932 /* Zip internal and external file attributes. */ 933 mz_uint16 m_internal_attr; 934 mz_uint32 m_external_attr; 935 936 /* Entry's local header file offset in bytes. */ 937 mz_uint64 m_local_header_ofs; 938 939 /* Size of comment in bytes. */ 940 mz_uint32 m_comment_size; 941 942 /* MZ_TRUE if the entry appears to be a directory. */ 943 mz_bool m_is_directory; 944 945 /* MZ_TRUE if the entry uses encryption/strong encryption (which miniz_zip doesn't support) */ 946 mz_bool m_is_encrypted; 947 948 /* MZ_TRUE if the file is not encrypted, a patch file, and if it uses a compression method we support. */ 949 mz_bool m_is_supported; 950 951 /* Filename. If string ends in '/' it's a subdirectory entry. */ 952 /* Guaranteed to be zero terminated, may be truncated to fit. */ 953 char m_filename[MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE]; 954 955 /* Comment field. */ 956 /* Guaranteed to be zero terminated, may be truncated to fit. */ 957 char m_comment[MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE]; 958 959 } mz_zip_archive_file_stat; 960 961 typedef size_t (*mz_file_read_func)(void *pOpaque, mz_uint64 file_ofs, void *pBuf, size_t n); 962 typedef size_t (*mz_file_write_func)(void *pOpaque, mz_uint64 file_ofs, const void *pBuf, size_t n); 963 typedef mz_bool (*mz_file_needs_keepalive)(void *pOpaque); 964 965 struct mz_zip_internal_state_tag; 966 typedef struct mz_zip_internal_state_tag mz_zip_internal_state; 967 968 typedef enum 969 { 970 MZ_ZIP_MODE_INVALID = 0, 971 MZ_ZIP_MODE_READING = 1, 972 MZ_ZIP_MODE_WRITING = 2, 973 MZ_ZIP_MODE_WRITING_HAS_BEEN_FINALIZED = 3 974 } mz_zip_mode; 975 976 typedef enum 977 { 978 MZ_ZIP_FLAG_CASE_SENSITIVE = 0x0100, 979 MZ_ZIP_FLAG_IGNORE_PATH = 0x0200, 980 MZ_ZIP_FLAG_COMPRESSED_DATA = 0x0400, 981 MZ_ZIP_FLAG_DO_NOT_SORT_CENTRAL_DIRECTORY = 0x0800, 982 MZ_ZIP_FLAG_VALIDATE_LOCATE_FILE_FLAG = 0x1000, /* if enabled, mz_zip_reader_locate_file() will be called on each file as its validated to ensure the func finds the file in the central dir (intended for testing) */ 983 MZ_ZIP_FLAG_VALIDATE_HEADERS_ONLY = 0x2000, /* validate the local headers, but don't decompress the entire file and check the crc32 */ 984 MZ_ZIP_FLAG_WRITE_ZIP64 = 0x4000, /* use the zip64 file format, instead of the original zip file format */ 985 MZ_ZIP_FLAG_WRITE_ALLOW_READING = 0x8000, 986 MZ_ZIP_FLAG_ASCII_FILENAME = 0x10000 987 } mz_zip_flags; 988 989 typedef enum 990 { 991 MZ_ZIP_TYPE_INVALID = 0, 992 MZ_ZIP_TYPE_USER, 993 MZ_ZIP_TYPE_MEMORY, 994 MZ_ZIP_TYPE_HEAP, 995 MZ_ZIP_TYPE_FILE, 996 MZ_ZIP_TYPE_CFILE, 997 MZ_ZIP_TOTAL_TYPES 998 } mz_zip_type; 999 1000 /* miniz error codes. Be sure to update mz_zip_get_error_string() if you add or modify this enum. */ 1001 typedef enum 1002 { 1003 MZ_ZIP_NO_ERROR = 0, 1004 MZ_ZIP_UNDEFINED_ERROR, 1005 MZ_ZIP_TOO_MANY_FILES, 1006 MZ_ZIP_FILE_TOO_LARGE, 1007 MZ_ZIP_UNSUPPORTED_METHOD, 1008 MZ_ZIP_UNSUPPORTED_ENCRYPTION, 1009 MZ_ZIP_UNSUPPORTED_FEATURE, 1010 MZ_ZIP_FAILED_FINDING_CENTRAL_DIR, 1011 MZ_ZIP_NOT_AN_ARCHIVE, 1012 MZ_ZIP_INVALID_HEADER_OR_CORRUPTED, 1013 MZ_ZIP_UNSUPPORTED_MULTIDISK, 1014 MZ_ZIP_DECOMPRESSION_FAILED, 1015 MZ_ZIP_COMPRESSION_FAILED, 1016 MZ_ZIP_UNEXPECTED_DECOMPRESSED_SIZE, 1017 MZ_ZIP_CRC_CHECK_FAILED, 1018 MZ_ZIP_UNSUPPORTED_CDIR_SIZE, 1019 MZ_ZIP_ALLOC_FAILED, 1020 MZ_ZIP_FILE_OPEN_FAILED, 1021 MZ_ZIP_FILE_CREATE_FAILED, 1022 MZ_ZIP_FILE_WRITE_FAILED, 1023 MZ_ZIP_FILE_READ_FAILED, 1024 MZ_ZIP_FILE_CLOSE_FAILED, 1025 MZ_ZIP_FILE_SEEK_FAILED, 1026 MZ_ZIP_FILE_STAT_FAILED, 1027 MZ_ZIP_INVALID_PARAMETER, 1028 MZ_ZIP_INVALID_FILENAME, 1029 MZ_ZIP_BUF_TOO_SMALL, 1030 MZ_ZIP_INTERNAL_ERROR, 1031 MZ_ZIP_FILE_NOT_FOUND, 1032 MZ_ZIP_ARCHIVE_TOO_LARGE, 1033 MZ_ZIP_VALIDATION_FAILED, 1034 MZ_ZIP_WRITE_CALLBACK_FAILED, 1035 MZ_ZIP_TOTAL_ERRORS 1036 } mz_zip_error; 1037 1038 typedef struct 1039 { 1040 mz_uint64 m_archive_size; 1041 mz_uint64 m_central_directory_file_ofs; 1042 1043 /* We only support up to UINT32_MAX files in zip64 mode. */ 1044 mz_uint32 m_total_files; 1045 mz_zip_mode m_zip_mode; 1046 mz_zip_type m_zip_type; 1047 mz_zip_error m_last_error; 1048 1049 mz_uint64 m_file_offset_alignment; 1050 1051 mz_alloc_func m_pAlloc; 1052 mz_free_func m_pFree; 1053 mz_realloc_func m_pRealloc; 1054 void *m_pAlloc_opaque; 1055 1056 mz_file_read_func m_pRead; 1057 mz_file_write_func m_pWrite; 1058 mz_file_needs_keepalive m_pNeeds_keepalive; 1059 void *m_pIO_opaque; 1060 1061 mz_zip_internal_state *m_pState; 1062 1063 } mz_zip_archive; 1064 1065 /* -------- ZIP reading */ 1066 1067 /* Inits a ZIP archive reader. */ 1068 /* These functions read and validate the archive's central directory. */ 1069 mz_bool mz_zip_reader_init(mz_zip_archive *pZip, mz_uint64 size, mz_uint flags); 1070 1071 mz_bool mz_zip_reader_init_mem(mz_zip_archive *pZip, const void *pMem, size_t size, mz_uint flags); 1072 1073 #ifndef MINIZ_NO_STDIO 1074 /* Read a archive from a disk file. */ 1075 /* file_start_ofs is the file offset where the archive actually begins, or 0. */ 1076 /* actual_archive_size is the true total size of the archive, which may be smaller than the file's actual size on disk. If zero the entire file is treated as the archive. */ 1077 mz_bool mz_zip_reader_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint32 flags); 1078 mz_bool mz_zip_reader_init_file_v2(mz_zip_archive *pZip, const char *pFilename, mz_uint flags, mz_uint64 file_start_ofs, mz_uint64 archive_size); 1079 1080 /* Read an archive from an already opened FILE, beginning at the current file position. */ 1081 /* The archive is assumed to be archive_size bytes long. If archive_size is < 0, then the entire rest of the file is assumed to contain the archive. */ 1082 /* The FILE will NOT be closed when mz_zip_reader_end() is called. */ 1083 mz_bool mz_zip_reader_init_cfile(mz_zip_archive *pZip, MZ_FILE *pFile, mz_uint64 archive_size, mz_uint flags); 1084 #endif 1085 1086 /* Ends archive reading, freeing all allocations, and closing the input archive file if mz_zip_reader_init_file() was used. */ 1087 mz_bool mz_zip_reader_end(mz_zip_archive *pZip); 1088 1089 /* -------- ZIP reading or writing */ 1090 1091 /* Clears a mz_zip_archive struct to all zeros. */ 1092 /* Important: This must be done before passing the struct to any mz_zip functions. */ 1093 void mz_zip_zero_struct(mz_zip_archive *pZip); 1094 1095 mz_zip_mode mz_zip_get_mode(mz_zip_archive *pZip); 1096 mz_zip_type mz_zip_get_type(mz_zip_archive *pZip); 1097 1098 /* Returns the total number of files in the archive. */ 1099 mz_uint mz_zip_reader_get_num_files(mz_zip_archive *pZip); 1100 1101 mz_uint64 mz_zip_get_archive_size(mz_zip_archive *pZip); 1102 mz_uint64 mz_zip_get_archive_file_start_offset(mz_zip_archive *pZip); 1103 MZ_FILE *mz_zip_get_cfile(mz_zip_archive *pZip); 1104 1105 /* Reads n bytes of raw archive data, starting at file offset file_ofs, to pBuf. */ 1106 size_t mz_zip_read_archive_data(mz_zip_archive *pZip, mz_uint64 file_ofs, void *pBuf, size_t n); 1107 1108 /* Attempts to locates a file in the archive's central directory. */ 1109 /* Valid flags: MZ_ZIP_FLAG_CASE_SENSITIVE, MZ_ZIP_FLAG_IGNORE_PATH */ 1110 /* Returns -1 if the file cannot be found. */ 1111 int mz_zip_locate_file(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags); 1112 /* Returns MZ_FALSE if the file cannot be found. */ 1113 mz_bool mz_zip_locate_file_v2(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags, mz_uint32 *pIndex); 1114 1115 /* All mz_zip funcs set the m_last_error field in the mz_zip_archive struct. These functions retrieve/manipulate this field. */ 1116 /* Note that the m_last_error functionality is not thread safe. */ 1117 mz_zip_error mz_zip_set_last_error(mz_zip_archive *pZip, mz_zip_error err_num); 1118 mz_zip_error mz_zip_peek_last_error(mz_zip_archive *pZip); 1119 mz_zip_error mz_zip_clear_last_error(mz_zip_archive *pZip); 1120 mz_zip_error mz_zip_get_last_error(mz_zip_archive *pZip); 1121 const char *mz_zip_get_error_string(mz_zip_error mz_err); 1122 1123 /* MZ_TRUE if the archive file entry is a directory entry. */ 1124 mz_bool mz_zip_reader_is_file_a_directory(mz_zip_archive *pZip, mz_uint file_index); 1125 1126 /* MZ_TRUE if the file is encrypted/strong encrypted. */ 1127 mz_bool mz_zip_reader_is_file_encrypted(mz_zip_archive *pZip, mz_uint file_index); 1128 1129 /* MZ_TRUE if the compression method is supported, and the file is not encrypted, and the file is not a compressed patch file. */ 1130 mz_bool mz_zip_reader_is_file_supported(mz_zip_archive *pZip, mz_uint file_index); 1131 1132 /* Retrieves the filename of an archive file entry. */ 1133 /* Returns the number of bytes written to pFilename, or if filename_buf_size is 0 this function returns the number of bytes needed to fully store the filename. */ 1134 mz_uint mz_zip_reader_get_filename(mz_zip_archive *pZip, mz_uint file_index, char *pFilename, mz_uint filename_buf_size); 1135 1136 /* Attempts to locates a file in the archive's central directory. */ 1137 /* Valid flags: MZ_ZIP_FLAG_CASE_SENSITIVE, MZ_ZIP_FLAG_IGNORE_PATH */ 1138 /* Returns -1 if the file cannot be found. */ 1139 int mz_zip_reader_locate_file(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags); 1140 int mz_zip_reader_locate_file_v2(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags, mz_uint32 *file_index); 1141 1142 /* Returns detailed information about an archive file entry. */ 1143 mz_bool mz_zip_reader_file_stat(mz_zip_archive *pZip, mz_uint file_index, mz_zip_archive_file_stat *pStat); 1144 1145 /* MZ_TRUE if the file is in zip64 format. */ 1146 /* A file is considered zip64 if it contained a zip64 end of central directory marker, or if it contained any zip64 extended file information fields in the central directory. */ 1147 mz_bool mz_zip_is_zip64(mz_zip_archive *pZip); 1148 1149 /* Returns the total central directory size in bytes. */ 1150 /* The current max supported size is <= MZ_UINT32_MAX. */ 1151 size_t mz_zip_get_central_dir_size(mz_zip_archive *pZip); 1152 1153 /* Extracts a archive file to a memory buffer using no memory allocation. */ 1154 /* There must be at least enough room on the stack to store the inflator's state (~34KB or so). */ 1155 mz_bool mz_zip_reader_extract_to_mem_no_alloc(mz_zip_archive *pZip, mz_uint file_index, void *pBuf, size_t buf_size, mz_uint flags, void *pUser_read_buf, size_t user_read_buf_size); 1156 mz_bool mz_zip_reader_extract_file_to_mem_no_alloc(mz_zip_archive *pZip, const char *pFilename, void *pBuf, size_t buf_size, mz_uint flags, void *pUser_read_buf, size_t user_read_buf_size); 1157 1158 /* Extracts a archive file to a memory buffer. */ 1159 mz_bool mz_zip_reader_extract_to_mem(mz_zip_archive *pZip, mz_uint file_index, void *pBuf, size_t buf_size, mz_uint flags); 1160 mz_bool mz_zip_reader_extract_file_to_mem(mz_zip_archive *pZip, const char *pFilename, void *pBuf, size_t buf_size, mz_uint flags); 1161 1162 /* Extracts a archive file to a dynamically allocated heap buffer. */ 1163 /* The memory will be allocated via the mz_zip_archive's alloc/realloc functions. */ 1164 /* Returns NULL and sets the last error on failure. */ 1165 void *mz_zip_reader_extract_to_heap(mz_zip_archive *pZip, mz_uint file_index, size_t *pSize, mz_uint flags); 1166 void *mz_zip_reader_extract_file_to_heap(mz_zip_archive *pZip, const char *pFilename, size_t *pSize, mz_uint flags); 1167 1168 /* Extracts a archive file using a callback function to output the file's data. */ 1169 mz_bool mz_zip_reader_extract_to_callback(mz_zip_archive *pZip, mz_uint file_index, mz_file_write_func pCallback, void *pOpaque, mz_uint flags); 1170 mz_bool mz_zip_reader_extract_file_to_callback(mz_zip_archive *pZip, const char *pFilename, mz_file_write_func pCallback, void *pOpaque, mz_uint flags); 1171 1172 #ifndef MINIZ_NO_STDIO 1173 /* Extracts a archive file to a disk file and sets its last accessed and modified times. */ 1174 /* This function only extracts files, not archive directory records. */ 1175 mz_bool mz_zip_reader_extract_to_file(mz_zip_archive *pZip, mz_uint file_index, const char *pDst_filename, mz_uint flags); 1176 mz_bool mz_zip_reader_extract_file_to_file(mz_zip_archive *pZip, const char *pArchive_filename, const char *pDst_filename, mz_uint flags); 1177 1178 /* Extracts a archive file starting at the current position in the destination FILE stream. */ 1179 mz_bool mz_zip_reader_extract_to_cfile(mz_zip_archive *pZip, mz_uint file_index, MZ_FILE *File, mz_uint flags); 1180 mz_bool mz_zip_reader_extract_file_to_cfile(mz_zip_archive *pZip, const char *pArchive_filename, MZ_FILE *pFile, mz_uint flags); 1181 #endif 1182 1183 #if 0 1184 /* TODO */ 1185 typedef void *mz_zip_streaming_extract_state_ptr; 1186 mz_zip_streaming_extract_state_ptr mz_zip_streaming_extract_begin(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags); 1187 uint64_t mz_zip_streaming_extract_get_size(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState); 1188 uint64_t mz_zip_streaming_extract_get_cur_ofs(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState); 1189 mz_bool mz_zip_streaming_extract_seek(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState, uint64_t new_ofs); 1190 size_t mz_zip_streaming_extract_read(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState, void *pBuf, size_t buf_size); 1191 mz_bool mz_zip_streaming_extract_end(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState); 1192 #endif 1193 1194 /* This function compares the archive's local headers, the optional local zip64 extended information block, and the optional descriptor following the compressed data vs. the data in the central directory. */ 1195 /* It also validates that each file can be successfully uncompressed unless the MZ_ZIP_FLAG_VALIDATE_HEADERS_ONLY is specified. */ 1196 mz_bool mz_zip_validate_file(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags); 1197 1198 /* Validates an entire archive by calling mz_zip_validate_file() on each file. */ 1199 mz_bool mz_zip_validate_archive(mz_zip_archive *pZip, mz_uint flags); 1200 1201 /* Misc utils/helpers, valid for ZIP reading or writing */ 1202 mz_bool mz_zip_validate_mem_archive(const void *pMem, size_t size, mz_uint flags, mz_zip_error *pErr); 1203 mz_bool mz_zip_validate_file_archive(const char *pFilename, mz_uint flags, mz_zip_error *pErr); 1204 1205 /* Universal end function - calls either mz_zip_reader_end() or mz_zip_writer_end(). */ 1206 mz_bool mz_zip_end(mz_zip_archive *pZip); 1207 1208 /* -------- ZIP writing */ 1209 1210 #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS 1211 1212 /* Inits a ZIP archive writer. */ 1213 mz_bool mz_zip_writer_init(mz_zip_archive *pZip, mz_uint64 existing_size); 1214 mz_bool mz_zip_writer_init_v2(mz_zip_archive *pZip, mz_uint64 existing_size, mz_uint flags); 1215 mz_bool mz_zip_writer_init_heap(mz_zip_archive *pZip, size_t size_to_reserve_at_beginning, size_t initial_allocation_size); 1216 mz_bool mz_zip_writer_init_heap_v2(mz_zip_archive *pZip, size_t size_to_reserve_at_beginning, size_t initial_allocation_size, mz_uint flags); 1217 1218 #ifndef MINIZ_NO_STDIO 1219 mz_bool mz_zip_writer_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint64 size_to_reserve_at_beginning); 1220 mz_bool mz_zip_writer_init_file_v2(mz_zip_archive *pZip, const char *pFilename, mz_uint64 size_to_reserve_at_beginning, mz_uint flags); 1221 mz_bool mz_zip_writer_init_cfile(mz_zip_archive *pZip, MZ_FILE *pFile, mz_uint flags); 1222 #endif 1223 1224 /* Converts a ZIP archive reader object into a writer object, to allow efficient in-place file appends to occur on an existing archive. */ 1225 /* For archives opened using mz_zip_reader_init_file, pFilename must be the archive's filename so it can be reopened for writing. If the file can't be reopened, mz_zip_reader_end() will be called. */ 1226 /* For archives opened using mz_zip_reader_init_mem, the memory block must be growable using the realloc callback (which defaults to realloc unless you've overridden it). */ 1227 /* Finally, for archives opened using mz_zip_reader_init, the mz_zip_archive's user provided m_pWrite function cannot be NULL. */ 1228 /* Note: In-place archive modification is not recommended unless you know what you're doing, because if execution stops or something goes wrong before */ 1229 /* the archive is finalized the file's central directory will be hosed. */ 1230 mz_bool mz_zip_writer_init_from_reader(mz_zip_archive *pZip, const char *pFilename); 1231 mz_bool mz_zip_writer_init_from_reader_v2(mz_zip_archive *pZip, const char *pFilename, mz_uint flags); 1232 1233 /* Adds the contents of a memory buffer to an archive. These functions record the current local time into the archive. */ 1234 /* To add a directory entry, call this method with an archive name ending in a forwardslash with an empty buffer. */ 1235 /* level_and_flags - compression level (0-10, see MZ_BEST_SPEED, MZ_BEST_COMPRESSION, etc.) logically OR'd with zero or more mz_zip_flags, or just set to MZ_DEFAULT_COMPRESSION. */ 1236 mz_bool mz_zip_writer_add_mem(mz_zip_archive *pZip, const char *pArchive_name, const void *pBuf, size_t buf_size, mz_uint level_and_flags); 1237 1238 /* Like mz_zip_writer_add_mem(), except you can specify a file comment field, and optionally supply the function with already compressed data. */ 1239 /* uncomp_size/uncomp_crc32 are only used if the MZ_ZIP_FLAG_COMPRESSED_DATA flag is specified. */ 1240 mz_bool mz_zip_writer_add_mem_ex(mz_zip_archive *pZip, const char *pArchive_name, const void *pBuf, size_t buf_size, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags, 1241 mz_uint64 uncomp_size, mz_uint32 uncomp_crc32); 1242 1243 mz_bool mz_zip_writer_add_mem_ex_v2(mz_zip_archive *pZip, const char *pArchive_name, const void *pBuf, size_t buf_size, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags, 1244 mz_uint64 uncomp_size, mz_uint32 uncomp_crc32, MZ_TIME_T *last_modified, const char *user_extra_data_local, mz_uint user_extra_data_local_len, 1245 const char *user_extra_data_central, mz_uint user_extra_data_central_len); 1246 1247 #ifndef MINIZ_NO_STDIO 1248 /* Adds the contents of a disk file to an archive. This function also records the disk file's modified time into the archive. */ 1249 /* level_and_flags - compression level (0-10, see MZ_BEST_SPEED, MZ_BEST_COMPRESSION, etc.) logically OR'd with zero or more mz_zip_flags, or just set to MZ_DEFAULT_COMPRESSION. */ 1250 mz_bool mz_zip_writer_add_file(mz_zip_archive *pZip, const char *pArchive_name, const char *pSrc_filename, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags); 1251 1252 /* Like mz_zip_writer_add_file(), except the file data is read from the specified FILE stream. */ 1253 mz_bool mz_zip_writer_add_cfile(mz_zip_archive *pZip, const char *pArchive_name, MZ_FILE *pSrc_file, mz_uint64 size_to_add, 1254 const MZ_TIME_T *pFile_time, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags, const char *user_extra_data_local, mz_uint user_extra_data_local_len, 1255 const char *user_extra_data_central, mz_uint user_extra_data_central_len); 1256 #endif 1257 1258 /* Adds a file to an archive by fully cloning the data from another archive. */ 1259 /* This function fully clones the source file's compressed data (no recompression), along with its full filename, extra data (it may add or modify the zip64 local header extra data field), and the optional descriptor following the compressed data. */ 1260 mz_bool mz_zip_writer_add_from_zip_reader(mz_zip_archive *pZip, mz_zip_archive *pSource_zip, mz_uint src_file_index); 1261 1262 /* Finalizes the archive by writing the central directory records followed by the end of central directory record. */ 1263 /* After an archive is finalized, the only valid call on the mz_zip_archive struct is mz_zip_writer_end(). */ 1264 /* An archive must be manually finalized by calling this function for it to be valid. */ 1265 mz_bool mz_zip_writer_finalize_archive(mz_zip_archive *pZip); 1266 1267 /* Finalizes a heap archive, returning a poiner to the heap block and its size. */ 1268 /* The heap block will be allocated using the mz_zip_archive's alloc/realloc callbacks. */ 1269 mz_bool mz_zip_writer_finalize_heap_archive(mz_zip_archive *pZip, void **ppBuf, size_t *pSize); 1270 1271 /* Ends archive writing, freeing all allocations, and closing the output file if mz_zip_writer_init_file() was used. */ 1272 /* Note for the archive to be valid, it *must* have been finalized before ending (this function will not do it for you). */ 1273 mz_bool mz_zip_writer_end(mz_zip_archive *pZip); 1274 1275 /* -------- Misc. high-level helper functions: */ 1276 1277 /* mz_zip_add_mem_to_archive_file_in_place() efficiently (but not atomically) appends a memory blob to a ZIP archive. */ 1278 /* Note this is NOT a fully safe operation. If it crashes or dies in some way your archive can be left in a screwed up state (without a central directory). */ 1279 /* level_and_flags - compression level (0-10, see MZ_BEST_SPEED, MZ_BEST_COMPRESSION, etc.) logically OR'd with zero or more mz_zip_flags, or just set to MZ_DEFAULT_COMPRESSION. */ 1280 /* TODO: Perhaps add an option to leave the existing central dir in place in case the add dies? We could then truncate the file (so the old central dir would be at the end) if something goes wrong. */ 1281 mz_bool mz_zip_add_mem_to_archive_file_in_place(const char *pZip_filename, const char *pArchive_name, const void *pBuf, size_t buf_size, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags); 1282 mz_bool mz_zip_add_mem_to_archive_file_in_place_v2(const char *pZip_filename, const char *pArchive_name, const void *pBuf, size_t buf_size, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags, mz_zip_error *pErr); 1283 1284 /* Reads a single file from an archive into a heap block. */ 1285 /* If pComment is not NULL, only the file with the specified comment will be extracted. */ 1286 /* Returns NULL on failure. */ 1287 void *mz_zip_extract_archive_file_to_heap(const char *pZip_filename, const char *pArchive_name, size_t *pSize, mz_uint flags); 1288 void *mz_zip_extract_archive_file_to_heap_v2(const char *pZip_filename, const char *pArchive_name, const char *pComment, size_t *pSize, mz_uint flags, mz_zip_error *pErr); 1289 1290 #endif /* #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS */ 1291 1292 #ifdef __cplusplus 1293 } 1294 #endif 1295 1296 #endif /* MINIZ_NO_ARCHIVE_APIS */ 1297