Added support for cp932 (Shift-JIS) conversion
[deark.git] / foreign / miniz.h
blob9fcfffcc8cd7ac9e9d9af271cffdbc8d0a58a9ea
1 #ifndef MINIZ_EXPORT
2 #define MINIZ_EXPORT
3 #endif
4 /* miniz.c 3.0.0 - public domain deflate/inflate, zlib-subset, ZIP reading/writing/appending, PNG writing
5 See "unlicense" statement at the end of this file.
6 Rich Geldreich <richgel99@gmail.com>, last updated Oct. 13, 2013
7 Implements RFC 1950: http://www.ietf.org/rfc/rfc1950.txt and RFC 1951: http://www.ietf.org/rfc/rfc1951.txt
9 Most API's defined in miniz.c are optional. For example, to disable the archive related functions just define
10 MINIZ_NO_ARCHIVE_APIS, or to get rid of all stdio usage define MINIZ_NO_STDIO (see the list below for more macros).
12 * Low-level Deflate/Inflate implementation notes:
14 Compression: Use the "tdefl" API's. The compressor supports raw, static, and dynamic blocks, lazy or
15 greedy parsing, match length filtering, RLE-only, and Huffman-only streams. It performs and compresses
16 approximately as well as zlib.
18 Decompression: Use the "tinfl" API's. The entire decompressor is implemented as a single function
19 coroutine: see tinfl_decompress(). It supports decompression into a 32KB (or larger power of 2) wrapping buffer, or into a memory
20 block large enough to hold the entire file.
22 The low-level tdefl/tinfl API's do not make any use of dynamic memory allocation.
24 * zlib-style API notes:
26 miniz.c implements a fairly large subset of zlib. There's enough functionality present for it to be a drop-in
27 zlib replacement in many apps:
28 The z_stream struct, optional memory allocation callbacks
29 deflateInit/deflateInit2/deflate/deflateReset/deflateEnd/deflateBound
30 inflateInit/inflateInit2/inflate/inflateReset/inflateEnd
31 compress, compress2, compressBound, uncompress
32 CRC-32, Adler-32 - Using modern, minimal code size, CPU cache friendly routines.
33 Supports raw deflate streams or standard zlib streams with adler-32 checking.
35 Limitations:
36 The callback API's are not implemented yet. No support for gzip headers or zlib static dictionaries.
37 I've tried to closely emulate zlib's various flavors of stream flushing and return status codes, but
38 there are no guarantees that miniz.c pulls this off perfectly.
40 * PNG writing: See the tdefl_write_image_to_png_file_in_memory() function, originally written by
41 Alex Evans. Supports 1-4 bytes/pixel images.
43 * ZIP archive API notes:
45 The ZIP archive API's where designed with simplicity and efficiency in mind, with just enough abstraction to
46 get the job done with minimal fuss. There are simple API's to retrieve file information, read files from
47 existing archives, create new archives, append new files to existing archives, or clone archive data from
48 one archive to another. It supports archives located in memory or the heap, on disk (using stdio.h),
49 or you can specify custom file read/write callbacks.
51 - Archive reading: Just call this function to read a single file from a disk archive:
53 void *mz_zip_extract_archive_file_to_heap(const char *pZip_filename, const char *pArchive_name,
54 size_t *pSize, mz_uint zip_flags);
56 For more complex cases, use the "mz_zip_reader" functions. Upon opening an archive, the entire central
57 directory is located and read as-is into memory, and subsequent file access only occurs when reading individual files.
59 - Archives file scanning: The simple way is to use this function to scan a loaded archive for a specific file:
61 int mz_zip_reader_locate_file(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags);
63 The locate operation can optionally check file comments too, which (as one example) can be used to identify
64 multiple versions of the same file in an archive. This function uses a simple linear search through the central
65 directory, so it's not very fast.
67 Alternately, you can iterate through all the files in an archive (using mz_zip_reader_get_num_files()) and
68 retrieve detailed info on each file by calling mz_zip_reader_file_stat().
70 - Archive creation: Use the "mz_zip_writer" functions. The ZIP writer immediately writes compressed file data
71 to disk and builds an exact image of the central directory in memory. The central directory image is written
72 all at once at the end of the archive file when the archive is finalized.
74 The archive writer can optionally align each file's local header and file data to any power of 2 alignment,
75 which can be useful when the archive will be read from optical media. Also, the writer supports placing
76 arbitrary data blobs at the very beginning of ZIP archives. Archives written using either feature are still
77 readable by any ZIP tool.
79 - Archive appending: The simple way to add a single file to an archive is to call this function:
81 mz_bool mz_zip_add_mem_to_archive_file_in_place(const char *pZip_filename, const char *pArchive_name,
82 const void *pBuf, size_t buf_size, const void *pComment, mz_uint16 comment_size, mz_uint level_and_flags);
84 The archive will be created if it doesn't already exist, otherwise it'll be appended to.
85 Note the appending is done in-place and is not an atomic operation, so if something goes wrong
86 during the operation it's possible the archive could be left without a central directory (although the local
87 file headers and file data will be fine, so the archive will be recoverable).
89 For more complex archive modification scenarios:
90 1. The safest way is to use a mz_zip_reader to read the existing archive, cloning only those bits you want to
91 preserve into a new archive using using the mz_zip_writer_add_from_zip_reader() function (which compiles the
92 compressed file data as-is). When you're done, delete the old archive and rename the newly written archive, and
93 you're done. This is safe but requires a bunch of temporary disk space or heap memory.
95 2. Or, you can convert an mz_zip_reader in-place to an mz_zip_writer using mz_zip_writer_init_from_reader(),
96 append new files as needed, then finalize the archive which will write an updated central directory to the
97 original archive. (This is basically what mz_zip_add_mem_to_archive_file_in_place() does.) There's a
98 possibility that the archive's central directory could be lost with this method if anything goes wrong, though.
100 - ZIP archive support limitations:
101 No spanning support. Extraction functions can only handle unencrypted, stored or deflated files.
102 Requires streams capable of seeking.
104 * This is a header file library, like stb_image.c. To get only a header file, either cut and paste the
105 below header, or create miniz.h, #define MINIZ_HEADER_FILE_ONLY, and then include miniz.c from it.
107 * Important: For best perf. be sure to customize the below macros for your target platform:
108 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 1
109 #define MINIZ_LITTLE_ENDIAN 1
110 #define MINIZ_HAS_64BIT_REGISTERS 1
112 * On platforms using glibc, Be sure to "#define _LARGEFILE64_SOURCE 1" before including miniz.c to ensure miniz
113 uses the 64-bit variants: fopen64(), stat64(), etc. Otherwise you won't be able to process large files
114 (i.e. 32-bit stat() fails for me on files > 0x7FFFFFFF bytes).
116 #pragma once
120 /* Defines to completely disable specific portions of miniz.c:
121 If all macros here are defined the only functionality remaining will be CRC-32 and adler-32. */
123 /* Define MINIZ_NO_STDIO to disable all usage and any functions which rely on stdio for file I/O. */
124 /*#define MINIZ_NO_STDIO */
126 /* If MINIZ_NO_TIME is specified then the ZIP archive functions will not be able to get the current time, or */
127 /* get/set file times, and the C run-time funcs that get/set times won't be called. */
128 /* The current downside is the times written to your archives will be from 1979. */
129 /*#define MINIZ_NO_TIME */
131 /* Define MINIZ_NO_DEFLATE_APIS to disable all compression API's. */
132 /*#define MINIZ_NO_DEFLATE_APIS */
134 /* Define MINIZ_NO_INFLATE_APIS to disable all decompression API's. */
135 /*#define MINIZ_NO_INFLATE_APIS */
137 /* Define MINIZ_NO_ARCHIVE_APIS to disable all ZIP archive API's. */
138 /*#define MINIZ_NO_ARCHIVE_APIS */
140 /* Define MINIZ_NO_ARCHIVE_WRITING_APIS to disable all writing related ZIP archive API's. */
141 /*#define MINIZ_NO_ARCHIVE_WRITING_APIS */
143 /* Define MINIZ_NO_ZLIB_APIS to remove all ZLIB-style compression/decompression API's. */
144 /*#define MINIZ_NO_ZLIB_APIS */
146 /* Define MINIZ_NO_ZLIB_COMPATIBLE_NAME to disable zlib names, to prevent conflicts against stock zlib. */
147 /*#define MINIZ_NO_ZLIB_COMPATIBLE_NAMES */
149 /* Define MINIZ_NO_MALLOC to disable all calls to malloc, free, and realloc.
150 Note if MINIZ_NO_MALLOC is defined then the user must always provide custom user alloc/free/realloc
151 callbacks to the zlib and archive API's, and a few stand-alone helper API's which don't provide custom user
152 functions (such as tdefl_compress_mem_to_heap() and tinfl_decompress_mem_to_heap()) won't work. */
153 /*#define MINIZ_NO_MALLOC */
155 #ifdef MINIZ_NO_INFLATE_APIS
156 #define MINIZ_NO_ARCHIVE_APIS
157 #endif
159 #ifdef MINIZ_NO_DEFLATE_APIS
160 #define MINIZ_NO_ARCHIVE_WRITING_APIS
161 #endif
163 #if defined(__TINYC__) && (defined(__linux) || defined(__linux__))
164 /* TODO: Work around "error: include file 'sys\utime.h' when compiling with tcc on Linux */
165 #define MINIZ_NO_TIME
166 #endif
168 #include <stddef.h>
170 #if !defined(MINIZ_NO_TIME) && !defined(MINIZ_NO_ARCHIVE_APIS)
171 #include <time.h>
172 #endif
174 #if defined(_M_IX86) || defined(_M_X64) || defined(__i386__) || defined(__i386) || defined(__i486__) || defined(__i486) || defined(i386) || defined(__ia64__) || defined(__x86_64__)
175 /* MINIZ_X86_OR_X64_CPU is only used to help set the below macros. */
176 #define MINIZ_X86_OR_X64_CPU 1
177 #else
178 #define MINIZ_X86_OR_X64_CPU 0
179 #endif
181 /* Set MINIZ_LITTLE_ENDIAN only if not set */
182 #if !defined(MINIZ_LITTLE_ENDIAN)
183 #if defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__)
185 #if (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__)
186 /* Set MINIZ_LITTLE_ENDIAN to 1 if the processor is little endian. */
187 #define MINIZ_LITTLE_ENDIAN 1
188 #else
189 #define MINIZ_LITTLE_ENDIAN 0
190 #endif
192 #else
194 #if MINIZ_X86_OR_X64_CPU
195 #define MINIZ_LITTLE_ENDIAN 1
196 #else
197 #define MINIZ_LITTLE_ENDIAN 0
198 #endif
200 #endif
201 #endif
203 /* Using unaligned loads and stores causes errors when using UBSan */
204 #if defined(__has_feature)
205 #if __has_feature(undefined_behavior_sanitizer)
206 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 0
207 #endif
208 #endif
210 /* Set MINIZ_USE_UNALIGNED_LOADS_AND_STORES only if not set */
211 #if !defined(MINIZ_USE_UNALIGNED_LOADS_AND_STORES)
212 #if MINIZ_X86_OR_X64_CPU
213 /* Set MINIZ_USE_UNALIGNED_LOADS_AND_STORES to 1 on CPU's that permit efficient integer loads and stores from unaligned addresses. */
214 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 0
215 #define MINIZ_UNALIGNED_USE_MEMCPY
216 #else
217 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 0
218 #endif
219 #endif
221 #if defined(_M_X64) || defined(_WIN64) || defined(__MINGW64__) || defined(_LP64) || defined(__LP64__) || defined(__ia64__) || defined(__x86_64__)
222 /* 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). */
223 #define MINIZ_HAS_64BIT_REGISTERS 1
224 #else
225 #define MINIZ_HAS_64BIT_REGISTERS 0
226 #endif
228 #ifdef __cplusplus
229 extern "C" {
230 #endif
232 /* ------------------- zlib-style API Definitions. */
234 /* 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! */
235 typedef unsigned long mz_ulong;
237 /* 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. */
238 MINIZ_EXPORT void mz_free(void *p);
240 #define MZ_ADLER32_INIT (1)
241 /* mz_adler32() returns the initial adler-32 value to use when called with ptr==NULL. */
242 MINIZ_EXPORT mz_ulong mz_adler32(mz_ulong adler, const unsigned char *ptr, size_t buf_len);
244 #define MZ_CRC32_INIT (0)
245 /* mz_crc32() returns the initial CRC-32 value to use when called with ptr==NULL. */
246 MINIZ_EXPORT mz_ulong mz_crc32(mz_ulong crc, const unsigned char *ptr, size_t buf_len);
248 /* Compression strategies. */
249 enum
251 MZ_DEFAULT_STRATEGY = 0,
252 MZ_FILTERED = 1,
253 MZ_HUFFMAN_ONLY = 2,
254 MZ_RLE = 3,
255 MZ_FIXED = 4
258 /* Method */
259 #define MZ_DEFLATED 8
261 /* Heap allocation callbacks.
262 Note that mz_alloc_func parameter types purposely differ from zlib's: items/size is size_t, not unsigned long. */
263 typedef void *(*mz_alloc_func)(void *opaque, size_t items, size_t size);
264 typedef void (*mz_free_func)(void *opaque, void *address);
265 typedef void *(*mz_realloc_func)(void *opaque, void *address, size_t items, size_t size);
267 /* 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. */
268 enum
270 MZ_NO_COMPRESSION = 0,
271 MZ_BEST_SPEED = 1,
272 MZ_BEST_COMPRESSION = 9,
273 MZ_UBER_COMPRESSION = 10,
274 MZ_DEFAULT_LEVEL = 6,
275 MZ_DEFAULT_COMPRESSION = -1
278 #define MZ_VERSION "11.0.2"
279 #define MZ_VERNUM 0xB002
280 #define MZ_VER_MAJOR 11
281 #define MZ_VER_MINOR 2
282 #define MZ_VER_REVISION 0
283 #define MZ_VER_SUBREVISION 0
285 #ifndef MINIZ_NO_ZLIB_APIS
287 /* 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). */
288 enum
290 MZ_NO_FLUSH = 0,
291 MZ_PARTIAL_FLUSH = 1,
292 MZ_SYNC_FLUSH = 2,
293 MZ_FULL_FLUSH = 3,
294 MZ_FINISH = 4,
295 MZ_BLOCK = 5
298 /* Return status codes. MZ_PARAM_ERROR is non-standard. */
299 enum
301 MZ_OK = 0,
302 MZ_STREAM_END = 1,
303 MZ_NEED_DICT = 2,
304 MZ_ERRNO = -1,
305 MZ_STREAM_ERROR = -2,
306 MZ_DATA_ERROR = -3,
307 MZ_MEM_ERROR = -4,
308 MZ_BUF_ERROR = -5,
309 MZ_VERSION_ERROR = -6,
310 MZ_PARAM_ERROR = -10000
313 /* Window bits */
314 #define MZ_DEFAULT_WINDOW_BITS 15
316 struct mz_internal_state;
318 /* Compression/decompression stream struct. */
319 typedef struct mz_stream_s
321 const unsigned char *next_in; /* pointer to next byte to read */
322 unsigned int avail_in; /* number of bytes available at next_in */
323 mz_ulong total_in; /* total number of bytes consumed so far */
325 unsigned char *next_out; /* pointer to next byte to write */
326 unsigned int avail_out; /* number of bytes that can be written to next_out */
327 mz_ulong total_out; /* total number of bytes produced so far */
329 char *msg; /* error msg (unused) */
330 struct mz_internal_state *state; /* internal state, allocated by zalloc/zfree */
332 mz_alloc_func zalloc; /* optional heap allocation function (defaults to malloc) */
333 mz_free_func zfree; /* optional heap free function (defaults to free) */
334 void *opaque; /* heap alloc function user pointer */
336 int data_type; /* data_type (unused) */
337 mz_ulong adler; /* adler32 of the source or uncompressed data */
338 mz_ulong reserved; /* not used */
339 } mz_stream;
341 typedef mz_stream *mz_streamp;
343 /* Returns the version string of miniz.c. */
344 MINIZ_EXPORT const char *mz_version(void);
346 #ifndef MINIZ_NO_DEFLATE_APIS
348 /* mz_deflateInit() initializes a compressor with default options: */
349 /* Parameters: */
350 /* pStream must point to an initialized mz_stream struct. */
351 /* level must be between [MZ_NO_COMPRESSION, MZ_BEST_COMPRESSION]. */
352 /* level 1 enables a specially optimized compression function that's been optimized purely for performance, not ratio. */
353 /* (This special func. is currently only enabled when MINIZ_USE_UNALIGNED_LOADS_AND_STORES and MINIZ_LITTLE_ENDIAN are defined.) */
354 /* Return values: */
355 /* MZ_OK on success. */
356 /* MZ_STREAM_ERROR if the stream is bogus. */
357 /* MZ_PARAM_ERROR if the input parameters are bogus. */
358 /* MZ_MEM_ERROR on out of memory. */
359 MINIZ_EXPORT int mz_deflateInit(mz_streamp pStream, int level);
361 /* mz_deflateInit2() is like mz_deflate(), except with more control: */
362 /* Additional parameters: */
363 /* method must be MZ_DEFLATED */
364 /* 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) */
365 /* mem_level must be between [1, 9] (it's checked but ignored by miniz.c) */
366 MINIZ_EXPORT int mz_deflateInit2(mz_streamp pStream, int level, int method, int window_bits, int mem_level, int strategy);
368 /* Quickly resets a compressor without having to reallocate anything. Same as calling mz_deflateEnd() followed by mz_deflateInit()/mz_deflateInit2(). */
369 MINIZ_EXPORT int mz_deflateReset(mz_streamp pStream);
371 /* mz_deflate() compresses the input to output, consuming as much of the input and producing as much output as possible. */
372 /* Parameters: */
373 /* 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. */
374 /* flush may be MZ_NO_FLUSH, MZ_PARTIAL_FLUSH/MZ_SYNC_FLUSH, MZ_FULL_FLUSH, or MZ_FINISH. */
375 /* Return values: */
376 /* 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). */
377 /* 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. */
378 /* MZ_STREAM_ERROR if the stream is bogus. */
379 /* MZ_PARAM_ERROR if one of the parameters is invalid. */
380 /* 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.) */
381 MINIZ_EXPORT int mz_deflate(mz_streamp pStream, int flush);
383 /* mz_deflateEnd() deinitializes a compressor: */
384 /* Return values: */
385 /* MZ_OK on success. */
386 /* MZ_STREAM_ERROR if the stream is bogus. */
387 MINIZ_EXPORT int mz_deflateEnd(mz_streamp pStream);
389 /* 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. */
390 MINIZ_EXPORT mz_ulong mz_deflateBound(mz_streamp pStream, mz_ulong source_len);
392 /* Single-call compression functions mz_compress() and mz_compress2(): */
393 /* Returns MZ_OK on success, or one of the error codes from mz_deflate() on failure. */
394 MINIZ_EXPORT int mz_compress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len);
395 MINIZ_EXPORT int mz_compress2(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len, int level);
397 /* mz_compressBound() returns a (very) conservative upper bound on the amount of data that could be generated by calling mz_compress(). */
398 MINIZ_EXPORT mz_ulong mz_compressBound(mz_ulong source_len);
400 #endif /*#ifndef MINIZ_NO_DEFLATE_APIS*/
402 #ifndef MINIZ_NO_INFLATE_APIS
404 /* Initializes a decompressor. */
405 MINIZ_EXPORT int mz_inflateInit(mz_streamp pStream);
407 /* 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: */
408 /* window_bits must be MZ_DEFAULT_WINDOW_BITS (to parse zlib header/footer) or -MZ_DEFAULT_WINDOW_BITS (raw deflate). */
409 MINIZ_EXPORT int mz_inflateInit2(mz_streamp pStream, int window_bits);
411 /* Quickly resets a compressor without having to reallocate anything. Same as calling mz_inflateEnd() followed by mz_inflateInit()/mz_inflateInit2(). */
412 MINIZ_EXPORT int mz_inflateReset(mz_streamp pStream);
414 /* 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. */
415 /* Parameters: */
416 /* 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. */
417 /* flush may be MZ_NO_FLUSH, MZ_SYNC_FLUSH, or MZ_FINISH. */
418 /* 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). */
419 /* 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. */
420 /* Return values: */
421 /* 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. */
422 /* 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. */
423 /* MZ_STREAM_ERROR if the stream is bogus. */
424 /* MZ_DATA_ERROR if the deflate stream is invalid. */
425 /* MZ_PARAM_ERROR if one of the parameters is invalid. */
426 /* 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 */
427 /* with more input data, or with more room in the output buffer (except when using single call decompression, described above). */
428 MINIZ_EXPORT int mz_inflate(mz_streamp pStream, int flush);
430 /* Deinitializes a decompressor. */
431 MINIZ_EXPORT int mz_inflateEnd(mz_streamp pStream);
433 /* Single-call decompression. */
434 /* Returns MZ_OK on success, or one of the error codes from mz_inflate() on failure. */
435 MINIZ_EXPORT int mz_uncompress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len);
436 MINIZ_EXPORT int mz_uncompress2(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong *pSource_len);
437 #endif /*#ifndef MINIZ_NO_INFLATE_APIS*/
439 /* Returns a string description of the specified error code, or NULL if the error code is invalid. */
440 MINIZ_EXPORT const char *mz_error(int err);
442 /* 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. */
443 /* Define MINIZ_NO_ZLIB_COMPATIBLE_NAMES to disable zlib-compatibility if you use zlib in the same project. */
444 #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES
445 typedef unsigned char Byte;
446 typedef unsigned int uInt;
447 typedef mz_ulong uLong;
448 typedef Byte Bytef;
449 typedef uInt uIntf;
450 typedef char charf;
451 typedef int intf;
452 typedef void *voidpf;
453 typedef uLong uLongf;
454 typedef void *voidp;
455 typedef void *const voidpc;
456 #define Z_NULL 0
457 #define Z_NO_FLUSH MZ_NO_FLUSH
458 #define Z_PARTIAL_FLUSH MZ_PARTIAL_FLUSH
459 #define Z_SYNC_FLUSH MZ_SYNC_FLUSH
460 #define Z_FULL_FLUSH MZ_FULL_FLUSH
461 #define Z_FINISH MZ_FINISH
462 #define Z_BLOCK MZ_BLOCK
463 #define Z_OK MZ_OK
464 #define Z_STREAM_END MZ_STREAM_END
465 #define Z_NEED_DICT MZ_NEED_DICT
466 #define Z_ERRNO MZ_ERRNO
467 #define Z_STREAM_ERROR MZ_STREAM_ERROR
468 #define Z_DATA_ERROR MZ_DATA_ERROR
469 #define Z_MEM_ERROR MZ_MEM_ERROR
470 #define Z_BUF_ERROR MZ_BUF_ERROR
471 #define Z_VERSION_ERROR MZ_VERSION_ERROR
472 #define Z_PARAM_ERROR MZ_PARAM_ERROR
473 #define Z_NO_COMPRESSION MZ_NO_COMPRESSION
474 #define Z_BEST_SPEED MZ_BEST_SPEED
475 #define Z_BEST_COMPRESSION MZ_BEST_COMPRESSION
476 #define Z_DEFAULT_COMPRESSION MZ_DEFAULT_COMPRESSION
477 #define Z_DEFAULT_STRATEGY MZ_DEFAULT_STRATEGY
478 #define Z_FILTERED MZ_FILTERED
479 #define Z_HUFFMAN_ONLY MZ_HUFFMAN_ONLY
480 #define Z_RLE MZ_RLE
481 #define Z_FIXED MZ_FIXED
482 #define Z_DEFLATED MZ_DEFLATED
483 #define Z_DEFAULT_WINDOW_BITS MZ_DEFAULT_WINDOW_BITS
484 #define alloc_func mz_alloc_func
485 #define free_func mz_free_func
486 #define internal_state mz_internal_state
487 #define z_stream mz_stream
489 #ifndef MINIZ_NO_DEFLATE_APIS
490 #define deflateInit mz_deflateInit
491 #define deflateInit2 mz_deflateInit2
492 #define deflateReset mz_deflateReset
493 #define deflate mz_deflate
494 #define deflateEnd mz_deflateEnd
495 #define deflateBound mz_deflateBound
496 #define compress mz_compress
497 #define compress2 mz_compress2
498 #define compressBound mz_compressBound
499 #endif /*#ifndef MINIZ_NO_DEFLATE_APIS*/
501 #ifndef MINIZ_NO_INFLATE_APIS
502 #define inflateInit mz_inflateInit
503 #define inflateInit2 mz_inflateInit2
504 #define inflateReset mz_inflateReset
505 #define inflate mz_inflate
506 #define inflateEnd mz_inflateEnd
507 #define uncompress mz_uncompress
508 #define uncompress2 mz_uncompress2
509 #endif /*#ifndef MINIZ_NO_INFLATE_APIS*/
511 #define crc32 mz_crc32
512 #define adler32 mz_adler32
513 #define MAX_WBITS 15
514 #define MAX_MEM_LEVEL 9
515 #define zError mz_error
516 #define ZLIB_VERSION MZ_VERSION
517 #define ZLIB_VERNUM MZ_VERNUM
518 #define ZLIB_VER_MAJOR MZ_VER_MAJOR
519 #define ZLIB_VER_MINOR MZ_VER_MINOR
520 #define ZLIB_VER_REVISION MZ_VER_REVISION
521 #define ZLIB_VER_SUBREVISION MZ_VER_SUBREVISION
522 #define zlibVersion mz_version
523 #define zlib_version mz_version()
524 #endif /* #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES */
526 #endif /* MINIZ_NO_ZLIB_APIS */
528 #ifdef __cplusplus
530 #endif
536 #pragma once
537 #include <assert.h>
538 #include <stdint.h>
539 #include <stdlib.h>
540 #include <string.h>
544 /* ------------------- Types and macros */
545 typedef unsigned char mz_uint8;
546 typedef signed short mz_int16;
547 typedef unsigned short mz_uint16;
548 typedef unsigned int mz_uint32;
549 typedef unsigned int mz_uint;
550 typedef int64_t mz_int64;
551 typedef uint64_t mz_uint64;
552 typedef int mz_bool;
554 #define MZ_FALSE (0)
555 #define MZ_TRUE (1)
557 /* Works around MSVC's spammy "warning C4127: conditional expression is constant" message. */
558 #ifdef _MSC_VER
559 #define MZ_MACRO_END while (0, 0)
560 #else
561 #define MZ_MACRO_END while (0)
562 #endif
564 #ifdef MINIZ_NO_STDIO
565 #define MZ_FILE void *
566 #else
567 #include <stdio.h>
568 #define MZ_FILE FILE
569 #endif /* #ifdef MINIZ_NO_STDIO */
571 #ifdef MINIZ_NO_TIME
572 typedef struct mz_dummy_time_t_tag
574 mz_uint32 m_dummy1;
575 mz_uint32 m_dummy2;
576 } mz_dummy_time_t;
577 #define MZ_TIME_T mz_dummy_time_t
578 #else
579 #define MZ_TIME_T time_t
580 #endif
582 #define MZ_ASSERT(x) assert(x)
584 #ifdef MINIZ_NO_MALLOC
585 #define MZ_MALLOC(x) NULL
586 #define MZ_FREE(x) (void)x, ((void)0)
587 #define MZ_REALLOC(p, x) NULL
588 #else
589 #define MZ_MALLOC(x) malloc(x)
590 #define MZ_FREE(x) free(x)
591 #define MZ_REALLOC(p, x) realloc(p, x)
592 #endif
594 #define MZ_MAX(a, b) (((a) > (b)) ? (a) : (b))
595 #define MZ_MIN(a, b) (((a) < (b)) ? (a) : (b))
596 #define MZ_CLEAR_OBJ(obj) memset(&(obj), 0, sizeof(obj))
597 #define MZ_CLEAR_ARR(obj) memset((obj), 0, sizeof(obj))
598 #define MZ_CLEAR_PTR(obj) memset((obj), 0, sizeof(*obj))
600 #if MINIZ_USE_UNALIGNED_LOADS_AND_STORES && MINIZ_LITTLE_ENDIAN
601 #define MZ_READ_LE16(p) *((const mz_uint16 *)(p))
602 #define MZ_READ_LE32(p) *((const mz_uint32 *)(p))
603 #else
604 #define MZ_READ_LE16(p) ((mz_uint32)(((const mz_uint8 *)(p))[0]) | ((mz_uint32)(((const mz_uint8 *)(p))[1]) << 8U))
605 #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))
606 #endif
608 #define MZ_READ_LE64(p) (((mz_uint64)MZ_READ_LE32(p)) | (((mz_uint64)MZ_READ_LE32((const mz_uint8 *)(p) + sizeof(mz_uint32))) << 32U))
610 #ifdef _MSC_VER
611 #define MZ_FORCEINLINE __forceinline
612 #elif defined(__GNUC__)
613 #define MZ_FORCEINLINE __inline__ __attribute__((__always_inline__))
614 #else
615 #define MZ_FORCEINLINE inline
616 #endif
618 #ifdef __cplusplus
619 extern "C" {
620 #endif
622 extern MINIZ_EXPORT void *miniz_def_alloc_func(void *opaque, size_t items, size_t size);
623 extern MINIZ_EXPORT void miniz_def_free_func(void *opaque, void *address);
624 extern MINIZ_EXPORT void *miniz_def_realloc_func(void *opaque, void *address, size_t items, size_t size);
626 #define MZ_UINT16_MAX (0xFFFFU)
627 #define MZ_UINT32_MAX (0xFFFFFFFFU)
629 #ifdef __cplusplus
631 #endif
632 #pragma once
635 #ifndef MINIZ_NO_DEFLATE_APIS
637 #ifdef __cplusplus
638 extern "C" {
639 #endif
640 /* ------------------- Low-level Compression API Definitions */
642 /* Set TDEFL_LESS_MEMORY to 1 to use less memory (compression will be slightly slower, and raw/dynamic blocks will be output more frequently). */
643 #define TDEFL_LESS_MEMORY 0
645 /* tdefl_init() compression flags logically OR'd together (low 12 bits contain the max. number of probes per dictionary search): */
646 /* 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). */
647 enum
649 TDEFL_HUFFMAN_ONLY = 0,
650 TDEFL_DEFAULT_MAX_PROBES = 128,
651 TDEFL_MAX_PROBES_MASK = 0xFFF
654 /* 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. */
655 /* TDEFL_COMPUTE_ADLER32: Always compute the adler-32 of the input data (even when not writing zlib headers). */
656 /* TDEFL_GREEDY_PARSING_FLAG: Set to use faster greedy parsing, instead of more efficient lazy parsing. */
657 /* 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). */
658 /* TDEFL_RLE_MATCHES: Only look for RLE matches (matches with a distance of 1) */
659 /* TDEFL_FILTER_MATCHES: Discards matches <= 5 chars if enabled. */
660 /* TDEFL_FORCE_ALL_STATIC_BLOCKS: Disable usage of optimized Huffman tables. */
661 /* TDEFL_FORCE_ALL_RAW_BLOCKS: Only use raw (uncompressed) deflate blocks. */
662 /* The low 12 bits are reserved to control the max # of hash probes per dictionary lookup (see TDEFL_MAX_PROBES_MASK). */
663 enum
665 TDEFL_WRITE_ZLIB_HEADER = 0x01000,
666 TDEFL_COMPUTE_ADLER32 = 0x02000,
667 TDEFL_GREEDY_PARSING_FLAG = 0x04000,
668 TDEFL_NONDETERMINISTIC_PARSING_FLAG = 0x08000,
669 TDEFL_RLE_MATCHES = 0x10000,
670 TDEFL_FILTER_MATCHES = 0x20000,
671 TDEFL_FORCE_ALL_STATIC_BLOCKS = 0x40000,
672 TDEFL_FORCE_ALL_RAW_BLOCKS = 0x80000
675 /* High level compression functions: */
676 /* tdefl_compress_mem_to_heap() compresses a block in memory to a heap block allocated via malloc(). */
677 /* On entry: */
678 /* pSrc_buf, src_buf_len: Pointer and size of source block to compress. */
679 /* flags: The max match finder probes (default is 128) logically OR'd against the above flags. Higher probes are slower but improve compression. */
680 /* On return: */
681 /* Function returns a pointer to the compressed data, or NULL on failure. */
682 /* *pOut_len will be set to the compressed data's size, which could be larger than src_buf_len on uncompressible data. */
683 /* The caller must free() the returned block when it's no longer needed. */
684 MINIZ_EXPORT void *tdefl_compress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags);
686 /* tdefl_compress_mem_to_mem() compresses a block in memory to another block in memory. */
687 /* Returns 0 on failure. */
688 MINIZ_EXPORT 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);
690 /* Compresses an image to a compressed PNG file in memory. */
691 /* On entry: */
692 /* pImage, w, h, and num_chans describe the image to compress. num_chans may be 1, 2, 3, or 4. */
693 /* The image pitch in bytes per scanline will be w*num_chans. The leftmost pixel on the top scanline is stored first in memory. */
694 /* 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 */
695 /* If flip is true, the image will be flipped on the Y axis (useful for OpenGL apps). */
696 /* On return: */
697 /* Function returns a pointer to the compressed data, or NULL on failure. */
698 /* *pLen_out will be set to the size of the PNG image file. */
699 /* The caller must mz_free() the returned heap block (which will typically be larger than *pLen_out) when it's no longer needed. */
700 MINIZ_EXPORT 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);
701 MINIZ_EXPORT void *tdefl_write_image_to_png_file_in_memory(const void *pImage, int w, int h, int num_chans, size_t *pLen_out);
703 /* Output stream interface. The compressor uses this interface to write compressed data. It'll typically be called TDEFL_OUT_BUF_SIZE at a time. */
704 typedef mz_bool (*tdefl_put_buf_func_ptr)(const void *pBuf, int len, void *pUser);
706 /* tdefl_compress_mem_to_output() compresses a block to an output stream. The above helpers use this function internally. */
707 MINIZ_EXPORT 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);
709 enum
711 TDEFL_MAX_HUFF_TABLES = 3,
712 TDEFL_MAX_HUFF_SYMBOLS_0 = 288,
713 TDEFL_MAX_HUFF_SYMBOLS_1 = 32,
714 TDEFL_MAX_HUFF_SYMBOLS_2 = 19,
715 TDEFL_LZ_DICT_SIZE = 32768,
716 TDEFL_LZ_DICT_SIZE_MASK = TDEFL_LZ_DICT_SIZE - 1,
717 TDEFL_MIN_MATCH_LEN = 3,
718 TDEFL_MAX_MATCH_LEN = 258
721 /* TDEFL_OUT_BUF_SIZE MUST be large enough to hold a single entire compressed output block (using static/fixed Huffman codes). */
722 #if TDEFL_LESS_MEMORY
723 enum
725 TDEFL_LZ_CODE_BUF_SIZE = 24 * 1024,
726 TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13) / 10,
727 TDEFL_MAX_HUFF_SYMBOLS = 288,
728 TDEFL_LZ_HASH_BITS = 12,
729 TDEFL_LEVEL1_HASH_SIZE_MASK = 4095,
730 TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3,
731 TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS
733 #else
734 enum
736 TDEFL_LZ_CODE_BUF_SIZE = 64 * 1024,
737 TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13) / 10,
738 TDEFL_MAX_HUFF_SYMBOLS = 288,
739 TDEFL_LZ_HASH_BITS = 15,
740 TDEFL_LEVEL1_HASH_SIZE_MASK = 4095,
741 TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3,
742 TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS
744 #endif
746 /* 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. */
747 typedef enum {
748 TDEFL_STATUS_BAD_PARAM = -2,
749 TDEFL_STATUS_PUT_BUF_FAILED = -1,
750 TDEFL_STATUS_OKAY = 0,
751 TDEFL_STATUS_DONE = 1
752 } tdefl_status;
754 /* Must map to MZ_NO_FLUSH, MZ_SYNC_FLUSH, etc. enums */
755 typedef enum {
756 TDEFL_NO_FLUSH = 0,
757 TDEFL_SYNC_FLUSH = 2,
758 TDEFL_FULL_FLUSH = 3,
759 TDEFL_FINISH = 4
760 } tdefl_flush;
762 /* tdefl's compression state structure. */
763 typedef struct
765 tdefl_put_buf_func_ptr m_pPut_buf_func;
766 void *m_pPut_buf_user;
767 mz_uint m_flags, m_max_probes[2];
768 int m_greedy_parsing;
769 mz_uint m_adler32, m_lookahead_pos, m_lookahead_size, m_dict_size;
770 mz_uint8 *m_pLZ_code_buf, *m_pLZ_flags, *m_pOutput_buf, *m_pOutput_buf_end;
771 mz_uint m_num_flags_left, m_total_lz_bytes, m_lz_code_buf_dict_pos, m_bits_in, m_bit_buffer;
772 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;
773 tdefl_status m_prev_return_status;
774 const void *m_pIn_buf;
775 void *m_pOut_buf;
776 size_t *m_pIn_buf_size, *m_pOut_buf_size;
777 tdefl_flush m_flush;
778 const mz_uint8 *m_pSrc;
779 size_t m_src_buf_left, m_out_buf_ofs;
780 mz_uint8 m_dict[TDEFL_LZ_DICT_SIZE + TDEFL_MAX_MATCH_LEN - 1];
781 mz_uint16 m_huff_count[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS];
782 mz_uint16 m_huff_codes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS];
783 mz_uint8 m_huff_code_sizes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS];
784 mz_uint8 m_lz_code_buf[TDEFL_LZ_CODE_BUF_SIZE];
785 mz_uint16 m_next[TDEFL_LZ_DICT_SIZE];
786 mz_uint16 m_hash[TDEFL_LZ_HASH_SIZE];
787 mz_uint8 m_output_buf[TDEFL_OUT_BUF_SIZE];
788 } tdefl_compressor;
790 /* Initializes the compressor. */
791 /* There is no corresponding deinit() function because the tdefl API's do not dynamically allocate memory. */
792 /* 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. */
793 /* If pBut_buf_func is NULL the user should always call the tdefl_compress() API. */
794 /* flags: See the above enums (TDEFL_HUFFMAN_ONLY, TDEFL_WRITE_ZLIB_HEADER, etc.) */
795 MINIZ_EXPORT tdefl_status tdefl_init(tdefl_compressor *d, tdefl_put_buf_func_ptr pPut_buf_func, void *pPut_buf_user, int flags);
797 /* 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. */
798 MINIZ_EXPORT 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);
800 /* tdefl_compress_buffer() is only usable when the tdefl_init() is called with a non-NULL tdefl_put_buf_func_ptr. */
801 /* tdefl_compress_buffer() always consumes the entire input buffer. */
802 MINIZ_EXPORT tdefl_status tdefl_compress_buffer(tdefl_compressor *d, const void *pIn_buf, size_t in_buf_size, tdefl_flush flush);
804 MINIZ_EXPORT tdefl_status tdefl_get_prev_return_status(tdefl_compressor *d);
805 MINIZ_EXPORT mz_uint32 tdefl_get_adler32(tdefl_compressor *d);
807 /* Create tdefl_compress() flags given zlib-style compression parameters. */
808 /* level may range from [0,10] (where 10 is absolute max compression, but may be much slower on some files) */
809 /* window_bits may be -15 (raw deflate) or 15 (zlib) */
810 /* strategy may be either MZ_DEFAULT_STRATEGY, MZ_FILTERED, MZ_HUFFMAN_ONLY, MZ_RLE, or MZ_FIXED */
811 MINIZ_EXPORT mz_uint tdefl_create_comp_flags_from_zip_params(int level, int window_bits, int strategy);
813 #ifndef MINIZ_NO_MALLOC
814 /* Allocate the tdefl_compressor structure in C so that */
815 /* non-C language bindings to tdefl_ API don't need to worry about */
816 /* structure size and allocation mechanism. */
817 MINIZ_EXPORT tdefl_compressor *tdefl_compressor_alloc(void);
818 MINIZ_EXPORT void tdefl_compressor_free(tdefl_compressor *pComp);
819 #endif
821 #ifdef __cplusplus
823 #endif
825 #endif /*#ifndef MINIZ_NO_DEFLATE_APIS*/
826 #pragma once
828 /* ------------------- Low-level Decompression API Definitions */
830 #ifndef MINIZ_NO_INFLATE_APIS
832 #ifdef __cplusplus
833 extern "C" {
834 #endif
835 /* Decompression flags used by tinfl_decompress(). */
836 /* 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. */
837 /* 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. */
838 /* 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). */
839 /* TINFL_FLAG_COMPUTE_ADLER32: Force adler-32 checksum computation of the decompressed bytes. */
840 enum
842 TINFL_FLAG_PARSE_ZLIB_HEADER = 1,
843 TINFL_FLAG_HAS_MORE_INPUT = 2,
844 TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF = 4,
845 TINFL_FLAG_COMPUTE_ADLER32 = 8
848 /* High level decompression functions: */
849 /* tinfl_decompress_mem_to_heap() decompresses a block in memory to a heap block allocated via malloc(). */
850 /* On entry: */
851 /* pSrc_buf, src_buf_len: Pointer and size of the Deflate or zlib source data to decompress. */
852 /* On return: */
853 /* Function returns a pointer to the decompressed data, or NULL on failure. */
854 /* *pOut_len will be set to the decompressed data's size, which could be larger than src_buf_len on uncompressible data. */
855 /* The caller must call mz_free() on the returned block when it's no longer needed. */
856 MINIZ_EXPORT void *tinfl_decompress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags);
858 /* tinfl_decompress_mem_to_mem() decompresses a block in memory to another block in memory. */
859 /* Returns TINFL_DECOMPRESS_MEM_TO_MEM_FAILED on failure, or the number of bytes written on success. */
860 #define TINFL_DECOMPRESS_MEM_TO_MEM_FAILED ((size_t)(-1))
861 MINIZ_EXPORT 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);
863 /* 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. */
864 /* Returns 1 on success or 0 on failure. */
865 typedef int (*tinfl_put_buf_func_ptr)(const void *pBuf, int len, void *pUser);
866 MINIZ_EXPORT 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);
868 struct tinfl_decompressor_tag;
869 typedef struct tinfl_decompressor_tag tinfl_decompressor;
871 #ifndef MINIZ_NO_MALLOC
872 /* Allocate the tinfl_decompressor structure in C so that */
873 /* non-C language bindings to tinfl_ API don't need to worry about */
874 /* structure size and allocation mechanism. */
875 MINIZ_EXPORT tinfl_decompressor *tinfl_decompressor_alloc(void);
876 MINIZ_EXPORT void tinfl_decompressor_free(tinfl_decompressor *pDecomp);
877 #endif
879 /* Max size of LZ dictionary. */
880 #define TINFL_LZ_DICT_SIZE 32768
882 /* Return status. */
883 typedef enum {
884 /* 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 */
885 /* 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). */
886 /* If you call it again with no input you'll just get TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS again. */
887 TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS = -4,
889 /* 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.) */
890 TINFL_STATUS_BAD_PARAM = -3,
892 /* 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. */
893 TINFL_STATUS_ADLER32_MISMATCH = -2,
895 /* 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. */
896 TINFL_STATUS_FAILED = -1,
898 /* Any status code less than TINFL_STATUS_DONE must indicate a failure. */
900 /* 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 */
901 /* 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. */
902 TINFL_STATUS_DONE = 0,
904 /* 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 */
905 /* 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 */
906 /* proceed, so be sure to properly set the TINFL_FLAG_HAS_MORE_INPUT flag. */
907 TINFL_STATUS_NEEDS_MORE_INPUT = 1,
909 /* 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. */
910 /* 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 */
911 /* (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 */
912 /* so I may need to add some code to address this. */
913 TINFL_STATUS_HAS_MORE_OUTPUT = 2
914 } tinfl_status;
916 /* Initializes the decompressor to its initial state. */
917 #define tinfl_init(r) \
918 do \
920 (r)->m_state = 0; \
922 MZ_MACRO_END
923 #define tinfl_get_adler32(r) (r)->m_check_adler32
925 /* 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. */
926 /* 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. */
927 MINIZ_EXPORT 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);
929 /* Internal/private bits follow. */
930 enum
932 TINFL_MAX_HUFF_TABLES = 3,
933 TINFL_MAX_HUFF_SYMBOLS_0 = 288,
934 TINFL_MAX_HUFF_SYMBOLS_1 = 32,
935 TINFL_MAX_HUFF_SYMBOLS_2 = 19,
936 TINFL_FAST_LOOKUP_BITS = 10,
937 TINFL_FAST_LOOKUP_SIZE = 1 << TINFL_FAST_LOOKUP_BITS
940 #if MINIZ_HAS_64BIT_REGISTERS
941 #define TINFL_USE_64BIT_BITBUF 1
942 #else
943 #define TINFL_USE_64BIT_BITBUF 0
944 #endif
946 #if TINFL_USE_64BIT_BITBUF
947 typedef mz_uint64 tinfl_bit_buf_t;
948 #define TINFL_BITBUF_SIZE (64)
949 #else
950 typedef mz_uint32 tinfl_bit_buf_t;
951 #define TINFL_BITBUF_SIZE (32)
952 #endif
954 struct tinfl_decompressor_tag
956 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];
957 tinfl_bit_buf_t m_bit_buf;
958 size_t m_dist_from_out_buf_start;
959 mz_int16 m_look_up[TINFL_MAX_HUFF_TABLES][TINFL_FAST_LOOKUP_SIZE];
960 mz_int16 m_tree_0[TINFL_MAX_HUFF_SYMBOLS_0 * 2];
961 mz_int16 m_tree_1[TINFL_MAX_HUFF_SYMBOLS_1 * 2];
962 mz_int16 m_tree_2[TINFL_MAX_HUFF_SYMBOLS_2 * 2];
963 mz_uint8 m_code_size_0[TINFL_MAX_HUFF_SYMBOLS_0];
964 mz_uint8 m_code_size_1[TINFL_MAX_HUFF_SYMBOLS_1];
965 mz_uint8 m_code_size_2[TINFL_MAX_HUFF_SYMBOLS_2];
966 mz_uint8 m_raw_header[4], m_len_codes[TINFL_MAX_HUFF_SYMBOLS_0 + TINFL_MAX_HUFF_SYMBOLS_1 + 137];
969 #ifdef __cplusplus
971 #endif
973 #endif /*#ifndef MINIZ_NO_INFLATE_APIS*/
975 #pragma once
978 /* ------------------- ZIP archive reading/writing */
980 #ifndef MINIZ_NO_ARCHIVE_APIS
982 #ifdef __cplusplus
983 extern "C" {
984 #endif
986 enum
988 /* Note: These enums can be reduced as needed to save memory or stack space - they are pretty conservative. */
989 MZ_ZIP_MAX_IO_BUF_SIZE = 64 * 1024,
990 MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE = 512,
991 MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE = 512
994 typedef struct
996 /* Central directory file index. */
997 mz_uint32 m_file_index;
999 /* 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. */
1000 mz_uint64 m_central_dir_ofs;
1002 /* These fields are copied directly from the zip's central dir. */
1003 mz_uint16 m_version_made_by;
1004 mz_uint16 m_version_needed;
1005 mz_uint16 m_bit_flag;
1006 mz_uint16 m_method;
1008 /* CRC-32 of uncompressed data. */
1009 mz_uint32 m_crc32;
1011 /* File's compressed size. */
1012 mz_uint64 m_comp_size;
1014 /* 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. */
1015 mz_uint64 m_uncomp_size;
1017 /* Zip internal and external file attributes. */
1018 mz_uint16 m_internal_attr;
1019 mz_uint32 m_external_attr;
1021 /* Entry's local header file offset in bytes. */
1022 mz_uint64 m_local_header_ofs;
1024 /* Size of comment in bytes. */
1025 mz_uint32 m_comment_size;
1027 /* MZ_TRUE if the entry appears to be a directory. */
1028 mz_bool m_is_directory;
1030 /* MZ_TRUE if the entry uses encryption/strong encryption (which miniz_zip doesn't support) */
1031 mz_bool m_is_encrypted;
1033 /* MZ_TRUE if the file is not encrypted, a patch file, and if it uses a compression method we support. */
1034 mz_bool m_is_supported;
1036 /* Filename. If string ends in '/' it's a subdirectory entry. */
1037 /* Guaranteed to be zero terminated, may be truncated to fit. */
1038 char m_filename[MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE];
1040 /* Comment field. */
1041 /* Guaranteed to be zero terminated, may be truncated to fit. */
1042 char m_comment[MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE];
1044 #ifdef MINIZ_NO_TIME
1045 MZ_TIME_T m_padding;
1046 #else
1047 MZ_TIME_T m_time;
1048 #endif
1049 } mz_zip_archive_file_stat;
1051 typedef size_t (*mz_file_read_func)(void *pOpaque, mz_uint64 file_ofs, void *pBuf, size_t n);
1052 typedef size_t (*mz_file_write_func)(void *pOpaque, mz_uint64 file_ofs, const void *pBuf, size_t n);
1053 typedef mz_bool (*mz_file_needs_keepalive)(void *pOpaque);
1055 struct mz_zip_internal_state_tag;
1056 typedef struct mz_zip_internal_state_tag mz_zip_internal_state;
1058 typedef enum {
1059 MZ_ZIP_MODE_INVALID = 0,
1060 MZ_ZIP_MODE_READING = 1,
1061 MZ_ZIP_MODE_WRITING = 2,
1062 MZ_ZIP_MODE_WRITING_HAS_BEEN_FINALIZED = 3
1063 } mz_zip_mode;
1065 typedef enum {
1066 MZ_ZIP_FLAG_CASE_SENSITIVE = 0x0100,
1067 MZ_ZIP_FLAG_IGNORE_PATH = 0x0200,
1068 MZ_ZIP_FLAG_COMPRESSED_DATA = 0x0400,
1069 MZ_ZIP_FLAG_DO_NOT_SORT_CENTRAL_DIRECTORY = 0x0800,
1070 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) */
1071 MZ_ZIP_FLAG_VALIDATE_HEADERS_ONLY = 0x2000, /* validate the local headers, but don't decompress the entire file and check the crc32 */
1072 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 */
1073 MZ_ZIP_FLAG_WRITE_ALLOW_READING = 0x8000,
1074 MZ_ZIP_FLAG_ASCII_FILENAME = 0x10000,
1075 /*After adding a compressed file, seek back
1076 to local file header and set the correct sizes*/
1077 MZ_ZIP_FLAG_WRITE_HEADER_SET_SIZE = 0x20000
1078 } mz_zip_flags;
1080 typedef enum {
1081 MZ_ZIP_TYPE_INVALID = 0,
1082 MZ_ZIP_TYPE_USER,
1083 MZ_ZIP_TYPE_MEMORY,
1084 MZ_ZIP_TYPE_HEAP,
1085 MZ_ZIP_TYPE_FILE,
1086 MZ_ZIP_TYPE_CFILE,
1087 MZ_ZIP_TOTAL_TYPES
1088 } mz_zip_type;
1090 /* miniz error codes. Be sure to update mz_zip_get_error_string() if you add or modify this enum. */
1091 typedef enum {
1092 MZ_ZIP_NO_ERROR = 0,
1093 MZ_ZIP_UNDEFINED_ERROR,
1094 MZ_ZIP_TOO_MANY_FILES,
1095 MZ_ZIP_FILE_TOO_LARGE,
1096 MZ_ZIP_UNSUPPORTED_METHOD,
1097 MZ_ZIP_UNSUPPORTED_ENCRYPTION,
1098 MZ_ZIP_UNSUPPORTED_FEATURE,
1099 MZ_ZIP_FAILED_FINDING_CENTRAL_DIR,
1100 MZ_ZIP_NOT_AN_ARCHIVE,
1101 MZ_ZIP_INVALID_HEADER_OR_CORRUPTED,
1102 MZ_ZIP_UNSUPPORTED_MULTIDISK,
1103 MZ_ZIP_DECOMPRESSION_FAILED,
1104 MZ_ZIP_COMPRESSION_FAILED,
1105 MZ_ZIP_UNEXPECTED_DECOMPRESSED_SIZE,
1106 MZ_ZIP_CRC_CHECK_FAILED,
1107 MZ_ZIP_UNSUPPORTED_CDIR_SIZE,
1108 MZ_ZIP_ALLOC_FAILED,
1109 MZ_ZIP_FILE_OPEN_FAILED,
1110 MZ_ZIP_FILE_CREATE_FAILED,
1111 MZ_ZIP_FILE_WRITE_FAILED,
1112 MZ_ZIP_FILE_READ_FAILED,
1113 MZ_ZIP_FILE_CLOSE_FAILED,
1114 MZ_ZIP_FILE_SEEK_FAILED,
1115 MZ_ZIP_FILE_STAT_FAILED,
1116 MZ_ZIP_INVALID_PARAMETER,
1117 MZ_ZIP_INVALID_FILENAME,
1118 MZ_ZIP_BUF_TOO_SMALL,
1119 MZ_ZIP_INTERNAL_ERROR,
1120 MZ_ZIP_FILE_NOT_FOUND,
1121 MZ_ZIP_ARCHIVE_TOO_LARGE,
1122 MZ_ZIP_VALIDATION_FAILED,
1123 MZ_ZIP_WRITE_CALLBACK_FAILED,
1124 MZ_ZIP_TOTAL_ERRORS
1125 } mz_zip_error;
1127 typedef struct
1129 mz_uint64 m_archive_size;
1130 mz_uint64 m_central_directory_file_ofs;
1132 /* We only support up to UINT32_MAX files in zip64 mode. */
1133 mz_uint32 m_total_files;
1134 mz_zip_mode m_zip_mode;
1135 mz_zip_type m_zip_type;
1136 mz_zip_error m_last_error;
1138 mz_uint64 m_file_offset_alignment;
1140 mz_alloc_func m_pAlloc;
1141 mz_free_func m_pFree;
1142 mz_realloc_func m_pRealloc;
1143 void *m_pAlloc_opaque;
1145 mz_file_read_func m_pRead;
1146 mz_file_write_func m_pWrite;
1147 mz_file_needs_keepalive m_pNeeds_keepalive;
1148 void *m_pIO_opaque;
1150 mz_zip_internal_state *m_pState;
1152 } mz_zip_archive;
1154 typedef struct
1156 mz_zip_archive *pZip;
1157 mz_uint flags;
1159 int status;
1161 mz_uint64 read_buf_size, read_buf_ofs, read_buf_avail, comp_remaining, out_buf_ofs, cur_file_ofs;
1162 mz_zip_archive_file_stat file_stat;
1163 void *pRead_buf;
1164 void *pWrite_buf;
1166 size_t out_blk_remain;
1168 tinfl_decompressor inflator;
1170 #ifdef MINIZ_DISABLE_ZIP_READER_CRC32_CHECKS
1171 mz_uint padding;
1172 #else
1173 mz_uint file_crc32;
1174 #endif
1176 } mz_zip_reader_extract_iter_state;
1178 /* -------- ZIP reading */
1180 /* Inits a ZIP archive reader. */
1181 /* These functions read and validate the archive's central directory. */
1182 MINIZ_EXPORT mz_bool mz_zip_reader_init(mz_zip_archive *pZip, mz_uint64 size, mz_uint flags);
1184 MINIZ_EXPORT mz_bool mz_zip_reader_init_mem(mz_zip_archive *pZip, const void *pMem, size_t size, mz_uint flags);
1186 #ifndef MINIZ_NO_STDIO
1187 /* Read a archive from a disk file. */
1188 /* file_start_ofs is the file offset where the archive actually begins, or 0. */
1189 /* 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. */
1190 MINIZ_EXPORT mz_bool mz_zip_reader_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint32 flags);
1191 MINIZ_EXPORT 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);
1193 /* Read an archive from an already opened FILE, beginning at the current file position. */
1194 /* 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. */
1195 /* The FILE will NOT be closed when mz_zip_reader_end() is called. */
1196 MINIZ_EXPORT mz_bool mz_zip_reader_init_cfile(mz_zip_archive *pZip, MZ_FILE *pFile, mz_uint64 archive_size, mz_uint flags);
1197 #endif
1199 /* Ends archive reading, freeing all allocations, and closing the input archive file if mz_zip_reader_init_file() was used. */
1200 MINIZ_EXPORT mz_bool mz_zip_reader_end(mz_zip_archive *pZip);
1202 /* -------- ZIP reading or writing */
1204 /* Clears a mz_zip_archive struct to all zeros. */
1205 /* Important: This must be done before passing the struct to any mz_zip functions. */
1206 MINIZ_EXPORT void mz_zip_zero_struct(mz_zip_archive *pZip);
1208 MINIZ_EXPORT mz_zip_mode mz_zip_get_mode(mz_zip_archive *pZip);
1209 MINIZ_EXPORT mz_zip_type mz_zip_get_type(mz_zip_archive *pZip);
1211 /* Returns the total number of files in the archive. */
1212 MINIZ_EXPORT mz_uint mz_zip_reader_get_num_files(mz_zip_archive *pZip);
1214 MINIZ_EXPORT mz_uint64 mz_zip_get_archive_size(mz_zip_archive *pZip);
1215 MINIZ_EXPORT mz_uint64 mz_zip_get_archive_file_start_offset(mz_zip_archive *pZip);
1216 MINIZ_EXPORT MZ_FILE *mz_zip_get_cfile(mz_zip_archive *pZip);
1218 /* Reads n bytes of raw archive data, starting at file offset file_ofs, to pBuf. */
1219 MINIZ_EXPORT size_t mz_zip_read_archive_data(mz_zip_archive *pZip, mz_uint64 file_ofs, void *pBuf, size_t n);
1221 /* All mz_zip funcs set the m_last_error field in the mz_zip_archive struct. These functions retrieve/manipulate this field. */
1222 /* Note that the m_last_error functionality is not thread safe. */
1223 MINIZ_EXPORT mz_zip_error mz_zip_set_last_error(mz_zip_archive *pZip, mz_zip_error err_num);
1224 MINIZ_EXPORT mz_zip_error mz_zip_peek_last_error(mz_zip_archive *pZip);
1225 MINIZ_EXPORT mz_zip_error mz_zip_clear_last_error(mz_zip_archive *pZip);
1226 MINIZ_EXPORT mz_zip_error mz_zip_get_last_error(mz_zip_archive *pZip);
1227 MINIZ_EXPORT const char *mz_zip_get_error_string(mz_zip_error mz_err);
1229 /* MZ_TRUE if the archive file entry is a directory entry. */
1230 MINIZ_EXPORT mz_bool mz_zip_reader_is_file_a_directory(mz_zip_archive *pZip, mz_uint file_index);
1232 /* MZ_TRUE if the file is encrypted/strong encrypted. */
1233 MINIZ_EXPORT mz_bool mz_zip_reader_is_file_encrypted(mz_zip_archive *pZip, mz_uint file_index);
1235 /* MZ_TRUE if the compression method is supported, and the file is not encrypted, and the file is not a compressed patch file. */
1236 MINIZ_EXPORT mz_bool mz_zip_reader_is_file_supported(mz_zip_archive *pZip, mz_uint file_index);
1238 /* Retrieves the filename of an archive file entry. */
1239 /* 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. */
1240 MINIZ_EXPORT mz_uint mz_zip_reader_get_filename(mz_zip_archive *pZip, mz_uint file_index, char *pFilename, mz_uint filename_buf_size);
1242 /* Attempts to locates a file in the archive's central directory. */
1243 /* Valid flags: MZ_ZIP_FLAG_CASE_SENSITIVE, MZ_ZIP_FLAG_IGNORE_PATH */
1244 /* Returns -1 if the file cannot be found. */
1245 MINIZ_EXPORT int mz_zip_reader_locate_file(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags);
1246 MINIZ_EXPORT mz_bool mz_zip_reader_locate_file_v2(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags, mz_uint32 *file_index);
1248 /* Returns detailed information about an archive file entry. */
1249 MINIZ_EXPORT mz_bool mz_zip_reader_file_stat(mz_zip_archive *pZip, mz_uint file_index, mz_zip_archive_file_stat *pStat);
1251 /* MZ_TRUE if the file is in zip64 format. */
1252 /* 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. */
1253 MINIZ_EXPORT mz_bool mz_zip_is_zip64(mz_zip_archive *pZip);
1255 /* Returns the total central directory size in bytes. */
1256 /* The current max supported size is <= MZ_UINT32_MAX. */
1257 MINIZ_EXPORT size_t mz_zip_get_central_dir_size(mz_zip_archive *pZip);
1259 /* Extracts a archive file to a memory buffer using no memory allocation. */
1260 /* There must be at least enough room on the stack to store the inflator's state (~34KB or so). */
1261 MINIZ_EXPORT 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);
1262 MINIZ_EXPORT 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);
1264 /* Extracts a archive file to a memory buffer. */
1265 MINIZ_EXPORT 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);
1266 MINIZ_EXPORT 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);
1268 /* Extracts a archive file to a dynamically allocated heap buffer. */
1269 /* The memory will be allocated via the mz_zip_archive's alloc/realloc functions. */
1270 /* Returns NULL and sets the last error on failure. */
1271 MINIZ_EXPORT void *mz_zip_reader_extract_to_heap(mz_zip_archive *pZip, mz_uint file_index, size_t *pSize, mz_uint flags);
1272 MINIZ_EXPORT void *mz_zip_reader_extract_file_to_heap(mz_zip_archive *pZip, const char *pFilename, size_t *pSize, mz_uint flags);
1274 /* Extracts a archive file using a callback function to output the file's data. */
1275 MINIZ_EXPORT 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);
1276 MINIZ_EXPORT 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);
1278 /* Extract a file iteratively */
1279 MINIZ_EXPORT mz_zip_reader_extract_iter_state* mz_zip_reader_extract_iter_new(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags);
1280 MINIZ_EXPORT mz_zip_reader_extract_iter_state* mz_zip_reader_extract_file_iter_new(mz_zip_archive *pZip, const char *pFilename, mz_uint flags);
1281 MINIZ_EXPORT size_t mz_zip_reader_extract_iter_read(mz_zip_reader_extract_iter_state* pState, void* pvBuf, size_t buf_size);
1282 MINIZ_EXPORT mz_bool mz_zip_reader_extract_iter_free(mz_zip_reader_extract_iter_state* pState);
1284 #ifndef MINIZ_NO_STDIO
1285 /* Extracts a archive file to a disk file and sets its last accessed and modified times. */
1286 /* This function only extracts files, not archive directory records. */
1287 MINIZ_EXPORT mz_bool mz_zip_reader_extract_to_file(mz_zip_archive *pZip, mz_uint file_index, const char *pDst_filename, mz_uint flags);
1288 MINIZ_EXPORT mz_bool mz_zip_reader_extract_file_to_file(mz_zip_archive *pZip, const char *pArchive_filename, const char *pDst_filename, mz_uint flags);
1290 /* Extracts a archive file starting at the current position in the destination FILE stream. */
1291 MINIZ_EXPORT mz_bool mz_zip_reader_extract_to_cfile(mz_zip_archive *pZip, mz_uint file_index, MZ_FILE *File, mz_uint flags);
1292 MINIZ_EXPORT mz_bool mz_zip_reader_extract_file_to_cfile(mz_zip_archive *pZip, const char *pArchive_filename, MZ_FILE *pFile, mz_uint flags);
1293 #endif
1295 #if 0
1296 /* TODO */
1297 typedef void *mz_zip_streaming_extract_state_ptr;
1298 mz_zip_streaming_extract_state_ptr mz_zip_streaming_extract_begin(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags);
1299 mz_uint64 mz_zip_streaming_extract_get_size(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState);
1300 mz_uint64 mz_zip_streaming_extract_get_cur_ofs(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState);
1301 mz_bool mz_zip_streaming_extract_seek(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState, mz_uint64 new_ofs);
1302 size_t mz_zip_streaming_extract_read(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState, void *pBuf, size_t buf_size);
1303 mz_bool mz_zip_streaming_extract_end(mz_zip_archive *pZip, mz_zip_streaming_extract_state_ptr pState);
1304 #endif
1306 /* 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. */
1307 /* It also validates that each file can be successfully uncompressed unless the MZ_ZIP_FLAG_VALIDATE_HEADERS_ONLY is specified. */
1308 MINIZ_EXPORT mz_bool mz_zip_validate_file(mz_zip_archive *pZip, mz_uint file_index, mz_uint flags);
1310 /* Validates an entire archive by calling mz_zip_validate_file() on each file. */
1311 MINIZ_EXPORT mz_bool mz_zip_validate_archive(mz_zip_archive *pZip, mz_uint flags);
1313 /* Misc utils/helpers, valid for ZIP reading or writing */
1314 MINIZ_EXPORT mz_bool mz_zip_validate_mem_archive(const void *pMem, size_t size, mz_uint flags, mz_zip_error *pErr);
1315 #ifndef MINIZ_NO_STDIO
1316 MINIZ_EXPORT mz_bool mz_zip_validate_file_archive(const char *pFilename, mz_uint flags, mz_zip_error *pErr);
1317 #endif
1319 /* Universal end function - calls either mz_zip_reader_end() or mz_zip_writer_end(). */
1320 MINIZ_EXPORT mz_bool mz_zip_end(mz_zip_archive *pZip);
1322 /* -------- ZIP writing */
1324 #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS
1326 /* Inits a ZIP archive writer. */
1327 /*Set pZip->m_pWrite (and pZip->m_pIO_opaque) before calling mz_zip_writer_init or mz_zip_writer_init_v2*/
1328 /*The output is streamable, i.e. file_ofs in mz_file_write_func always increases only by n*/
1329 MINIZ_EXPORT mz_bool mz_zip_writer_init(mz_zip_archive *pZip, mz_uint64 existing_size);
1330 MINIZ_EXPORT mz_bool mz_zip_writer_init_v2(mz_zip_archive *pZip, mz_uint64 existing_size, mz_uint flags);
1332 MINIZ_EXPORT mz_bool mz_zip_writer_init_heap(mz_zip_archive *pZip, size_t size_to_reserve_at_beginning, size_t initial_allocation_size);
1333 MINIZ_EXPORT 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);
1335 #ifndef MINIZ_NO_STDIO
1336 MINIZ_EXPORT mz_bool mz_zip_writer_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint64 size_to_reserve_at_beginning);
1337 MINIZ_EXPORT 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);
1338 MINIZ_EXPORT mz_bool mz_zip_writer_init_cfile(mz_zip_archive *pZip, MZ_FILE *pFile, mz_uint flags);
1339 #endif
1341 /* Converts a ZIP archive reader object into a writer object, to allow efficient in-place file appends to occur on an existing archive. */
1342 /* 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. */
1343 /* 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). */
1344 /* Finally, for archives opened using mz_zip_reader_init, the mz_zip_archive's user provided m_pWrite function cannot be NULL. */
1345 /* Note: In-place archive modification is not recommended unless you know what you're doing, because if execution stops or something goes wrong before */
1346 /* the archive is finalized the file's central directory will be hosed. */
1347 MINIZ_EXPORT mz_bool mz_zip_writer_init_from_reader(mz_zip_archive *pZip, const char *pFilename);
1348 MINIZ_EXPORT mz_bool mz_zip_writer_init_from_reader_v2(mz_zip_archive *pZip, const char *pFilename, mz_uint flags);
1350 /* Adds the contents of a memory buffer to an archive. These functions record the current local time into the archive. */
1351 /* To add a directory entry, call this method with an archive name ending in a forwardslash with an empty buffer. */
1352 /* 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. */
1353 MINIZ_EXPORT 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);
1355 /* Like mz_zip_writer_add_mem(), except you can specify a file comment field, and optionally supply the function with already compressed data. */
1356 /* uncomp_size/uncomp_crc32 are only used if the MZ_ZIP_FLAG_COMPRESSED_DATA flag is specified. */
1357 MINIZ_EXPORT 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,
1358 mz_uint64 uncomp_size, mz_uint32 uncomp_crc32);
1360 MINIZ_EXPORT 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,
1361 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,
1362 const char *user_extra_data_central, mz_uint user_extra_data_central_len);
1364 /* Adds the contents of a file to an archive. This function also records the disk file's modified time into the archive. */
1365 /* File data is supplied via a read callback function. User mz_zip_writer_add_(c)file to add a file directly.*/
1366 MINIZ_EXPORT mz_bool mz_zip_writer_add_read_buf_callback(mz_zip_archive *pZip, const char *pArchive_name, mz_file_read_func read_callback, void* callback_opaque, mz_uint64 max_size,
1367 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,
1368 const char *user_extra_data_central, mz_uint user_extra_data_central_len);
1371 #ifndef MINIZ_NO_STDIO
1372 /* Adds the contents of a disk file to an archive. This function also records the disk file's modified time into the archive. */
1373 /* 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. */
1374 MINIZ_EXPORT 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);
1376 /* Like mz_zip_writer_add_file(), except the file data is read from the specified FILE stream. */
1377 MINIZ_EXPORT mz_bool mz_zip_writer_add_cfile(mz_zip_archive *pZip, const char *pArchive_name, MZ_FILE *pSrc_file, mz_uint64 max_size,
1378 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,
1379 const char *user_extra_data_central, mz_uint user_extra_data_central_len);
1380 #endif
1382 /* Adds a file to an archive by fully cloning the data from another archive. */
1383 /* 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. */
1384 MINIZ_EXPORT mz_bool mz_zip_writer_add_from_zip_reader(mz_zip_archive *pZip, mz_zip_archive *pSource_zip, mz_uint src_file_index);
1386 /* Finalizes the archive by writing the central directory records followed by the end of central directory record. */
1387 /* After an archive is finalized, the only valid call on the mz_zip_archive struct is mz_zip_writer_end(). */
1388 /* An archive must be manually finalized by calling this function for it to be valid. */
1389 MINIZ_EXPORT mz_bool mz_zip_writer_finalize_archive(mz_zip_archive *pZip);
1391 /* Finalizes a heap archive, returning a pointer to the heap block and its size. */
1392 /* The heap block will be allocated using the mz_zip_archive's alloc/realloc callbacks. */
1393 MINIZ_EXPORT mz_bool mz_zip_writer_finalize_heap_archive(mz_zip_archive *pZip, void **ppBuf, size_t *pSize);
1395 /* Ends archive writing, freeing all allocations, and closing the output file if mz_zip_writer_init_file() was used. */
1396 /* Note for the archive to be valid, it *must* have been finalized before ending (this function will not do it for you). */
1397 MINIZ_EXPORT mz_bool mz_zip_writer_end(mz_zip_archive *pZip);
1399 /* -------- Misc. high-level helper functions: */
1401 /* mz_zip_add_mem_to_archive_file_in_place() efficiently (but not atomically) appends a memory blob to a ZIP archive. */
1402 /* 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). */
1403 /* 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. */
1404 /* 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. */
1405 MINIZ_EXPORT 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);
1406 MINIZ_EXPORT 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);
1408 #ifndef MINIZ_NO_STDIO
1409 /* Reads a single file from an archive into a heap block. */
1410 /* If pComment is not NULL, only the file with the specified comment will be extracted. */
1411 /* Returns NULL on failure. */
1412 MINIZ_EXPORT void *mz_zip_extract_archive_file_to_heap(const char *pZip_filename, const char *pArchive_name, size_t *pSize, mz_uint flags);
1413 MINIZ_EXPORT 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);
1414 #endif
1416 #endif /* #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS */
1418 #ifdef __cplusplus
1420 #endif
1422 #endif /* MINIZ_NO_ARCHIVE_APIS */