1 #ifndef MINIZ_HEADER_INCLUDED 2 #define MINIZ_HEADER_INCLUDED 3 4 #include <stdlib.h> 5 6 #if defined(__TINYC__) && (defined(__linux) || defined(__linux__)) 7 // TODO: Work around "error: include file 'sys\utime.h' when compiling with tcc on Linux 8 #define MINIZ_NO_TIME 9 #endif 10 11 #if !defined(MINIZ_NO_TIME) && !defined(MINIZ_NO_ARCHIVE_APIS) 12 #include <time.h> 13 #endif 14 15 #if defined(_M_IX86) || defined(_M_X64) || defined(__i386__) || defined(__i386) || defined(__i486__) || defined(__i486) || defined(i386) || defined(__ia64__) || defined(__x86_64__) 16 // MINIZ_X86_OR_X64_CPU is only used to help set the below macros. 17 #define MINIZ_X86_OR_X64_CPU 1 18 #endif 19 20 #if (__BYTE_ORDER__==__ORDER_LITTLE_ENDIAN__) || MINIZ_X86_OR_X64_CPU 21 // Set MINIZ_LITTLE_ENDIAN to 1 if the processor is little endian. 22 #define MINIZ_LITTLE_ENDIAN 1 23 #endif 24 25 #if MINIZ_X86_OR_X64_CPU 26 // Set MINIZ_USE_UNALIGNED_LOADS_AND_STORES to 1 on CPU's that permit efficient integer loads and stores from unaligned addresses. 27 #define MINIZ_USE_UNALIGNED_LOADS_AND_STORES 1 28 #endif 29 30 #if defined(_M_X64) || defined(_WIN64) || defined(__MINGW64__) || defined(_LP64) || defined(__LP64__) || defined(__ia64__) || defined(__x86_64__) 31 // 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). 32 #define MINIZ_HAS_64BIT_REGISTERS 1 33 #endif 34 35 // Return status codes. MZ_PARAM_ERROR is non-standard. 36 enum { 37 MZ_OK = 0, 38 MZ_STREAM_END = 1, 39 MZ_NEED_DICT = 2, 40 MZ_ERRNO = -1, 41 MZ_STREAM_ERROR = -2, 42 MZ_DATA_ERROR = -3, 43 MZ_MEM_ERROR = -4, 44 MZ_BUF_ERROR = -5, 45 MZ_VERSION_ERROR = -6, 46 MZ_PARAM_ERROR = -10000 47 }; 48 49 typedef unsigned long mz_ulong; 50 51 #ifdef __cplusplus 52 extern "C" { 53 #endif 54 55 // ------------------- zlib-style API Definitions. 56 57 // 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. 58 void mz_free(void *p); 59 60 #define MZ_ADLER32_INIT (1) 61 // mz_adler32() returns the initial adler-32 value to use when called with ptr==NULL. 62 mz_ulong mz_adler32(mz_ulong adler, const unsigned char *ptr, size_t buf_len); 63 64 #define MZ_CRC32_INIT (0) 65 // mz_crc32() returns the initial CRC-32 value to use when called with ptr==NULL. 66 mz_ulong mz_crc32(mz_ulong crc, const unsigned char *ptr, size_t buf_len); 67 68 // Compression strategies. 69 enum { MZ_DEFAULT_STRATEGY = 0, MZ_FILTERED = 1, MZ_HUFFMAN_ONLY = 2, MZ_RLE = 3, MZ_FIXED = 4 }; 70 71 // Method 72 #define MZ_DEFLATED 8 73 74 #ifndef MINIZ_NO_ZLIB_APIS 75 76 // Heap allocation callbacks. 77 // Note that mz_alloc_func parameter types purpsosely differ from zlib's: items/size is size_t, not unsigned long. 78 typedef void *(*mz_alloc_func)(void *opaque, size_t items, size_t size); 79 typedef void (*mz_free_func)(void *opaque, void *address); 80 typedef void *(*mz_realloc_func)(void *opaque, void *address, size_t items, size_t size); 81 82 #define MZ_VERSION "9.1.15" 83 #define MZ_VERNUM 0x91F0 84 #define MZ_VER_MAJOR 9 85 #define MZ_VER_MINOR 1 86 #define MZ_VER_REVISION 15 87 #define MZ_VER_SUBREVISION 0 88 89 // 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). 90 enum { MZ_NO_FLUSH = 0, MZ_PARTIAL_FLUSH = 1, MZ_SYNC_FLUSH = 2, MZ_FULL_FLUSH = 3, MZ_FINISH = 4, MZ_BLOCK = 5 }; 91 92 // 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. 93 enum { MZ_NO_COMPRESSION = 0, MZ_BEST_SPEED = 1, MZ_BEST_COMPRESSION = 9, MZ_UBER_COMPRESSION = 10, MZ_DEFAULT_LEVEL = 6, MZ_DEFAULT_COMPRESSION = -1 }; 94 95 // Window bits 96 #define MZ_DEFAULT_WINDOW_BITS 15 97 98 struct mz_internal_state; 99 100 // Compression/decompression stream struct. 101 typedef struct mz_stream_s 102 { 103 const unsigned char *next_in; // pointer to next byte to read 104 unsigned int avail_in; // number of bytes available at next_in 105 mz_ulong total_in; // total number of bytes consumed so far 106 107 unsigned char *next_out; // pointer to next byte to write 108 unsigned int avail_out; // number of bytes that can be written to next_out 109 mz_ulong total_out; // total number of bytes produced so far 110 111 char *msg; // error msg (unused) 112 struct mz_internal_state *state; // internal state, allocated by zalloc/zfree 113 114 mz_alloc_func zalloc; // optional heap allocation function (defaults to malloc) 115 mz_free_func zfree; // optional heap free function (defaults to free) 116 void *opaque; // heap alloc function user pointer 117 118 int data_type; // data_type (unused) 119 mz_ulong adler; // adler32 of the source or uncompressed data 120 mz_ulong reserved; // not used 121 } mz_stream; 122 123 typedef mz_stream *mz_streamp; 124 125 // Returns the version string of miniz.c. 126 const char *mz_version(void); 127 128 // mz_deflateInit() initializes a compressor with default options: 129 // Parameters: 130 // pStream must point to an initialized mz_stream struct. 131 // level must be between [MZ_NO_COMPRESSION, MZ_BEST_COMPRESSION]. 132 // level 1 enables a specially optimized compression function that's been optimized purely for performance, not ratio. 133 // (This special func. is currently only enabled when MINIZ_USE_UNALIGNED_LOADS_AND_STORES and MINIZ_LITTLE_ENDIAN are defined.) 134 // Return values: 135 // MZ_OK on success. 136 // MZ_STREAM_ERROR if the stream is bogus. 137 // MZ_PARAM_ERROR if the input parameters are bogus. 138 // MZ_MEM_ERROR on out of memory. 139 int mz_deflateInit(mz_streamp pStream, int level); 140 141 // mz_deflateInit2() is like mz_deflate(), except with more control: 142 // Additional parameters: 143 // method must be MZ_DEFLATED 144 // 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) 145 // mem_level must be between [1, 9] (it's checked but ignored by miniz.c) 146 int mz_deflateInit2(mz_streamp pStream, int level, int method, int window_bits, int mem_level, int strategy); 147 148 // Quickly resets a compressor without having to reallocate anything. Same as calling mz_deflateEnd() followed by mz_deflateInit()/mz_deflateInit2(). 149 int mz_deflateReset(mz_streamp pStream); 150 151 // mz_deflate() compresses the input to output, consuming as much of the input and producing as much output as possible. 152 // Parameters: 153 // 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. 154 // flush may be MZ_NO_FLUSH, MZ_PARTIAL_FLUSH/MZ_SYNC_FLUSH, MZ_FULL_FLUSH, or MZ_FINISH. 155 // Return values: 156 // 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). 157 // 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. 158 // MZ_STREAM_ERROR if the stream is bogus. 159 // MZ_PARAM_ERROR if one of the parameters is invalid. 160 // 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.) 161 int mz_deflate(mz_streamp pStream, int flush); 162 163 // mz_deflateEnd() deinitializes a compressor: 164 // Return values: 165 // MZ_OK on success. 166 // MZ_STREAM_ERROR if the stream is bogus. 167 int mz_deflateEnd(mz_streamp pStream); 168 169 // 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. 170 mz_ulong mz_deflateBound(mz_streamp pStream, mz_ulong source_len); 171 172 // Single-call compression functions mz_compress() and mz_compress2(): 173 // Returns MZ_OK on success, or one of the error codes from mz_deflate() on failure. 174 int mz_compress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len); 175 int mz_compress2(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len, int level); 176 177 // mz_compressBound() returns a (very) conservative upper bound on the amount of data that could be generated by calling mz_compress(). 178 mz_ulong mz_compressBound(mz_ulong source_len); 179 180 // Initializes a decompressor. 181 int mz_inflateInit(mz_streamp pStream); 182 183 // 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: 184 // window_bits must be MZ_DEFAULT_WINDOW_BITS (to parse zlib header/footer) or -MZ_DEFAULT_WINDOW_BITS (raw deflate). 185 int mz_inflateInit2(mz_streamp pStream, int window_bits); 186 187 // 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. 188 // Parameters: 189 // 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. 190 // flush may be MZ_NO_FLUSH, MZ_SYNC_FLUSH, or MZ_FINISH. 191 // 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). 192 // 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. 193 // Return values: 194 // 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. 195 // 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. 196 // MZ_STREAM_ERROR if the stream is bogus. 197 // MZ_DATA_ERROR if the deflate stream is invalid. 198 // MZ_PARAM_ERROR if one of the parameters is invalid. 199 // 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 200 // with more input data, or with more room in the output buffer (except when using single call decompression, described above). 201 int mz_inflate(mz_streamp pStream, int flush); 202 203 // Deinitializes a decompressor. 204 int mz_inflateEnd(mz_streamp pStream); 205 206 // Single-call decompression. 207 // Returns MZ_OK on success, or one of the error codes from mz_inflate() on failure. 208 int mz_uncompress(unsigned char *pDest, mz_ulong *pDest_len, const unsigned char *pSource, mz_ulong source_len); 209 210 // Returns a string description of the specified error code, or NULL if the error code is invalid. 211 const char *mz_error(int err); 212 213 // 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. 214 // Define MINIZ_NO_ZLIB_COMPATIBLE_NAMES to disable zlib-compatibility if you use zlib in the same project. 215 #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES 216 typedef unsigned char Byte; 217 typedef unsigned int uInt; 218 typedef mz_ulong uLong; 219 typedef Byte Bytef; 220 typedef uInt uIntf; 221 typedef char charf; 222 typedef int intf; 223 typedef void *voidpf; 224 typedef uLong uLongf; 225 typedef void *voidp; 226 typedef void *const voidpc; 227 #define Z_NULL 0 228 #define Z_NO_FLUSH MZ_NO_FLUSH 229 #define Z_PARTIAL_FLUSH MZ_PARTIAL_FLUSH 230 #define Z_SYNC_FLUSH MZ_SYNC_FLUSH 231 #define Z_FULL_FLUSH MZ_FULL_FLUSH 232 #define Z_FINISH MZ_FINISH 233 #define Z_BLOCK MZ_BLOCK 234 #define Z_OK MZ_OK 235 #define Z_STREAM_END MZ_STREAM_END 236 #define Z_NEED_DICT MZ_NEED_DICT 237 #define Z_ERRNO MZ_ERRNO 238 #define Z_STREAM_ERROR MZ_STREAM_ERROR 239 #define Z_DATA_ERROR MZ_DATA_ERROR 240 #define Z_MEM_ERROR MZ_MEM_ERROR 241 #define Z_BUF_ERROR MZ_BUF_ERROR 242 #define Z_VERSION_ERROR MZ_VERSION_ERROR 243 #define Z_PARAM_ERROR MZ_PARAM_ERROR 244 #define Z_NO_COMPRESSION MZ_NO_COMPRESSION 245 #define Z_BEST_SPEED MZ_BEST_SPEED 246 #define Z_BEST_COMPRESSION MZ_BEST_COMPRESSION 247 #define Z_DEFAULT_COMPRESSION MZ_DEFAULT_COMPRESSION 248 #define Z_DEFAULT_STRATEGY MZ_DEFAULT_STRATEGY 249 #define Z_FILTERED MZ_FILTERED 250 #define Z_HUFFMAN_ONLY MZ_HUFFMAN_ONLY 251 #define Z_RLE MZ_RLE 252 #define Z_FIXED MZ_FIXED 253 #define Z_DEFLATED MZ_DEFLATED 254 #define Z_DEFAULT_WINDOW_BITS MZ_DEFAULT_WINDOW_BITS 255 #define alloc_func mz_alloc_func 256 #define free_func mz_free_func 257 #define internal_state mz_internal_state 258 #define z_stream mz_stream 259 #define deflateInit mz_deflateInit 260 #define deflateInit2 mz_deflateInit2 261 #define deflateReset mz_deflateReset 262 #define deflate mz_deflate 263 #define deflateEnd mz_deflateEnd 264 #define deflateBound mz_deflateBound 265 #define compress mz_compress 266 #define compress2 mz_compress2 267 #define compressBound mz_compressBound 268 #define inflateInit mz_inflateInit 269 #define inflateInit2 mz_inflateInit2 270 #define inflate mz_inflate 271 #define inflateEnd mz_inflateEnd 272 #define uncompress mz_uncompress 273 #define crc32 mz_crc32 274 #define adler32 mz_adler32 275 #define MAX_WBITS 15 276 #define MAX_MEM_LEVEL 9 277 #define zError mz_error 278 #define ZLIB_VERSION MZ_VERSION 279 #define ZLIB_VERNUM MZ_VERNUM 280 #define ZLIB_VER_MAJOR MZ_VER_MAJOR 281 #define ZLIB_VER_MINOR MZ_VER_MINOR 282 #define ZLIB_VER_REVISION MZ_VER_REVISION 283 #define ZLIB_VER_SUBREVISION MZ_VER_SUBREVISION 284 #define zlibVersion mz_version 285 #define zlib_version mz_version() 286 #endif // #ifndef MINIZ_NO_ZLIB_COMPATIBLE_NAMES 287 288 #endif // MINIZ_NO_ZLIB_APIS 289 290 // ------------------- Types and macros 291 292 typedef unsigned char mz_uint8; 293 typedef signed short mz_int16; 294 typedef unsigned short mz_uint16; 295 typedef unsigned int mz_uint32; 296 typedef unsigned int mz_uint; 297 typedef long long mz_int64; 298 typedef unsigned long long mz_uint64; 299 typedef int mz_bool; 300 301 #define MZ_FALSE (0) 302 #define MZ_TRUE (1) 303 304 // An attempt to work around MSVC's spammy "warning C4127: conditional expression is constant" message. 305 #ifdef _MSC_VER 306 #define MZ_MACRO_END while (0, 0) 307 #else 308 #define MZ_MACRO_END while (0) 309 #endif 310 311 // ------------------- ZIP archive reading/writing 312 313 #ifndef MINIZ_NO_ARCHIVE_APIS 314 315 enum 316 { 317 MZ_ZIP_MAX_IO_BUF_SIZE = 64*1024, 318 MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE = 260, 319 MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE = 256 320 }; 321 322 typedef struct 323 { 324 mz_uint32 m_file_index; 325 mz_uint32 m_central_dir_ofs; 326 mz_uint16 m_version_made_by; 327 mz_uint16 m_version_needed; 328 mz_uint16 m_bit_flag; 329 mz_uint16 m_method; 330 #ifndef MINIZ_NO_TIME 331 time_t m_time; 332 #endif 333 mz_uint32 m_crc32; 334 mz_uint64 m_comp_size; 335 mz_uint64 m_uncomp_size; 336 mz_uint16 m_internal_attr; 337 mz_uint32 m_external_attr; 338 mz_uint64 m_local_header_ofs; 339 mz_uint32 m_comment_size; 340 char m_filename[MZ_ZIP_MAX_ARCHIVE_FILENAME_SIZE]; 341 char m_comment[MZ_ZIP_MAX_ARCHIVE_FILE_COMMENT_SIZE]; 342 } mz_zip_archive_file_stat; 343 344 typedef size_t (*mz_file_read_func)(void *pOpaque, mz_uint64 file_ofs, void *pBuf, size_t n); 345 typedef size_t (*mz_file_write_func)(void *pOpaque, mz_uint64 file_ofs, const void *pBuf, size_t n); 346 347 struct mz_zip_internal_state_tag; 348 typedef struct mz_zip_internal_state_tag mz_zip_internal_state; 349 350 typedef enum 351 { 352 MZ_ZIP_MODE_INVALID = 0, 353 MZ_ZIP_MODE_READING = 1, 354 MZ_ZIP_MODE_WRITING = 2, 355 MZ_ZIP_MODE_WRITING_HAS_BEEN_FINALIZED = 3 356 } mz_zip_mode; 357 358 typedef struct mz_zip_archive_tag 359 { 360 mz_uint64 m_archive_size; 361 mz_uint64 m_central_directory_file_ofs; 362 mz_uint m_total_files; 363 mz_zip_mode m_zip_mode; 364 365 mz_uint m_file_offset_alignment; 366 367 mz_alloc_func m_pAlloc; 368 mz_free_func m_pFree; 369 mz_realloc_func m_pRealloc; 370 void *m_pAlloc_opaque; 371 372 mz_file_read_func m_pRead; 373 mz_file_write_func m_pWrite; 374 void *m_pIO_opaque; 375 376 mz_zip_internal_state *m_pState; 377 378 } mz_zip_archive; 379 380 typedef enum 381 { 382 MZ_ZIP_FLAG_CASE_SENSITIVE = 0x0100, 383 MZ_ZIP_FLAG_IGNORE_PATH = 0x0200, 384 MZ_ZIP_FLAG_COMPRESSED_DATA = 0x0400, 385 MZ_ZIP_FLAG_DO_NOT_SORT_CENTRAL_DIRECTORY = 0x0800 386 } mz_zip_flags; 387 388 // ZIP archive reading 389 390 // Inits a ZIP archive reader. 391 // These functions read and validate the archive's central directory. 392 mz_bool mz_zip_reader_init(mz_zip_archive *pZip, mz_uint64 size, mz_uint32 flags); 393 mz_bool mz_zip_reader_init_mem(mz_zip_archive *pZip, const void *pMem, size_t size, mz_uint32 flags); 394 395 #ifndef MINIZ_NO_STDIO 396 mz_bool mz_zip_reader_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint32 flags); 397 #endif 398 399 // Returns the total number of files in the archive. 400 mz_uint mz_zip_reader_get_num_files(mz_zip_archive *pZip); 401 402 // Returns detailed information about an archive file entry. 403 mz_bool mz_zip_reader_file_stat(mz_zip_archive *pZip, mz_uint file_index, mz_zip_archive_file_stat *pStat); 404 405 // Determines if an archive file entry is a directory entry. 406 mz_bool mz_zip_reader_is_file_a_directory(mz_zip_archive *pZip, mz_uint file_index); 407 mz_bool mz_zip_reader_is_file_encrypted(mz_zip_archive *pZip, mz_uint file_index); 408 409 // Retrieves the filename of an archive file entry. 410 // 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. 411 mz_uint mz_zip_reader_get_filename(mz_zip_archive *pZip, mz_uint file_index, char *pFilename, mz_uint filename_buf_size); 412 413 // Attempts to locates a file in the archive's central directory. 414 // Valid flags: MZ_ZIP_FLAG_CASE_SENSITIVE, MZ_ZIP_FLAG_IGNORE_PATH 415 // Returns -1 if the file cannot be found. 416 int mz_zip_reader_locate_file(mz_zip_archive *pZip, const char *pName, const char *pComment, mz_uint flags); 417 418 // Extracts a archive file to a memory buffer using no memory allocation. 419 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); 420 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); 421 422 // Extracts a archive file to a memory buffer. 423 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); 424 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); 425 426 // Extracts a archive file to a dynamically allocated heap buffer. 427 void *mz_zip_reader_extract_to_heap(mz_zip_archive *pZip, mz_uint file_index, size_t *pSize, mz_uint flags); 428 void *mz_zip_reader_extract_file_to_heap(mz_zip_archive *pZip, const char *pFilename, size_t *pSize, mz_uint flags); 429 430 // Extracts a archive file using a callback function to output the file's data. 431 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); 432 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); 433 434 #ifndef MINIZ_NO_STDIO 435 // Extracts a archive file to a disk file and sets its last accessed and modified times. 436 // This function only extracts files, not archive directory records. 437 mz_bool mz_zip_reader_extract_to_file(mz_zip_archive *pZip, mz_uint file_index, const char *pDst_filename, mz_uint flags); 438 mz_bool mz_zip_reader_extract_file_to_file(mz_zip_archive *pZip, const char *pArchive_filename, const char *pDst_filename, mz_uint flags); 439 #endif 440 441 // Ends archive reading, freeing all allocations, and closing the input archive file if mz_zip_reader_init_file() was used. 442 mz_bool mz_zip_reader_end(mz_zip_archive *pZip); 443 444 // ZIP archive writing 445 446 #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS 447 448 // Inits a ZIP archive writer. 449 mz_bool mz_zip_writer_init(mz_zip_archive *pZip, mz_uint64 existing_size); 450 mz_bool mz_zip_writer_init_heap(mz_zip_archive *pZip, size_t size_to_reserve_at_beginning, size_t initial_allocation_size); 451 452 #ifndef MINIZ_NO_STDIO 453 mz_bool mz_zip_writer_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint64 size_to_reserve_at_beginning); 454 #endif 455 456 // Converts a ZIP archive reader object into a writer object, to allow efficient in-place file appends to occur on an existing archive. 457 // 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. 458 // 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). 459 // Finally, for archives opened using mz_zip_reader_init, the mz_zip_archive's user provided m_pWrite function cannot be NULL. 460 // Note: In-place archive modification is not recommended unless you know what you're doing, because if execution stops or something goes wrong before 461 // the archive is finalized the file's central directory will be hosed. 462 mz_bool mz_zip_writer_init_from_reader(mz_zip_archive *pZip, const char *pFilename); 463 464 // Adds the contents of a memory buffer to an archive. These functions record the current local time into the archive. 465 // To add a directory entry, call this method with an archive name ending in a forwardslash with empty buffer. 466 // 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. 467 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); 468 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, mz_uint64 uncomp_size, mz_uint32 uncomp_crc32); 469 470 #ifndef MINIZ_NO_STDIO 471 // Adds the contents of a disk file to an archive. This function also records the disk file's modified time into the archive. 472 // 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. 473 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); 474 #endif 475 476 // Adds a file to an archive by fully cloning the data from another archive. 477 // This function fully clones the source file's compressed data (no recompression), along with its full filename, extra data, and comment fields. 478 mz_bool mz_zip_writer_add_from_zip_reader(mz_zip_archive *pZip, mz_zip_archive *pSource_zip, mz_uint file_index); 479 480 // Finalizes the archive by writing the central directory records followed by the end of central directory record. 481 // After an archive is finalized, the only valid call on the mz_zip_archive struct is mz_zip_writer_end(). 482 // An archive must be manually finalized by calling this function for it to be valid. 483 mz_bool mz_zip_writer_finalize_archive(mz_zip_archive *pZip); 484 mz_bool mz_zip_writer_finalize_heap_archive(mz_zip_archive *pZip, void **pBuf, size_t *pSize); 485 486 // Ends archive writing, freeing all allocations, and closing the output file if mz_zip_writer_init_file() was used. 487 // Note for the archive to be valid, it must have been finalized before ending. 488 mz_bool mz_zip_writer_end(mz_zip_archive *pZip); 489 490 // Misc. high-level helper functions: 491 492 // mz_zip_add_mem_to_archive_file_in_place() efficiently (but not atomically) appends a memory blob to a ZIP archive. 493 // 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. 494 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); 495 496 // Reads a single file from an archive into a heap block. 497 // Returns NULL on failure. 498 void *mz_zip_extract_archive_file_to_heap(const char *pZip_filename, const char *pArchive_name, size_t *pSize, mz_uint zip_flags); 499 500 #endif // #ifndef MINIZ_NO_ARCHIVE_WRITING_APIS 501 502 #endif // #ifndef MINIZ_NO_ARCHIVE_APIS 503 504 // ------------------- Low-level Decompression API Definitions 505 506 // Decompression flags used by tinfl_decompress(). 507 // 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. 508 // 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. 509 // 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). 510 // TINFL_FLAG_COMPUTE_ADLER32: Force adler-32 checksum computation of the decompressed bytes. 511 enum 512 { 513 TINFL_FLAG_PARSE_ZLIB_HEADER = 1, 514 TINFL_FLAG_HAS_MORE_INPUT = 2, 515 TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF = 4, 516 TINFL_FLAG_COMPUTE_ADLER32 = 8 517 }; 518 519 // High level decompression functions: 520 // tinfl_decompress_mem_to_heap() decompresses a block in memory to a heap block allocated via malloc(). 521 // On entry: 522 // pSrc_buf, src_buf_len: Pointer and size of the Deflate or zlib source data to decompress. 523 // On return: 524 // Function returns a pointer to the decompressed data, or NULL on failure. 525 // *pOut_len will be set to the decompressed data's size, which could be larger than src_buf_len on uncompressible data. 526 // The caller must call mz_free() on the returned block when it's no longer needed. 527 void *tinfl_decompress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); 528 529 // tinfl_decompress_mem_to_mem() decompresses a block in memory to another block in memory. 530 // Returns TINFL_DECOMPRESS_MEM_TO_MEM_FAILED on failure, or the number of bytes written on success. 531 #define TINFL_DECOMPRESS_MEM_TO_MEM_FAILED ((size_t)(-1)) 532 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); 533 534 // 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. 535 // Returns 1 on success or 0 on failure. 536 typedef int (*tinfl_put_buf_func_ptr)(const void* pBuf, int len, void *pUser); 537 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); 538 539 struct tinfl_decompressor_tag; typedef struct tinfl_decompressor_tag tinfl_decompressor; 540 541 // Max size of LZ dictionary. 542 #define TINFL_LZ_DICT_SIZE 32768 543 544 // Return status. 545 typedef enum 546 { 547 TINFL_STATUS_BAD_PARAM = -3, 548 TINFL_STATUS_ADLER32_MISMATCH = -2, 549 TINFL_STATUS_FAILED = -1, 550 TINFL_STATUS_DONE = 0, 551 TINFL_STATUS_NEEDS_MORE_INPUT = 1, 552 TINFL_STATUS_HAS_MORE_OUTPUT = 2 553 } tinfl_status; 554 555 // Initializes the decompressor to its initial state. 556 #define tinfl_init(r) do { (r)->m_state = 0; } MZ_MACRO_END 557 #define tinfl_get_adler32(r) (r)->m_check_adler32 558 559 // 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. 560 // 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. 561 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); 562 563 // Internal/private bits follow. 564 enum 565 { 566 TINFL_MAX_HUFF_TABLES = 3, TINFL_MAX_HUFF_SYMBOLS_0 = 288, TINFL_MAX_HUFF_SYMBOLS_1 = 32, TINFL_MAX_HUFF_SYMBOLS_2 = 19, 567 TINFL_FAST_LOOKUP_BITS = 10, TINFL_FAST_LOOKUP_SIZE = 1 << TINFL_FAST_LOOKUP_BITS 568 }; 569 570 typedef struct 571 { 572 mz_uint8 m_code_size[TINFL_MAX_HUFF_SYMBOLS_0]; 573 mz_int16 m_look_up[TINFL_FAST_LOOKUP_SIZE], m_tree[TINFL_MAX_HUFF_SYMBOLS_0 * 2]; 574 } tinfl_huff_table; 575 576 #if MINIZ_HAS_64BIT_REGISTERS 577 #define TINFL_USE_64BIT_BITBUF 1 578 #endif 579 580 #if TINFL_USE_64BIT_BITBUF 581 typedef mz_uint64 tinfl_bit_buf_t; 582 #define TINFL_BITBUF_SIZE (64) 583 #else 584 typedef mz_uint32 tinfl_bit_buf_t; 585 #define TINFL_BITBUF_SIZE (32) 586 #endif 587 588 struct tinfl_decompressor_tag 589 { 590 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]; 591 tinfl_bit_buf_t m_bit_buf; 592 size_t m_dist_from_out_buf_start; 593 tinfl_huff_table m_tables[TINFL_MAX_HUFF_TABLES]; 594 mz_uint8 m_raw_header[4], m_len_codes[TINFL_MAX_HUFF_SYMBOLS_0 + TINFL_MAX_HUFF_SYMBOLS_1 + 137]; 595 }; 596 597 // ------------------- Low-level Compression API Definitions 598 599 // Set TDEFL_LESS_MEMORY to 1 to use less memory (compression will be slightly slower, and raw/dynamic blocks will be output more frequently). 600 #define TDEFL_LESS_MEMORY 0 601 602 // tdefl_init() compression flags logically OR'd together (low 12 bits contain the max. number of probes per dictionary search): 603 // 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). 604 enum 605 { 606 TDEFL_HUFFMAN_ONLY = 0, TDEFL_DEFAULT_MAX_PROBES = 128, TDEFL_MAX_PROBES_MASK = 0xFFF 607 }; 608 609 // 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. 610 // TDEFL_COMPUTE_ADLER32: Always compute the adler-32 of the input data (even when not writing zlib headers). 611 // TDEFL_GREEDY_PARSING_FLAG: Set to use faster greedy parsing, instead of more efficient lazy parsing. 612 // 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). 613 // TDEFL_RLE_MATCHES: Only look for RLE matches (matches with a distance of 1) 614 // TDEFL_FILTER_MATCHES: Discards matches <= 5 chars if enabled. 615 // TDEFL_FORCE_ALL_STATIC_BLOCKS: Disable usage of optimized Huffman tables. 616 // TDEFL_FORCE_ALL_RAW_BLOCKS: Only use raw (uncompressed) deflate blocks. 617 // The low 12 bits are reserved to control the max # of hash probes per dictionary lookup (see TDEFL_MAX_PROBES_MASK). 618 enum 619 { 620 TDEFL_WRITE_ZLIB_HEADER = 0x01000, 621 TDEFL_COMPUTE_ADLER32 = 0x02000, 622 TDEFL_GREEDY_PARSING_FLAG = 0x04000, 623 TDEFL_NONDETERMINISTIC_PARSING_FLAG = 0x08000, 624 TDEFL_RLE_MATCHES = 0x10000, 625 TDEFL_FILTER_MATCHES = 0x20000, 626 TDEFL_FORCE_ALL_STATIC_BLOCKS = 0x40000, 627 TDEFL_FORCE_ALL_RAW_BLOCKS = 0x80000 628 }; 629 630 // High level compression functions: 631 // tdefl_compress_mem_to_heap() compresses a block in memory to a heap block allocated via malloc(). 632 // On entry: 633 // pSrc_buf, src_buf_len: Pointer and size of source block to compress. 634 // flags: The max match finder probes (default is 128) logically OR'd against the above flags. Higher probes are slower but improve compression. 635 // On return: 636 // Function returns a pointer to the compressed data, or NULL on failure. 637 // *pOut_len will be set to the compressed data's size, which could be larger than src_buf_len on uncompressible data. 638 // The caller must free() the returned block when it's no longer needed. 639 void *tdefl_compress_mem_to_heap(const void *pSrc_buf, size_t src_buf_len, size_t *pOut_len, int flags); 640 641 // tdefl_compress_mem_to_mem() compresses a block in memory to another block in memory. 642 // Returns 0 on failure. 643 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); 644 645 // Compresses an image to a compressed PNG file in memory. 646 // On entry: 647 // pImage, w, h, and num_chans describe the image to compress. num_chans may be 1, 2, 3, or 4. 648 // The image pitch in bytes per scanline will be w*num_chans. The leftmost pixel on the top scanline is stored first in memory. 649 // 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 650 // If flip is true, the image will be flipped on the Y axis (useful for OpenGL apps). 651 // On return: 652 // Function returns a pointer to the compressed data, or NULL on failure. 653 // *pLen_out will be set to the size of the PNG image file. 654 // The caller must mz_free() the returned heap block (which will typically be larger than *pLen_out) when it's no longer needed. 655 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); 656 void *tdefl_write_image_to_png_file_in_memory(const void *pImage, int w, int h, int num_chans, size_t *pLen_out); 657 658 // Output stream interface. The compressor uses this interface to write compressed data. It'll typically be called TDEFL_OUT_BUF_SIZE at a time. 659 typedef mz_bool (*tdefl_put_buf_func_ptr)(const void* pBuf, int len, void *pUser); 660 661 // tdefl_compress_mem_to_output() compresses a block to an output stream. The above helpers use this function internally. 662 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); 663 664 enum { TDEFL_MAX_HUFF_TABLES = 3, TDEFL_MAX_HUFF_SYMBOLS_0 = 288, TDEFL_MAX_HUFF_SYMBOLS_1 = 32, TDEFL_MAX_HUFF_SYMBOLS_2 = 19, TDEFL_LZ_DICT_SIZE = 32768, TDEFL_LZ_DICT_SIZE_MASK = TDEFL_LZ_DICT_SIZE - 1, TDEFL_MIN_MATCH_LEN = 3, TDEFL_MAX_MATCH_LEN = 258 }; 665 666 // TDEFL_OUT_BUF_SIZE MUST be large enough to hold a single entire compressed output block (using static/fixed Huffman codes). 667 #if TDEFL_LESS_MEMORY 668 enum { TDEFL_LZ_CODE_BUF_SIZE = 24 * 1024, TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13 ) / 10, TDEFL_MAX_HUFF_SYMBOLS = 288, TDEFL_LZ_HASH_BITS = 12, TDEFL_LEVEL1_HASH_SIZE_MASK = 4095, TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3, TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS }; 669 #else 670 enum { TDEFL_LZ_CODE_BUF_SIZE = 64 * 1024, TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13 ) / 10, TDEFL_MAX_HUFF_SYMBOLS = 288, TDEFL_LZ_HASH_BITS = 15, TDEFL_LEVEL1_HASH_SIZE_MASK = 4095, TDEFL_LZ_HASH_SHIFT = (TDEFL_LZ_HASH_BITS + 2) / 3, TDEFL_LZ_HASH_SIZE = 1 << TDEFL_LZ_HASH_BITS }; 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 { 676 TDEFL_STATUS_BAD_PARAM = -2, 677 TDEFL_STATUS_PUT_BUF_FAILED = -1, 678 TDEFL_STATUS_OKAY = 0, 679 TDEFL_STATUS_DONE = 1, 680 } tdefl_status; 681 682 // Must map to MZ_NO_FLUSH, MZ_SYNC_FLUSH, etc. enums 683 typedef enum 684 { 685 TDEFL_NO_FLUSH = 0, 686 TDEFL_SYNC_FLUSH = 2, 687 TDEFL_FULL_FLUSH = 3, 688 TDEFL_FINISH = 4 689 } tdefl_flush; 690 691 // tdefl's compression state structure. 692 typedef struct 693 { 694 tdefl_put_buf_func_ptr m_pPut_buf_func; 695 void *m_pPut_buf_user; 696 mz_uint m_flags, m_max_probes[2]; 697 int m_greedy_parsing; 698 mz_uint m_adler32, m_lookahead_pos, m_lookahead_size, m_dict_size; 699 mz_uint8 *m_pLZ_code_buf, *m_pLZ_flags, *m_pOutput_buf, *m_pOutput_buf_end; 700 mz_uint m_num_flags_left, m_total_lz_bytes, m_lz_code_buf_dict_pos, m_bits_in, m_bit_buffer; 701 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; 702 tdefl_status m_prev_return_status; 703 const void *m_pIn_buf; 704 void *m_pOut_buf; 705 size_t *m_pIn_buf_size, *m_pOut_buf_size; 706 tdefl_flush m_flush; 707 const mz_uint8 *m_pSrc; 708 size_t m_src_buf_left, m_out_buf_ofs; 709 mz_uint8 m_dict[TDEFL_LZ_DICT_SIZE + TDEFL_MAX_MATCH_LEN - 1]; 710 mz_uint16 m_huff_count[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 711 mz_uint16 m_huff_codes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 712 mz_uint8 m_huff_code_sizes[TDEFL_MAX_HUFF_TABLES][TDEFL_MAX_HUFF_SYMBOLS]; 713 mz_uint8 m_lz_code_buf[TDEFL_LZ_CODE_BUF_SIZE]; 714 mz_uint16 m_next[TDEFL_LZ_DICT_SIZE]; 715 mz_uint16 m_hash[TDEFL_LZ_HASH_SIZE]; 716 mz_uint8 m_output_buf[TDEFL_OUT_BUF_SIZE]; 717 } tdefl_compressor; 718 719 // Initializes the compressor. 720 // There is no corresponding deinit() function because the tdefl API's do not dynamically allocate memory. 721 // 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. 722 // If pBut_buf_func is NULL the user should always call the tdefl_compress() API. 723 // flags: See the above enums (TDEFL_HUFFMAN_ONLY, TDEFL_WRITE_ZLIB_HEADER, etc.) 724 tdefl_status tdefl_init(tdefl_compressor *d, tdefl_put_buf_func_ptr pPut_buf_func, void *pPut_buf_user, int flags); 725 726 // 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. 727 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); 728 729 // tdefl_compress_buffer() is only usable when the tdefl_init() is called with a non-NULL tdefl_put_buf_func_ptr. 730 // tdefl_compress_buffer() always consumes the entire input buffer. 731 tdefl_status tdefl_compress_buffer(tdefl_compressor *d, const void *pIn_buf, size_t in_buf_size, tdefl_flush flush); 732 733 tdefl_status tdefl_get_prev_return_status(tdefl_compressor *d); 734 mz_uint32 tdefl_get_adler32(tdefl_compressor *d); 735 736 // Can't use tdefl_create_comp_flags_from_zip_params if MINIZ_NO_ZLIB_APIS isn't defined, because it uses some of its macros. 737 #ifndef MINIZ_NO_ZLIB_APIS 738 // Create tdefl_compress() flags given zlib-style compression parameters. 739 // level may range from [0,10] (where 10 is absolute max compression, but may be much slower on some files) 740 // window_bits may be -15 (raw deflate) or 15 (zlib) 741 // strategy may be either MZ_DEFAULT_STRATEGY, MZ_FILTERED, MZ_HUFFMAN_ONLY, MZ_RLE, or MZ_FIXED 742 mz_uint tdefl_create_comp_flags_from_zip_params(int level, int window_bits, int strategy); 743 #endif // #ifndef MINIZ_NO_ZLIB_APIS 744 745 #ifdef __cplusplus 746 } 747 #endif 748 749 #endif // MINIZ_HEADER_INCLUDED 750