1 /* miniz.c 2.0.8 - 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 #else 163 #define MINIZ_X86_OR_X64_CPU 0 164 #endif 165 166 #if (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__) || MINIZ_X86_OR_X64_CPU 167 /* Set MINIZ_LITTLE_ENDIAN to 1 if the processor is little endian. */ 168 #define MINIZ_LITTLE_ENDIAN 1 169 #else 170 #define MINIZ_LITTLE_ENDIAN 0 171 #endif 172 173 #if MINIZ_X86_OR_X64_CPU 174 /* Set MINIZ_USE_UNALIGNED_LOADS_AND_STORES to 1 on CPU's that permit efficient integer loads and stores from unaligned addresses. */ 175 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 0 176 #else 177 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 0 178 #endif 179 180 #if defined(_M_X64) || defined(_WIN64) || defined(__MINGW64__) || defined(_LP64) || defined(__LP64__) || defined(__ia64__) || defined(__x86_64__) 181 /* 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). */ 182 #define MINIZ_HAS_64BIT_REGISTERS 1 183 #else 184 #define MINIZ_HAS_64BIT_REGISTERS 0 185 #endif 186 187 #ifdef __cplusplus 188 extern "C" { 189 #endif 190 191 /* ------------------- zlib-style API Definitions. */ 192 193 /* 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! */ 194 typedef unsigned long mz_ulong; 195 196 /* 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. */ 197 void mz_free(void *p); 198 199 #define MZ_ADLER32_INIT (1) 200 /* mz_adler32() returns the initial adler-32 value to use when called with ptr==NULL. */ 201 mz_ulong mz_adler32(mz_ulong adler, const unsigned char *ptr, size_t buf_len); 202 203 #define MZ_CRC32_INIT (0) 204 /* mz_crc32() returns the initial CRC-32 value to use when called with ptr==NULL. */ 205 mz_ulong mz_crc32(mz_ulong crc, const unsigned char *ptr, size_t buf_len); 206 207 /* Compression strategies. */ 208 enum 209 { 210 MZ_DEFAULT_STRATEGY = 0, 211 MZ_FILTERED = 1, 212 MZ_HUFFMAN_ONLY = 2, 213 MZ_RLE = 3, 214 MZ_FIXED = 4 215 }; 216 217 /* Method */ 218 #define MZ_DEFLATED 8 219 220 /* Heap allocation callbacks. 221 Note that mz_alloc_func parameter types purpsosely differ from zlib's: items/size is size_t, not unsigned long. */ 222 typedef void *(*mz_alloc_func)(void *opaque, size_t items, size_t size); 223 typedef void (*mz_free_func)(void *opaque, void *address); 224 typedef void *(*mz_realloc_func)(void *opaque, void *address, size_t items, size_t size); 225 226 /* 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. */ 227 enum 228 { 229 MZ_NO_COMPRESSION = 0, 230 MZ_BEST_SPEED = 1, 231 MZ_BEST_COMPRESSION = 9, 232 MZ_UBER_COMPRESSION = 10, 233 MZ_DEFAULT_LEVEL = 6, 234 MZ_DEFAULT_COMPRESSION = -1 235 }; 236 237 #define MZ_VERSION "10.0.3" 238 #define MZ_VERNUM 0xA030 239 #define MZ_VER_MAJOR 10 240 #define MZ_VER_MINOR 0 241 #define MZ_VER_REVISION 3 242 #define MZ_VER_SUBREVISION 0 243 244 #ifndef MINIZ_NO_ZLIB_APIS 245 246 /* 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). */ 247 enum 248 { 249 MZ_NO_FLUSH = 0, 250 MZ_PARTIAL_FLUSH = 1, 251 MZ_SYNC_FLUSH = 2, 252 MZ_FULL_FLUSH = 3, 253 MZ_FINISH = 4, 254 MZ_BLOCK = 5 255 }; 256 257 /* Return status codes. MZ_PARAM_ERROR is non-standard. */ 258 enum 259 { 260 MZ_OK = 0, 261 MZ_STREAM_END = 1, 262 MZ_NEED_DICT = 2, 263 MZ_ERRNO = -1, 264 MZ_STREAM_ERROR = -2, 265 MZ_DATA_ERROR = -3, 266 MZ_MEM_ERROR = -4, 267 MZ_BUF_ERROR = -5, 268 MZ_VERSION_ERROR = -6, 269 MZ_PARAM_ERROR = -10000 270 }; 271 272 /* Window bits */ 273 #define MZ_DEFAULT_WINDOW_BITS 15 274 275 struct mz_internal_state; 276 277 /* Compression/decompression stream struct. */ 278 typedef struct mz_stream_s 279 { 280 const unsigned char *next_in; /* pointer to next byte to read */ 281 unsigned int avail_in; /* number of bytes available at next_in */ 282 mz_ulong total_in; /* total number of bytes consumed so far */ 283 284 unsigned char *next_out; /* pointer to next byte to write */ 285 unsigned int avail_out; /* number of bytes that can be written to next_out */ 286 mz_ulong total_out; /* total number of bytes produced so far */ 287 288 char *msg; /* error msg (unused) */ 289 struct mz_internal_state *state; /* internal state, allocated by zalloc/zfree */ 290 291 mz_alloc_func zalloc; /* optional heap allocation function (defaults to malloc) */ 292 mz_free_func zfree; /* optional heap free function (defaults to free) */ 293 void *opaque; /* heap alloc function user pointer */ 294 295 int data_type; /* data_type (unused) */ 296 mz_ulong adler; /* adler32 of the source or uncompressed data */ 297 mz_ulong reserved; /* not used */ 298 } mz_stream; 299 300 typedef mz_stream *mz_streamp; 301 302 /* Returns the version string of miniz.c. */ 303 const char *mz_version(void); 304 305 /* mz_deflateInit() initializes a compressor with default options: */ 306 /* Parameters: */ 307 /* pStream must point to an initialized mz_stream struct. */ 308 /* level must be between [MZ_NO_COMPRESSION, MZ_BEST_COMPRESSION]. */ 309 /* level 1 enables a specially optimized compression function that's been optimized purely for performance, not ratio. */ 310 /* (This special func. is currently only enabled when MINIZ_USE_UNALIGNED_LOADS_AND_STORES and MINIZ_LITTLE_ENDIAN are defined.) */ 311 /* Return values: */ 312 /* MZ_OK on success. */ 313 /* MZ_STREAM_ERROR if the stream is bogus. */ 314 /* MZ_PARAM_ERROR if the input parameters are bogus. */ 315 /* MZ_MEM_ERROR on out of memory. */ 316 int mz_deflateInit(mz_streamp pStream, int level); 317 318 /* mz_deflateInit2() is like mz_deflate(), except with more control: */ 319 /* Additional parameters: */ 320 /* method must be MZ_DEFLATED */ 321 /* 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) */ 322 /* mem_level must be between [1, 9] (it's checked but ignored by miniz.c) */ 323 int mz_deflateInit2(mz_streamp pStream, int level, int method, int window_bits, int mem_level, int strategy); 324 325 /* Quickly resets a compressor without having to reallocate anything. Same as calling mz_deflateEnd() followed by mz_deflateInit()/mz_deflateInit2(). */ 326 int mz_deflateReset(mz_streamp pStream); 327 328 /* mz_deflate() compresses the input to output, consuming as much of the input and producing as much output as possible. */ 329 /* Parameters: */ 330 /* 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. */ 331 /* flush may be MZ_NO_FLUSH, MZ_PARTIAL_FLUSH/MZ_SYNC_FLUSH, MZ_FULL_FLUSH, or MZ_FINISH. */ 332 /* Return values: */ 333 /* 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). */ 334 /* 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. */ 335 /* MZ_STREAM_ERROR if the stream is bogus. */ 336 /* MZ_PARAM_ERROR if one of the parameters is invalid. */ 337 /* 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.) */ 338 int mz_deflate(mz_streamp pStream, int flush); 339 340 /* mz_deflateEnd() deinitializes a compressor: */ 341 /* Return values: */ 342 /* MZ_OK on success. */ 343 /* MZ_STREAM_ERROR if the stream is bogus. */ 344 int mz_deflateEnd(mz_streamp pStream); 345 346 /* 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. */ 347 mz_ulong mz_deflateBound(mz_streamp pStream, mz_ulong source_len); 348 349 /* Single-call compression functions mz_compress() and mz_compress2(): */ 350 /* Returns MZ_OK on success, or one of the error codes from mz_deflate() on failure. */ 351 int mz_compress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len); 352 int mz_compress2(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len, int level); 353 354 /* mz_compressBound() returns a (very) conservative upper bound on the amount of data that could be generated by calling mz_compress(). */ 355 mz_ulong mz_compressBound(mz_ulong source_len); 356 357 /* Initializes a decompressor. */ 358 int mz_inflateInit(mz_streamp pStream); 359 360 /* 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: */ 361 /* window_bits must be MZ_DEFAULT_WINDOW_BITS (to parse zlib header/footer) or -MZ_DEFAULT_WINDOW_BITS (raw deflate). */ 362 int mz_inflateInit2(mz_streamp pStream, int window_bits); 363 364 /* 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. */ 365 /* Parameters: */ 366 /* 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. */ 367 /* flush may be MZ_NO_FLUSH, MZ_SYNC_FLUSH, or MZ_FINISH. */ 368 /* 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). */ 369 /* 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. */ 370 /* Return values: */ 371 /* 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. */ 372 /* 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. */ 373 /* MZ_STREAM_ERROR if the stream is bogus. */ 374 /* MZ_DATA_ERROR if the deflate stream is invalid. */ 375 /* MZ_PARAM_ERROR if one of the parameters is invalid. */ 376 /* 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 */ 377 /* with more input data, or with more room in the output buffer (except when using single call decompression, described above). */ 378 int mz_inflate(mz_streamp pStream, int flush); 379 380 /* Deinitializes a decompressor. */ 381 int mz_inflateEnd(mz_streamp pStream); 382 383 /* Single-call decompression. */ 384 /* Returns MZ_OK on success, or one of the error codes from mz_inflate() on failure. */ 385 int mz_uncompress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len); 386 387 /* Returns a string description of the specified error code, or NULL if the error code is invalid. */ 388 const char *mz_error(int err); 389 390 /* 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. */ 391 /* Define MINIZ_NO_ZLIB_COMPATIBLE_NAMES to disable zlib-compatibility if you use zlib in the same project. */ 392 #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES 393 typedef unsigned char Byte; 394 typedef unsigned int uInt; 395 typedef mz_ulong uLong; 396 typedef Byte Bytef; 397 typedef uInt uIntf; 398 typedef char charf; 399 typedef int intf; 400 typedef void *voidpf; 401 typedef uLong uLongf; 402 typedef void *voidp; 403 typedef void *const voidpc; 404 #define Z_NULL 0 405 #define Z_NO_FLUSH MZ_NO_FLUSH 406 #define Z_PARTIAL_FLUSH MZ_PARTIAL_FLUSH 407 #define Z_SYNC_FLUSH MZ_SYNC_FLUSH 408 #define Z_FULL_FLUSH MZ_FULL_FLUSH 409 #define Z_FINISH MZ_FINISH 410 #define Z_BLOCK MZ_BLOCK 411 #define Z_OK MZ_OK 412 #define Z_STREAM_END MZ_STREAM_END 413 #define Z_NEED_DICT MZ_NEED_DICT 414 #define Z_ERRNO MZ_ERRNO 415 #define Z_STREAM_ERROR MZ_STREAM_ERROR 416 #define Z_DATA_ERROR MZ_DATA_ERROR 417 #define Z_MEM_ERROR MZ_MEM_ERROR 418 #define Z_BUF_ERROR MZ_BUF_ERROR 419 #define Z_VERSION_ERROR MZ_VERSION_ERROR 420 #define Z_PARAM_ERROR MZ_PARAM_ERROR 421 #define Z_NO_COMPRESSION MZ_NO_COMPRESSION 422 #define Z_BEST_SPEED MZ_BEST_SPEED 423 #define Z_BEST_COMPRESSION MZ_BEST_COMPRESSION 424 #define Z_DEFAULT_COMPRESSION MZ_DEFAULT_COMPRESSION 425 #define Z_DEFAULT_STRATEGY MZ_DEFAULT_STRATEGY 426 #define Z_FILTERED MZ_FILTERED 427 #define Z_HUFFMAN_ONLY MZ_HUFFMAN_ONLY 428 #define Z_RLE MZ_RLE 429 #define Z_FIXED MZ_FIXED 430 #define Z_DEFLATED MZ_DEFLATED 431 #define Z_DEFAULT_WINDOW_BITS MZ_DEFAULT_WINDOW_BITS 432 #define alloc_func mz_alloc_func 433 #define free_func mz_free_func 434 #define internal_state mz_internal_state 435 #define z_stream mz_stream 436 #define deflateInit mz_deflateInit 437 #define deflateInit2 mz_deflateInit2 438 #define deflateReset mz_deflateReset 439 #define deflate mz_deflate 440 #define deflateEnd mz_deflateEnd 441 #define deflateBound mz_deflateBound 442 #define compress mz_compress 443 #define compress2 mz_compress2 444 #define compressBound mz_compressBound 445 #define inflateInit mz_inflateInit 446 #define inflateInit2 mz_inflateInit2 447 #define inflate mz_inflate 448 #define inflateEnd mz_inflateEnd 449 #define uncompress mz_uncompress 450 #define crc32 mz_crc32 451 #define adler32 mz_adler32 452 #define MAX_WBITS 15 453 #define MAX_MEM_LEVEL 9 454 #define zError mz_error 455 #define ZLIB_VERSION MZ_VERSION 456 #define ZLIB_VERNUM MZ_VERNUM 457 #define ZLIB_VER_MAJOR MZ_VER_MAJOR 458 #define ZLIB_VER_MINOR MZ_VER_MINOR 459 #define ZLIB_VER_REVISION MZ_VER_REVISION 460 #define ZLIB_VER_SUBREVISION MZ_VER_SUBREVISION 461 #define zlibVersion mz_version 462 #define zlib_version mz_version() 463 #endif /* #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES */ 464 465 #endif /* MINIZ_NO_ZLIB_APIS */ 466 467 #ifdef __cplusplus 468 } 469 #endif 470 #pragma once 471 #include <assert.h> 472 #include <stdint.h> 473 #include <stdlib.h> 474 #include <string.h> 475 476 /* ------------------- Types and macros */ 477 typedef unsigned char mz_uint8; 478 typedef signed short mz_int16; 479 typedef unsigned short mz_uint16; 480 typedef unsigned int mz_uint32; 481 typedef unsigned int mz_uint; 482 typedef int64_t mz_int64; 483 typedef uint64_t mz_uint64; 484 typedef int mz_bool; 485 486 #define MZ_FALSE (0) 487 #define MZ_TRUE (1) 488 489 /* Works around MSVC's spammy "warning C4127: conditional expression is constant" message. */ 490 #ifdef _MSC_VER 491 #define MZ_MACRO_END while (0, 0) 492 #else 493 #define MZ_MACRO_END while (0) 494 #endif 495 496 #ifdef MINIZ_NO_STDIO 497 #define MZ_FILE void * 498 #else 499 #include <stdio.h> 500 #define MZ_FILE FILE 501 #endif /* #ifdef MINIZ_NO_STDIO */ 502 503 #ifdef MINIZ_NO_TIME 504 typedef struct mz_dummy_time_t_tag 505 { 506 int m_dummy; 507 } mz_dummy_time_t; 508 #define MZ_TIME_T mz_dummy_time_t 509 #else 510 #define MZ_TIME_T time_t 511 #endif 512 513 #define MZ_ASSERT(x) assert(x) 514 515 #ifdef MINIZ_NO_MALLOC 516 #define MZ_MALLOC(x) NULL 517 #define MZ_FREE(x) (void)x, ((void)0) 518 #define MZ_REALLOC(p, x) NULL 519 #else 520 #define MZ_MALLOC(x) malloc(x) 521 #define MZ_FREE(x) free(x) 522 #define MZ_REALLOC(p, x) realloc(p, x) 523 #endif 524 525 #define MZ_MAX(a, b) (((a) > (b)) ? (a) : (b)) 526 #define MZ_MIN(a, b) (((a) < (b)) ? (a) : (b)) 527 #define MZ_CLEAR_OBJ(obj) memset(&(obj), 0, sizeof(obj)) 528 529 #if MINIZ_USE_UNALIGNED_LOADS_AND_STORES && MINIZ_LITTLE_ENDIAN 530 #define MZ_READ_LE16(p) *((const mz_uint16 *)(p)) 531 #define MZ_READ_LE32(p) *((const mz_uint32 *)(p)) 532 #else 533 #define MZ_READ_LE16(p) ((mz_uint32)(((const mz_uint8 *)(p))[0]) | ((mz_uint32)(((const mz_uint8 *)(p))[1]) << 8U)) 534 #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)) 535 #endif 536 537 #define MZ_READ_LE64(p) (((mz_uint64)MZ_READ_LE32(p)) | (((mz_uint64)MZ_READ_LE32((const mz_uint8 *)(p) + sizeof(mz_uint32))) << 32U)) 538 539 #ifdef _MSC_VER 540 #define MZ_FORCEINLINE __forceinline 541 #elif defined(__GNUC__) 542 #define MZ_FORCEINLINE __inline__ __attribute__((__always_inline__)) 543 #else 544 #define MZ_FORCEINLINE inline 545 #endif 546 547 #ifdef __cplusplus 548 extern "C" { 549 #endif 550 551 extern void *miniz_def_alloc_func(void *opaque, size_t items, size_t size); 552 extern void miniz_def_free_func(void *opaque, void *address); 553 extern void *miniz_def_realloc_func(void *opaque, void *address, size_t items, size_t size); 554 555 #define MZ_UINT16_MAX (0xFFFFU) 556 #define MZ_UINT32_MAX (0xFFFFFFFFU) 557 558 #ifdef __cplusplus 559 } 560 #endif 561 #pragma once 562 563 564 #ifdef __cplusplus 565 extern "C" { 566 #endif 567 /* ------------------- Low-level Compression API Definitions */ 568 569 /* Set TDEFL_LESS_MEMORY to 1 to use less memory (compression will be slightly slower, and raw/dynamic blocks will be output more frequently). */ 570 #define TDEFL_LESS_MEMORY 0 571 572 /* tdefl_init() compression flags logically OR'd together (low 12 bits contain the max. number of probes per dictionary search): */ 573 /* 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). */ 574 enum 575 { 576 TDEFL_HUFFMAN_ONLY = 0, 577 TDEFL_DEFAULT_MAX_PROBES = 128, 578 TDEFL_MAX_PROBES_MASK = 0xFFF 579 }; 580 581 /* 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. */ 582 /* TDEFL_COMPUTE_ADLER32: Always compute the adler-32 of the input data (even when not writing zlib headers). */ 583 /* TDEFL_GREEDY_PARSING_FLAG: Set to use faster greedy parsing, instead of more efficient lazy parsing. */ 584 /* 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). */ 585 /* TDEFL_RLE_MATCHES: Only look for RLE matches (matches with a distance of 1) */ 586 /* TDEFL_FILTER_MATCHES: Discards matches <= 5 chars if enabled. */ 587 /* TDEFL_FORCE_ALL_STATIC_BLOCKS: Disable usage of optimized Huffman tables. */ 588 /* TDEFL_FORCE_ALL_RAW_BLOCKS: Only use raw (uncompressed) deflate blocks. */ 589 /* The low 12 bits are reserved to control the max # of hash probes per dictionary lookup (see TDEFL_MAX_PROBES_MASK). */ 590 enum 591 { 592 TDEFL_WRITE_ZLIB_HEADER = 0x01000, 593 TDEFL_COMPUTE_ADLER32 = 0x02000, 594 TDEFL_GREEDY_PARSING_FLAG = 0x04000, 595 TDEFL_NONDETERMINISTIC_PARSING_FLAG = 0x08000, 596 TDEFL_RLE_MATCHES = 0x10000, 597 TDEFL_FILTER_MATCHES = 0x20000, 598 TDEFL_FORCE_ALL_STATIC_BLOCKS = 0x40000, 599 TDEFL_FORCE_ALL_RAW_BLOCKS = 0x80000 600 }; 601 602 /* High level compression functions: */ 603 /* tdefl_compress_mem_to_heap() compresses a block in memory to a heap block allocated via malloc(). */ 604 /* On entry: */ 605 /* pSrc_buf, src_buf_len: Pointer and size of source block to compress. */ 606 /* flags: The max match finder probes (default is 128) logically OR'd against the above flags. Higher probes are slower but improve compression. */ 607 /* On return: */ 608 /* Function returns a pointer to the compressed data, or NULL on failure. */ 609 /* *pOut_len will be set to the compressed data's size, which could be larger than src_buf_len on uncompressible data. */ 610 /* The caller must free() the returned block when it's no longer needed. */ 611 void *tdefl_compress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); 612 613 /* tdefl_compress_mem_to_mem() compresses a block in memory to another block in memory. */ 614 /* Returns 0 on failure. */ 615 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); 616 617 /* Compresses an image to a compressed PNG file in memory. */ 618 /* On entry: */ 619 /* pImage, w, h, and num_chans describe the image to compress. num_chans may be 1, 2, 3, or 4. */ 620 /* The image pitch in bytes per scanline will be w*num_chans. The leftmost pixel on the top scanline is stored first in memory. */ 621 /* 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 */ 622 /* If flip is true, the image will be flipped on the Y axis (useful for OpenGL apps). */ 623 /* On return: */ 624 /* Function returns a pointer to the compressed data, or NULL on failure. */ 625 /* *pLen_out will be set to the size of the PNG image file. */ 626 /* The caller must mz_free() the returned heap block (which will typically be larger than *pLen_out) when it's no longer needed. */ 627 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); 628 void *tdefl_write_image_to_png_file_in_memory(const void *pImage, int w, int h, int num_chans, size_t *pLen_out); 629 630 /* Output stream interface. The compressor uses this interface to write compressed data. It'll typically be called TDEFL_OUT_BUF_SIZE at a time. */ 631 typedef mz_bool (*tdefl_put_buf_func_ptr)(const void *pBuf, int len, void *pUser); 632 633 /* tdefl_compress_mem_to_output() compresses a block to an output stream. The above helpers use this function internally. */ 634 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); 635 636 enum 637 { 638 TDEFL_MAX_HUFF_TABLES = 3, 639 TDEFL_MAX_HUFF_SYMBOLS_0 = 288, 640 TDEFL_MAX_HUFF_SYMBOLS_1 = 32, 641 TDEFL_MAX_HUFF_SYMBOLS_2 = 19, 642 TDEFL_LZ_DICT_SIZE = 32768, 643 TDEFL_LZ_DICT_SIZE_MASK = TDEFL_LZ_DICT_SIZE - 1, 644 TDEFL_MIN_MATCH_LEN = 3, 645 TDEFL_MAX_MATCH_LEN = 258 646 }; 647 648 /* TDEFL_OUT_BUF_SIZE MUST be large enough to hold a single entire compressed output block (using static/fixed Huffman codes). */ 649 #if TDEFL_LESS_MEMORY 650 enum 651 { 652 TDEFL_LZ_CODE_BUF_SIZE = 24 * 1024, 653 TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13) / 10, 654 TDEFL_MAX_HUFF_SYMBOLS = 288, 655 TDEFL_LZ_HASH_BITS = 12, 656 TDEFL_LEVEL1_HASH_SIZE_MASK = 4095, 657 TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3, 658 TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS 659 }; 660 #else 661 enum 662 { 663 TDEFL_LZ_CODE_BUF_SIZE = 64 * 1024, 664 TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13) / 10, 665 TDEFL_MAX_HUFF_SYMBOLS = 288, 666 TDEFL_LZ_HASH_BITS = 15, 667 TDEFL_LEVEL1_HASH_SIZE_MASK = 4095, 668 TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3, 669 TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS 670 }; 671 #endif 672 673 /* 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. */ 674 typedef enum { 675 TDEFL_STATUS_BAD_PARAM = -2, 676 TDEFL_STATUS_PUT_BUF_FAILED = -1, 677 TDEFL_STATUS_OKAY = 0, 678 TDEFL_STATUS_DONE = 1 679 } tdefl_status; 680 681 /* Must map to MZ_NO_FLUSH, MZ_SYNC_FLUSH, etc. enums */ 682 typedef enum { 683 TDEFL_NO_FLUSH = 0, 684 TDEFL_SYNC_FLUSH = 2, 685 TDEFL_FULL_FLUSH = 3, 686 TDEFL_FINISH = 4 687 } tdefl_flush; 688 689 /* tdefl's compression state structure. */ 690 typedef struct 691 { 692 tdefl_put_buf_func_ptr m_pPut_buf_func; 693 void *m_pPut_buf_user; 694 mz_uint m_flags, m_max_probes[2]; 695 int m_greedy_parsing; 696 mz_uint m_adler32, m_lookahead_pos, m_lookahead_size, m_dict_size; 697 mz_uint8 *m_pLZ_code_buf, *m_pLZ_flags, *m_pOutput_buf, *m_pOutput_buf_end; 698 mz_uint m_num_flags_left, m_total_lz_bytes, m_lz_code_buf_dict_pos, m_bits_in, m_bit_buffer; 699 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; 700 tdefl_status m_prev_return_status; 701 const void *m_pIn_buf; 702 void *m_pOut_buf; 703 size_t *m_pIn_buf_size, *m_pOut_buf_size; 704 tdefl_flush m_flush; 705 const mz_uint8 *m_pSrc; 706 size_t m_src_buf_left, m_out_buf_ofs; 707 mz_uint8 m_dict[TDEFL_LZ_DICT_SIZE + TDEFL_MAX_MATCH_LEN - 1]; 708 mz_uint16 m_huff_count[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 709 mz_uint16 m_huff_codes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 710 mz_uint8 m_huff_code_sizes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 711 mz_uint8 m_lz_code_buf[TDEFL_LZ_CODE_BUF_SIZE]; 712 mz_uint16 m_next[TDEFL_LZ_DICT_SIZE]; 713 mz_uint16 m_hash[TDEFL_LZ_HASH_SIZE]; 714 mz_uint8 m_output_buf[TDEFL_OUT_BUF_SIZE]; 715 } tdefl_compressor; 716 717 /* Initializes the compressor. */ 718 /* There is no corresponding deinit() function because the tdefl API's do not dynamically allocate memory. */ 719 /* 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. */ 720 /* If pBut_buf_func is NULL the user should always call the tdefl_compress() API. */ 721 /* flags: See the above enums (TDEFL_HUFFMAN_ONLY, TDEFL_WRITE_ZLIB_HEADER, etc.) */ 722 tdefl_status tdefl_init(tdefl_compressor *d, tdefl_put_buf_func_ptr pPut_buf_func, void *pPut_buf_user, int flags); 723 724 /* 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. */ 725 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); 726 727 /* tdefl_compress_buffer() is only usable when the tdefl_init() is called with a non-NULL tdefl_put_buf_func_ptr. */ 728 /* tdefl_compress_buffer() always consumes the entire input buffer. */ 729 tdefl_status tdefl_compress_buffer(tdefl_compressor *d, const void *pIn_buf, size_t in_buf_size, tdefl_flush flush); 730 731 tdefl_status tdefl_get_prev_return_status(tdefl_compressor *d); 732 mz_uint32 tdefl_get_adler32(tdefl_compressor *d); 733 734 /* Create tdefl_compress() flags given zlib-style compression parameters. */ 735 /* level may range from [0,10] (where 10 is absolute max compression, but may be much slower on some files) */ 736 /* window_bits may be -15 (raw deflate) or 15 (zlib) */ 737 /* strategy may be either MZ_DEFAULT_STRATEGY, MZ_FILTERED, MZ_HUFFMAN_ONLY, MZ_RLE, or MZ_FIXED */ 738 mz_uint tdefl_create_comp_flags_from_zip_params(int level, int window_bits, int strategy); 739 740 /* Allocate the tdefl_compressor structure in C so that */ 741 /* non-C language bindings to tdefl_ API don't need to worry about */ 742 /* structure size and allocation mechanism. */ 743 tdefl_compressor *tdefl_compressor_alloc(); 744 void tdefl_compressor_free(tdefl_compressor *pComp); 745 746 #ifdef __cplusplus 747 } 748 #endif 749 #pragma once 750 751 /* ------------------- Low-level Decompression API Definitions */ 752 753 #ifdef __cplusplus 754 extern "C" { 755 #endif 756 /* Decompression flags used by tinfl_decompress(). */ 757 /* 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. */ 758 /* 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. */ 759 /* 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). */ 760 /* TINFL_FLAG_COMPUTE_ADLER32: Force adler-32 checksum computation of the decompressed bytes. */ 761 enum 762 { 763 TINFL_FLAG_PARSE_ZLIB_HEADER = 1, 764 TINFL_FLAG_HAS_MORE_INPUT = 2, 765 TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF = 4, 766 TINFL_FLAG_COMPUTE_ADLER32 = 8 767 }; 768 769 /* High level decompression functions: */ 770 /* tinfl_decompress_mem_to_heap() decompresses a block in memory to a heap block allocated via malloc(). */ 771 /* On entry: */ 772 /* pSrc_buf, src_buf_len: Pointer and size of the Deflate or zlib source data to decompress. */ 773 /* On return: */ 774 /* Function returns a pointer to the decompressed data, or NULL on failure. */ 775 /* *pOut_len will be set to the decompressed data's size, which could be larger than src_buf_len on uncompressible data. */ 776 /* The caller must call mz_free() on the returned block when it's no longer needed. */ 777 void *tinfl_decompress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); 778 779 /* tinfl_decompress_mem_to_mem() decompresses a block in memory to another block in memory. */ 780 /* Returns TINFL_DECOMPRESS_MEM_TO_MEM_FAILED on failure, or the number of bytes written on success. */ 781 #define TINFL_DECOMPRESS_MEM_TO_MEM_FAILED ((size_t)(-1)) 782 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); 783 784 /* 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. */ 785 /* Returns 1 on success or 0 on failure. */ 786 typedef int (*tinfl_put_buf_func_ptr)(const void *pBuf, int len, void *pUser); 787 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); 788 789 struct tinfl_decompressor_tag; 790 typedef struct tinfl_decompressor_tag tinfl_decompressor; 791 792 /* Allocate the tinfl_decompressor structure in C so that */ 793 /* non-C language bindings to tinfl_ API don't need to worry about */ 794 /* structure size and allocation mechanism. */ 795 796 tinfl_decompressor *tinfl_decompressor_alloc(); 797 void tinfl_decompressor_free(tinfl_decompressor *pDecomp); 798 799 /* Max size of LZ dictionary. */ 800 #define TINFL_LZ_DICT_SIZE 32768 801 802 /* Return status. */ 803 typedef enum { 804 /* 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 */ 805 /* 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). */ 806 /* If you call it again with no input you'll just get TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS again. */ 807 TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS = -4, 808 809 /* 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.) */ 810 TINFL_STATUS_BAD_PARAM = -3, 811 812 /* 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. */ 813 TINFL_STATUS_ADLER32_MISMATCH = -2, 814 815 /* 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. */ 816 TINFL_STATUS_FAILED = -1, 817 818 /* Any status code less than TINFL_STATUS_DONE must indicate a failure. */ 819 820 /* 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 */ 821 /* 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. */ 822 TINFL_STATUS_DONE = 0, 823 824 /* 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 */ 825 /* 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 */ 826 /* proceed, so be sure to properly set the TINFL_FLAG_HAS_MORE_INPUT flag. */ 827 TINFL_STATUS_NEEDS_MORE_INPUT = 1, 828 829 /* 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. */ 830 /* 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 */ 831 /* (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 */ 832 /* so I may need to add some code to address this. */ 833 TINFL_STATUS_HAS_MORE_OUTPUT = 2 834 } tinfl_status; 835 836 /* Initializes the decompressor to its initial state. */ 837 #define tinfl_init(r) \ 838 do \ 839 { \ 840 (r)->m_state = 0; \ 841 } \ 842 MZ_MACRO_END 843 #define tinfl_get_adler32(r) (r)->m_check_adler32 844 845 /* 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. */ 846 /* 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. */ 847 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); 848 849 /* Internal/private bits follow. */ 850 enum 851 { 852 TINFL_MAX_HUFF_TABLES = 3, 853 TINFL_MAX_HUFF_SYMBOLS_0 = 288, 854 TINFL_MAX_HUFF_SYMBOLS_1 = 32, 855 TINFL_MAX_HUFF_SYMBOLS_2 = 19, 856 TINFL_FAST_LOOKUP_BITS = 10, 857 TINFL_FAST_LOOKUP_SIZE = 1 << TINFL_FAST_LOOKUP_BITS 858 }; 859 860 typedef struct 861 { 862 mz_uint8 m_code_size[TINFL_MAX_HUFF_SYMBOLS_0]; 863 mz_int16 m_look_up[TINFL_FAST_LOOKUP_SIZE], m_tree[TINFL_MAX_HUFF_SYMBOLS_0 * 2]; 864 } tinfl_huff_table; 865 866 #if MINIZ_HAS_64BIT_REGISTERS 867 #define TINFL_USE_64BIT_BITBUF 1 868 #else 869 #define TINFL_USE_64BIT_BITBUF 0 870 #endif 871 872 #if TINFL_USE_64BIT_BITBUF 873 typedef mz_uint64 tinfl_bit_buf_t; 874 #define TINFL_BITBUF_SIZE (64) 875 #else 876 typedef mz_uint32 tinfl_bit_buf_t; 877 #define TINFL_BITBUF_SIZE (32) 878 #endif 879 880 struct tinfl_decompressor_tag 881 { 882 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]; 883 tinfl_bit_buf_t m_bit_buf; 884 size_t m_dist_from_out_buf_start; 885 tinfl_huff_table m_tables[TINFL_MAX_HUFF_TABLES]; 886 mz_uint8 m_raw_header[4], m_len_codes[TINFL_MAX_HUFF_SYMBOLS_0 + TINFL_MAX_HUFF_SYMBOLS_1 + 137]; 887 }; 888 889 #ifdef __cplusplus 890 } 891 #endif 892 893 #pragma once 894 895 896 /* ------------------- ZIP archive reading/writing */ 897 898 #ifndef MINIZ_NO_ARCHIVE_APIS 899 900 #ifdef __cplusplus 901 extern "C" { 902 #endif 903 904 enum 905 { 906 /* Note: These enums can be reduced as needed to save memory or stack space - they are pretty conservative. */ 907 MZ_ZIP_MAX_IO_BUF_SIZE = 64 * 1024, 908 MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE = 512, 909 MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE = 512 910 }; 911 912 typedef struct 913 { 914 /* Central directory file index. */ 915 mz_uint32 m_file_index; 916 917 /* 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. */ 918 mz_uint64 m_central_dir_ofs; 919 920 /* These fields are copied directly from the zip's central dir. */ 921 mz_uint16 m_version_made_by; 922 mz_uint16 m_version_needed; 923 mz_uint16 m_bit_flag; 924 mz_uint16 m_method; 925 926 #ifndef MINIZ_NO_TIME 927 MZ_TIME_T m_time; 928 #endif 929 930 /* CRC-32 of uncompressed data. */ 931 mz_uint32 m_crc32; 932 933 /* File's compressed size. */ 934 mz_uint64 m_comp_size; 935 936 /* 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. */ 937 mz_uint64 m_uncomp_size; 938 939 /* Zip internal and external file attributes. */ 940 mz_uint16 m_internal_attr; 941 mz_uint32 m_external_attr; 942 943 /* Entry's local header file offset in bytes. */ 944 mz_uint64 m_local_header_ofs; 945 946 /* Size of comment in bytes. */ 947 mz_uint32 m_comment_size; 948 949 /* MZ_TRUE if the entry appears to be a directory. */ 950 mz_bool m_is_directory; 951 952 /* MZ_TRUE if the entry uses encryption/strong encryption (which miniz_zip doesn't support) */ 953 mz_bool m_is_encrypted; 954 955 /* MZ_TRUE if the file is not encrypted, a patch file, and if it uses a compression method we support. */ 956 mz_bool m_is_supported; 957 958 /* Filename. If string ends in '/' it's a subdirectory entry. */ 959 /* Guaranteed to be zero terminated, may be truncated to fit. */ 960 char m_filename[MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE]; 961 962 /* Comment field. */ 963 /* Guaranteed to be zero terminated, may be truncated to fit. */ 964 char m_comment[MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE]; 965 966 } mz_zip_archive_file_stat; 967 968 typedef size_t (*mz_file_read_func)(void *pOpaque, mz_uint64 file_ofs, void *pBuf, size_t n); 969 typedef size_t (*mz_file_write_func)(void *pOpaque, mz_uint64 file_ofs, const void *pBuf, size_t n); 970 typedef mz_bool (*mz_file_needs_keepalive)(void *pOpaque); 971 972 struct mz_zip_internal_state_tag; 973 typedef struct mz_zip_internal_state_tag mz_zip_internal_state; 974 975 typedef enum { 976 MZ_ZIP_MODE_INVALID = 0, 977 MZ_ZIP_MODE_READING = 1, 978 MZ_ZIP_MODE_WRITING = 2, 979 MZ_ZIP_MODE_WRITING_HAS_BEEN_FINALIZED = 3 980 } mz_zip_mode; 981 982 typedef enum { 983 MZ_ZIP_FLAG_CASE_SENSITIVE = 0x0100, 984 MZ_ZIP_FLAG_IGNORE_PATH = 0x0200, 985 MZ_ZIP_FLAG_COMPRESSED_DATA = 0x0400, 986 MZ_ZIP_FLAG_DO_NOT_SORT_CENTRAL_DIRECTORY = 0x0800, 987 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) */ 988 MZ_ZIP_FLAG_VALIDATE_HEADERS_ONLY = 0x2000, /* validate the local headers, but don't decompress the entire file and check the crc32 */ 989 MZ_ZIP_FLAG_WRITE_ZIP64 = 0x4000, /* always use the zip64 file format, instead of the original zip file format with automatic switch to zip64. Use as flags parameter with mz_zip_writer_init*_v2 */ 990 MZ_ZIP_FLAG_WRITE_ALLOW_READING = 0x8000, 991 MZ_ZIP_FLAG_ASCII_FILENAME = 0x10000 992 } mz_zip_flags; 993 994 typedef enum { 995 MZ_ZIP_TYPE_INVALID = 0, 996 MZ_ZIP_TYPE_USER, 997 MZ_ZIP_TYPE_MEMORY, 998 MZ_ZIP_TYPE_HEAP, 999 MZ_ZIP_TYPE_FILE, 1000 MZ_ZIP_TYPE_CFILE, 1001 MZ_ZIP_TOTAL_TYPES 1002 } mz_zip_type; 1003 1004 /* miniz error codes. Be sure to update mz_zip_get_error_string() if you add or modify this enum. */ 1005 typedef enum { 1006 MZ_ZIP_NO_ERROR = 0, 1007 MZ_ZIP_UNDEFINED_ERROR, 1008 MZ_ZIP_TOO_MANY_FILES, 1009 MZ_ZIP_FILE_TOO_LARGE, 1010 MZ_ZIP_UNSUPPORTED_METHOD, 1011 MZ_ZIP_UNSUPPORTED_ENCRYPTION, 1012 MZ_ZIP_UNSUPPORTED_FEATURE, 1013 MZ_ZIP_FAILED_FINDING_CENTRAL_DIR, 1014 MZ_ZIP_NOT_AN_ARCHIVE, 1015 MZ_ZIP_INVALID_HEADER_OR_CORRUPTED, 1016 MZ_ZIP_UNSUPPORTED_MULTIDISK, 1017 MZ_ZIP_DECOMPRESSION_FAILED, 1018 MZ_ZIP_COMPRESSION_FAILED, 1019 MZ_ZIP_UNEXPECTED_DECOMPRESSED_SIZE, 1020 MZ_ZIP_CRC_CHECK_FAILED, 1021 MZ_ZIP_UNSUPPORTED_CDIR_SIZE, 1022 MZ_ZIP_ALLOC_FAILED, 1023 MZ_ZIP_FILE_OPEN_FAILED, 1024 MZ_ZIP_FILE_CREATE_FAILED, 1025 MZ_ZIP_FILE_WRITE_FAILED, 1026 MZ_ZIP_FILE_READ_FAILED, 1027 MZ_ZIP_FILE_CLOSE_FAILED, 1028 MZ_ZIP_FILE_SEEK_FAILED, 1029 MZ_ZIP_FILE_STAT_FAILED, 1030 MZ_ZIP_INVALID_PARAMETER, 1031 MZ_ZIP_INVALID_FILENAME, 1032 MZ_ZIP_BUF_TOO_SMALL, 1033 MZ_ZIP_INTERNAL_ERROR, 1034 MZ_ZIP_FILE_NOT_FOUND, 1035 MZ_ZIP_ARCHIVE_TOO_LARGE, 1036 MZ_ZIP_VALIDATION_FAILED, 1037 MZ_ZIP_WRITE_CALLBACK_FAILED, 1038 MZ_ZIP_TOTAL_ERRORS 1039 } mz_zip_error; 1040 1041 typedef struct 1042 { 1043 mz_uint64 m_archive_size; 1044 mz_uint64 m_central_directory_file_ofs; 1045 1046 /* We only support up to UINT32_MAX files in zip64 mode. */ 1047 mz_uint32 m_total_files; 1048 mz_zip_mode m_zip_mode; 1049 mz_zip_type m_zip_type; 1050 mz_zip_error m_last_error; 1051 1052 mz_uint64 m_file_offset_alignment; 1053 1054 mz_alloc_func m_pAlloc; 1055 mz_free_func m_pFree; 1056 mz_realloc_func m_pRealloc; 1057 void *m_pAlloc_opaque; 1058 1059 mz_file_read_func m_pRead; 1060 mz_file_write_func m_pWrite; 1061 mz_file_needs_keepalive m_pNeeds_keepalive; 1062 void *m_pIO_opaque; 1063 1064 mz_zip_internal_state *m_pState; 1065 1066 } mz_zip_archive; 1067 1068 typedef struct 1069 { 1070 mz_zip_archive *pZip; 1071 mz_uint flags; 1072 1073 int status; 1074 #ifndef MINIZ_DISABLE_ZIP_READER_CRC32_CHECKS 1075 mz_uint file_crc32; 1076 #endif 1077 mz_uint64 read_buf_size, read_buf_ofs, read_buf_avail, comp_remaining, out_buf_ofs, cur_file_ofs; 1078 mz_zip_archive_file_stat file_stat; 1079 void *pRead_buf; 1080 void *pWrite_buf; 1081 1082 size_t out_blk_remain; 1083 1084 tinfl_decompressor inflator; 1085 1086 } mz_zip_reader_extract_iter_state; 1087 1088 /* -------- ZIP reading */ 1089 1090 /* Inits a ZIP archive reader. */ 1091 /* These functions read and validate the archive's central directory. */ 1092 mz_bool mz_zip_reader_init(mz_zip_archive *pZip, mz_uint64 size, mz_uint flags); 1093 1094 mz_bool mz_zip_reader_init_mem(mz_zip_archive *pZip, const void *pMem, size_t size, mz_uint flags); 1095 1096 #ifndef MINIZ_NO_STDIO 1097 /* Read a archive from a disk file. */ 1098 /* file_start_ofs is the file offset where the archive actually begins, or 0. */ 1099 /* 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. */ 1100 mz_bool mz_zip_reader_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint32 flags); 1101 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); 1102 1103 /* Read an archive from an already opened FILE, beginning at the current file position. */ 1104 /* 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. */ 1105 /* The FILE will NOT be closed when mz_zip_reader_end() is called. */ 1106 mz_bool mz_zip_reader_init_cfile(mz_zip_archive *pZip, MZ_FILE *pFile, mz_uint64 archive_size, mz_uint flags); 1107 #endif 1108 1109 /* Ends archive reading, freeing all allocations, and closing the input archive file if mz_zip_reader_init_file() was used. */ 1110 mz_bool mz_zip_reader_end(mz_zip_archive *pZip); 1111 1112 /* -------- ZIP reading or writing */ 1113 1114 /* Clears a mz_zip_archive struct to all zeros. */ 1115 /* Important: This must be done before passing the struct to any mz_zip functions. */ 1116 void mz_zip_zero_struct(mz_zip_archive *pZip); 1117 1118 mz_zip_mode mz_zip_get_mode(mz_zip_archive *pZip); 1119 mz_zip_type mz_zip_get_type(mz_zip_archive *pZip); 1120 1121 /* Returns the total number of files in the archive. */ 1122 mz_uint mz_zip_reader_get_num_files(mz_zip_archive *pZip); 1123 1124 mz_uint64 mz_zip_get_archive_size(mz_zip_archive *pZip); 1125 mz_uint64 mz_zip_get_archive_file_start_offset(mz_zip_archive *pZip); 1126 MZ_FILE *mz_zip_get_cfile(mz_zip_archive *pZip); 1127 1128 /* Reads n bytes of raw archive data, starting at file offset file_ofs, to pBuf. */ 1129 size_t mz_zip_read_archive_data(mz_zip_archive *pZip, mz_uint64 file_ofs, void *pBuf, size_t n); 1130 1131 /* All mz_zip funcs set the m_last_error field in the mz_zip_archive struct. These functions retrieve/manipulate this field. */ 1132 /* Note that the m_last_error functionality is not thread safe. */ 1133 mz_zip_error mz_zip_set_last_error(mz_zip_archive *pZip, mz_zip_error err_num); 1134 mz_zip_error mz_zip_peek_last_error(mz_zip_archive *pZip); 1135 mz_zip_error mz_zip_clear_last_error(mz_zip_archive *pZip); 1136 mz_zip_error mz_zip_get_last_error(mz_zip_archive *pZip); 1137 const char *mz_zip_get_error_string(mz_zip_error mz_err); 1138 1139 /* MZ_TRUE if the archive file entry is a directory entry. */ 1140 mz_bool mz_zip_reader_is_file_a_directory(mz_zip_archive *pZip, mz_uint file_index); 1141 1142 /* MZ_TRUE if the file is encrypted/strong encrypted. */ 1143 mz_bool mz_zip_reader_is_file_encrypted(mz_zip_archive *pZip, mz_uint file_index); 1144 1145 /* MZ_TRUE if the compression method is supported, and the file is not encrypted, and the file is not a compressed patch file. */ 1146 mz_bool mz_zip_reader_is_file_supported(mz_zip_archive *pZip, mz_uint file_index); 1147 1148 /* Retrieves the filename of an archive file entry. */ 1149 /* 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. */ 1150 mz_uint mz_zip_reader_get_filename(mz_zip_archive *pZip, mz_uint file_index, char *pFilename, mz_uint filename_buf_size); 1151 1152 /* Attempts to locates a file in the archive's central directory. */ 1153 /* Valid flags: MZ_ZIP_FLAG_CASE_SENSITIVE, MZ_ZIP_FLAG_IGNORE_PATH */ 1154 /* Returns -1 if the file cannot be found. */ 1155 int mz_zip_reader_locate_file(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags); 1156 int mz_zip_reader_locate_file_v2(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags, mz_uint32 *file_index); 1157 1158 /* Returns detailed information about an archive file entry. */ 1159 mz_bool mz_zip_reader_file_stat(mz_zip_archive *pZip, mz_uint file_index, mz_zip_archive_file_stat *pStat); 1160 1161 /* MZ_TRUE if the file is in zip64 format. */ 1162 /* 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. */ 1163 mz_bool mz_zip_is_zip64(mz_zip_archive *pZip); 1164 1165 /* Returns the total central directory size in bytes. */ 1166 /* The current max supported size is <= MZ_UINT32_MAX. */ 1167 size_t mz_zip_get_central_dir_size(mz_zip_archive *pZip); 1168 1169 /* Extracts a archive file to a memory buffer using no memory allocation. */ 1170 /* There must be at least enough room on the stack to store the inflator's state (~34KB or so). */ 1171 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); 1172 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); 1173 1174 /* Extracts a archive file to a memory buffer. */ 1175 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); 1176 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); 1177 1178 /* Extracts a archive file to a dynamically allocated heap buffer. */ 1179 /* The memory will be allocated via the mz_zip_archive's alloc/realloc functions. */ 1180 /* Returns NULL and sets the last error on failure. */ 1181 void *mz_zip_reader_extract_to_heap(mz_zip_archive *pZip, mz_uint file_index, size_t *pSize, mz_uint flags); 1182 void *mz_zip_reader_extract_file_to_heap(mz_zip_archive *pZip, const char *pFilename, size_t *pSize, mz_uint flags); 1183 1184 /* Extracts a archive file using a callback function to output the file's data. */ 1185 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); 1186 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); 1187 1188 /* Extract a file iteratively */ 1189 mz_zip_reader_extract_iter_state* mz_zip_reader_extract_iter_new(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags); 1190 mz_zip_reader_extract_iter_state* mz_zip_reader_extract_file_iter_new(mz_zip_archive *pZip, const char *pFilename, mz_uint flags); 1191 size_t mz_zip_reader_extract_iter_read(mz_zip_reader_extract_iter_state* pState, void* pvBuf, size_t buf_size); 1192 mz_bool mz_zip_reader_extract_iter_free(mz_zip_reader_extract_iter_state* pState); 1193 1194 #ifndef MINIZ_NO_STDIO 1195 /* Extracts a archive file to a disk file and sets its last accessed and modified times. */ 1196 /* This function only extracts files, not archive directory records. */ 1197 mz_bool mz_zip_reader_extract_to_file(mz_zip_archive *pZip, mz_uint file_index, const char *pDst_filename, mz_uint flags); 1198 mz_bool mz_zip_reader_extract_file_to_file(mz_zip_archive *pZip, const char *pArchive_filename, const char *pDst_filename, mz_uint flags); 1199 1200 /* Extracts a archive file starting at the current position in the destination FILE stream. */ 1201 mz_bool mz_zip_reader_extract_to_cfile(mz_zip_archive *pZip, mz_uint file_index, MZ_FILE *File, mz_uint flags); 1202 mz_bool mz_zip_reader_extract_file_to_cfile(mz_zip_archive *pZip, const char *pArchive_filename, MZ_FILE *pFile, mz_uint flags); 1203 #endif 1204 1205 #if 0 1206 /* TODO */ 1207 typedef void *mz_zip_streaming_extract_state_ptr; 1208 mz_zip_streaming_extract_state_ptr mz_zip_streaming_extract_begin(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags); 1209 uint64_t mz_zip_streaming_extract_get_size(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState); 1210 uint64_t mz_zip_streaming_extract_get_cur_ofs(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState); 1211 mz_bool mz_zip_streaming_extract_seek(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState, uint64_t new_ofs); 1212 size_t mz_zip_streaming_extract_read(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState, void *pBuf, size_t buf_size); 1213 mz_bool mz_zip_streaming_extract_end(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState); 1214 #endif 1215 1216 /* 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. */ 1217 /* It also validates that each file can be successfully uncompressed unless the MZ_ZIP_FLAG_VALIDATE_HEADERS_ONLY is specified. */ 1218 mz_bool mz_zip_validate_file(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags); 1219 1220 /* Validates an entire archive by calling mz_zip_validate_file() on each file. */ 1221 mz_bool mz_zip_validate_archive(mz_zip_archive *pZip, mz_uint flags); 1222 1223 /* Misc utils/helpers, valid for ZIP reading or writing */ 1224 mz_bool mz_zip_validate_mem_archive(const void *pMem, size_t size, mz_uint flags, mz_zip_error *pErr); 1225 mz_bool mz_zip_validate_file_archive(const char *pFilename, mz_uint flags, mz_zip_error *pErr); 1226 1227 /* Universal end function - calls either mz_zip_reader_end() or mz_zip_writer_end(). */ 1228 mz_bool mz_zip_end(mz_zip_archive *pZip); 1229 1230 /* -------- ZIP writing */ 1231 1232 #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS 1233 1234 /* Inits a ZIP archive writer. */ 1235 /*Set pZip->m_pWrite (and pZip->m_pIO_opaque) before calling mz_zip_writer_init or mz_zip_writer_init_v2*/ 1236 /*The output is streamable, i.e. file_ofs in mz_file_write_func always increases only by n*/ 1237 mz_bool mz_zip_writer_init(mz_zip_archive *pZip, mz_uint64 existing_size); 1238 mz_bool mz_zip_writer_init_v2(mz_zip_archive *pZip, mz_uint64 existing_size, mz_uint flags); 1239 1240 mz_bool mz_zip_writer_init_heap(mz_zip_archive *pZip, size_t size_to_reserve_at_beginning, size_t initial_allocation_size); 1241 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); 1242 1243 #ifndef MINIZ_NO_STDIO 1244 mz_bool mz_zip_writer_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint64 size_to_reserve_at_beginning); 1245 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); 1246 mz_bool mz_zip_writer_init_cfile(mz_zip_archive *pZip, MZ_FILE *pFile, mz_uint flags); 1247 #endif 1248 1249 /* Converts a ZIP archive reader object into a writer object, to allow efficient in-place file appends to occur on an existing archive. */ 1250 /* 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. */ 1251 /* 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). */ 1252 /* Finally, for archives opened using mz_zip_reader_init, the mz_zip_archive's user provided m_pWrite function cannot be NULL. */ 1253 /* Note: In-place archive modification is not recommended unless you know what you're doing, because if execution stops or something goes wrong before */ 1254 /* the archive is finalized the file's central directory will be hosed. */ 1255 mz_bool mz_zip_writer_init_from_reader(mz_zip_archive *pZip, const char *pFilename); 1256 mz_bool mz_zip_writer_init_from_reader_v2(mz_zip_archive *pZip, const char *pFilename, mz_uint flags); 1257 1258 /* Adds the contents of a memory buffer to an archive. These functions record the current local time into the archive. */ 1259 /* To add a directory entry, call this method with an archive name ending in a forwardslash with an empty buffer. */ 1260 /* 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. */ 1261 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); 1262 1263 /* Like mz_zip_writer_add_mem(), except you can specify a file comment field, and optionally supply the function with already compressed data. */ 1264 /* uncomp_size/uncomp_crc32 are only used if the MZ_ZIP_FLAG_COMPRESSED_DATA flag is specified. */ 1265 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, 1266 mz_uint64 uncomp_size, mz_uint32 uncomp_crc32); 1267 1268 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, 1269 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, 1270 const char *user_extra_data_central, mz_uint user_extra_data_central_len); 1271 1272 #ifndef MINIZ_NO_STDIO 1273 /* Adds the contents of a disk file to an archive. This function also records the disk file's modified time into the archive. */ 1274 /* 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. */ 1275 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); 1276 1277 /* Like mz_zip_writer_add_file(), except the file data is read from the specified FILE stream. */ 1278 mz_bool mz_zip_writer_add_cfile(mz_zip_archive *pZip, const char *pArchive_name, MZ_FILE *pSrc_file, mz_uint64 size_to_add, 1279 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, 1280 const char *user_extra_data_central, mz_uint user_extra_data_central_len); 1281 #endif 1282 1283 /* Adds a file to an archive by fully cloning the data from another archive. */ 1284 /* 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. */ 1285 mz_bool mz_zip_writer_add_from_zip_reader(mz_zip_archive *pZip, mz_zip_archive *pSource_zip, mz_uint src_file_index); 1286 1287 /* Finalizes the archive by writing the central directory records followed by the end of central directory record. */ 1288 /* After an archive is finalized, the only valid call on the mz_zip_archive struct is mz_zip_writer_end(). */ 1289 /* An archive must be manually finalized by calling this function for it to be valid. */ 1290 mz_bool mz_zip_writer_finalize_archive(mz_zip_archive *pZip); 1291 1292 /* Finalizes a heap archive, returning a poiner to the heap block and its size. */ 1293 /* The heap block will be allocated using the mz_zip_archive's alloc/realloc callbacks. */ 1294 mz_bool mz_zip_writer_finalize_heap_archive(mz_zip_archive *pZip, void **ppBuf, size_t *pSize); 1295 1296 /* Ends archive writing, freeing all allocations, and closing the output file if mz_zip_writer_init_file() was used. */ 1297 /* Note for the archive to be valid, it *must* have been finalized before ending (this function will not do it for you). */ 1298 mz_bool mz_zip_writer_end(mz_zip_archive *pZip); 1299 1300 /* -------- Misc. high-level helper functions: */ 1301 1302 /* mz_zip_add_mem_to_archive_file_in_place() efficiently (but not atomically) appends a memory blob to a ZIP archive. */ 1303 /* 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). */ 1304 /* 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. */ 1305 /* 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. */ 1306 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); 1307 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); 1308 1309 /* Reads a single file from an archive into a heap block. */ 1310 /* If pComment is not NULL, only the file with the specified comment will be extracted. */ 1311 /* Returns NULL on failure. */ 1312 void *mz_zip_extract_archive_file_to_heap(const char *pZip_filename, const char *pArchive_name, size_t *pSize, mz_uint flags); 1313 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); 1314 1315 #endif /* #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS */ 1316 1317 int mz_zip_get_version_made_by(mz_zip_archive *pZip, mz_uint file_index, 1318 mz_uint16 *value); 1319 int mz_zip_set_version_made_by(mz_zip_archive *pZip, mz_uint file_index, 1320 mz_uint16 value); 1321 int mz_zip_get_external_attr(mz_zip_archive *pZip, mz_uint file_index, 1322 mz_uint32 *value); 1323 int mz_zip_set_external_attr(mz_zip_archive *pZip, mz_uint file_index, 1324 mz_uint32 value); 1325 1326 #ifdef __cplusplus 1327 } 1328 #endif 1329 1330 #endif /* MINIZ_NO_ARCHIVE_APIS */ 1331