1 //<MStar Software> 2 //****************************************************************************** 3 // MStar Software 4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved. 5 // All software, firmware and related documentation herein ("MStar Software") are 6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by 7 // law, including, but not limited to, copyright law and international treaties. 8 // Any use, modification, reproduction, retransmission, or republication of all 9 // or part of MStar Software is expressly prohibited, unless prior written 10 // permission has been granted by MStar. 11 // 12 // By accessing, browsing and/or using MStar Software, you acknowledge that you 13 // have read, understood, and agree, to be bound by below terms ("Terms") and to 14 // comply with all applicable laws and regulations: 15 // 16 // 1. MStar shall retain any and all right, ownership and interest to MStar 17 // Software and any modification/derivatives thereof. 18 // No right, ownership, or interest to MStar Software and any 19 // modification/derivatives thereof is transferred to you under Terms. 20 // 21 // 2. You understand that MStar Software might include, incorporate or be 22 // supplied together with third party`s software and the use of MStar 23 // Software may require additional licenses from third parties. 24 // Therefore, you hereby agree it is your sole responsibility to separately 25 // obtain any and all third party right and license necessary for your use of 26 // such third party`s software. 27 // 28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as 29 // MStar`s confidential information and you agree to keep MStar`s 30 // confidential information in strictest confidence and not disclose to any 31 // third party. 32 // 33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any 34 // kind. Any warranties are hereby expressly disclaimed by MStar, including 35 // without limitation, any warranties of merchantability, non-infringement of 36 // intellectual property rights, fitness for a particular purpose, error free 37 // and in conformity with any international standard. You agree to waive any 38 // claim against MStar for any loss, damage, cost or expense that you may 39 // incur related to your use of MStar Software. 40 // In no event shall MStar be liable for any direct, indirect, incidental or 41 // consequential damages, including without limitation, lost of profit or 42 // revenues, lost or damage of data, and unauthorized system use. 43 // You agree that this Section 4 shall still apply without being affected 44 // even if MStar Software has been modified by MStar in accordance with your 45 // request or instruction for your use, except otherwise agreed by both 46 // parties in writing. 47 // 48 // 5. If requested, MStar may from time to time provide technical supports or 49 // services in relation with MStar Software to you for your use of 50 // MStar Software in conjunction with your or your customer`s product 51 // ("Services"). 52 // You understand and agree that, except otherwise agreed by both parties in 53 // writing, Services are provided on an "AS IS" basis and the warranty 54 // disclaimer set forth in Section 4 above shall apply. 55 // 56 // 6. Nothing contained herein shall be construed as by implication, estoppels 57 // or otherwise: 58 // (a) conferring any license or right to use MStar name, trademark, service 59 // mark, symbol or any other identification; 60 // (b) obligating MStar or any of its affiliates to furnish any person, 61 // including without limitation, you and your customers, any assistance 62 // of any kind whatsoever, or any information; or 63 // (c) conferring any license or right under any intellectual property right. 64 // 65 // 7. These terms shall be governed by and construed in accordance with the laws 66 // of Taiwan, R.O.C., excluding its conflict of law rules. 67 // Any and all dispute arising out hereof or related hereto shall be finally 68 // settled by arbitration referred to the Chinese Arbitration Association, 69 // Taipei in accordance with the ROC Arbitration Law and the Arbitration 70 // Rules of the Association by three (3) arbitrators appointed in accordance 71 // with the said Rules. 72 // The place of arbitration shall be in Taipei, Taiwan and the language shall 73 // be English. 74 // The arbitration award shall be final and binding to both parties. 75 // 76 //****************************************************************************** 77 //<MStar Software> 78 /* zlib.h -- interface of the 'zlib' general purpose compression library 79 version 1.2.3, July 18th, 2005 80 81 Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler 82 83 This software is provided 'as-is', without any express or implied 84 warranty. In no event will the authors be held liable for any damages 85 arising from the use of this software. 86 87 Permission is granted to anyone to use this software for any purpose, 88 including commercial applications, and to alter it and redistribute it 89 freely, subject to the following restrictions: 90 91 1. The origin of this software must not be misrepresented; you must not 92 claim that you wrote the original software. If you use this software 93 in a product, an acknowledgment in the product documentation would be 94 appreciated but is not required. 95 2. Altered source versions must be plainly marked as such, and must not be 96 misrepresented as being the original software. 97 3. This notice may not be removed or altered from any source distribution. 98 99 Jean-loup Gailly Mark Adler 100 jloup@gzip.org madler@alumni.caltech.edu 101 102 103 The data format used by the zlib library is described by RFCs (Request for 104 Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt 105 (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format). 106 */ 107 108 #ifndef ZLIB_H 109 #define ZLIB_H 110 111 #include "zconf.h" 112 113 //#ifdef __cplusplus 114 //extern "C" { 115 //#endif 116 117 #define ZLIB_VERSION "1.2.3" 118 #define ZLIB_VERNUM 0x1230 119 120 /* 121 The 'zlib' compression library provides in-memory compression and 122 decompression functions, including integrity checks of the uncompressed 123 data. This version of the library supports only one compression method 124 (deflation) but other algorithms will be added later and will have the same 125 stream interface. 126 127 Compression can be done in a single step if the buffers are large 128 enough (for example if an input file is mmap'ed), or can be done by 129 repeated calls of the compression function. In the latter case, the 130 application must provide more input and/or consume the output 131 (providing more output space) before each call. 132 133 The compressed data format used by default by the in-memory functions is 134 the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped 135 around a deflate stream, which is itself documented in RFC 1951. 136 137 The library also supports reading and writing files in gzip (.gz) format 138 with an interface similar to that of stdio using the functions that start 139 with "gz". The gzip format is different from the zlib format. gzip is a 140 gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. 141 142 This library can optionally read and write gzip streams in memory as well. 143 144 The zlib format was designed to be compact and fast for use in memory 145 and on communications channels. The gzip format was designed for single- 146 file compression on file systems, has a larger header than zlib to maintain 147 directory information, and uses a different, slower check method than zlib. 148 149 The library does not install any signal handler. The decoder checks 150 the consistency of the compressed data, so the library should never 151 crash even in case of corrupted input. 152 */ 153 154 typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); 155 typedef void (*free_func) OF((voidpf opaque, voidpf address)); 156 157 struct internal_state; 158 159 typedef struct z_stream_s { 160 Bytef *next_in; /* next input byte */ 161 uInt avail_in; /* number of bytes available at next_in */ 162 uLong total_in; /* total nb of input bytes read so far */ 163 164 Bytef *next_out; /* next output byte should be put there */ 165 uInt avail_out; /* remaining free space at next_out */ 166 uLong total_out; /* total nb of bytes output so far */ 167 168 char *msg; /* last error message, NULL if no error */ 169 struct internal_state FAR *state; /* not visible by applications */ 170 171 alloc_func zalloc; /* used to allocate the internal state */ 172 free_func zfree; /* used to free the internal state */ 173 voidpf opaque; /* private data object passed to zalloc and zfree */ 174 175 MS_U32 data_type; /* best guess about the data type: binary or text */ 176 uLong adler; /* adler32 value of the uncompressed data */ 177 uLong reserved; /* reserved for future use */ 178 } z_stream; 179 180 typedef z_stream FAR *z_streamp; 181 182 /* 183 gzip header information passed to and from zlib routines. See RFC 1952 184 for more details on the meanings of these fields. 185 */ 186 typedef struct gz_header_s { 187 MS_U32 text; /* true if compressed data believed to be text */ 188 uLong time; /* modification time */ 189 MS_U32 xflags; /* extra flags (not used when writing a gzip file) */ 190 MS_U32 os; /* operating system */ 191 Bytef *extra; /* pointer to extra field or Z_NULL if none */ 192 uInt extra_len; /* extra field length (valid if extra != Z_NULL) */ 193 uInt extra_max; /* space at extra (only when reading header) */ 194 Bytef *name; /* pointer to zero-terminated file name or Z_NULL */ 195 uInt name_max; /* space at name (only when reading header) */ 196 Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */ 197 uInt comm_max; /* space at comment (only when reading header) */ 198 MS_U32 hcrc; /* true if there was or will be a header crc */ 199 MS_U32 done; /* true when done reading gzip header (not used 200 when writing a gzip file) */ 201 } gz_header; 202 203 typedef gz_header FAR *gz_headerp; 204 205 /* 206 The application must update next_in and avail_in when avail_in has 207 dropped to zero. It must update next_out and avail_out when avail_out 208 has dropped to zero. The application must initialize zalloc, zfree and 209 opaque before calling the init function. All other fields are set by the 210 compression library and must not be updated by the application. 211 212 The opaque value provided by the application will be passed as the first 213 parameter for calls of zalloc and zfree. This can be useful for custom 214 memory management. The compression library attaches no meaning to the 215 opaque value. 216 217 zalloc must return Z_NULL if there is not enough memory for the object. 218 If zlib is used in a multi-threaded application, zalloc and zfree must be 219 thread safe. 220 221 On 16-bit systems, the functions zalloc and zfree must be able to allocate 222 exactly 65536 bytes, but will not be required to allocate more than this 223 if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, 224 pointers returned by zalloc for objects of exactly 65536 bytes *must* 225 have their offset normalized to zero. The default allocation function 226 provided by this library ensures this (see zutil.c). To reduce memory 227 requirements and avoid any allocation of 64K objects, at the expense of 228 compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h). 229 230 The fields total_in and total_out can be used for statistics or 231 progress reports. After compression, total_in holds the total size of 232 the uncompressed data and may be saved for use in the decompressor 233 (particularly if the decompressor wants to decompress everything in 234 a single step). 235 */ 236 237 /* constants */ 238 239 #define Z_NO_FLUSH 0 240 #define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */ 241 #define Z_SYNC_FLUSH 2 242 #define Z_FULL_FLUSH 3 243 #define Z_FINISH 4 244 #define Z_BLOCK 5 245 /* Allowed flush values; see deflate() and inflate() below for details */ 246 247 #define Z_OK 0 248 #define Z_STREAM_END 1 249 #define Z_NEED_DICT 2 250 #define Z_ERRNO (-1) 251 #define Z_STREAM_ERROR (-2) 252 #define Z_DATA_ERROR (-3) 253 #define Z_MEM_ERROR (-4) 254 #define Z_BUF_ERROR (-5) 255 #define Z_VERSION_ERROR (-6) 256 /* Return codes for the compression/decompression functions. Negative 257 * values are errors, positive values are used for special but normal events. 258 */ 259 260 #define Z_NO_COMPRESSION 0 261 #define Z_BEST_SPEED 1 262 #define Z_BEST_COMPRESSION 9 263 #define Z_DEFAULT_COMPRESSION (-1) 264 /* compression levels */ 265 266 #define Z_FILTERED 1 267 #define Z_HUFFMAN_ONLY 2 268 #define Z_RLE 3 269 #define Z_FIXED 4 270 #define Z_DEFAULT_STRATEGY 0 271 /* compression strategy; see deflateInit2() below for details */ 272 273 #define Z_BINARY 0 274 #define Z_TEXT 1 275 #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ 276 #define Z_UNKNOWN 2 277 /* Possible values of the data_type field (though see inflate()) */ 278 279 #define Z_DEFLATED 8 280 /* The deflate compression method (the only one supported in this version) */ 281 282 #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ 283 284 #define zlib_version zlibVersion() 285 /* for compatibility with versions < 1.0.2 */ 286 287 /* basic functions */ 288 289 ZEXTERN const char * ZEXPORT zlibVersion OF((void)); 290 /* The application can compare zlibVersion and ZLIB_VERSION for consistency. 291 If the first character differs, the library code actually used is 292 not compatible with the zlib.h header file used by the application. 293 This check is automatically made by deflateInit and inflateInit. 294 */ 295 296 /* 297 ZEXTERN MS_U32 ZEXPORT deflateInit OF((z_streamp strm, MS_U32 level)); 298 299 Initializes the internal stream state for compression. The fields 300 zalloc, zfree and opaque must be initialized before by the caller. 301 If zalloc and zfree are set to Z_NULL, deflateInit updates them to 302 use default allocation functions. 303 304 The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: 305 1 gives best speed, 9 gives best compression, 0 gives no compression at 306 all (the input data is simply copied a block at a time). 307 Z_DEFAULT_COMPRESSION requests a default compromise between speed and 308 compression (currently equivalent to level 6). 309 310 deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not 311 enough memory, Z_STREAM_ERROR if level is not a valid compression level, 312 Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible 313 with the version assumed by the caller (ZLIB_VERSION). 314 msg is set to null if there is no error message. deflateInit does not 315 perform any compression: this will be done by deflate(). 316 */ 317 318 319 ZEXTERN MS_U32 ZEXPORT deflate OF((z_streamp strm, MS_U32 flush)); 320 /* 321 deflate compresses as much data as possible, and stops when the input 322 buffer becomes empty or the output buffer becomes full. It may introduce some 323 output latency (reading input without producing any output) except when 324 forced to flush. 325 326 The detailed semantics are as follows. deflate performs one or both of the 327 following actions: 328 329 - Compress more input starting at next_in and update next_in and avail_in 330 accordingly. If not all input can be processed (because there is not 331 enough room in the output buffer), next_in and avail_in are updated and 332 processing will resume at this point for the next call of deflate(). 333 334 - Provide more output starting at next_out and update next_out and avail_out 335 accordingly. This action is forced if the parameter flush is non zero. 336 Forcing flush frequently degrades the compression ratio, so this parameter 337 should be set only when necessary (in interactive applications). 338 Some output may be provided even if flush is not set. 339 340 Before the call of deflate(), the application should ensure that at least 341 one of the actions is possible, by providing more input and/or consuming 342 more output, and updating avail_in or avail_out accordingly; avail_out 343 should never be zero before the call. The application can consume the 344 compressed output when it wants, for example when the output buffer is full 345 (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK 346 and with zero avail_out, it must be called again after making room in the 347 output buffer because there might be more output pending. 348 349 Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to 350 decide how much data to accumualte before producing output, in order to 351 maximize compression. 352 353 If the parameter flush is set to Z_SYNC_FLUSH, all pending output is 354 flushed to the output buffer and the output is aligned on a byte boundary, so 355 that the decompressor can get all input data available so far. (In particular 356 avail_in is zero after the call if enough output space has been provided 357 before the call.) Flushing may degrade compression for some compression 358 algorithms and so it should be used only when necessary. 359 360 If flush is set to Z_FULL_FLUSH, all output is flushed as with 361 Z_SYNC_FLUSH, and the compression state is reset so that decompression can 362 restart from this point if previous compressed data has been damaged or if 363 random access is desired. Using Z_FULL_FLUSH too often can seriously degrade 364 compression. 365 366 If deflate returns with avail_out == 0, this function must be called again 367 with the same value of the flush parameter and more output space (updated 368 avail_out), until the flush is complete (deflate returns with non-zero 369 avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that 370 avail_out is greater than six to avoid repeated flush markers due to 371 avail_out == 0 on return. 372 373 If the parameter flush is set to Z_FINISH, pending input is processed, 374 pending output is flushed and deflate returns with Z_STREAM_END if there 375 was enough output space; if deflate returns with Z_OK, this function must be 376 called again with Z_FINISH and more output space (updated avail_out) but no 377 more input data, until it returns with Z_STREAM_END or an error. After 378 deflate has returned Z_STREAM_END, the only possible operations on the 379 stream are deflateReset or deflateEnd. 380 381 Z_FINISH can be used immediately after deflateInit if all the compression 382 is to be done in a single step. In this case, avail_out must be at least 383 the value returned by deflateBound (see below). If deflate does not return 384 Z_STREAM_END, then it must be called again as described above. 385 386 deflate() sets strm->adler to the adler32 checksum of all input read 387 so far (that is, total_in bytes). 388 389 deflate() may update strm->data_type if it can make a good guess about 390 the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered 391 binary. This field is only for information purposes and does not affect 392 the compression algorithm in any manner. 393 394 deflate() returns Z_OK if some progress has been made (more input 395 processed or more output produced), Z_STREAM_END if all input has been 396 consumed and all output has been produced (only when flush is set to 397 Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example 398 if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible 399 (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not 400 fatal, and deflate() can be called again with more input and more output 401 space to continue compressing. 402 */ 403 404 405 ZEXTERN MS_U32 ZEXPORT deflateEnd OF((z_streamp strm)); 406 /* 407 All dynamically allocated data structures for this stream are freed. 408 This function discards any unprocessed input and does not flush any 409 pending output. 410 411 deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the 412 stream state was inconsistent, Z_DATA_ERROR if the stream was freed 413 prematurely (some input or output was discarded). In the error case, 414 msg may be set but then points to a static string (which must not be 415 deallocated). 416 */ 417 418 419 /* 420 ZEXTERN MS_U32 ZEXPORT inflateInit OF((z_streamp strm)); 421 422 Initializes the internal stream state for decompression. The fields 423 next_in, avail_in, zalloc, zfree and opaque must be initialized before by 424 the caller. If next_in is not Z_NULL and avail_in is large enough (the exact 425 value depends on the compression method), inflateInit determines the 426 compression method from the zlib header and allocates all data structures 427 accordingly; otherwise the allocation will be deferred to the first call of 428 inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to 429 use default allocation functions. 430 431 inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 432 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 433 version assumed by the caller. msg is set to null if there is no error 434 message. inflateInit does not perform any decompression apart from reading 435 the zlib header if present: this will be done by inflate(). (So next_in and 436 avail_in may be modified, but next_out and avail_out are unchanged.) 437 */ 438 439 440 ZEXTERN MS_U32 ZEXPORT gpdinflate OF((z_streamp strm, MS_U32 flush)); 441 /* 442 inflate decompresses as much data as possible, and stops when the input 443 buffer becomes empty or the output buffer becomes full. It may introduce 444 some output latency (reading input without producing any output) except when 445 forced to flush. 446 447 The detailed semantics are as follows. inflate performs one or both of the 448 following actions: 449 450 - Decompress more input starting at next_in and update next_in and avail_in 451 accordingly. If not all input can be processed (because there is not 452 enough room in the output buffer), next_in is updated and processing 453 will resume at this point for the next call of inflate(). 454 455 - Provide more output starting at next_out and update next_out and avail_out 456 accordingly. inflate() provides as much output as possible, until there 457 is no more input data or no more space in the output buffer (see below 458 about the flush parameter). 459 460 Before the call of inflate(), the application should ensure that at least 461 one of the actions is possible, by providing more input and/or consuming 462 more output, and updating the next_* and avail_* values accordingly. 463 The application can consume the uncompressed output when it wants, for 464 example when the output buffer is full (avail_out == 0), or after each 465 call of inflate(). If inflate returns Z_OK and with zero avail_out, it 466 must be called again after making room in the output buffer because there 467 might be more output pending. 468 469 The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, 470 Z_FINISH, or Z_BLOCK. Z_SYNC_FLUSH requests that inflate() flush as much 471 output as possible to the output buffer. Z_BLOCK requests that inflate() stop 472 if and when it gets to the next deflate block boundary. When decoding the 473 zlib or gzip format, this will cause inflate() to return immediately after 474 the header and before the first block. When doing a raw inflate, inflate() 475 will go ahead and process the first block, and will return when it gets to 476 the end of that block, or when it runs out of data. 477 478 The Z_BLOCK option assists in appending to or combining deflate streams. 479 Also to assist in this, on return inflate() will set strm->data_type to the 480 number of unused bits in the last byte taken from strm->next_in, plus 64 481 if inflate() is currently decoding the last block in the deflate stream, 482 plus 128 if inflate() returned immediately after decoding an end-of-block 483 code or decoding the complete header up to just before the first byte of the 484 deflate stream. The end-of-block will not be indicated until all of the 485 uncompressed data from that block has been written to strm->next_out. The 486 number of unused bits may in general be greater than seven, except when 487 bit 7 of data_type is set, in which case the number of unused bits will be 488 less than eight. 489 490 inflate() should normally be called until it returns Z_STREAM_END or an 491 error. However if all decompression is to be performed in a single step 492 (a single call of inflate), the parameter flush should be set to 493 Z_FINISH. In this case all pending input is processed and all pending 494 output is flushed; avail_out must be large enough to hold all the 495 uncompressed data. (The size of the uncompressed data may have been saved 496 by the compressor for this purpose.) The next operation on this stream must 497 be inflateEnd to deallocate the decompression state. The use of Z_FINISH 498 is never required, but can be used to inform inflate that a faster approach 499 may be used for the single inflate() call. 500 501 In this implementation, inflate() always flushes as much output as 502 possible to the output buffer, and always uses the faster approach on the 503 first call. So the only effect of the flush parameter in this implementation 504 is on the return value of inflate(), as noted below, or when it returns early 505 because Z_BLOCK is used. 506 507 If a preset dictionary is needed after this call (see inflateSetDictionary 508 below), inflate sets strm->adler to the adler32 checksum of the dictionary 509 chosen by the compressor and returns Z_NEED_DICT; otherwise it sets 510 strm->adler to the adler32 checksum of all output produced so far (that is, 511 total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described 512 below. At the end of the stream, inflate() checks that its computed adler32 513 checksum is equal to that saved by the compressor and returns Z_STREAM_END 514 only if the checksum is correct. 515 516 inflate() will decompress and check either zlib-wrapped or gzip-wrapped 517 deflate data. The header type is detected automatically. Any information 518 contained in the gzip header is not retained, so applications that need that 519 information should instead use raw inflate, see inflateInit2() below, or 520 inflateBack() and perform their own processing of the gzip header and 521 trailer. 522 523 inflate() returns Z_OK if some progress has been made (more input processed 524 or more output produced), Z_STREAM_END if the end of the compressed data has 525 been reached and all uncompressed output has been produced, Z_NEED_DICT if a 526 preset dictionary is needed at this point, Z_DATA_ERROR if the input data was 527 corrupted (input stream not conforming to the zlib format or incorrect check 528 value), Z_STREAM_ERROR if the stream structure was inconsistent (for example 529 if next_in or next_out was NULL), Z_MEM_ERROR if there was not enough memory, 530 Z_BUF_ERROR if no progress is possible or if there was not enough room in the 531 output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and 532 inflate() can be called again with more input and more output space to 533 continue decompressing. If Z_DATA_ERROR is returned, the application may then 534 call inflateSync() to look for a good compression block if a partial recovery 535 of the data is desired. 536 */ 537 538 539 ZEXTERN MS_U32 ZEXPORT inflateEnd OF((z_streamp strm)); 540 /* 541 All dynamically allocated data structures for this stream are freed. 542 This function discards any unprocessed input and does not flush any 543 pending output. 544 545 inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state 546 was inconsistent. In the error case, msg may be set but then points to a 547 static string (which must not be deallocated). 548 */ 549 550 /* Advanced functions */ 551 552 /* 553 The following functions are needed only in some special applications. 554 */ 555 556 /* 557 ZEXTERN MS_U32 ZEXPORT deflateInit2 OF((z_streamp strm, 558 MS_U32 level, 559 MS_U32 method, 560 MS_U32 windowBits, 561 MS_U32 memLevel, 562 MS_U32 strategy)); 563 564 This is another version of deflateInit with more compression options. The 565 fields next_in, zalloc, zfree and opaque must be initialized before by 566 the caller. 567 568 The method parameter is the compression method. It must be Z_DEFLATED in 569 this version of the library. 570 571 The windowBits parameter is the base two logarithm of the window size 572 (the size of the history buffer). It should be in the range 8..15 for this 573 version of the library. Larger values of this parameter result in better 574 compression at the expense of memory usage. The default value is 15 if 575 deflateInit is used instead. 576 577 windowBits can also be -8..-15 for raw deflate. In this case, -windowBits 578 determines the window size. deflate() will then generate raw deflate data 579 with no zlib header or trailer, and will not compute an adler32 check value. 580 581 windowBits can also be greater than 15 for optional gzip encoding. Add 582 16 to windowBits to write a simple gzip header and trailer around the 583 compressed data instead of a zlib wrapper. The gzip header will have no 584 file name, no extra data, no comment, no modification time (set to zero), 585 no header crc, and the operating system will be set to 255 (unknown). If a 586 gzip stream is being written, strm->adler is a crc32 instead of an adler32. 587 588 The memLevel parameter specifies how much memory should be allocated 589 for the internal compression state. memLevel=1 uses minimum memory but 590 is slow and reduces compression ratio; memLevel=9 uses maximum memory 591 for optimal speed. The default value is 8. See zconf.h for total memory 592 usage as a function of windowBits and memLevel. 593 594 The strategy parameter is used to tune the compression algorithm. Use the 595 value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a 596 filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no 597 string match), or Z_RLE to limit match distances to one (run-length 598 encoding). Filtered data consists mostly of small values with a somewhat 599 random distribution. In this case, the compression algorithm is tuned to 600 compress them better. The effect of Z_FILTERED is to force more Huffman 601 coding and less string matching; it is somewhat intermediate between 602 Z_DEFAULT and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as fast as 603 Z_HUFFMAN_ONLY, but give better compression for PNG image data. The strategy 604 parameter only affects the compression ratio but not the correctness of the 605 compressed output even if it is not set appropriately. Z_FIXED prevents the 606 use of dynamic Huffman codes, allowing for a simpler decoder for special 607 applications. 608 609 deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 610 memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid 611 method). msg is set to null if there is no error message. deflateInit2 does 612 not perform any compression: this will be done by deflate(). 613 */ 614 615 ZEXTERN MS_U32 ZEXPORT deflateSetDictionary OF((z_streamp strm, 616 const Bytef *dictionary, 617 uInt dictLength)); 618 /* 619 Initializes the compression dictionary from the given byte sequence 620 without producing any compressed output. This function must be called 621 immediately after deflateInit, deflateInit2 or deflateReset, before any 622 call of deflate. The compressor and decompressor must use exactly the same 623 dictionary (see inflateSetDictionary). 624 625 The dictionary should consist of strings (byte sequences) that are likely 626 to be encountered later in the data to be compressed, with the most commonly 627 used strings preferably put towards the end of the dictionary. Using a 628 dictionary is most useful when the data to be compressed is short and can be 629 predicted with good accuracy; the data can then be compressed better than 630 with the default empty dictionary. 631 632 Depending on the size of the compression data structures selected by 633 deflateInit or deflateInit2, a part of the dictionary may in effect be 634 discarded, for example if the dictionary is larger than the window size in 635 deflate or deflate2. Thus the strings most likely to be useful should be 636 put at the end of the dictionary, not at the front. In addition, the 637 current implementation of deflate will use at most the window size minus 638 262 bytes of the provided dictionary. 639 640 Upon return of this function, strm->adler is set to the adler32 value 641 of the dictionary; the decompressor may later use this value to determine 642 which dictionary has been used by the compressor. (The adler32 value 643 applies to the whole dictionary even if only a subset of the dictionary is 644 actually used by the compressor.) If a raw deflate was requested, then the 645 adler32 value is not computed and strm->adler is not set. 646 647 deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a 648 parameter is invalid (such as NULL dictionary) or the stream state is 649 inconsistent (for example if deflate has already been called for this stream 650 or if the compression method is bsort). deflateSetDictionary does not 651 perform any compression: this will be done by deflate(). 652 */ 653 654 ZEXTERN MS_U32 ZEXPORT deflateCopy OF((z_streamp dest, 655 z_streamp source)); 656 /* 657 Sets the destination stream as a complete copy of the source stream. 658 659 This function can be useful when several compression strategies will be 660 tried, for example when there are several ways of pre-processing the input 661 data with a filter. The streams that will be discarded should then be freed 662 by calling deflateEnd. Note that deflateCopy duplicates the internal 663 compression state which can be quite large, so this strategy is slow and 664 can consume lots of memory. 665 666 deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 667 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 668 (such as zalloc being NULL). msg is left unchanged in both source and 669 destination. 670 */ 671 672 ZEXTERN MS_U32 ZEXPORT deflateReset OF((z_streamp strm)); 673 /* 674 This function is equivalent to deflateEnd followed by deflateInit, 675 but does not free and reallocate all the internal compression state. 676 The stream will keep the same compression level and any other attributes 677 that may have been set by deflateInit2. 678 679 deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 680 stream state was inconsistent (such as zalloc or state being NULL). 681 */ 682 683 ZEXTERN MS_U32 ZEXPORT deflateParams OF((z_streamp strm, 684 MS_U32 level, 685 MS_U32 strategy)); 686 /* 687 Dynamically update the compression level and compression strategy. The 688 interpretation of level and strategy is as in deflateInit2. This can be 689 used to switch between compression and straight copy of the input data, or 690 to switch to a different kind of input data requiring a different 691 strategy. If the compression level is changed, the input available so far 692 is compressed with the old level (and may be flushed); the new level will 693 take effect only at the next call of deflate(). 694 695 Before the call of deflateParams, the stream state must be set as for 696 a call of deflate(), since the currently available input may have to 697 be compressed and flushed. In particular, strm->avail_out must be non-zero. 698 699 deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source 700 stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR 701 if strm->avail_out was zero. 702 */ 703 704 ZEXTERN MS_U32 ZEXPORT deflateTune OF((z_streamp strm, 705 MS_U32 good_length, 706 MS_U32 max_lazy, 707 MS_U32 nice_length, 708 MS_U32 max_chain)); 709 /* 710 Fine tune deflate's internal compression parameters. This should only be 711 used by someone who understands the algorithm used by zlib's deflate for 712 searching for the best matching string, and even then only by the most 713 fanatic optimizer trying to squeeze out the last compressed bit for their 714 specific input data. Read the deflate.c source code for the meaning of the 715 max_lazy, good_length, nice_length, and max_chain parameters. 716 717 deflateTune() can be called after deflateInit() or deflateInit2(), and 718 returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream. 719 */ 720 721 ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm, 722 uLong sourceLen)); 723 /* 724 deflateBound() returns an upper bound on the compressed size after 725 deflation of sourceLen bytes. It must be called after deflateInit() 726 or deflateInit2(). This would be used to allocate an output buffer 727 for deflation in a single pass, and so would be called before deflate(). 728 */ 729 730 ZEXTERN MS_U32 ZEXPORT deflatePrime OF((z_streamp strm, 731 MS_U32 bits, 732 MS_U32 value)); 733 /* 734 deflatePrime() inserts bits in the deflate output stream. The intent 735 is that this function is used to start off the deflate output with the 736 bits leftover from a previous deflate stream when appending to it. As such, 737 this function can only be used for raw deflate, and must be used before the 738 first deflate() call after a deflateInit2() or deflateReset(). bits must be 739 less than or equal to 16, and that many of the least significant bits of 740 value will be inserted in the output. 741 742 deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source 743 stream state was inconsistent. 744 */ 745 746 ZEXTERN MS_U32 ZEXPORT deflateSetHeader OF((z_streamp strm, 747 gz_headerp head)); 748 /* 749 deflateSetHeader() provides gzip header information for when a gzip 750 stream is requested by deflateInit2(). deflateSetHeader() may be called 751 after deflateInit2() or deflateReset() and before the first call of 752 deflate(). The text, time, os, extra field, name, and comment information 753 in the provided gz_header structure are written to the gzip header (xflag is 754 ignored -- the extra flags are set according to the compression level). The 755 caller must assure that, if not Z_NULL, name and comment are terminated with 756 a zero byte, and that if extra is not Z_NULL, that extra_len bytes are 757 available there. If hcrc is true, a gzip header crc is included. Note that 758 the current versions of the command-line version of gzip (up through version 759 1.3.x) do not support header crc's, and will report that it is a "multi-part 760 gzip file" and give up. 761 762 If deflateSetHeader is not used, the default gzip header has text false, 763 the time set to zero, and os set to 255, with no extra, name, or comment 764 fields. The gzip header is returned to the default state by deflateReset(). 765 766 deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 767 stream state was inconsistent. 768 */ 769 770 /* 771 ZEXTERN MS_U32 ZEXPORT inflateInit2 OF((z_streamp strm, 772 MS_U32 windowBits)); 773 774 This is another version of inflateInit with an extra parameter. The 775 fields next_in, avail_in, zalloc, zfree and opaque must be initialized 776 before by the caller. 777 778 The windowBits parameter is the base two logarithm of the maximum window 779 size (the size of the history buffer). It should be in the range 8..15 for 780 this version of the library. The default value is 15 if inflateInit is used 781 instead. windowBits must be greater than or equal to the windowBits value 782 provided to deflateInit2() while compressing, or it must be equal to 15 if 783 deflateInit2() was not used. If a compressed stream with a larger window 784 size is given as input, inflate() will return with the error code 785 Z_DATA_ERROR instead of trying to allocate a larger window. 786 787 windowBits can also be -8..-15 for raw inflate. In this case, -windowBits 788 determines the window size. inflate() will then process raw deflate data, 789 not looking for a zlib or gzip header, not generating a check value, and not 790 looking for any check values for comparison at the end of the stream. This 791 is for use with other formats that use the deflate compressed data format 792 such as zip. Those formats provide their own check values. If a custom 793 format is developed using the raw deflate format for compressed data, it is 794 recommended that a check value such as an adler32 or a crc32 be applied to 795 the uncompressed data as is done in the zlib, gzip, and zip formats. For 796 most applications, the zlib format should be used as is. Note that comments 797 above on the use in deflateInit2() applies to the magnitude of windowBits. 798 799 windowBits can also be greater than 15 for optional gzip decoding. Add 800 32 to windowBits to enable zlib and gzip decoding with automatic header 801 detection, or add 16 to decode only the gzip format (the zlib format will 802 return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is 803 a crc32 instead of an adler32. 804 805 inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 806 memory, Z_STREAM_ERROR if a parameter is invalid (such as a null strm). msg 807 is set to null if there is no error message. inflateInit2 does not perform 808 any decompression apart from reading the zlib header if present: this will 809 be done by inflate(). (So next_in and avail_in may be modified, but next_out 810 and avail_out are unchanged.) 811 */ 812 813 ZEXTERN MS_U32 ZEXPORT inflateSetDictionary OF((z_streamp strm, 814 const Bytef *dictionary, 815 uInt dictLength)); 816 /* 817 Initializes the decompression dictionary from the given uncompressed byte 818 sequence. This function must be called immediately after a call of inflate, 819 if that call returned Z_NEED_DICT. The dictionary chosen by the compressor 820 can be determined from the adler32 value returned by that call of inflate. 821 The compressor and decompressor must use exactly the same dictionary (see 822 deflateSetDictionary). For raw inflate, this function can be called 823 immediately after inflateInit2() or inflateReset() and before any call of 824 inflate() to set the dictionary. The application must insure that the 825 dictionary that was used for compression is provided. 826 827 inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a 828 parameter is invalid (such as NULL dictionary) or the stream state is 829 inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the 830 expected one (incorrect adler32 value). inflateSetDictionary does not 831 perform any decompression: this will be done by subsequent calls of 832 inflate(). 833 */ 834 835 ZEXTERN MS_U32 ZEXPORT inflateSync OF((z_streamp strm)); 836 /* 837 Skips invalid compressed data until a full flush point (see above the 838 description of deflate with Z_FULL_FLUSH) can be found, or until all 839 available input is skipped. No output is provided. 840 841 inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR 842 if no more input was provided, Z_DATA_ERROR if no flush point has been found, 843 or Z_STREAM_ERROR if the stream structure was inconsistent. In the success 844 case, the application may save the current current value of total_in which 845 indicates where valid compressed data was found. In the error case, the 846 application may repeatedly call inflateSync, providing more input each time, 847 until success or end of the input data. 848 */ 849 850 ZEXTERN MS_U32 ZEXPORT inflateCopy OF((z_streamp dest, 851 z_streamp source)); 852 /* 853 Sets the destination stream as a complete copy of the source stream. 854 855 This function can be useful when randomly accessing a large stream. The 856 first pass through the stream can periodically record the inflate state, 857 allowing restarting inflate at those points when randomly accessing the 858 stream. 859 860 inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 861 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 862 (such as zalloc being NULL). msg is left unchanged in both source and 863 destination. 864 */ 865 866 ZEXTERN MS_U32 ZEXPORT inflateReset OF((z_streamp strm)); 867 /* 868 This function is equivalent to inflateEnd followed by inflateInit, 869 but does not free and reallocate all the internal decompression state. 870 The stream will keep attributes that may have been set by inflateInit2. 871 872 inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 873 stream state was inconsistent (such as zalloc or state being NULL). 874 */ 875 876 ZEXTERN MS_U32 ZEXPORT inflatePrime OF((z_streamp strm, 877 MS_U32 bits, 878 MS_U32 value)); 879 /* 880 This function inserts bits in the inflate input stream. The intent is 881 that this function is used to start inflating at a bit position in the 882 middle of a byte. The provided bits will be used before any bytes are used 883 from next_in. This function should only be used with raw inflate, and 884 should be used before the first inflate() call after inflateInit2() or 885 inflateReset(). bits must be less than or equal to 16, and that many of the 886 least significant bits of value will be inserted in the input. 887 888 inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source 889 stream state was inconsistent. 890 */ 891 892 ZEXTERN MS_U32 ZEXPORT inflateGetHeader OF((z_streamp strm, 893 gz_headerp head)); 894 /* 895 inflateGetHeader() requests that gzip header information be stored in the 896 provided gz_header structure. inflateGetHeader() may be called after 897 inflateInit2() or inflateReset(), and before the first call of inflate(). 898 As inflate() processes the gzip stream, head->done is zero until the header 899 is completed, at which time head->done is set to one. If a zlib stream is 900 being decoded, then head->done is set to -1 to indicate that there will be 901 no gzip header information forthcoming. Note that Z_BLOCK can be used to 902 force inflate() to return immediately after header processing is complete 903 and before any actual data is decompressed. 904 905 The text, time, xflags, and os fields are filled in with the gzip header 906 contents. hcrc is set to true if there is a header CRC. (The header CRC 907 was valid if done is set to one.) If extra is not Z_NULL, then extra_max 908 contains the maximum number of bytes to write to extra. Once done is true, 909 extra_len contains the actual extra field length, and extra contains the 910 extra field, or that field truncated if extra_max is less than extra_len. 911 If name is not Z_NULL, then up to name_max characters are written there, 912 terminated with a zero unless the length is greater than name_max. If 913 comment is not Z_NULL, then up to comm_max characters are written there, 914 terminated with a zero unless the length is greater than comm_max. When 915 any of extra, name, or comment are not Z_NULL and the respective field is 916 not present in the header, then that field is set to Z_NULL to signal its 917 absence. This allows the use of deflateSetHeader() with the returned 918 structure to duplicate the header. However if those fields are set to 919 allocated memory, then the application will need to save those pointers 920 elsewhere so that they can be eventually freed. 921 922 If inflateGetHeader is not used, then the header information is simply 923 discarded. The header is always checked for validity, including the header 924 CRC if present. inflateReset() will reset the process to discard the header 925 information. The application would need to call inflateGetHeader() again to 926 retrieve the header from the next gzip stream. 927 928 inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 929 stream state was inconsistent. 930 */ 931 932 /* 933 ZEXTERN MS_U32 ZEXPORT inflateBackInit OF((z_streamp strm, MS_U32 windowBits, 934 MS_U8 FAR *window)); 935 936 Initialize the internal stream state for decompression using inflateBack() 937 calls. The fields zalloc, zfree and opaque in strm must be initialized 938 before the call. If zalloc and zfree are Z_NULL, then the default library- 939 derived memory allocation routines are used. windowBits is the base two 940 logarithm of the window size, in the range 8..15. window is a caller 941 supplied buffer of that size. Except for special applications where it is 942 assured that deflate was used with small window sizes, windowBits must be 15 943 and a 32K byte window must be supplied to be able to decompress general 944 deflate streams. 945 946 See inflateBack() for the usage of these routines. 947 948 inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of 949 the paramaters are invalid, Z_MEM_ERROR if the internal state could not 950 be allocated, or Z_VERSION_ERROR if the version of the library does not 951 match the version of the header file. 952 */ 953 954 typedef MS_U32 (*in_func) OF((void FAR *, MS_U8 FAR * FAR *)); 955 typedef MS_U32 (*out_func) OF((void FAR *, MS_U8 FAR *, MS_U32)); 956 957 ZEXTERN MS_U32 ZEXPORT inflateBack OF((z_streamp strm, 958 in_func in, void FAR *in_desc, 959 out_func out, void FAR *out_desc)); 960 /* 961 inflateBack() does a raw inflate with a single call using a call-back 962 interface for input and output. This is more efficient than inflate() for 963 file i/o applications in that it avoids copying between the output and the 964 sliding window by simply making the window itself the output buffer. This 965 function trusts the application to not change the output buffer passed by 966 the output function, at least until inflateBack() returns. 967 968 inflateBackInit() must be called first to allocate the internal state 969 and to initialize the state with the user-provided window buffer. 970 inflateBack() may then be used multiple times to inflate a complete, raw 971 deflate stream with each call. inflateBackEnd() is then called to free 972 the allocated state. 973 974 A raw deflate stream is one with no zlib or gzip header or trailer. 975 This routine would normally be used in a utility that reads zip or gzip 976 files and writes out uncompressed files. The utility would decode the 977 header and process the trailer on its own, hence this routine expects 978 only the raw deflate stream to decompress. This is different from the 979 normal behavior of inflate(), which expects either a zlib or gzip header and 980 trailer around the deflate stream. 981 982 inflateBack() uses two subroutines supplied by the caller that are then 983 called by inflateBack() for input and output. inflateBack() calls those 984 routines until it reads a complete deflate stream and writes out all of the 985 uncompressed data, or until it encounters an error. The function's 986 parameters and return types are defined above in the in_func and out_func 987 typedefs. inflateBack() will call in(in_desc, &buf) which should return the 988 number of bytes of provided input, and a pointer to that input in buf. If 989 there is no input available, in() must return zero--buf is ignored in that 990 case--and inflateBack() will return a buffer error. inflateBack() will call 991 out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out() 992 should return zero on success, or non-zero on failure. If out() returns 993 non-zero, inflateBack() will return with an error. Neither in() nor out() 994 are permitted to change the contents of the window provided to 995 inflateBackInit(), which is also the buffer that out() uses to write from. 996 The length written by out() will be at most the window size. Any non-zero 997 amount of input may be provided by in(). 998 999 For convenience, inflateBack() can be provided input on the first call by 1000 setting strm->next_in and strm->avail_in. If that input is exhausted, then 1001 in() will be called. Therefore strm->next_in must be initialized before 1002 calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called 1003 immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in 1004 must also be initialized, and then if strm->avail_in is not zero, input will 1005 initially be taken from strm->next_in[0 .. strm->avail_in - 1]. 1006 1007 The in_desc and out_desc parameters of inflateBack() is passed as the 1008 first parameter of in() and out() respectively when they are called. These 1009 descriptors can be optionally used to pass any information that the caller- 1010 supplied in() and out() functions need to do their job. 1011 1012 On return, inflateBack() will set strm->next_in and strm->avail_in to 1013 pass back any unused input that was provided by the last in() call. The 1014 return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR 1015 if in() or out() returned an error, Z_DATA_ERROR if there was a format 1016 error in the deflate stream (in which case strm->msg is set to indicate the 1017 nature of the error), or Z_STREAM_ERROR if the stream was not properly 1018 initialized. In the case of Z_BUF_ERROR, an input or output error can be 1019 distinguished using strm->next_in which will be Z_NULL only if in() returned 1020 an error. If strm->next is not Z_NULL, then the Z_BUF_ERROR was due to 1021 out() returning non-zero. (in() will always be called before out(), so 1022 strm->next_in is assured to be defined if out() returns non-zero.) Note 1023 that inflateBack() cannot return Z_OK. 1024 */ 1025 1026 ZEXTERN MS_U32 ZEXPORT inflateBackEnd OF((z_streamp strm)); 1027 /* 1028 All memory allocated by inflateBackInit() is freed. 1029 1030 inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream 1031 state was inconsistent. 1032 */ 1033 1034 ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void)); 1035 /* Return flags indicating compile-time options. 1036 1037 Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other: 1038 1.0: size of uInt 1039 3.2: size of uLong 1040 5.4: size of voidpf (pointer) 1041 7.6: size of z_off_t 1042 1043 Compiler, assembler, and debug options: 1044 8: DEBUG 1045 9: ASMV or ASMINF -- use ASM code 1046 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention 1047 11: 0 (reserved) 1048 1049 One-time table building (smaller code, but not thread-safe if true): 1050 12: BUILDFIXED -- build static block decoding tables when needed 1051 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed 1052 14,15: 0 (reserved) 1053 1054 Library content (indicates missing functionality): 1055 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking 1056 deflate code when not needed) 1057 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect 1058 and decode gzip streams (to avoid linking crc code) 1059 18-19: 0 (reserved) 1060 1061 Operation variations (changes in library functionality): 1062 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate 1063 21: FASTEST -- deflate algorithm with only one, lowest compression level 1064 22,23: 0 (reserved) 1065 1066 The sprintf variant used by gzprintf (zero is best): 1067 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format 1068 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure! 1069 26: 0 = returns value, 1 = void -- 1 means inferred string length returned 1070 1071 Remainder: 1072 27-31: 0 (reserved) 1073 */ 1074 1075 1076 /* utility functions */ 1077 1078 /* 1079 The following utility functions are implemented on top of the 1080 basic stream-oriented functions. To simplify the interface, some 1081 default options are assumed (compression level and memory usage, 1082 standard memory allocation functions). The source code of these 1083 utility functions can easily be modified if you need special options. 1084 */ 1085 1086 ZEXTERN MS_U32 ZEXPORT compress OF((Bytef *dest, uLongf *destLen, 1087 const Bytef *source, uLong sourceLen)); 1088 /* 1089 Compresses the source buffer into the destination buffer. sourceLen is 1090 the byte length of the source buffer. Upon entry, destLen is the total 1091 size of the destination buffer, which must be at least the value returned 1092 by compressBound(sourceLen). Upon exit, destLen is the actual size of the 1093 compressed buffer. 1094 This function can be used to compress a whole file at once if the 1095 input file is mmap'ed. 1096 compress returns Z_OK if success, Z_MEM_ERROR if there was not 1097 enough memory, Z_BUF_ERROR if there was not enough room in the output 1098 buffer. 1099 */ 1100 1101 ZEXTERN MS_U32 ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, 1102 const Bytef *source, uLong sourceLen, 1103 MS_U32 level)); 1104 /* 1105 Compresses the source buffer into the destination buffer. The level 1106 parameter has the same meaning as in deflateInit. sourceLen is the byte 1107 length of the source buffer. Upon entry, destLen is the total size of the 1108 destination buffer, which must be at least the value returned by 1109 compressBound(sourceLen). Upon exit, destLen is the actual size of the 1110 compressed buffer. 1111 1112 compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 1113 memory, Z_BUF_ERROR if there was not enough room in the output buffer, 1114 Z_STREAM_ERROR if the level parameter is invalid. 1115 */ 1116 1117 ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen)); 1118 /* 1119 compressBound() returns an upper bound on the compressed size after 1120 compress() or compress2() on sourceLen bytes. It would be used before 1121 a compress() or compress2() call to allocate the destination buffer. 1122 */ 1123 1124 ZEXTERN MS_U32 ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, 1125 const Bytef *source, uLong sourceLen)); 1126 /* 1127 Decompresses the source buffer into the destination buffer. sourceLen is 1128 the byte length of the source buffer. Upon entry, destLen is the total 1129 size of the destination buffer, which must be large enough to hold the 1130 entire uncompressed data. (The size of the uncompressed data must have 1131 been saved previously by the compressor and transmitted to the decompressor 1132 by some mechanism outside the scope of this compression library.) 1133 Upon exit, destLen is the actual size of the compressed buffer. 1134 This function can be used to decompress a whole file at once if the 1135 input file is mmap'ed. 1136 1137 uncompress returns Z_OK if success, Z_MEM_ERROR if there was not 1138 enough memory, Z_BUF_ERROR if there was not enough room in the output 1139 buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. 1140 */ 1141 1142 1143 typedef voidp gzFile; 1144 1145 ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode)); 1146 /* 1147 Opens a gzip (.gz) file for reading or writing. The mode parameter 1148 is as in fopen ("rb" or "wb") but can also include a compression level 1149 ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for 1150 Huffman only compression as in "wb1h", or 'R' for run-length encoding 1151 as in "wb1R". (See the description of deflateInit2 for more information 1152 about the strategy parameter.) 1153 1154 gzopen can be used to read a file which is not in gzip format; in this 1155 case gzread will directly read from the file without decompression. 1156 1157 gzopen returns NULL if the file could not be opened or if there was 1158 insufficient memory to allocate the (de)compression state; errno 1159 can be checked to distinguish the two cases (if errno is zero, the 1160 zlib error is Z_MEM_ERROR). */ 1161 1162 ZEXTERN gzFile ZEXPORT gzdopen OF((MS_U32 fd, const char *mode)); 1163 /* 1164 gzdopen() associates a gzFile with the file descriptor fd. File 1165 descriptors are obtained from calls like open, dup, creat, pipe or 1166 fileno (in the file has been previously opened with fopen). 1167 The mode parameter is as in gzopen. 1168 The next call of gzclose on the returned gzFile will also close the 1169 file descriptor fd, just like fclose(fdopen(fd), mode) closes the file 1170 descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode). 1171 gzdopen returns NULL if there was insufficient memory to allocate 1172 the (de)compression state. 1173 */ 1174 1175 ZEXTERN MS_U32 ZEXPORT gzsetparams OF((gzFile file, MS_U32 level, MS_U32 strategy)); 1176 /* 1177 Dynamically update the compression level or strategy. See the description 1178 of deflateInit2 for the meaning of these parameters. 1179 gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not 1180 opened for writing. 1181 */ 1182 1183 ZEXTERN MS_U32 ZEXPORT gzread OF((gzFile file, voidp buf, MS_U32 len)); 1184 /* 1185 Reads the given number of uncompressed bytes from the compressed file. 1186 If the input file was not in gzip format, gzread copies the given number 1187 of bytes into the buffer. 1188 gzread returns the number of uncompressed bytes actually read (0 for 1189 end of file, -1 for error). */ 1190 1191 ZEXTERN MS_U32 ZEXPORT gzwrite OF((gzFile file, 1192 voidpc buf, MS_U32 len)); 1193 /* 1194 Writes the given number of uncompressed bytes into the compressed file. 1195 gzwrite returns the number of uncompressed bytes actually written 1196 (0 in case of error). 1197 */ 1198 1199 ZEXTERN MS_U32 ZEXPORTVA gzprintf OF((gzFile file, const char *format, ...)); 1200 /* 1201 Converts, formats, and writes the args to the compressed file under 1202 control of the format string, as in fprintf. gzprintf returns the number of 1203 uncompressed bytes actually written (0 in case of error). The number of 1204 uncompressed bytes written is limited to 4095. The caller should assure that 1205 this limit is not exceeded. If it is exceeded, then gzprintf() will return 1206 return an error (0) with nothing written. In this case, there may also be a 1207 buffer overflow with unpredictable consequences, which is possible only if 1208 zlib was compiled with the insecure functions sprintf() or vsprintf() 1209 because the secure snprintf() or vsnprintf() functions were not available. 1210 */ 1211 1212 ZEXTERN MS_U32 ZEXPORT gzputs OF((gzFile file, const char *s)); 1213 /* 1214 Writes the given null-terminated string to the compressed file, excluding 1215 the terminating null character. 1216 gzputs returns the number of characters written, or -1 in case of error. 1217 */ 1218 1219 ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, MS_U32 len)); 1220 /* 1221 Reads bytes from the compressed file until len-1 characters are read, or 1222 a newline character is read and transferred to buf, or an end-of-file 1223 condition is encountered. The string is then terminated with a null 1224 character. 1225 gzgets returns buf, or Z_NULL in case of error. 1226 */ 1227 1228 ZEXTERN MS_U32 ZEXPORT gzputc OF((gzFile file, MS_U32 c)); 1229 /* 1230 Writes c, converted to an MS_U8, into the compressed file. 1231 gzputc returns the value that was written, or -1 in case of error. 1232 */ 1233 1234 ZEXTERN MS_U32 ZEXPORT gzgetc OF((gzFile file)); 1235 /* 1236 Reads one byte from the compressed file. gzgetc returns this byte 1237 or -1 in case of end of file or error. 1238 */ 1239 1240 ZEXTERN MS_U32 ZEXPORT gzungetc OF((MS_U32 c, gzFile file)); 1241 /* 1242 Push one character back onto the stream to be read again later. 1243 Only one character of push-back is allowed. gzungetc() returns the 1244 character pushed, or -1 on failure. gzungetc() will fail if a 1245 character has been pushed but not read yet, or if c is -1. The pushed 1246 character will be discarded if the stream is repositioned with gzseek() 1247 or gzrewind(). 1248 */ 1249 1250 ZEXTERN MS_U32 ZEXPORT gzflush OF((gzFile file, MS_U32 flush)); 1251 /* 1252 Flushes all pending output into the compressed file. The parameter 1253 flush is as in the deflate() function. The return value is the zlib 1254 error number (see function gzerror below). gzflush returns Z_OK if 1255 the flush parameter is Z_FINISH and all output could be flushed. 1256 gzflush should be called only when strictly necessary because it can 1257 degrade compression. 1258 */ 1259 1260 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, 1261 z_off_t offset, MS_U32 whence)); 1262 /* 1263 Sets the starting position for the next gzread or gzwrite on the 1264 given compressed file. The offset represents a number of bytes in the 1265 uncompressed data stream. The whence parameter is defined as in lseek(2); 1266 the value SEEK_END is not supported. 1267 If the file is opened for reading, this function is emulated but can be 1268 extremely slow. If the file is opened for writing, only forward seeks are 1269 supported; gzseek then compresses a sequence of zeroes up to the new 1270 starting position. 1271 1272 gzseek returns the resulting offset location as measured in bytes from 1273 the beginning of the uncompressed stream, or -1 in case of error, in 1274 particular if the file is opened for writing and the new starting position 1275 would be before the current position. 1276 */ 1277 1278 ZEXTERN MS_U32 ZEXPORT gzrewind OF((gzFile file)); 1279 /* 1280 Rewinds the given file. This function is supported only for reading. 1281 1282 gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) 1283 */ 1284 1285 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); 1286 /* 1287 Returns the starting position for the next gzread or gzwrite on the 1288 given compressed file. This position represents a number of bytes in the 1289 uncompressed data stream. 1290 1291 gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) 1292 */ 1293 1294 ZEXTERN MS_U32 ZEXPORT gzeof OF((gzFile file)); 1295 /* 1296 Returns 1 when EOF has previously been detected reading the given 1297 input stream, otherwise zero. 1298 */ 1299 1300 ZEXTERN MS_U32 ZEXPORT gzdirect OF((gzFile file)); 1301 /* 1302 Returns 1 if file is being read directly without decompression, otherwise 1303 zero. 1304 */ 1305 1306 ZEXTERN MS_U32 ZEXPORT gzclose OF((gzFile file)); 1307 /* 1308 Flushes all pending output if necessary, closes the compressed file 1309 and deallocates all the (de)compression state. The return value is the zlib 1310 error number (see function gzerror below). 1311 */ 1312 1313 ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, MS_U32 *errnum)); 1314 /* 1315 Returns the error message for the last error which occurred on the 1316 given compressed file. errnum is set to zlib error number. If an 1317 error occurred in the file system and not in the compression library, 1318 errnum is set to Z_ERRNO and the application may consult errno 1319 to get the exact error code. 1320 */ 1321 1322 ZEXTERN void ZEXPORT gzclearerr OF((gzFile file)); 1323 /* 1324 Clears the error and end-of-file flags for file. This is analogous to the 1325 clearerr() function in stdio. This is useful for continuing to read a gzip 1326 file that is being written concurrently. 1327 */ 1328 1329 /* checksum functions */ 1330 1331 /* 1332 These functions are not related to compression but are exported 1333 anyway because they might be useful in applications using the 1334 compression library. 1335 */ 1336 1337 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); 1338 /* 1339 Update a running Adler-32 checksum with the bytes buf[0..len-1] and 1340 return the updated checksum. If buf is NULL, this function returns 1341 the required initial value for the checksum. 1342 An Adler-32 checksum is almost as reliable as a CRC32 but can be computed 1343 much faster. Usage example: 1344 1345 uLong adler = adler32(0L, Z_NULL, 0); 1346 1347 while (read_buffer(buffer, length) != EOF) { 1348 adler = adler32(adler, buffer, length); 1349 } 1350 if (adler != original_adler) error(); 1351 */ 1352 1353 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, 1354 z_off_t len2)); 1355 /* 1356 Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 1357 and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for 1358 each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of 1359 seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. 1360 */ 1361 1362 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); 1363 /* 1364 Update a running CRC-32 with the bytes buf[0..len-1] and return the 1365 updated CRC-32. If buf is NULL, this function returns the required initial 1366 value for the for the crc. Pre- and post-conditioning (one's complement) is 1367 performed within this function so it shouldn't be done by the application. 1368 Usage example: 1369 1370 uLong crc = crc32(0L, Z_NULL, 0); 1371 1372 while (read_buffer(buffer, length) != EOF) { 1373 crc = crc32(crc, buffer, length); 1374 } 1375 if (crc != original_crc) error(); 1376 */ 1377 1378 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2)); 1379 1380 /* 1381 Combine two CRC-32 check values into one. For two sequences of bytes, 1382 seq1 and seq2 with lengths len1 and len2, CRC-32 check values were 1383 calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32 1384 check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and 1385 len2. 1386 */ 1387 1388 1389 /* various hacks, don't look :) */ 1390 1391 /* deflateInit and inflateInit are macros to allow checking the zlib version 1392 * and the compiler's view of z_stream: 1393 */ 1394 ZEXTERN MS_U32 ZEXPORT deflateInit_ OF((z_streamp strm, MS_U32 level, 1395 const char *version, MS_U32 stream_size)); 1396 ZEXTERN MS_U32 ZEXPORT gpdinflateInit_ OF((z_streamp strm, 1397 const char *version, MS_U32 stream_size)); 1398 ZEXTERN MS_U32 ZEXPORT deflateInit2_ OF((z_streamp strm, MS_U32 level, MS_U32 method, 1399 MS_U32 windowBits, MS_U32 memLevel, 1400 MS_U32 strategy, const char *version, 1401 MS_U32 stream_size)); 1402 ZEXTERN MS_U32 ZEXPORT gpdinflateInit2_ OF((z_streamp strm, MS_U32 windowBits, 1403 const char *version, MS_U32 stream_size)); 1404 ZEXTERN MS_U32 ZEXPORT inflateBackInit_ OF((z_streamp strm, MS_U32 windowBits, 1405 MS_U8 FAR *window, 1406 const char *version, 1407 MS_U32 stream_size)); 1408 #define deflateInit(strm, level) \ 1409 deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream)) 1410 #define gpdinflateInit(strm) \ 1411 gpdinflateInit_((strm), ZLIB_VERSION, sizeof(z_stream)) 1412 #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ 1413 deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ 1414 (strategy), ZLIB_VERSION, sizeof(z_stream)) 1415 #define gpdinflateInit2(strm, windowBits) \ 1416 gpdinflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream)) 1417 #define inflateBackInit(strm, windowBits, window) \ 1418 inflateBackInit_((strm), (windowBits), (window), \ 1419 ZLIB_VERSION, sizeof(z_stream)) 1420 1421 1422 #if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL) 1423 struct internal_state {MS_U32 dummy;}; /* hack for buggy compilers */ 1424 #endif 1425 1426 ZEXTERN const char * ZEXPORT zError OF((int)); 1427 ZEXTERN MS_U32 ZEXPORT inflateSyncPoint OF((z_streamp z)); 1428 ZEXTERN const uLongf * ZEXPORT get_crc_table OF((void)); 1429 1430 #ifdef __cplusplus 1431 } 1432 #endif 1433 1434 #endif /* ZLIB_H */ 1435