1*4a5d661aSToomas Soome /* zlib.h -- interface of the 'zlib' general purpose compression library 2*4a5d661aSToomas Soome version 1.2.8, April 28th, 2013 3*4a5d661aSToomas Soome 4*4a5d661aSToomas Soome Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler 5*4a5d661aSToomas Soome 6*4a5d661aSToomas Soome This software is provided 'as-is', without any express or implied 7*4a5d661aSToomas Soome warranty. In no event will the authors be held liable for any damages 8*4a5d661aSToomas Soome arising from the use of this software. 9*4a5d661aSToomas Soome 10*4a5d661aSToomas Soome Permission is granted to anyone to use this software for any purpose, 11*4a5d661aSToomas Soome including commercial applications, and to alter it and redistribute it 12*4a5d661aSToomas Soome freely, subject to the following restrictions: 13*4a5d661aSToomas Soome 14*4a5d661aSToomas Soome 1. The origin of this software must not be misrepresented; you must not 15*4a5d661aSToomas Soome claim that you wrote the original software. If you use this software 16*4a5d661aSToomas Soome in a product, an acknowledgment in the product documentation would be 17*4a5d661aSToomas Soome appreciated but is not required. 18*4a5d661aSToomas Soome 2. Altered source versions must be plainly marked as such, and must not be 19*4a5d661aSToomas Soome misrepresented as being the original software. 20*4a5d661aSToomas Soome 3. This notice may not be removed or altered from any source distribution. 21*4a5d661aSToomas Soome 22*4a5d661aSToomas Soome Jean-loup Gailly Mark Adler 23*4a5d661aSToomas Soome jloup@gzip.org madler@alumni.caltech.edu 24*4a5d661aSToomas Soome 25*4a5d661aSToomas Soome 26*4a5d661aSToomas Soome The data format used by the zlib library is described by RFCs (Request for 27*4a5d661aSToomas Soome Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950 28*4a5d661aSToomas Soome (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format). 29*4a5d661aSToomas Soome */ 30*4a5d661aSToomas Soome 31*4a5d661aSToomas Soome #ifndef ZLIB_H 32*4a5d661aSToomas Soome #define ZLIB_H 33*4a5d661aSToomas Soome 34*4a5d661aSToomas Soome #include "zconf.h" 35*4a5d661aSToomas Soome 36*4a5d661aSToomas Soome #ifdef __cplusplus 37*4a5d661aSToomas Soome extern "C" { 38*4a5d661aSToomas Soome #endif 39*4a5d661aSToomas Soome 40*4a5d661aSToomas Soome #define ZLIB_VERSION "1.2.8" 41*4a5d661aSToomas Soome #define ZLIB_VERNUM 0x1280 42*4a5d661aSToomas Soome #define ZLIB_VER_MAJOR 1 43*4a5d661aSToomas Soome #define ZLIB_VER_MINOR 2 44*4a5d661aSToomas Soome #define ZLIB_VER_REVISION 8 45*4a5d661aSToomas Soome #define ZLIB_VER_SUBREVISION 0 46*4a5d661aSToomas Soome 47*4a5d661aSToomas Soome /* 48*4a5d661aSToomas Soome The 'zlib' compression library provides in-memory compression and 49*4a5d661aSToomas Soome decompression functions, including integrity checks of the uncompressed data. 50*4a5d661aSToomas Soome This version of the library supports only one compression method (deflation) 51*4a5d661aSToomas Soome but other algorithms will be added later and will have the same stream 52*4a5d661aSToomas Soome interface. 53*4a5d661aSToomas Soome 54*4a5d661aSToomas Soome Compression can be done in a single step if the buffers are large enough, 55*4a5d661aSToomas Soome or can be done by repeated calls of the compression function. In the latter 56*4a5d661aSToomas Soome case, the application must provide more input and/or consume the output 57*4a5d661aSToomas Soome (providing more output space) before each call. 58*4a5d661aSToomas Soome 59*4a5d661aSToomas Soome The compressed data format used by default by the in-memory functions is 60*4a5d661aSToomas Soome the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped 61*4a5d661aSToomas Soome around a deflate stream, which is itself documented in RFC 1951. 62*4a5d661aSToomas Soome 63*4a5d661aSToomas Soome The library also supports reading and writing files in gzip (.gz) format 64*4a5d661aSToomas Soome with an interface similar to that of stdio using the functions that start 65*4a5d661aSToomas Soome with "gz". The gzip format is different from the zlib format. gzip is a 66*4a5d661aSToomas Soome gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. 67*4a5d661aSToomas Soome 68*4a5d661aSToomas Soome This library can optionally read and write gzip streams in memory as well. 69*4a5d661aSToomas Soome 70*4a5d661aSToomas Soome The zlib format was designed to be compact and fast for use in memory 71*4a5d661aSToomas Soome and on communications channels. The gzip format was designed for single- 72*4a5d661aSToomas Soome file compression on file systems, has a larger header than zlib to maintain 73*4a5d661aSToomas Soome directory information, and uses a different, slower check method than zlib. 74*4a5d661aSToomas Soome 75*4a5d661aSToomas Soome The library does not install any signal handler. The decoder checks 76*4a5d661aSToomas Soome the consistency of the compressed data, so the library should never crash 77*4a5d661aSToomas Soome even in case of corrupted input. 78*4a5d661aSToomas Soome */ 79*4a5d661aSToomas Soome 80*4a5d661aSToomas Soome typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); 81*4a5d661aSToomas Soome typedef void (*free_func) OF((voidpf opaque, voidpf address)); 82*4a5d661aSToomas Soome 83*4a5d661aSToomas Soome struct internal_state; 84*4a5d661aSToomas Soome 85*4a5d661aSToomas Soome typedef struct z_stream_s { 86*4a5d661aSToomas Soome z_const Bytef *next_in; /* next input byte */ 87*4a5d661aSToomas Soome uInt avail_in; /* number of bytes available at next_in */ 88*4a5d661aSToomas Soome uLong total_in; /* total number of input bytes read so far */ 89*4a5d661aSToomas Soome 90*4a5d661aSToomas Soome Bytef *next_out; /* next output byte should be put there */ 91*4a5d661aSToomas Soome uInt avail_out; /* remaining free space at next_out */ 92*4a5d661aSToomas Soome uLong total_out; /* total number of bytes output so far */ 93*4a5d661aSToomas Soome 94*4a5d661aSToomas Soome z_const char *msg; /* last error message, NULL if no error */ 95*4a5d661aSToomas Soome struct internal_state FAR *state; /* not visible by applications */ 96*4a5d661aSToomas Soome 97*4a5d661aSToomas Soome alloc_func zalloc; /* used to allocate the internal state */ 98*4a5d661aSToomas Soome free_func zfree; /* used to free the internal state */ 99*4a5d661aSToomas Soome voidpf opaque; /* private data object passed to zalloc and zfree */ 100*4a5d661aSToomas Soome 101*4a5d661aSToomas Soome int data_type; /* best guess about the data type: binary or text */ 102*4a5d661aSToomas Soome uLong adler; /* adler32 value of the uncompressed data */ 103*4a5d661aSToomas Soome uLong reserved; /* reserved for future use */ 104*4a5d661aSToomas Soome } z_stream; 105*4a5d661aSToomas Soome 106*4a5d661aSToomas Soome typedef z_stream FAR *z_streamp; 107*4a5d661aSToomas Soome 108*4a5d661aSToomas Soome /* 109*4a5d661aSToomas Soome gzip header information passed to and from zlib routines. See RFC 1952 110*4a5d661aSToomas Soome for more details on the meanings of these fields. 111*4a5d661aSToomas Soome */ 112*4a5d661aSToomas Soome typedef struct gz_header_s { 113*4a5d661aSToomas Soome int text; /* true if compressed data believed to be text */ 114*4a5d661aSToomas Soome uLong time; /* modification time */ 115*4a5d661aSToomas Soome int xflags; /* extra flags (not used when writing a gzip file) */ 116*4a5d661aSToomas Soome int os; /* operating system */ 117*4a5d661aSToomas Soome Bytef *extra; /* pointer to extra field or Z_NULL if none */ 118*4a5d661aSToomas Soome uInt extra_len; /* extra field length (valid if extra != Z_NULL) */ 119*4a5d661aSToomas Soome uInt extra_max; /* space at extra (only when reading header) */ 120*4a5d661aSToomas Soome Bytef *name; /* pointer to zero-terminated file name or Z_NULL */ 121*4a5d661aSToomas Soome uInt name_max; /* space at name (only when reading header) */ 122*4a5d661aSToomas Soome Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */ 123*4a5d661aSToomas Soome uInt comm_max; /* space at comment (only when reading header) */ 124*4a5d661aSToomas Soome int hcrc; /* true if there was or will be a header crc */ 125*4a5d661aSToomas Soome int done; /* true when done reading gzip header (not used 126*4a5d661aSToomas Soome when writing a gzip file) */ 127*4a5d661aSToomas Soome } gz_header; 128*4a5d661aSToomas Soome 129*4a5d661aSToomas Soome typedef gz_header FAR *gz_headerp; 130*4a5d661aSToomas Soome 131*4a5d661aSToomas Soome /* 132*4a5d661aSToomas Soome The application must update next_in and avail_in when avail_in has dropped 133*4a5d661aSToomas Soome to zero. It must update next_out and avail_out when avail_out has dropped 134*4a5d661aSToomas Soome to zero. The application must initialize zalloc, zfree and opaque before 135*4a5d661aSToomas Soome calling the init function. All other fields are set by the compression 136*4a5d661aSToomas Soome library and must not be updated by the application. 137*4a5d661aSToomas Soome 138*4a5d661aSToomas Soome The opaque value provided by the application will be passed as the first 139*4a5d661aSToomas Soome parameter for calls of zalloc and zfree. This can be useful for custom 140*4a5d661aSToomas Soome memory management. The compression library attaches no meaning to the 141*4a5d661aSToomas Soome opaque value. 142*4a5d661aSToomas Soome 143*4a5d661aSToomas Soome zalloc must return Z_NULL if there is not enough memory for the object. 144*4a5d661aSToomas Soome If zlib is used in a multi-threaded application, zalloc and zfree must be 145*4a5d661aSToomas Soome thread safe. 146*4a5d661aSToomas Soome 147*4a5d661aSToomas Soome On 16-bit systems, the functions zalloc and zfree must be able to allocate 148*4a5d661aSToomas Soome exactly 65536 bytes, but will not be required to allocate more than this if 149*4a5d661aSToomas Soome the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers 150*4a5d661aSToomas Soome returned by zalloc for objects of exactly 65536 bytes *must* have their 151*4a5d661aSToomas Soome offset normalized to zero. The default allocation function provided by this 152*4a5d661aSToomas Soome library ensures this (see zutil.c). To reduce memory requirements and avoid 153*4a5d661aSToomas Soome any allocation of 64K objects, at the expense of compression ratio, compile 154*4a5d661aSToomas Soome the library with -DMAX_WBITS=14 (see zconf.h). 155*4a5d661aSToomas Soome 156*4a5d661aSToomas Soome The fields total_in and total_out can be used for statistics or progress 157*4a5d661aSToomas Soome reports. After compression, total_in holds the total size of the 158*4a5d661aSToomas Soome uncompressed data and may be saved for use in the decompressor (particularly 159*4a5d661aSToomas Soome if the decompressor wants to decompress everything in a single step). 160*4a5d661aSToomas Soome */ 161*4a5d661aSToomas Soome 162*4a5d661aSToomas Soome /* constants */ 163*4a5d661aSToomas Soome 164*4a5d661aSToomas Soome #define Z_NO_FLUSH 0 165*4a5d661aSToomas Soome #define Z_PARTIAL_FLUSH 1 166*4a5d661aSToomas Soome #define Z_SYNC_FLUSH 2 167*4a5d661aSToomas Soome #define Z_FULL_FLUSH 3 168*4a5d661aSToomas Soome #define Z_FINISH 4 169*4a5d661aSToomas Soome #define Z_BLOCK 5 170*4a5d661aSToomas Soome #define Z_TREES 6 171*4a5d661aSToomas Soome /* Allowed flush values; see deflate() and inflate() below for details */ 172*4a5d661aSToomas Soome 173*4a5d661aSToomas Soome #define Z_OK 0 174*4a5d661aSToomas Soome #define Z_STREAM_END 1 175*4a5d661aSToomas Soome #define Z_NEED_DICT 2 176*4a5d661aSToomas Soome #define Z_ERRNO (-1) 177*4a5d661aSToomas Soome #define Z_STREAM_ERROR (-2) 178*4a5d661aSToomas Soome #define Z_DATA_ERROR (-3) 179*4a5d661aSToomas Soome #define Z_MEM_ERROR (-4) 180*4a5d661aSToomas Soome #define Z_BUF_ERROR (-5) 181*4a5d661aSToomas Soome #define Z_VERSION_ERROR (-6) 182*4a5d661aSToomas Soome /* Return codes for the compression/decompression functions. Negative values 183*4a5d661aSToomas Soome * are errors, positive values are used for special but normal events. 184*4a5d661aSToomas Soome */ 185*4a5d661aSToomas Soome 186*4a5d661aSToomas Soome #define Z_NO_COMPRESSION 0 187*4a5d661aSToomas Soome #define Z_BEST_SPEED 1 188*4a5d661aSToomas Soome #define Z_BEST_COMPRESSION 9 189*4a5d661aSToomas Soome #define Z_DEFAULT_COMPRESSION (-1) 190*4a5d661aSToomas Soome /* compression levels */ 191*4a5d661aSToomas Soome 192*4a5d661aSToomas Soome #define Z_FILTERED 1 193*4a5d661aSToomas Soome #define Z_HUFFMAN_ONLY 2 194*4a5d661aSToomas Soome #define Z_RLE 3 195*4a5d661aSToomas Soome #define Z_FIXED 4 196*4a5d661aSToomas Soome #define Z_DEFAULT_STRATEGY 0 197*4a5d661aSToomas Soome /* compression strategy; see deflateInit2() below for details */ 198*4a5d661aSToomas Soome 199*4a5d661aSToomas Soome #define Z_BINARY 0 200*4a5d661aSToomas Soome #define Z_TEXT 1 201*4a5d661aSToomas Soome #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ 202*4a5d661aSToomas Soome #define Z_UNKNOWN 2 203*4a5d661aSToomas Soome /* Possible values of the data_type field (though see inflate()) */ 204*4a5d661aSToomas Soome 205*4a5d661aSToomas Soome #define Z_DEFLATED 8 206*4a5d661aSToomas Soome /* The deflate compression method (the only one supported in this version) */ 207*4a5d661aSToomas Soome 208*4a5d661aSToomas Soome #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ 209*4a5d661aSToomas Soome 210*4a5d661aSToomas Soome #define zlib_version zlibVersion() 211*4a5d661aSToomas Soome /* for compatibility with versions < 1.0.2 */ 212*4a5d661aSToomas Soome 213*4a5d661aSToomas Soome 214*4a5d661aSToomas Soome /* basic functions */ 215*4a5d661aSToomas Soome 216*4a5d661aSToomas Soome ZEXTERN const char * ZEXPORT zlibVersion OF((void)); 217*4a5d661aSToomas Soome /* The application can compare zlibVersion and ZLIB_VERSION for consistency. 218*4a5d661aSToomas Soome If the first character differs, the library code actually used is not 219*4a5d661aSToomas Soome compatible with the zlib.h header file used by the application. This check 220*4a5d661aSToomas Soome is automatically made by deflateInit and inflateInit. 221*4a5d661aSToomas Soome */ 222*4a5d661aSToomas Soome 223*4a5d661aSToomas Soome /* 224*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level)); 225*4a5d661aSToomas Soome 226*4a5d661aSToomas Soome Initializes the internal stream state for compression. The fields 227*4a5d661aSToomas Soome zalloc, zfree and opaque must be initialized before by the caller. If 228*4a5d661aSToomas Soome zalloc and zfree are set to Z_NULL, deflateInit updates them to use default 229*4a5d661aSToomas Soome allocation functions. 230*4a5d661aSToomas Soome 231*4a5d661aSToomas Soome The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: 232*4a5d661aSToomas Soome 1 gives best speed, 9 gives best compression, 0 gives no compression at all 233*4a5d661aSToomas Soome (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION 234*4a5d661aSToomas Soome requests a default compromise between speed and compression (currently 235*4a5d661aSToomas Soome equivalent to level 6). 236*4a5d661aSToomas Soome 237*4a5d661aSToomas Soome deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 238*4a5d661aSToomas Soome memory, Z_STREAM_ERROR if level is not a valid compression level, or 239*4a5d661aSToomas Soome Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible 240*4a5d661aSToomas Soome with the version assumed by the caller (ZLIB_VERSION). msg is set to null 241*4a5d661aSToomas Soome if there is no error message. deflateInit does not perform any compression: 242*4a5d661aSToomas Soome this will be done by deflate(). 243*4a5d661aSToomas Soome */ 244*4a5d661aSToomas Soome 245*4a5d661aSToomas Soome 246*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush)); 247*4a5d661aSToomas Soome /* 248*4a5d661aSToomas Soome deflate compresses as much data as possible, and stops when the input 249*4a5d661aSToomas Soome buffer becomes empty or the output buffer becomes full. It may introduce 250*4a5d661aSToomas Soome some output latency (reading input without producing any output) except when 251*4a5d661aSToomas Soome forced to flush. 252*4a5d661aSToomas Soome 253*4a5d661aSToomas Soome The detailed semantics are as follows. deflate performs one or both of the 254*4a5d661aSToomas Soome following actions: 255*4a5d661aSToomas Soome 256*4a5d661aSToomas Soome - Compress more input starting at next_in and update next_in and avail_in 257*4a5d661aSToomas Soome accordingly. If not all input can be processed (because there is not 258*4a5d661aSToomas Soome enough room in the output buffer), next_in and avail_in are updated and 259*4a5d661aSToomas Soome processing will resume at this point for the next call of deflate(). 260*4a5d661aSToomas Soome 261*4a5d661aSToomas Soome - Provide more output starting at next_out and update next_out and avail_out 262*4a5d661aSToomas Soome accordingly. This action is forced if the parameter flush is non zero. 263*4a5d661aSToomas Soome Forcing flush frequently degrades the compression ratio, so this parameter 264*4a5d661aSToomas Soome should be set only when necessary (in interactive applications). Some 265*4a5d661aSToomas Soome output may be provided even if flush is not set. 266*4a5d661aSToomas Soome 267*4a5d661aSToomas Soome Before the call of deflate(), the application should ensure that at least 268*4a5d661aSToomas Soome one of the actions is possible, by providing more input and/or consuming more 269*4a5d661aSToomas Soome output, and updating avail_in or avail_out accordingly; avail_out should 270*4a5d661aSToomas Soome never be zero before the call. The application can consume the compressed 271*4a5d661aSToomas Soome output when it wants, for example when the output buffer is full (avail_out 272*4a5d661aSToomas Soome == 0), or after each call of deflate(). If deflate returns Z_OK and with 273*4a5d661aSToomas Soome zero avail_out, it must be called again after making room in the output 274*4a5d661aSToomas Soome buffer because there might be more output pending. 275*4a5d661aSToomas Soome 276*4a5d661aSToomas Soome Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to 277*4a5d661aSToomas Soome decide how much data to accumulate before producing output, in order to 278*4a5d661aSToomas Soome maximize compression. 279*4a5d661aSToomas Soome 280*4a5d661aSToomas Soome If the parameter flush is set to Z_SYNC_FLUSH, all pending output is 281*4a5d661aSToomas Soome flushed to the output buffer and the output is aligned on a byte boundary, so 282*4a5d661aSToomas Soome that the decompressor can get all input data available so far. (In 283*4a5d661aSToomas Soome particular avail_in is zero after the call if enough output space has been 284*4a5d661aSToomas Soome provided before the call.) Flushing may degrade compression for some 285*4a5d661aSToomas Soome compression algorithms and so it should be used only when necessary. This 286*4a5d661aSToomas Soome completes the current deflate block and follows it with an empty stored block 287*4a5d661aSToomas Soome that is three bits plus filler bits to the next byte, followed by four bytes 288*4a5d661aSToomas Soome (00 00 ff ff). 289*4a5d661aSToomas Soome 290*4a5d661aSToomas Soome If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the 291*4a5d661aSToomas Soome output buffer, but the output is not aligned to a byte boundary. All of the 292*4a5d661aSToomas Soome input data so far will be available to the decompressor, as for Z_SYNC_FLUSH. 293*4a5d661aSToomas Soome This completes the current deflate block and follows it with an empty fixed 294*4a5d661aSToomas Soome codes block that is 10 bits long. This assures that enough bytes are output 295*4a5d661aSToomas Soome in order for the decompressor to finish the block before the empty fixed code 296*4a5d661aSToomas Soome block. 297*4a5d661aSToomas Soome 298*4a5d661aSToomas Soome If flush is set to Z_BLOCK, a deflate block is completed and emitted, as 299*4a5d661aSToomas Soome for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to 300*4a5d661aSToomas Soome seven bits of the current block are held to be written as the next byte after 301*4a5d661aSToomas Soome the next deflate block is completed. In this case, the decompressor may not 302*4a5d661aSToomas Soome be provided enough bits at this point in order to complete decompression of 303*4a5d661aSToomas Soome the data provided so far to the compressor. It may need to wait for the next 304*4a5d661aSToomas Soome block to be emitted. This is for advanced applications that need to control 305*4a5d661aSToomas Soome the emission of deflate blocks. 306*4a5d661aSToomas Soome 307*4a5d661aSToomas Soome If flush is set to Z_FULL_FLUSH, all output is flushed as with 308*4a5d661aSToomas Soome Z_SYNC_FLUSH, and the compression state is reset so that decompression can 309*4a5d661aSToomas Soome restart from this point if previous compressed data has been damaged or if 310*4a5d661aSToomas Soome random access is desired. Using Z_FULL_FLUSH too often can seriously degrade 311*4a5d661aSToomas Soome compression. 312*4a5d661aSToomas Soome 313*4a5d661aSToomas Soome If deflate returns with avail_out == 0, this function must be called again 314*4a5d661aSToomas Soome with the same value of the flush parameter and more output space (updated 315*4a5d661aSToomas Soome avail_out), until the flush is complete (deflate returns with non-zero 316*4a5d661aSToomas Soome avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that 317*4a5d661aSToomas Soome avail_out is greater than six to avoid repeated flush markers due to 318*4a5d661aSToomas Soome avail_out == 0 on return. 319*4a5d661aSToomas Soome 320*4a5d661aSToomas Soome If the parameter flush is set to Z_FINISH, pending input is processed, 321*4a5d661aSToomas Soome pending output is flushed and deflate returns with Z_STREAM_END if there was 322*4a5d661aSToomas Soome enough output space; if deflate returns with Z_OK, this function must be 323*4a5d661aSToomas Soome called again with Z_FINISH and more output space (updated avail_out) but no 324*4a5d661aSToomas Soome more input data, until it returns with Z_STREAM_END or an error. After 325*4a5d661aSToomas Soome deflate has returned Z_STREAM_END, the only possible operations on the stream 326*4a5d661aSToomas Soome are deflateReset or deflateEnd. 327*4a5d661aSToomas Soome 328*4a5d661aSToomas Soome Z_FINISH can be used immediately after deflateInit if all the compression 329*4a5d661aSToomas Soome is to be done in a single step. In this case, avail_out must be at least the 330*4a5d661aSToomas Soome value returned by deflateBound (see below). Then deflate is guaranteed to 331*4a5d661aSToomas Soome return Z_STREAM_END. If not enough output space is provided, deflate will 332*4a5d661aSToomas Soome not return Z_STREAM_END, and it must be called again as described above. 333*4a5d661aSToomas Soome 334*4a5d661aSToomas Soome deflate() sets strm->adler to the adler32 checksum of all input read 335*4a5d661aSToomas Soome so far (that is, total_in bytes). 336*4a5d661aSToomas Soome 337*4a5d661aSToomas Soome deflate() may update strm->data_type if it can make a good guess about 338*4a5d661aSToomas Soome the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered 339*4a5d661aSToomas Soome binary. This field is only for information purposes and does not affect the 340*4a5d661aSToomas Soome compression algorithm in any manner. 341*4a5d661aSToomas Soome 342*4a5d661aSToomas Soome deflate() returns Z_OK if some progress has been made (more input 343*4a5d661aSToomas Soome processed or more output produced), Z_STREAM_END if all input has been 344*4a5d661aSToomas Soome consumed and all output has been produced (only when flush is set to 345*4a5d661aSToomas Soome Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example 346*4a5d661aSToomas Soome if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible 347*4a5d661aSToomas Soome (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not 348*4a5d661aSToomas Soome fatal, and deflate() can be called again with more input and more output 349*4a5d661aSToomas Soome space to continue compressing. 350*4a5d661aSToomas Soome */ 351*4a5d661aSToomas Soome 352*4a5d661aSToomas Soome 353*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm)); 354*4a5d661aSToomas Soome /* 355*4a5d661aSToomas Soome All dynamically allocated data structures for this stream are freed. 356*4a5d661aSToomas Soome This function discards any unprocessed input and does not flush any pending 357*4a5d661aSToomas Soome output. 358*4a5d661aSToomas Soome 359*4a5d661aSToomas Soome deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the 360*4a5d661aSToomas Soome stream state was inconsistent, Z_DATA_ERROR if the stream was freed 361*4a5d661aSToomas Soome prematurely (some input or output was discarded). In the error case, msg 362*4a5d661aSToomas Soome may be set but then points to a static string (which must not be 363*4a5d661aSToomas Soome deallocated). 364*4a5d661aSToomas Soome */ 365*4a5d661aSToomas Soome 366*4a5d661aSToomas Soome 367*4a5d661aSToomas Soome /* 368*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm)); 369*4a5d661aSToomas Soome 370*4a5d661aSToomas Soome Initializes the internal stream state for decompression. The fields 371*4a5d661aSToomas Soome next_in, avail_in, zalloc, zfree and opaque must be initialized before by 372*4a5d661aSToomas Soome the caller. If next_in is not Z_NULL and avail_in is large enough (the 373*4a5d661aSToomas Soome exact value depends on the compression method), inflateInit determines the 374*4a5d661aSToomas Soome compression method from the zlib header and allocates all data structures 375*4a5d661aSToomas Soome accordingly; otherwise the allocation will be deferred to the first call of 376*4a5d661aSToomas Soome inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to 377*4a5d661aSToomas Soome use default allocation functions. 378*4a5d661aSToomas Soome 379*4a5d661aSToomas Soome inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 380*4a5d661aSToomas Soome memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 381*4a5d661aSToomas Soome version assumed by the caller, or Z_STREAM_ERROR if the parameters are 382*4a5d661aSToomas Soome invalid, such as a null pointer to the structure. msg is set to null if 383*4a5d661aSToomas Soome there is no error message. inflateInit does not perform any decompression 384*4a5d661aSToomas Soome apart from possibly reading the zlib header if present: actual decompression 385*4a5d661aSToomas Soome will be done by inflate(). (So next_in and avail_in may be modified, but 386*4a5d661aSToomas Soome next_out and avail_out are unused and unchanged.) The current implementation 387*4a5d661aSToomas Soome of inflateInit() does not process any header information -- that is deferred 388*4a5d661aSToomas Soome until inflate() is called. 389*4a5d661aSToomas Soome */ 390*4a5d661aSToomas Soome 391*4a5d661aSToomas Soome 392*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush)); 393*4a5d661aSToomas Soome /* 394*4a5d661aSToomas Soome inflate decompresses as much data as possible, and stops when the input 395*4a5d661aSToomas Soome buffer becomes empty or the output buffer becomes full. It may introduce 396*4a5d661aSToomas Soome some output latency (reading input without producing any output) except when 397*4a5d661aSToomas Soome forced to flush. 398*4a5d661aSToomas Soome 399*4a5d661aSToomas Soome The detailed semantics are as follows. inflate performs one or both of the 400*4a5d661aSToomas Soome following actions: 401*4a5d661aSToomas Soome 402*4a5d661aSToomas Soome - Decompress more input starting at next_in and update next_in and avail_in 403*4a5d661aSToomas Soome accordingly. If not all input can be processed (because there is not 404*4a5d661aSToomas Soome enough room in the output buffer), next_in is updated and processing will 405*4a5d661aSToomas Soome resume at this point for the next call of inflate(). 406*4a5d661aSToomas Soome 407*4a5d661aSToomas Soome - Provide more output starting at next_out and update next_out and avail_out 408*4a5d661aSToomas Soome accordingly. inflate() provides as much output as possible, until there is 409*4a5d661aSToomas Soome no more input data or no more space in the output buffer (see below about 410*4a5d661aSToomas Soome the flush parameter). 411*4a5d661aSToomas Soome 412*4a5d661aSToomas Soome Before the call of inflate(), the application should ensure that at least 413*4a5d661aSToomas Soome one of the actions is possible, by providing more input and/or consuming more 414*4a5d661aSToomas Soome output, and updating the next_* and avail_* values accordingly. The 415*4a5d661aSToomas Soome application can consume the uncompressed output when it wants, for example 416*4a5d661aSToomas Soome when the output buffer is full (avail_out == 0), or after each call of 417*4a5d661aSToomas Soome inflate(). If inflate returns Z_OK and with zero avail_out, it must be 418*4a5d661aSToomas Soome called again after making room in the output buffer because there might be 419*4a5d661aSToomas Soome more output pending. 420*4a5d661aSToomas Soome 421*4a5d661aSToomas Soome The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH, 422*4a5d661aSToomas Soome Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much 423*4a5d661aSToomas Soome output as possible to the output buffer. Z_BLOCK requests that inflate() 424*4a5d661aSToomas Soome stop if and when it gets to the next deflate block boundary. When decoding 425*4a5d661aSToomas Soome the zlib or gzip format, this will cause inflate() to return immediately 426*4a5d661aSToomas Soome after the header and before the first block. When doing a raw inflate, 427*4a5d661aSToomas Soome inflate() will go ahead and process the first block, and will return when it 428*4a5d661aSToomas Soome gets to the end of that block, or when it runs out of data. 429*4a5d661aSToomas Soome 430*4a5d661aSToomas Soome The Z_BLOCK option assists in appending to or combining deflate streams. 431*4a5d661aSToomas Soome Also to assist in this, on return inflate() will set strm->data_type to the 432*4a5d661aSToomas Soome number of unused bits in the last byte taken from strm->next_in, plus 64 if 433*4a5d661aSToomas Soome inflate() is currently decoding the last block in the deflate stream, plus 434*4a5d661aSToomas Soome 128 if inflate() returned immediately after decoding an end-of-block code or 435*4a5d661aSToomas Soome decoding the complete header up to just before the first byte of the deflate 436*4a5d661aSToomas Soome stream. The end-of-block will not be indicated until all of the uncompressed 437*4a5d661aSToomas Soome data from that block has been written to strm->next_out. The number of 438*4a5d661aSToomas Soome unused bits may in general be greater than seven, except when bit 7 of 439*4a5d661aSToomas Soome data_type is set, in which case the number of unused bits will be less than 440*4a5d661aSToomas Soome eight. data_type is set as noted here every time inflate() returns for all 441*4a5d661aSToomas Soome flush options, and so can be used to determine the amount of currently 442*4a5d661aSToomas Soome consumed input in bits. 443*4a5d661aSToomas Soome 444*4a5d661aSToomas Soome The Z_TREES option behaves as Z_BLOCK does, but it also returns when the 445*4a5d661aSToomas Soome end of each deflate block header is reached, before any actual data in that 446*4a5d661aSToomas Soome block is decoded. This allows the caller to determine the length of the 447*4a5d661aSToomas Soome deflate block header for later use in random access within a deflate block. 448*4a5d661aSToomas Soome 256 is added to the value of strm->data_type when inflate() returns 449*4a5d661aSToomas Soome immediately after reaching the end of the deflate block header. 450*4a5d661aSToomas Soome 451*4a5d661aSToomas Soome inflate() should normally be called until it returns Z_STREAM_END or an 452*4a5d661aSToomas Soome error. However if all decompression is to be performed in a single step (a 453*4a5d661aSToomas Soome single call of inflate), the parameter flush should be set to Z_FINISH. In 454*4a5d661aSToomas Soome this case all pending input is processed and all pending output is flushed; 455*4a5d661aSToomas Soome avail_out must be large enough to hold all of the uncompressed data for the 456*4a5d661aSToomas Soome operation to complete. (The size of the uncompressed data may have been 457*4a5d661aSToomas Soome saved by the compressor for this purpose.) The use of Z_FINISH is not 458*4a5d661aSToomas Soome required to perform an inflation in one step. However it may be used to 459*4a5d661aSToomas Soome inform inflate that a faster approach can be used for the single inflate() 460*4a5d661aSToomas Soome call. Z_FINISH also informs inflate to not maintain a sliding window if the 461*4a5d661aSToomas Soome stream completes, which reduces inflate's memory footprint. If the stream 462*4a5d661aSToomas Soome does not complete, either because not all of the stream is provided or not 463*4a5d661aSToomas Soome enough output space is provided, then a sliding window will be allocated and 464*4a5d661aSToomas Soome inflate() can be called again to continue the operation as if Z_NO_FLUSH had 465*4a5d661aSToomas Soome been used. 466*4a5d661aSToomas Soome 467*4a5d661aSToomas Soome In this implementation, inflate() always flushes as much output as 468*4a5d661aSToomas Soome possible to the output buffer, and always uses the faster approach on the 469*4a5d661aSToomas Soome first call. So the effects of the flush parameter in this implementation are 470*4a5d661aSToomas Soome on the return value of inflate() as noted below, when inflate() returns early 471*4a5d661aSToomas Soome when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of 472*4a5d661aSToomas Soome memory for a sliding window when Z_FINISH is used. 473*4a5d661aSToomas Soome 474*4a5d661aSToomas Soome If a preset dictionary is needed after this call (see inflateSetDictionary 475*4a5d661aSToomas Soome below), inflate sets strm->adler to the Adler-32 checksum of the dictionary 476*4a5d661aSToomas Soome chosen by the compressor and returns Z_NEED_DICT; otherwise it sets 477*4a5d661aSToomas Soome strm->adler to the Adler-32 checksum of all output produced so far (that is, 478*4a5d661aSToomas Soome total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described 479*4a5d661aSToomas Soome below. At the end of the stream, inflate() checks that its computed adler32 480*4a5d661aSToomas Soome checksum is equal to that saved by the compressor and returns Z_STREAM_END 481*4a5d661aSToomas Soome only if the checksum is correct. 482*4a5d661aSToomas Soome 483*4a5d661aSToomas Soome inflate() can decompress and check either zlib-wrapped or gzip-wrapped 484*4a5d661aSToomas Soome deflate data. The header type is detected automatically, if requested when 485*4a5d661aSToomas Soome initializing with inflateInit2(). Any information contained in the gzip 486*4a5d661aSToomas Soome header is not retained, so applications that need that information should 487*4a5d661aSToomas Soome instead use raw inflate, see inflateInit2() below, or inflateBack() and 488*4a5d661aSToomas Soome perform their own processing of the gzip header and trailer. When processing 489*4a5d661aSToomas Soome gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output 490*4a5d661aSToomas Soome producted so far. The CRC-32 is checked against the gzip trailer. 491*4a5d661aSToomas Soome 492*4a5d661aSToomas Soome inflate() returns Z_OK if some progress has been made (more input processed 493*4a5d661aSToomas Soome or more output produced), Z_STREAM_END if the end of the compressed data has 494*4a5d661aSToomas Soome been reached and all uncompressed output has been produced, Z_NEED_DICT if a 495*4a5d661aSToomas Soome preset dictionary is needed at this point, Z_DATA_ERROR if the input data was 496*4a5d661aSToomas Soome corrupted (input stream not conforming to the zlib format or incorrect check 497*4a5d661aSToomas Soome value), Z_STREAM_ERROR if the stream structure was inconsistent (for example 498*4a5d661aSToomas Soome next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory, 499*4a5d661aSToomas Soome Z_BUF_ERROR if no progress is possible or if there was not enough room in the 500*4a5d661aSToomas Soome output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and 501*4a5d661aSToomas Soome inflate() can be called again with more input and more output space to 502*4a5d661aSToomas Soome continue decompressing. If Z_DATA_ERROR is returned, the application may 503*4a5d661aSToomas Soome then call inflateSync() to look for a good compression block if a partial 504*4a5d661aSToomas Soome recovery of the data is desired. 505*4a5d661aSToomas Soome */ 506*4a5d661aSToomas Soome 507*4a5d661aSToomas Soome 508*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm)); 509*4a5d661aSToomas Soome /* 510*4a5d661aSToomas Soome All dynamically allocated data structures for this stream are freed. 511*4a5d661aSToomas Soome This function discards any unprocessed input and does not flush any pending 512*4a5d661aSToomas Soome output. 513*4a5d661aSToomas Soome 514*4a5d661aSToomas Soome inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state 515*4a5d661aSToomas Soome was inconsistent. In the error case, msg may be set but then points to a 516*4a5d661aSToomas Soome static string (which must not be deallocated). 517*4a5d661aSToomas Soome */ 518*4a5d661aSToomas Soome 519*4a5d661aSToomas Soome 520*4a5d661aSToomas Soome /* Advanced functions */ 521*4a5d661aSToomas Soome 522*4a5d661aSToomas Soome /* 523*4a5d661aSToomas Soome The following functions are needed only in some special applications. 524*4a5d661aSToomas Soome */ 525*4a5d661aSToomas Soome 526*4a5d661aSToomas Soome /* 527*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm, 528*4a5d661aSToomas Soome int level, 529*4a5d661aSToomas Soome int method, 530*4a5d661aSToomas Soome int windowBits, 531*4a5d661aSToomas Soome int memLevel, 532*4a5d661aSToomas Soome int strategy)); 533*4a5d661aSToomas Soome 534*4a5d661aSToomas Soome This is another version of deflateInit with more compression options. The 535*4a5d661aSToomas Soome fields next_in, zalloc, zfree and opaque must be initialized before by the 536*4a5d661aSToomas Soome caller. 537*4a5d661aSToomas Soome 538*4a5d661aSToomas Soome The method parameter is the compression method. It must be Z_DEFLATED in 539*4a5d661aSToomas Soome this version of the library. 540*4a5d661aSToomas Soome 541*4a5d661aSToomas Soome The windowBits parameter is the base two logarithm of the window size 542*4a5d661aSToomas Soome (the size of the history buffer). It should be in the range 8..15 for this 543*4a5d661aSToomas Soome version of the library. Larger values of this parameter result in better 544*4a5d661aSToomas Soome compression at the expense of memory usage. The default value is 15 if 545*4a5d661aSToomas Soome deflateInit is used instead. 546*4a5d661aSToomas Soome 547*4a5d661aSToomas Soome windowBits can also be -8..-15 for raw deflate. In this case, -windowBits 548*4a5d661aSToomas Soome determines the window size. deflate() will then generate raw deflate data 549*4a5d661aSToomas Soome with no zlib header or trailer, and will not compute an adler32 check value. 550*4a5d661aSToomas Soome 551*4a5d661aSToomas Soome windowBits can also be greater than 15 for optional gzip encoding. Add 552*4a5d661aSToomas Soome 16 to windowBits to write a simple gzip header and trailer around the 553*4a5d661aSToomas Soome compressed data instead of a zlib wrapper. The gzip header will have no 554*4a5d661aSToomas Soome file name, no extra data, no comment, no modification time (set to zero), no 555*4a5d661aSToomas Soome header crc, and the operating system will be set to 255 (unknown). If a 556*4a5d661aSToomas Soome gzip stream is being written, strm->adler is a crc32 instead of an adler32. 557*4a5d661aSToomas Soome 558*4a5d661aSToomas Soome The memLevel parameter specifies how much memory should be allocated 559*4a5d661aSToomas Soome for the internal compression state. memLevel=1 uses minimum memory but is 560*4a5d661aSToomas Soome slow and reduces compression ratio; memLevel=9 uses maximum memory for 561*4a5d661aSToomas Soome optimal speed. The default value is 8. See zconf.h for total memory usage 562*4a5d661aSToomas Soome as a function of windowBits and memLevel. 563*4a5d661aSToomas Soome 564*4a5d661aSToomas Soome The strategy parameter is used to tune the compression algorithm. Use the 565*4a5d661aSToomas Soome value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a 566*4a5d661aSToomas Soome filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no 567*4a5d661aSToomas Soome string match), or Z_RLE to limit match distances to one (run-length 568*4a5d661aSToomas Soome encoding). Filtered data consists mostly of small values with a somewhat 569*4a5d661aSToomas Soome random distribution. In this case, the compression algorithm is tuned to 570*4a5d661aSToomas Soome compress them better. The effect of Z_FILTERED is to force more Huffman 571*4a5d661aSToomas Soome coding and less string matching; it is somewhat intermediate between 572*4a5d661aSToomas Soome Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as 573*4a5d661aSToomas Soome fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The 574*4a5d661aSToomas Soome strategy parameter only affects the compression ratio but not the 575*4a5d661aSToomas Soome correctness of the compressed output even if it is not set appropriately. 576*4a5d661aSToomas Soome Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler 577*4a5d661aSToomas Soome decoder for special applications. 578*4a5d661aSToomas Soome 579*4a5d661aSToomas Soome deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 580*4a5d661aSToomas Soome memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid 581*4a5d661aSToomas Soome method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is 582*4a5d661aSToomas Soome incompatible with the version assumed by the caller (ZLIB_VERSION). msg is 583*4a5d661aSToomas Soome set to null if there is no error message. deflateInit2 does not perform any 584*4a5d661aSToomas Soome compression: this will be done by deflate(). 585*4a5d661aSToomas Soome */ 586*4a5d661aSToomas Soome 587*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm, 588*4a5d661aSToomas Soome const Bytef *dictionary, 589*4a5d661aSToomas Soome uInt dictLength)); 590*4a5d661aSToomas Soome /* 591*4a5d661aSToomas Soome Initializes the compression dictionary from the given byte sequence 592*4a5d661aSToomas Soome without producing any compressed output. When using the zlib format, this 593*4a5d661aSToomas Soome function must be called immediately after deflateInit, deflateInit2 or 594*4a5d661aSToomas Soome deflateReset, and before any call of deflate. When doing raw deflate, this 595*4a5d661aSToomas Soome function must be called either before any call of deflate, or immediately 596*4a5d661aSToomas Soome after the completion of a deflate block, i.e. after all input has been 597*4a5d661aSToomas Soome consumed and all output has been delivered when using any of the flush 598*4a5d661aSToomas Soome options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The 599*4a5d661aSToomas Soome compressor and decompressor must use exactly the same dictionary (see 600*4a5d661aSToomas Soome inflateSetDictionary). 601*4a5d661aSToomas Soome 602*4a5d661aSToomas Soome The dictionary should consist of strings (byte sequences) that are likely 603*4a5d661aSToomas Soome to be encountered later in the data to be compressed, with the most commonly 604*4a5d661aSToomas Soome used strings preferably put towards the end of the dictionary. Using a 605*4a5d661aSToomas Soome dictionary is most useful when the data to be compressed is short and can be 606*4a5d661aSToomas Soome predicted with good accuracy; the data can then be compressed better than 607*4a5d661aSToomas Soome with the default empty dictionary. 608*4a5d661aSToomas Soome 609*4a5d661aSToomas Soome Depending on the size of the compression data structures selected by 610*4a5d661aSToomas Soome deflateInit or deflateInit2, a part of the dictionary may in effect be 611*4a5d661aSToomas Soome discarded, for example if the dictionary is larger than the window size 612*4a5d661aSToomas Soome provided in deflateInit or deflateInit2. Thus the strings most likely to be 613*4a5d661aSToomas Soome useful should be put at the end of the dictionary, not at the front. In 614*4a5d661aSToomas Soome addition, the current implementation of deflate will use at most the window 615*4a5d661aSToomas Soome size minus 262 bytes of the provided dictionary. 616*4a5d661aSToomas Soome 617*4a5d661aSToomas Soome Upon return of this function, strm->adler is set to the adler32 value 618*4a5d661aSToomas Soome of the dictionary; the decompressor may later use this value to determine 619*4a5d661aSToomas Soome which dictionary has been used by the compressor. (The adler32 value 620*4a5d661aSToomas Soome applies to the whole dictionary even if only a subset of the dictionary is 621*4a5d661aSToomas Soome actually used by the compressor.) If a raw deflate was requested, then the 622*4a5d661aSToomas Soome adler32 value is not computed and strm->adler is not set. 623*4a5d661aSToomas Soome 624*4a5d661aSToomas Soome deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a 625*4a5d661aSToomas Soome parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 626*4a5d661aSToomas Soome inconsistent (for example if deflate has already been called for this stream 627*4a5d661aSToomas Soome or if not at a block boundary for raw deflate). deflateSetDictionary does 628*4a5d661aSToomas Soome not perform any compression: this will be done by deflate(). 629*4a5d661aSToomas Soome */ 630*4a5d661aSToomas Soome 631*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest, 632*4a5d661aSToomas Soome z_streamp source)); 633*4a5d661aSToomas Soome /* 634*4a5d661aSToomas Soome Sets the destination stream as a complete copy of the source stream. 635*4a5d661aSToomas Soome 636*4a5d661aSToomas Soome This function can be useful when several compression strategies will be 637*4a5d661aSToomas Soome tried, for example when there are several ways of pre-processing the input 638*4a5d661aSToomas Soome data with a filter. The streams that will be discarded should then be freed 639*4a5d661aSToomas Soome by calling deflateEnd. Note that deflateCopy duplicates the internal 640*4a5d661aSToomas Soome compression state which can be quite large, so this strategy is slow and can 641*4a5d661aSToomas Soome consume lots of memory. 642*4a5d661aSToomas Soome 643*4a5d661aSToomas Soome deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 644*4a5d661aSToomas Soome enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 645*4a5d661aSToomas Soome (such as zalloc being Z_NULL). msg is left unchanged in both source and 646*4a5d661aSToomas Soome destination. 647*4a5d661aSToomas Soome */ 648*4a5d661aSToomas Soome 649*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); 650*4a5d661aSToomas Soome /* 651*4a5d661aSToomas Soome This function is equivalent to deflateEnd followed by deflateInit, 652*4a5d661aSToomas Soome but does not free and reallocate all the internal compression state. The 653*4a5d661aSToomas Soome stream will keep the same compression level and any other attributes that 654*4a5d661aSToomas Soome may have been set by deflateInit2. 655*4a5d661aSToomas Soome 656*4a5d661aSToomas Soome deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 657*4a5d661aSToomas Soome stream state was inconsistent (such as zalloc or state being Z_NULL). 658*4a5d661aSToomas Soome */ 659*4a5d661aSToomas Soome 660*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm, 661*4a5d661aSToomas Soome int level, 662*4a5d661aSToomas Soome int strategy)); 663*4a5d661aSToomas Soome /* 664*4a5d661aSToomas Soome Dynamically update the compression level and compression strategy. The 665*4a5d661aSToomas Soome interpretation of level and strategy is as in deflateInit2. This can be 666*4a5d661aSToomas Soome used to switch between compression and straight copy of the input data, or 667*4a5d661aSToomas Soome to switch to a different kind of input data requiring a different strategy. 668*4a5d661aSToomas Soome If the compression level is changed, the input available so far is 669*4a5d661aSToomas Soome compressed with the old level (and may be flushed); the new level will take 670*4a5d661aSToomas Soome effect only at the next call of deflate(). 671*4a5d661aSToomas Soome 672*4a5d661aSToomas Soome Before the call of deflateParams, the stream state must be set as for 673*4a5d661aSToomas Soome a call of deflate(), since the currently available input may have to be 674*4a5d661aSToomas Soome compressed and flushed. In particular, strm->avail_out must be non-zero. 675*4a5d661aSToomas Soome 676*4a5d661aSToomas Soome deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source 677*4a5d661aSToomas Soome stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if 678*4a5d661aSToomas Soome strm->avail_out was zero. 679*4a5d661aSToomas Soome */ 680*4a5d661aSToomas Soome 681*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm, 682*4a5d661aSToomas Soome int good_length, 683*4a5d661aSToomas Soome int max_lazy, 684*4a5d661aSToomas Soome int nice_length, 685*4a5d661aSToomas Soome int max_chain)); 686*4a5d661aSToomas Soome /* 687*4a5d661aSToomas Soome Fine tune deflate's internal compression parameters. This should only be 688*4a5d661aSToomas Soome used by someone who understands the algorithm used by zlib's deflate for 689*4a5d661aSToomas Soome searching for the best matching string, and even then only by the most 690*4a5d661aSToomas Soome fanatic optimizer trying to squeeze out the last compressed bit for their 691*4a5d661aSToomas Soome specific input data. Read the deflate.c source code for the meaning of the 692*4a5d661aSToomas Soome max_lazy, good_length, nice_length, and max_chain parameters. 693*4a5d661aSToomas Soome 694*4a5d661aSToomas Soome deflateTune() can be called after deflateInit() or deflateInit2(), and 695*4a5d661aSToomas Soome returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream. 696*4a5d661aSToomas Soome */ 697*4a5d661aSToomas Soome 698*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm, 699*4a5d661aSToomas Soome uLong sourceLen)); 700*4a5d661aSToomas Soome /* 701*4a5d661aSToomas Soome deflateBound() returns an upper bound on the compressed size after 702*4a5d661aSToomas Soome deflation of sourceLen bytes. It must be called after deflateInit() or 703*4a5d661aSToomas Soome deflateInit2(), and after deflateSetHeader(), if used. This would be used 704*4a5d661aSToomas Soome to allocate an output buffer for deflation in a single pass, and so would be 705*4a5d661aSToomas Soome called before deflate(). If that first deflate() call is provided the 706*4a5d661aSToomas Soome sourceLen input bytes, an output buffer allocated to the size returned by 707*4a5d661aSToomas Soome deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed 708*4a5d661aSToomas Soome to return Z_STREAM_END. Note that it is possible for the compressed size to 709*4a5d661aSToomas Soome be larger than the value returned by deflateBound() if flush options other 710*4a5d661aSToomas Soome than Z_FINISH or Z_NO_FLUSH are used. 711*4a5d661aSToomas Soome */ 712*4a5d661aSToomas Soome 713*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflatePending OF((z_streamp strm, 714*4a5d661aSToomas Soome unsigned *pending, 715*4a5d661aSToomas Soome int *bits)); 716*4a5d661aSToomas Soome /* 717*4a5d661aSToomas Soome deflatePending() returns the number of bytes and bits of output that have 718*4a5d661aSToomas Soome been generated, but not yet provided in the available output. The bytes not 719*4a5d661aSToomas Soome provided would be due to the available output space having being consumed. 720*4a5d661aSToomas Soome The number of bits of output not provided are between 0 and 7, where they 721*4a5d661aSToomas Soome await more bits to join them in order to fill out a full byte. If pending 722*4a5d661aSToomas Soome or bits are Z_NULL, then those values are not set. 723*4a5d661aSToomas Soome 724*4a5d661aSToomas Soome deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source 725*4a5d661aSToomas Soome stream state was inconsistent. 726*4a5d661aSToomas Soome */ 727*4a5d661aSToomas Soome 728*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm, 729*4a5d661aSToomas Soome int bits, 730*4a5d661aSToomas Soome int value)); 731*4a5d661aSToomas Soome /* 732*4a5d661aSToomas Soome deflatePrime() inserts bits in the deflate output stream. The intent 733*4a5d661aSToomas Soome is that this function is used to start off the deflate output with the bits 734*4a5d661aSToomas Soome leftover from a previous deflate stream when appending to it. As such, this 735*4a5d661aSToomas Soome function can only be used for raw deflate, and must be used before the first 736*4a5d661aSToomas Soome deflate() call after a deflateInit2() or deflateReset(). bits must be less 737*4a5d661aSToomas Soome than or equal to 16, and that many of the least significant bits of value 738*4a5d661aSToomas Soome will be inserted in the output. 739*4a5d661aSToomas Soome 740*4a5d661aSToomas Soome deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough 741*4a5d661aSToomas Soome room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the 742*4a5d661aSToomas Soome source stream state was inconsistent. 743*4a5d661aSToomas Soome */ 744*4a5d661aSToomas Soome 745*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm, 746*4a5d661aSToomas Soome gz_headerp head)); 747*4a5d661aSToomas Soome /* 748*4a5d661aSToomas Soome deflateSetHeader() provides gzip header information for when a gzip 749*4a5d661aSToomas Soome stream is requested by deflateInit2(). deflateSetHeader() may be called 750*4a5d661aSToomas Soome after deflateInit2() or deflateReset() and before the first call of 751*4a5d661aSToomas Soome deflate(). The text, time, os, extra field, name, and comment information 752*4a5d661aSToomas Soome in the provided gz_header structure are written to the gzip header (xflag is 753*4a5d661aSToomas Soome ignored -- the extra flags are set according to the compression level). The 754*4a5d661aSToomas Soome caller must assure that, if not Z_NULL, name and comment are terminated with 755*4a5d661aSToomas Soome a zero byte, and that if extra is not Z_NULL, that extra_len bytes are 756*4a5d661aSToomas Soome available there. If hcrc is true, a gzip header crc is included. Note that 757*4a5d661aSToomas Soome the current versions of the command-line version of gzip (up through version 758*4a5d661aSToomas Soome 1.3.x) do not support header crc's, and will report that it is a "multi-part 759*4a5d661aSToomas Soome gzip file" and give up. 760*4a5d661aSToomas Soome 761*4a5d661aSToomas Soome If deflateSetHeader is not used, the default gzip header has text false, 762*4a5d661aSToomas Soome the time set to zero, and os set to 255, with no extra, name, or comment 763*4a5d661aSToomas Soome fields. The gzip header is returned to the default state by deflateReset(). 764*4a5d661aSToomas Soome 765*4a5d661aSToomas Soome deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 766*4a5d661aSToomas Soome stream state was inconsistent. 767*4a5d661aSToomas Soome */ 768*4a5d661aSToomas Soome 769*4a5d661aSToomas Soome /* 770*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm, 771*4a5d661aSToomas Soome int windowBits)); 772*4a5d661aSToomas Soome 773*4a5d661aSToomas Soome This is another version of inflateInit with an extra parameter. The 774*4a5d661aSToomas Soome fields next_in, avail_in, zalloc, zfree and opaque must be initialized 775*4a5d661aSToomas Soome before by the caller. 776*4a5d661aSToomas Soome 777*4a5d661aSToomas Soome The windowBits parameter is the base two logarithm of the maximum window 778*4a5d661aSToomas Soome size (the size of the history buffer). It should be in the range 8..15 for 779*4a5d661aSToomas Soome this version of the library. The default value is 15 if inflateInit is used 780*4a5d661aSToomas Soome instead. windowBits must be greater than or equal to the windowBits value 781*4a5d661aSToomas Soome provided to deflateInit2() while compressing, or it must be equal to 15 if 782*4a5d661aSToomas Soome deflateInit2() was not used. If a compressed stream with a larger window 783*4a5d661aSToomas Soome size is given as input, inflate() will return with the error code 784*4a5d661aSToomas Soome Z_DATA_ERROR instead of trying to allocate a larger window. 785*4a5d661aSToomas Soome 786*4a5d661aSToomas Soome windowBits can also be zero to request that inflate use the window size in 787*4a5d661aSToomas Soome the zlib header of the compressed stream. 788*4a5d661aSToomas Soome 789*4a5d661aSToomas Soome windowBits can also be -8..-15 for raw inflate. In this case, -windowBits 790*4a5d661aSToomas Soome determines the window size. inflate() will then process raw deflate data, 791*4a5d661aSToomas Soome not looking for a zlib or gzip header, not generating a check value, and not 792*4a5d661aSToomas Soome looking for any check values for comparison at the end of the stream. This 793*4a5d661aSToomas Soome is for use with other formats that use the deflate compressed data format 794*4a5d661aSToomas Soome such as zip. Those formats provide their own check values. If a custom 795*4a5d661aSToomas Soome format is developed using the raw deflate format for compressed data, it is 796*4a5d661aSToomas Soome recommended that a check value such as an adler32 or a crc32 be applied to 797*4a5d661aSToomas Soome the uncompressed data as is done in the zlib, gzip, and zip formats. For 798*4a5d661aSToomas Soome most applications, the zlib format should be used as is. Note that comments 799*4a5d661aSToomas Soome above on the use in deflateInit2() applies to the magnitude of windowBits. 800*4a5d661aSToomas Soome 801*4a5d661aSToomas Soome windowBits can also be greater than 15 for optional gzip decoding. Add 802*4a5d661aSToomas Soome 32 to windowBits to enable zlib and gzip decoding with automatic header 803*4a5d661aSToomas Soome detection, or add 16 to decode only the gzip format (the zlib format will 804*4a5d661aSToomas Soome return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a 805*4a5d661aSToomas Soome crc32 instead of an adler32. 806*4a5d661aSToomas Soome 807*4a5d661aSToomas Soome inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 808*4a5d661aSToomas Soome memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 809*4a5d661aSToomas Soome version assumed by the caller, or Z_STREAM_ERROR if the parameters are 810*4a5d661aSToomas Soome invalid, such as a null pointer to the structure. msg is set to null if 811*4a5d661aSToomas Soome there is no error message. inflateInit2 does not perform any decompression 812*4a5d661aSToomas Soome apart from possibly reading the zlib header if present: actual decompression 813*4a5d661aSToomas Soome will be done by inflate(). (So next_in and avail_in may be modified, but 814*4a5d661aSToomas Soome next_out and avail_out are unused and unchanged.) The current implementation 815*4a5d661aSToomas Soome of inflateInit2() does not process any header information -- that is 816*4a5d661aSToomas Soome deferred until inflate() is called. 817*4a5d661aSToomas Soome */ 818*4a5d661aSToomas Soome 819*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm, 820*4a5d661aSToomas Soome const Bytef *dictionary, 821*4a5d661aSToomas Soome uInt dictLength)); 822*4a5d661aSToomas Soome /* 823*4a5d661aSToomas Soome Initializes the decompression dictionary from the given uncompressed byte 824*4a5d661aSToomas Soome sequence. This function must be called immediately after a call of inflate, 825*4a5d661aSToomas Soome if that call returned Z_NEED_DICT. The dictionary chosen by the compressor 826*4a5d661aSToomas Soome can be determined from the adler32 value returned by that call of inflate. 827*4a5d661aSToomas Soome The compressor and decompressor must use exactly the same dictionary (see 828*4a5d661aSToomas Soome deflateSetDictionary). For raw inflate, this function can be called at any 829*4a5d661aSToomas Soome time to set the dictionary. If the provided dictionary is smaller than the 830*4a5d661aSToomas Soome window and there is already data in the window, then the provided dictionary 831*4a5d661aSToomas Soome will amend what's there. The application must insure that the dictionary 832*4a5d661aSToomas Soome that was used for compression is provided. 833*4a5d661aSToomas Soome 834*4a5d661aSToomas Soome inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a 835*4a5d661aSToomas Soome parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 836*4a5d661aSToomas Soome inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the 837*4a5d661aSToomas Soome expected one (incorrect adler32 value). inflateSetDictionary does not 838*4a5d661aSToomas Soome perform any decompression: this will be done by subsequent calls of 839*4a5d661aSToomas Soome inflate(). 840*4a5d661aSToomas Soome */ 841*4a5d661aSToomas Soome 842*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateGetDictionary OF((z_streamp strm, 843*4a5d661aSToomas Soome Bytef *dictionary, 844*4a5d661aSToomas Soome uInt *dictLength)); 845*4a5d661aSToomas Soome /* 846*4a5d661aSToomas Soome Returns the sliding dictionary being maintained by inflate. dictLength is 847*4a5d661aSToomas Soome set to the number of bytes in the dictionary, and that many bytes are copied 848*4a5d661aSToomas Soome to dictionary. dictionary must have enough space, where 32768 bytes is 849*4a5d661aSToomas Soome always enough. If inflateGetDictionary() is called with dictionary equal to 850*4a5d661aSToomas Soome Z_NULL, then only the dictionary length is returned, and nothing is copied. 851*4a5d661aSToomas Soome Similary, if dictLength is Z_NULL, then it is not set. 852*4a5d661aSToomas Soome 853*4a5d661aSToomas Soome inflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the 854*4a5d661aSToomas Soome stream state is inconsistent. 855*4a5d661aSToomas Soome */ 856*4a5d661aSToomas Soome 857*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm)); 858*4a5d661aSToomas Soome /* 859*4a5d661aSToomas Soome Skips invalid compressed data until a possible full flush point (see above 860*4a5d661aSToomas Soome for the description of deflate with Z_FULL_FLUSH) can be found, or until all 861*4a5d661aSToomas Soome available input is skipped. No output is provided. 862*4a5d661aSToomas Soome 863*4a5d661aSToomas Soome inflateSync searches for a 00 00 FF FF pattern in the compressed data. 864*4a5d661aSToomas Soome All full flush points have this pattern, but not all occurrences of this 865*4a5d661aSToomas Soome pattern are full flush points. 866*4a5d661aSToomas Soome 867*4a5d661aSToomas Soome inflateSync returns Z_OK if a possible full flush point has been found, 868*4a5d661aSToomas Soome Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point 869*4a5d661aSToomas Soome has been found, or Z_STREAM_ERROR if the stream structure was inconsistent. 870*4a5d661aSToomas Soome In the success case, the application may save the current current value of 871*4a5d661aSToomas Soome total_in which indicates where valid compressed data was found. In the 872*4a5d661aSToomas Soome error case, the application may repeatedly call inflateSync, providing more 873*4a5d661aSToomas Soome input each time, until success or end of the input data. 874*4a5d661aSToomas Soome */ 875*4a5d661aSToomas Soome 876*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest, 877*4a5d661aSToomas Soome z_streamp source)); 878*4a5d661aSToomas Soome /* 879*4a5d661aSToomas Soome Sets the destination stream as a complete copy of the source stream. 880*4a5d661aSToomas Soome 881*4a5d661aSToomas Soome This function can be useful when randomly accessing a large stream. The 882*4a5d661aSToomas Soome first pass through the stream can periodically record the inflate state, 883*4a5d661aSToomas Soome allowing restarting inflate at those points when randomly accessing the 884*4a5d661aSToomas Soome stream. 885*4a5d661aSToomas Soome 886*4a5d661aSToomas Soome inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 887*4a5d661aSToomas Soome enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 888*4a5d661aSToomas Soome (such as zalloc being Z_NULL). msg is left unchanged in both source and 889*4a5d661aSToomas Soome destination. 890*4a5d661aSToomas Soome */ 891*4a5d661aSToomas Soome 892*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm)); 893*4a5d661aSToomas Soome /* 894*4a5d661aSToomas Soome This function is equivalent to inflateEnd followed by inflateInit, 895*4a5d661aSToomas Soome but does not free and reallocate all the internal decompression state. The 896*4a5d661aSToomas Soome stream will keep attributes that may have been set by inflateInit2. 897*4a5d661aSToomas Soome 898*4a5d661aSToomas Soome inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 899*4a5d661aSToomas Soome stream state was inconsistent (such as zalloc or state being Z_NULL). 900*4a5d661aSToomas Soome */ 901*4a5d661aSToomas Soome 902*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm, 903*4a5d661aSToomas Soome int windowBits)); 904*4a5d661aSToomas Soome /* 905*4a5d661aSToomas Soome This function is the same as inflateReset, but it also permits changing 906*4a5d661aSToomas Soome the wrap and window size requests. The windowBits parameter is interpreted 907*4a5d661aSToomas Soome the same as it is for inflateInit2. 908*4a5d661aSToomas Soome 909*4a5d661aSToomas Soome inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source 910*4a5d661aSToomas Soome stream state was inconsistent (such as zalloc or state being Z_NULL), or if 911*4a5d661aSToomas Soome the windowBits parameter is invalid. 912*4a5d661aSToomas Soome */ 913*4a5d661aSToomas Soome 914*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm, 915*4a5d661aSToomas Soome int bits, 916*4a5d661aSToomas Soome int value)); 917*4a5d661aSToomas Soome /* 918*4a5d661aSToomas Soome This function inserts bits in the inflate input stream. The intent is 919*4a5d661aSToomas Soome that this function is used to start inflating at a bit position in the 920*4a5d661aSToomas Soome middle of a byte. The provided bits will be used before any bytes are used 921*4a5d661aSToomas Soome from next_in. This function should only be used with raw inflate, and 922*4a5d661aSToomas Soome should be used before the first inflate() call after inflateInit2() or 923*4a5d661aSToomas Soome inflateReset(). bits must be less than or equal to 16, and that many of the 924*4a5d661aSToomas Soome least significant bits of value will be inserted in the input. 925*4a5d661aSToomas Soome 926*4a5d661aSToomas Soome If bits is negative, then the input stream bit buffer is emptied. Then 927*4a5d661aSToomas Soome inflatePrime() can be called again to put bits in the buffer. This is used 928*4a5d661aSToomas Soome to clear out bits leftover after feeding inflate a block description prior 929*4a5d661aSToomas Soome to feeding inflate codes. 930*4a5d661aSToomas Soome 931*4a5d661aSToomas Soome inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source 932*4a5d661aSToomas Soome stream state was inconsistent. 933*4a5d661aSToomas Soome */ 934*4a5d661aSToomas Soome 935*4a5d661aSToomas Soome ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm)); 936*4a5d661aSToomas Soome /* 937*4a5d661aSToomas Soome This function returns two values, one in the lower 16 bits of the return 938*4a5d661aSToomas Soome value, and the other in the remaining upper bits, obtained by shifting the 939*4a5d661aSToomas Soome return value down 16 bits. If the upper value is -1 and the lower value is 940*4a5d661aSToomas Soome zero, then inflate() is currently decoding information outside of a block. 941*4a5d661aSToomas Soome If the upper value is -1 and the lower value is non-zero, then inflate is in 942*4a5d661aSToomas Soome the middle of a stored block, with the lower value equaling the number of 943*4a5d661aSToomas Soome bytes from the input remaining to copy. If the upper value is not -1, then 944*4a5d661aSToomas Soome it is the number of bits back from the current bit position in the input of 945*4a5d661aSToomas Soome the code (literal or length/distance pair) currently being processed. In 946*4a5d661aSToomas Soome that case the lower value is the number of bytes already emitted for that 947*4a5d661aSToomas Soome code. 948*4a5d661aSToomas Soome 949*4a5d661aSToomas Soome A code is being processed if inflate is waiting for more input to complete 950*4a5d661aSToomas Soome decoding of the code, or if it has completed decoding but is waiting for 951*4a5d661aSToomas Soome more output space to write the literal or match data. 952*4a5d661aSToomas Soome 953*4a5d661aSToomas Soome inflateMark() is used to mark locations in the input data for random 954*4a5d661aSToomas Soome access, which may be at bit positions, and to note those cases where the 955*4a5d661aSToomas Soome output of a code may span boundaries of random access blocks. The current 956*4a5d661aSToomas Soome location in the input stream can be determined from avail_in and data_type 957*4a5d661aSToomas Soome as noted in the description for the Z_BLOCK flush parameter for inflate. 958*4a5d661aSToomas Soome 959*4a5d661aSToomas Soome inflateMark returns the value noted above or -1 << 16 if the provided 960*4a5d661aSToomas Soome source stream state was inconsistent. 961*4a5d661aSToomas Soome */ 962*4a5d661aSToomas Soome 963*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm, 964*4a5d661aSToomas Soome gz_headerp head)); 965*4a5d661aSToomas Soome /* 966*4a5d661aSToomas Soome inflateGetHeader() requests that gzip header information be stored in the 967*4a5d661aSToomas Soome provided gz_header structure. inflateGetHeader() may be called after 968*4a5d661aSToomas Soome inflateInit2() or inflateReset(), and before the first call of inflate(). 969*4a5d661aSToomas Soome As inflate() processes the gzip stream, head->done is zero until the header 970*4a5d661aSToomas Soome is completed, at which time head->done is set to one. If a zlib stream is 971*4a5d661aSToomas Soome being decoded, then head->done is set to -1 to indicate that there will be 972*4a5d661aSToomas Soome no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be 973*4a5d661aSToomas Soome used to force inflate() to return immediately after header processing is 974*4a5d661aSToomas Soome complete and before any actual data is decompressed. 975*4a5d661aSToomas Soome 976*4a5d661aSToomas Soome The text, time, xflags, and os fields are filled in with the gzip header 977*4a5d661aSToomas Soome contents. hcrc is set to true if there is a header CRC. (The header CRC 978*4a5d661aSToomas Soome was valid if done is set to one.) If extra is not Z_NULL, then extra_max 979*4a5d661aSToomas Soome contains the maximum number of bytes to write to extra. Once done is true, 980*4a5d661aSToomas Soome extra_len contains the actual extra field length, and extra contains the 981*4a5d661aSToomas Soome extra field, or that field truncated if extra_max is less than extra_len. 982*4a5d661aSToomas Soome If name is not Z_NULL, then up to name_max characters are written there, 983*4a5d661aSToomas Soome terminated with a zero unless the length is greater than name_max. If 984*4a5d661aSToomas Soome comment is not Z_NULL, then up to comm_max characters are written there, 985*4a5d661aSToomas Soome terminated with a zero unless the length is greater than comm_max. When any 986*4a5d661aSToomas Soome of extra, name, or comment are not Z_NULL and the respective field is not 987*4a5d661aSToomas Soome present in the header, then that field is set to Z_NULL to signal its 988*4a5d661aSToomas Soome absence. This allows the use of deflateSetHeader() with the returned 989*4a5d661aSToomas Soome structure to duplicate the header. However if those fields are set to 990*4a5d661aSToomas Soome allocated memory, then the application will need to save those pointers 991*4a5d661aSToomas Soome elsewhere so that they can be eventually freed. 992*4a5d661aSToomas Soome 993*4a5d661aSToomas Soome If inflateGetHeader is not used, then the header information is simply 994*4a5d661aSToomas Soome discarded. The header is always checked for validity, including the header 995*4a5d661aSToomas Soome CRC if present. inflateReset() will reset the process to discard the header 996*4a5d661aSToomas Soome information. The application would need to call inflateGetHeader() again to 997*4a5d661aSToomas Soome retrieve the header from the next gzip stream. 998*4a5d661aSToomas Soome 999*4a5d661aSToomas Soome inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 1000*4a5d661aSToomas Soome stream state was inconsistent. 1001*4a5d661aSToomas Soome */ 1002*4a5d661aSToomas Soome 1003*4a5d661aSToomas Soome /* 1004*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits, 1005*4a5d661aSToomas Soome unsigned char FAR *window)); 1006*4a5d661aSToomas Soome 1007*4a5d661aSToomas Soome Initialize the internal stream state for decompression using inflateBack() 1008*4a5d661aSToomas Soome calls. The fields zalloc, zfree and opaque in strm must be initialized 1009*4a5d661aSToomas Soome before the call. If zalloc and zfree are Z_NULL, then the default library- 1010*4a5d661aSToomas Soome derived memory allocation routines are used. windowBits is the base two 1011*4a5d661aSToomas Soome logarithm of the window size, in the range 8..15. window is a caller 1012*4a5d661aSToomas Soome supplied buffer of that size. Except for special applications where it is 1013*4a5d661aSToomas Soome assured that deflate was used with small window sizes, windowBits must be 15 1014*4a5d661aSToomas Soome and a 32K byte window must be supplied to be able to decompress general 1015*4a5d661aSToomas Soome deflate streams. 1016*4a5d661aSToomas Soome 1017*4a5d661aSToomas Soome See inflateBack() for the usage of these routines. 1018*4a5d661aSToomas Soome 1019*4a5d661aSToomas Soome inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of 1020*4a5d661aSToomas Soome the parameters are invalid, Z_MEM_ERROR if the internal state could not be 1021*4a5d661aSToomas Soome allocated, or Z_VERSION_ERROR if the version of the library does not match 1022*4a5d661aSToomas Soome the version of the header file. 1023*4a5d661aSToomas Soome */ 1024*4a5d661aSToomas Soome 1025*4a5d661aSToomas Soome typedef unsigned (*in_func) OF((void FAR *, 1026*4a5d661aSToomas Soome z_const unsigned char FAR * FAR *)); 1027*4a5d661aSToomas Soome typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned)); 1028*4a5d661aSToomas Soome 1029*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm, 1030*4a5d661aSToomas Soome in_func in, void FAR *in_desc, 1031*4a5d661aSToomas Soome out_func out, void FAR *out_desc)); 1032*4a5d661aSToomas Soome /* 1033*4a5d661aSToomas Soome inflateBack() does a raw inflate with a single call using a call-back 1034*4a5d661aSToomas Soome interface for input and output. This is potentially more efficient than 1035*4a5d661aSToomas Soome inflate() for file i/o applications, in that it avoids copying between the 1036*4a5d661aSToomas Soome output and the sliding window by simply making the window itself the output 1037*4a5d661aSToomas Soome buffer. inflate() can be faster on modern CPUs when used with large 1038*4a5d661aSToomas Soome buffers. inflateBack() trusts the application to not change the output 1039*4a5d661aSToomas Soome buffer passed by the output function, at least until inflateBack() returns. 1040*4a5d661aSToomas Soome 1041*4a5d661aSToomas Soome inflateBackInit() must be called first to allocate the internal state 1042*4a5d661aSToomas Soome and to initialize the state with the user-provided window buffer. 1043*4a5d661aSToomas Soome inflateBack() may then be used multiple times to inflate a complete, raw 1044*4a5d661aSToomas Soome deflate stream with each call. inflateBackEnd() is then called to free the 1045*4a5d661aSToomas Soome allocated state. 1046*4a5d661aSToomas Soome 1047*4a5d661aSToomas Soome A raw deflate stream is one with no zlib or gzip header or trailer. 1048*4a5d661aSToomas Soome This routine would normally be used in a utility that reads zip or gzip 1049*4a5d661aSToomas Soome files and writes out uncompressed files. The utility would decode the 1050*4a5d661aSToomas Soome header and process the trailer on its own, hence this routine expects only 1051*4a5d661aSToomas Soome the raw deflate stream to decompress. This is different from the normal 1052*4a5d661aSToomas Soome behavior of inflate(), which expects either a zlib or gzip header and 1053*4a5d661aSToomas Soome trailer around the deflate stream. 1054*4a5d661aSToomas Soome 1055*4a5d661aSToomas Soome inflateBack() uses two subroutines supplied by the caller that are then 1056*4a5d661aSToomas Soome called by inflateBack() for input and output. inflateBack() calls those 1057*4a5d661aSToomas Soome routines until it reads a complete deflate stream and writes out all of the 1058*4a5d661aSToomas Soome uncompressed data, or until it encounters an error. The function's 1059*4a5d661aSToomas Soome parameters and return types are defined above in the in_func and out_func 1060*4a5d661aSToomas Soome typedefs. inflateBack() will call in(in_desc, &buf) which should return the 1061*4a5d661aSToomas Soome number of bytes of provided input, and a pointer to that input in buf. If 1062*4a5d661aSToomas Soome there is no input available, in() must return zero--buf is ignored in that 1063*4a5d661aSToomas Soome case--and inflateBack() will return a buffer error. inflateBack() will call 1064*4a5d661aSToomas Soome out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out() 1065*4a5d661aSToomas Soome should return zero on success, or non-zero on failure. If out() returns 1066*4a5d661aSToomas Soome non-zero, inflateBack() will return with an error. Neither in() nor out() 1067*4a5d661aSToomas Soome are permitted to change the contents of the window provided to 1068*4a5d661aSToomas Soome inflateBackInit(), which is also the buffer that out() uses to write from. 1069*4a5d661aSToomas Soome The length written by out() will be at most the window size. Any non-zero 1070*4a5d661aSToomas Soome amount of input may be provided by in(). 1071*4a5d661aSToomas Soome 1072*4a5d661aSToomas Soome For convenience, inflateBack() can be provided input on the first call by 1073*4a5d661aSToomas Soome setting strm->next_in and strm->avail_in. If that input is exhausted, then 1074*4a5d661aSToomas Soome in() will be called. Therefore strm->next_in must be initialized before 1075*4a5d661aSToomas Soome calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called 1076*4a5d661aSToomas Soome immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in 1077*4a5d661aSToomas Soome must also be initialized, and then if strm->avail_in is not zero, input will 1078*4a5d661aSToomas Soome initially be taken from strm->next_in[0 .. strm->avail_in - 1]. 1079*4a5d661aSToomas Soome 1080*4a5d661aSToomas Soome The in_desc and out_desc parameters of inflateBack() is passed as the 1081*4a5d661aSToomas Soome first parameter of in() and out() respectively when they are called. These 1082*4a5d661aSToomas Soome descriptors can be optionally used to pass any information that the caller- 1083*4a5d661aSToomas Soome supplied in() and out() functions need to do their job. 1084*4a5d661aSToomas Soome 1085*4a5d661aSToomas Soome On return, inflateBack() will set strm->next_in and strm->avail_in to 1086*4a5d661aSToomas Soome pass back any unused input that was provided by the last in() call. The 1087*4a5d661aSToomas Soome return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR 1088*4a5d661aSToomas Soome if in() or out() returned an error, Z_DATA_ERROR if there was a format error 1089*4a5d661aSToomas Soome in the deflate stream (in which case strm->msg is set to indicate the nature 1090*4a5d661aSToomas Soome of the error), or Z_STREAM_ERROR if the stream was not properly initialized. 1091*4a5d661aSToomas Soome In the case of Z_BUF_ERROR, an input or output error can be distinguished 1092*4a5d661aSToomas Soome using strm->next_in which will be Z_NULL only if in() returned an error. If 1093*4a5d661aSToomas Soome strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning 1094*4a5d661aSToomas Soome non-zero. (in() will always be called before out(), so strm->next_in is 1095*4a5d661aSToomas Soome assured to be defined if out() returns non-zero.) Note that inflateBack() 1096*4a5d661aSToomas Soome cannot return Z_OK. 1097*4a5d661aSToomas Soome */ 1098*4a5d661aSToomas Soome 1099*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm)); 1100*4a5d661aSToomas Soome /* 1101*4a5d661aSToomas Soome All memory allocated by inflateBackInit() is freed. 1102*4a5d661aSToomas Soome 1103*4a5d661aSToomas Soome inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream 1104*4a5d661aSToomas Soome state was inconsistent. 1105*4a5d661aSToomas Soome */ 1106*4a5d661aSToomas Soome 1107*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void)); 1108*4a5d661aSToomas Soome /* Return flags indicating compile-time options. 1109*4a5d661aSToomas Soome 1110*4a5d661aSToomas Soome Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other: 1111*4a5d661aSToomas Soome 1.0: size of uInt 1112*4a5d661aSToomas Soome 3.2: size of uLong 1113*4a5d661aSToomas Soome 5.4: size of voidpf (pointer) 1114*4a5d661aSToomas Soome 7.6: size of z_off_t 1115*4a5d661aSToomas Soome 1116*4a5d661aSToomas Soome Compiler, assembler, and debug options: 1117*4a5d661aSToomas Soome 8: DEBUG 1118*4a5d661aSToomas Soome 9: ASMV or ASMINF -- use ASM code 1119*4a5d661aSToomas Soome 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention 1120*4a5d661aSToomas Soome 11: 0 (reserved) 1121*4a5d661aSToomas Soome 1122*4a5d661aSToomas Soome One-time table building (smaller code, but not thread-safe if true): 1123*4a5d661aSToomas Soome 12: BUILDFIXED -- build static block decoding tables when needed 1124*4a5d661aSToomas Soome 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed 1125*4a5d661aSToomas Soome 14,15: 0 (reserved) 1126*4a5d661aSToomas Soome 1127*4a5d661aSToomas Soome Library content (indicates missing functionality): 1128*4a5d661aSToomas Soome 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking 1129*4a5d661aSToomas Soome deflate code when not needed) 1130*4a5d661aSToomas Soome 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect 1131*4a5d661aSToomas Soome and decode gzip streams (to avoid linking crc code) 1132*4a5d661aSToomas Soome 18-19: 0 (reserved) 1133*4a5d661aSToomas Soome 1134*4a5d661aSToomas Soome Operation variations (changes in library functionality): 1135*4a5d661aSToomas Soome 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate 1136*4a5d661aSToomas Soome 21: FASTEST -- deflate algorithm with only one, lowest compression level 1137*4a5d661aSToomas Soome 22,23: 0 (reserved) 1138*4a5d661aSToomas Soome 1139*4a5d661aSToomas Soome The sprintf variant used by gzprintf (zero is best): 1140*4a5d661aSToomas Soome 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format 1141*4a5d661aSToomas Soome 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure! 1142*4a5d661aSToomas Soome 26: 0 = returns value, 1 = void -- 1 means inferred string length returned 1143*4a5d661aSToomas Soome 1144*4a5d661aSToomas Soome Remainder: 1145*4a5d661aSToomas Soome 27-31: 0 (reserved) 1146*4a5d661aSToomas Soome */ 1147*4a5d661aSToomas Soome 1148*4a5d661aSToomas Soome #ifndef Z_SOLO 1149*4a5d661aSToomas Soome 1150*4a5d661aSToomas Soome /* utility functions */ 1151*4a5d661aSToomas Soome 1152*4a5d661aSToomas Soome /* 1153*4a5d661aSToomas Soome The following utility functions are implemented on top of the basic 1154*4a5d661aSToomas Soome stream-oriented functions. To simplify the interface, some default options 1155*4a5d661aSToomas Soome are assumed (compression level and memory usage, standard memory allocation 1156*4a5d661aSToomas Soome functions). The source code of these utility functions can be modified if 1157*4a5d661aSToomas Soome you need special options. 1158*4a5d661aSToomas Soome */ 1159*4a5d661aSToomas Soome 1160*4a5d661aSToomas Soome ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen, 1161*4a5d661aSToomas Soome const Bytef *source, uLong sourceLen)); 1162*4a5d661aSToomas Soome /* 1163*4a5d661aSToomas Soome Compresses the source buffer into the destination buffer. sourceLen is 1164*4a5d661aSToomas Soome the byte length of the source buffer. Upon entry, destLen is the total size 1165*4a5d661aSToomas Soome of the destination buffer, which must be at least the value returned by 1166*4a5d661aSToomas Soome compressBound(sourceLen). Upon exit, destLen is the actual size of the 1167*4a5d661aSToomas Soome compressed buffer. 1168*4a5d661aSToomas Soome 1169*4a5d661aSToomas Soome compress returns Z_OK if success, Z_MEM_ERROR if there was not 1170*4a5d661aSToomas Soome enough memory, Z_BUF_ERROR if there was not enough room in the output 1171*4a5d661aSToomas Soome buffer. 1172*4a5d661aSToomas Soome */ 1173*4a5d661aSToomas Soome 1174*4a5d661aSToomas Soome ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, 1175*4a5d661aSToomas Soome const Bytef *source, uLong sourceLen, 1176*4a5d661aSToomas Soome int level)); 1177*4a5d661aSToomas Soome /* 1178*4a5d661aSToomas Soome Compresses the source buffer into the destination buffer. The level 1179*4a5d661aSToomas Soome parameter has the same meaning as in deflateInit. sourceLen is the byte 1180*4a5d661aSToomas Soome length of the source buffer. Upon entry, destLen is the total size of the 1181*4a5d661aSToomas Soome destination buffer, which must be at least the value returned by 1182*4a5d661aSToomas Soome compressBound(sourceLen). Upon exit, destLen is the actual size of the 1183*4a5d661aSToomas Soome compressed buffer. 1184*4a5d661aSToomas Soome 1185*4a5d661aSToomas Soome compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 1186*4a5d661aSToomas Soome memory, Z_BUF_ERROR if there was not enough room in the output buffer, 1187*4a5d661aSToomas Soome Z_STREAM_ERROR if the level parameter is invalid. 1188*4a5d661aSToomas Soome */ 1189*4a5d661aSToomas Soome 1190*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen)); 1191*4a5d661aSToomas Soome /* 1192*4a5d661aSToomas Soome compressBound() returns an upper bound on the compressed size after 1193*4a5d661aSToomas Soome compress() or compress2() on sourceLen bytes. It would be used before a 1194*4a5d661aSToomas Soome compress() or compress2() call to allocate the destination buffer. 1195*4a5d661aSToomas Soome */ 1196*4a5d661aSToomas Soome 1197*4a5d661aSToomas Soome ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, 1198*4a5d661aSToomas Soome const Bytef *source, uLong sourceLen)); 1199*4a5d661aSToomas Soome /* 1200*4a5d661aSToomas Soome Decompresses the source buffer into the destination buffer. sourceLen is 1201*4a5d661aSToomas Soome the byte length of the source buffer. Upon entry, destLen is the total size 1202*4a5d661aSToomas Soome of the destination buffer, which must be large enough to hold the entire 1203*4a5d661aSToomas Soome uncompressed data. (The size of the uncompressed data must have been saved 1204*4a5d661aSToomas Soome previously by the compressor and transmitted to the decompressor by some 1205*4a5d661aSToomas Soome mechanism outside the scope of this compression library.) Upon exit, destLen 1206*4a5d661aSToomas Soome is the actual size of the uncompressed buffer. 1207*4a5d661aSToomas Soome 1208*4a5d661aSToomas Soome uncompress returns Z_OK if success, Z_MEM_ERROR if there was not 1209*4a5d661aSToomas Soome enough memory, Z_BUF_ERROR if there was not enough room in the output 1210*4a5d661aSToomas Soome buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In 1211*4a5d661aSToomas Soome the case where there is not enough room, uncompress() will fill the output 1212*4a5d661aSToomas Soome buffer with the uncompressed data up to that point. 1213*4a5d661aSToomas Soome */ 1214*4a5d661aSToomas Soome 1215*4a5d661aSToomas Soome /* gzip file access functions */ 1216*4a5d661aSToomas Soome 1217*4a5d661aSToomas Soome /* 1218*4a5d661aSToomas Soome This library supports reading and writing files in gzip (.gz) format with 1219*4a5d661aSToomas Soome an interface similar to that of stdio, using the functions that start with 1220*4a5d661aSToomas Soome "gz". The gzip format is different from the zlib format. gzip is a gzip 1221*4a5d661aSToomas Soome wrapper, documented in RFC 1952, wrapped around a deflate stream. 1222*4a5d661aSToomas Soome */ 1223*4a5d661aSToomas Soome 1224*4a5d661aSToomas Soome typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */ 1225*4a5d661aSToomas Soome 1226*4a5d661aSToomas Soome /* 1227*4a5d661aSToomas Soome ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode)); 1228*4a5d661aSToomas Soome 1229*4a5d661aSToomas Soome Opens a gzip (.gz) file for reading or writing. The mode parameter is as 1230*4a5d661aSToomas Soome in fopen ("rb" or "wb") but can also include a compression level ("wb9") or 1231*4a5d661aSToomas Soome a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only 1232*4a5d661aSToomas Soome compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F' 1233*4a5d661aSToomas Soome for fixed code compression as in "wb9F". (See the description of 1234*4a5d661aSToomas Soome deflateInit2 for more information about the strategy parameter.) 'T' will 1235*4a5d661aSToomas Soome request transparent writing or appending with no compression and not using 1236*4a5d661aSToomas Soome the gzip format. 1237*4a5d661aSToomas Soome 1238*4a5d661aSToomas Soome "a" can be used instead of "w" to request that the gzip stream that will 1239*4a5d661aSToomas Soome be written be appended to the file. "+" will result in an error, since 1240*4a5d661aSToomas Soome reading and writing to the same gzip file is not supported. The addition of 1241*4a5d661aSToomas Soome "x" when writing will create the file exclusively, which fails if the file 1242*4a5d661aSToomas Soome already exists. On systems that support it, the addition of "e" when 1243*4a5d661aSToomas Soome reading or writing will set the flag to close the file on an execve() call. 1244*4a5d661aSToomas Soome 1245*4a5d661aSToomas Soome These functions, as well as gzip, will read and decode a sequence of gzip 1246*4a5d661aSToomas Soome streams in a file. The append function of gzopen() can be used to create 1247*4a5d661aSToomas Soome such a file. (Also see gzflush() for another way to do this.) When 1248*4a5d661aSToomas Soome appending, gzopen does not test whether the file begins with a gzip stream, 1249*4a5d661aSToomas Soome nor does it look for the end of the gzip streams to begin appending. gzopen 1250*4a5d661aSToomas Soome will simply append a gzip stream to the existing file. 1251*4a5d661aSToomas Soome 1252*4a5d661aSToomas Soome gzopen can be used to read a file which is not in gzip format; in this 1253*4a5d661aSToomas Soome case gzread will directly read from the file without decompression. When 1254*4a5d661aSToomas Soome reading, this will be detected automatically by looking for the magic two- 1255*4a5d661aSToomas Soome byte gzip header. 1256*4a5d661aSToomas Soome 1257*4a5d661aSToomas Soome gzopen returns NULL if the file could not be opened, if there was 1258*4a5d661aSToomas Soome insufficient memory to allocate the gzFile state, or if an invalid mode was 1259*4a5d661aSToomas Soome specified (an 'r', 'w', or 'a' was not provided, or '+' was provided). 1260*4a5d661aSToomas Soome errno can be checked to determine if the reason gzopen failed was that the 1261*4a5d661aSToomas Soome file could not be opened. 1262*4a5d661aSToomas Soome */ 1263*4a5d661aSToomas Soome 1264*4a5d661aSToomas Soome ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode)); 1265*4a5d661aSToomas Soome /* 1266*4a5d661aSToomas Soome gzdopen associates a gzFile with the file descriptor fd. File descriptors 1267*4a5d661aSToomas Soome are obtained from calls like open, dup, creat, pipe or fileno (if the file 1268*4a5d661aSToomas Soome has been previously opened with fopen). The mode parameter is as in gzopen. 1269*4a5d661aSToomas Soome 1270*4a5d661aSToomas Soome The next call of gzclose on the returned gzFile will also close the file 1271*4a5d661aSToomas Soome descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor 1272*4a5d661aSToomas Soome fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd, 1273*4a5d661aSToomas Soome mode);. The duplicated descriptor should be saved to avoid a leak, since 1274*4a5d661aSToomas Soome gzdopen does not close fd if it fails. If you are using fileno() to get the 1275*4a5d661aSToomas Soome file descriptor from a FILE *, then you will have to use dup() to avoid 1276*4a5d661aSToomas Soome double-close()ing the file descriptor. Both gzclose() and fclose() will 1277*4a5d661aSToomas Soome close the associated file descriptor, so they need to have different file 1278*4a5d661aSToomas Soome descriptors. 1279*4a5d661aSToomas Soome 1280*4a5d661aSToomas Soome gzdopen returns NULL if there was insufficient memory to allocate the 1281*4a5d661aSToomas Soome gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not 1282*4a5d661aSToomas Soome provided, or '+' was provided), or if fd is -1. The file descriptor is not 1283*4a5d661aSToomas Soome used until the next gz* read, write, seek, or close operation, so gzdopen 1284*4a5d661aSToomas Soome will not detect if fd is invalid (unless fd is -1). 1285*4a5d661aSToomas Soome */ 1286*4a5d661aSToomas Soome 1287*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size)); 1288*4a5d661aSToomas Soome /* 1289*4a5d661aSToomas Soome Set the internal buffer size used by this library's functions. The 1290*4a5d661aSToomas Soome default buffer size is 8192 bytes. This function must be called after 1291*4a5d661aSToomas Soome gzopen() or gzdopen(), and before any other calls that read or write the 1292*4a5d661aSToomas Soome file. The buffer memory allocation is always deferred to the first read or 1293*4a5d661aSToomas Soome write. Two buffers are allocated, either both of the specified size when 1294*4a5d661aSToomas Soome writing, or one of the specified size and the other twice that size when 1295*4a5d661aSToomas Soome reading. A larger buffer size of, for example, 64K or 128K bytes will 1296*4a5d661aSToomas Soome noticeably increase the speed of decompression (reading). 1297*4a5d661aSToomas Soome 1298*4a5d661aSToomas Soome The new buffer size also affects the maximum length for gzprintf(). 1299*4a5d661aSToomas Soome 1300*4a5d661aSToomas Soome gzbuffer() returns 0 on success, or -1 on failure, such as being called 1301*4a5d661aSToomas Soome too late. 1302*4a5d661aSToomas Soome */ 1303*4a5d661aSToomas Soome 1304*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy)); 1305*4a5d661aSToomas Soome /* 1306*4a5d661aSToomas Soome Dynamically update the compression level or strategy. See the description 1307*4a5d661aSToomas Soome of deflateInit2 for the meaning of these parameters. 1308*4a5d661aSToomas Soome 1309*4a5d661aSToomas Soome gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not 1310*4a5d661aSToomas Soome opened for writing. 1311*4a5d661aSToomas Soome */ 1312*4a5d661aSToomas Soome 1313*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len)); 1314*4a5d661aSToomas Soome /* 1315*4a5d661aSToomas Soome Reads the given number of uncompressed bytes from the compressed file. If 1316*4a5d661aSToomas Soome the input file is not in gzip format, gzread copies the given number of 1317*4a5d661aSToomas Soome bytes into the buffer directly from the file. 1318*4a5d661aSToomas Soome 1319*4a5d661aSToomas Soome After reaching the end of a gzip stream in the input, gzread will continue 1320*4a5d661aSToomas Soome to read, looking for another gzip stream. Any number of gzip streams may be 1321*4a5d661aSToomas Soome concatenated in the input file, and will all be decompressed by gzread(). 1322*4a5d661aSToomas Soome If something other than a gzip stream is encountered after a gzip stream, 1323*4a5d661aSToomas Soome that remaining trailing garbage is ignored (and no error is returned). 1324*4a5d661aSToomas Soome 1325*4a5d661aSToomas Soome gzread can be used to read a gzip file that is being concurrently written. 1326*4a5d661aSToomas Soome Upon reaching the end of the input, gzread will return with the available 1327*4a5d661aSToomas Soome data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then 1328*4a5d661aSToomas Soome gzclearerr can be used to clear the end of file indicator in order to permit 1329*4a5d661aSToomas Soome gzread to be tried again. Z_OK indicates that a gzip stream was completed 1330*4a5d661aSToomas Soome on the last gzread. Z_BUF_ERROR indicates that the input file ended in the 1331*4a5d661aSToomas Soome middle of a gzip stream. Note that gzread does not return -1 in the event 1332*4a5d661aSToomas Soome of an incomplete gzip stream. This error is deferred until gzclose(), which 1333*4a5d661aSToomas Soome will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip 1334*4a5d661aSToomas Soome stream. Alternatively, gzerror can be used before gzclose to detect this 1335*4a5d661aSToomas Soome case. 1336*4a5d661aSToomas Soome 1337*4a5d661aSToomas Soome gzread returns the number of uncompressed bytes actually read, less than 1338*4a5d661aSToomas Soome len for end of file, or -1 for error. 1339*4a5d661aSToomas Soome */ 1340*4a5d661aSToomas Soome 1341*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzwrite OF((gzFile file, 1342*4a5d661aSToomas Soome voidpc buf, unsigned len)); 1343*4a5d661aSToomas Soome /* 1344*4a5d661aSToomas Soome Writes the given number of uncompressed bytes into the compressed file. 1345*4a5d661aSToomas Soome gzwrite returns the number of uncompressed bytes written or 0 in case of 1346*4a5d661aSToomas Soome error. 1347*4a5d661aSToomas Soome */ 1348*4a5d661aSToomas Soome 1349*4a5d661aSToomas Soome ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...)); 1350*4a5d661aSToomas Soome /* 1351*4a5d661aSToomas Soome Converts, formats, and writes the arguments to the compressed file under 1352*4a5d661aSToomas Soome control of the format string, as in fprintf. gzprintf returns the number of 1353*4a5d661aSToomas Soome uncompressed bytes actually written, or 0 in case of error. The number of 1354*4a5d661aSToomas Soome uncompressed bytes written is limited to 8191, or one less than the buffer 1355*4a5d661aSToomas Soome size given to gzbuffer(). The caller should assure that this limit is not 1356*4a5d661aSToomas Soome exceeded. If it is exceeded, then gzprintf() will return an error (0) with 1357*4a5d661aSToomas Soome nothing written. In this case, there may also be a buffer overflow with 1358*4a5d661aSToomas Soome unpredictable consequences, which is possible only if zlib was compiled with 1359*4a5d661aSToomas Soome the insecure functions sprintf() or vsprintf() because the secure snprintf() 1360*4a5d661aSToomas Soome or vsnprintf() functions were not available. This can be determined using 1361*4a5d661aSToomas Soome zlibCompileFlags(). 1362*4a5d661aSToomas Soome */ 1363*4a5d661aSToomas Soome 1364*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s)); 1365*4a5d661aSToomas Soome /* 1366*4a5d661aSToomas Soome Writes the given null-terminated string to the compressed file, excluding 1367*4a5d661aSToomas Soome the terminating null character. 1368*4a5d661aSToomas Soome 1369*4a5d661aSToomas Soome gzputs returns the number of characters written, or -1 in case of error. 1370*4a5d661aSToomas Soome */ 1371*4a5d661aSToomas Soome 1372*4a5d661aSToomas Soome ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len)); 1373*4a5d661aSToomas Soome /* 1374*4a5d661aSToomas Soome Reads bytes from the compressed file until len-1 characters are read, or a 1375*4a5d661aSToomas Soome newline character is read and transferred to buf, or an end-of-file 1376*4a5d661aSToomas Soome condition is encountered. If any characters are read or if len == 1, the 1377*4a5d661aSToomas Soome string is terminated with a null character. If no characters are read due 1378*4a5d661aSToomas Soome to an end-of-file or len < 1, then the buffer is left untouched. 1379*4a5d661aSToomas Soome 1380*4a5d661aSToomas Soome gzgets returns buf which is a null-terminated string, or it returns NULL 1381*4a5d661aSToomas Soome for end-of-file or in case of error. If there was an error, the contents at 1382*4a5d661aSToomas Soome buf are indeterminate. 1383*4a5d661aSToomas Soome */ 1384*4a5d661aSToomas Soome 1385*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c)); 1386*4a5d661aSToomas Soome /* 1387*4a5d661aSToomas Soome Writes c, converted to an unsigned char, into the compressed file. gzputc 1388*4a5d661aSToomas Soome returns the value that was written, or -1 in case of error. 1389*4a5d661aSToomas Soome */ 1390*4a5d661aSToomas Soome 1391*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzgetc OF((gzFile file)); 1392*4a5d661aSToomas Soome /* 1393*4a5d661aSToomas Soome Reads one byte from the compressed file. gzgetc returns this byte or -1 1394*4a5d661aSToomas Soome in case of end of file or error. This is implemented as a macro for speed. 1395*4a5d661aSToomas Soome As such, it does not do all of the checking the other functions do. I.e. 1396*4a5d661aSToomas Soome it does not check to see if file is NULL, nor whether the structure file 1397*4a5d661aSToomas Soome points to has been clobbered or not. 1398*4a5d661aSToomas Soome */ 1399*4a5d661aSToomas Soome 1400*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file)); 1401*4a5d661aSToomas Soome /* 1402*4a5d661aSToomas Soome Push one character back onto the stream to be read as the first character 1403*4a5d661aSToomas Soome on the next read. At least one character of push-back is allowed. 1404*4a5d661aSToomas Soome gzungetc() returns the character pushed, or -1 on failure. gzungetc() will 1405*4a5d661aSToomas Soome fail if c is -1, and may fail if a character has been pushed but not read 1406*4a5d661aSToomas Soome yet. If gzungetc is used immediately after gzopen or gzdopen, at least the 1407*4a5d661aSToomas Soome output buffer size of pushed characters is allowed. (See gzbuffer above.) 1408*4a5d661aSToomas Soome The pushed character will be discarded if the stream is repositioned with 1409*4a5d661aSToomas Soome gzseek() or gzrewind(). 1410*4a5d661aSToomas Soome */ 1411*4a5d661aSToomas Soome 1412*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush)); 1413*4a5d661aSToomas Soome /* 1414*4a5d661aSToomas Soome Flushes all pending output into the compressed file. The parameter flush 1415*4a5d661aSToomas Soome is as in the deflate() function. The return value is the zlib error number 1416*4a5d661aSToomas Soome (see function gzerror below). gzflush is only permitted when writing. 1417*4a5d661aSToomas Soome 1418*4a5d661aSToomas Soome If the flush parameter is Z_FINISH, the remaining data is written and the 1419*4a5d661aSToomas Soome gzip stream is completed in the output. If gzwrite() is called again, a new 1420*4a5d661aSToomas Soome gzip stream will be started in the output. gzread() is able to read such 1421*4a5d661aSToomas Soome concatented gzip streams. 1422*4a5d661aSToomas Soome 1423*4a5d661aSToomas Soome gzflush should be called only when strictly necessary because it will 1424*4a5d661aSToomas Soome degrade compression if called too often. 1425*4a5d661aSToomas Soome */ 1426*4a5d661aSToomas Soome 1427*4a5d661aSToomas Soome /* 1428*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, 1429*4a5d661aSToomas Soome z_off_t offset, int whence)); 1430*4a5d661aSToomas Soome 1431*4a5d661aSToomas Soome Sets the starting position for the next gzread or gzwrite on the given 1432*4a5d661aSToomas Soome compressed file. The offset represents a number of bytes in the 1433*4a5d661aSToomas Soome uncompressed data stream. The whence parameter is defined as in lseek(2); 1434*4a5d661aSToomas Soome the value SEEK_END is not supported. 1435*4a5d661aSToomas Soome 1436*4a5d661aSToomas Soome If the file is opened for reading, this function is emulated but can be 1437*4a5d661aSToomas Soome extremely slow. If the file is opened for writing, only forward seeks are 1438*4a5d661aSToomas Soome supported; gzseek then compresses a sequence of zeroes up to the new 1439*4a5d661aSToomas Soome starting position. 1440*4a5d661aSToomas Soome 1441*4a5d661aSToomas Soome gzseek returns the resulting offset location as measured in bytes from 1442*4a5d661aSToomas Soome the beginning of the uncompressed stream, or -1 in case of error, in 1443*4a5d661aSToomas Soome particular if the file is opened for writing and the new starting position 1444*4a5d661aSToomas Soome would be before the current position. 1445*4a5d661aSToomas Soome */ 1446*4a5d661aSToomas Soome 1447*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzrewind OF((gzFile file)); 1448*4a5d661aSToomas Soome /* 1449*4a5d661aSToomas Soome Rewinds the given file. This function is supported only for reading. 1450*4a5d661aSToomas Soome 1451*4a5d661aSToomas Soome gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) 1452*4a5d661aSToomas Soome */ 1453*4a5d661aSToomas Soome 1454*4a5d661aSToomas Soome /* 1455*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); 1456*4a5d661aSToomas Soome 1457*4a5d661aSToomas Soome Returns the starting position for the next gzread or gzwrite on the given 1458*4a5d661aSToomas Soome compressed file. This position represents a number of bytes in the 1459*4a5d661aSToomas Soome uncompressed data stream, and is zero when starting, even if appending or 1460*4a5d661aSToomas Soome reading a gzip stream from the middle of a file using gzdopen(). 1461*4a5d661aSToomas Soome 1462*4a5d661aSToomas Soome gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) 1463*4a5d661aSToomas Soome */ 1464*4a5d661aSToomas Soome 1465*4a5d661aSToomas Soome /* 1466*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file)); 1467*4a5d661aSToomas Soome 1468*4a5d661aSToomas Soome Returns the current offset in the file being read or written. This offset 1469*4a5d661aSToomas Soome includes the count of bytes that precede the gzip stream, for example when 1470*4a5d661aSToomas Soome appending or when using gzdopen() for reading. When reading, the offset 1471*4a5d661aSToomas Soome does not include as yet unused buffered input. This information can be used 1472*4a5d661aSToomas Soome for a progress indicator. On error, gzoffset() returns -1. 1473*4a5d661aSToomas Soome */ 1474*4a5d661aSToomas Soome 1475*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzeof OF((gzFile file)); 1476*4a5d661aSToomas Soome /* 1477*4a5d661aSToomas Soome Returns true (1) if the end-of-file indicator has been set while reading, 1478*4a5d661aSToomas Soome false (0) otherwise. Note that the end-of-file indicator is set only if the 1479*4a5d661aSToomas Soome read tried to go past the end of the input, but came up short. Therefore, 1480*4a5d661aSToomas Soome just like feof(), gzeof() may return false even if there is no more data to 1481*4a5d661aSToomas Soome read, in the event that the last read request was for the exact number of 1482*4a5d661aSToomas Soome bytes remaining in the input file. This will happen if the input file size 1483*4a5d661aSToomas Soome is an exact multiple of the buffer size. 1484*4a5d661aSToomas Soome 1485*4a5d661aSToomas Soome If gzeof() returns true, then the read functions will return no more data, 1486*4a5d661aSToomas Soome unless the end-of-file indicator is reset by gzclearerr() and the input file 1487*4a5d661aSToomas Soome has grown since the previous end of file was detected. 1488*4a5d661aSToomas Soome */ 1489*4a5d661aSToomas Soome 1490*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzdirect OF((gzFile file)); 1491*4a5d661aSToomas Soome /* 1492*4a5d661aSToomas Soome Returns true (1) if file is being copied directly while reading, or false 1493*4a5d661aSToomas Soome (0) if file is a gzip stream being decompressed. 1494*4a5d661aSToomas Soome 1495*4a5d661aSToomas Soome If the input file is empty, gzdirect() will return true, since the input 1496*4a5d661aSToomas Soome does not contain a gzip stream. 1497*4a5d661aSToomas Soome 1498*4a5d661aSToomas Soome If gzdirect() is used immediately after gzopen() or gzdopen() it will 1499*4a5d661aSToomas Soome cause buffers to be allocated to allow reading the file to determine if it 1500*4a5d661aSToomas Soome is a gzip file. Therefore if gzbuffer() is used, it should be called before 1501*4a5d661aSToomas Soome gzdirect(). 1502*4a5d661aSToomas Soome 1503*4a5d661aSToomas Soome When writing, gzdirect() returns true (1) if transparent writing was 1504*4a5d661aSToomas Soome requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note: 1505*4a5d661aSToomas Soome gzdirect() is not needed when writing. Transparent writing must be 1506*4a5d661aSToomas Soome explicitly requested, so the application already knows the answer. When 1507*4a5d661aSToomas Soome linking statically, using gzdirect() will include all of the zlib code for 1508*4a5d661aSToomas Soome gzip file reading and decompression, which may not be desired.) 1509*4a5d661aSToomas Soome */ 1510*4a5d661aSToomas Soome 1511*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzclose OF((gzFile file)); 1512*4a5d661aSToomas Soome /* 1513*4a5d661aSToomas Soome Flushes all pending output if necessary, closes the compressed file and 1514*4a5d661aSToomas Soome deallocates the (de)compression state. Note that once file is closed, you 1515*4a5d661aSToomas Soome cannot call gzerror with file, since its structures have been deallocated. 1516*4a5d661aSToomas Soome gzclose must not be called more than once on the same file, just as free 1517*4a5d661aSToomas Soome must not be called more than once on the same allocation. 1518*4a5d661aSToomas Soome 1519*4a5d661aSToomas Soome gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a 1520*4a5d661aSToomas Soome file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the 1521*4a5d661aSToomas Soome last read ended in the middle of a gzip stream, or Z_OK on success. 1522*4a5d661aSToomas Soome */ 1523*4a5d661aSToomas Soome 1524*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzclose_r OF((gzFile file)); 1525*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzclose_w OF((gzFile file)); 1526*4a5d661aSToomas Soome /* 1527*4a5d661aSToomas Soome Same as gzclose(), but gzclose_r() is only for use when reading, and 1528*4a5d661aSToomas Soome gzclose_w() is only for use when writing or appending. The advantage to 1529*4a5d661aSToomas Soome using these instead of gzclose() is that they avoid linking in zlib 1530*4a5d661aSToomas Soome compression or decompression code that is not used when only reading or only 1531*4a5d661aSToomas Soome writing respectively. If gzclose() is used, then both compression and 1532*4a5d661aSToomas Soome decompression code will be included the application when linking to a static 1533*4a5d661aSToomas Soome zlib library. 1534*4a5d661aSToomas Soome */ 1535*4a5d661aSToomas Soome 1536*4a5d661aSToomas Soome ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum)); 1537*4a5d661aSToomas Soome /* 1538*4a5d661aSToomas Soome Returns the error message for the last error which occurred on the given 1539*4a5d661aSToomas Soome compressed file. errnum is set to zlib error number. If an error occurred 1540*4a5d661aSToomas Soome in the file system and not in the compression library, errnum is set to 1541*4a5d661aSToomas Soome Z_ERRNO and the application may consult errno to get the exact error code. 1542*4a5d661aSToomas Soome 1543*4a5d661aSToomas Soome The application must not modify the returned string. Future calls to 1544*4a5d661aSToomas Soome this function may invalidate the previously returned string. If file is 1545*4a5d661aSToomas Soome closed, then the string previously returned by gzerror will no longer be 1546*4a5d661aSToomas Soome available. 1547*4a5d661aSToomas Soome 1548*4a5d661aSToomas Soome gzerror() should be used to distinguish errors from end-of-file for those 1549*4a5d661aSToomas Soome functions above that do not distinguish those cases in their return values. 1550*4a5d661aSToomas Soome */ 1551*4a5d661aSToomas Soome 1552*4a5d661aSToomas Soome ZEXTERN void ZEXPORT gzclearerr OF((gzFile file)); 1553*4a5d661aSToomas Soome /* 1554*4a5d661aSToomas Soome Clears the error and end-of-file flags for file. This is analogous to the 1555*4a5d661aSToomas Soome clearerr() function in stdio. This is useful for continuing to read a gzip 1556*4a5d661aSToomas Soome file that is being written concurrently. 1557*4a5d661aSToomas Soome */ 1558*4a5d661aSToomas Soome 1559*4a5d661aSToomas Soome #endif /* !Z_SOLO */ 1560*4a5d661aSToomas Soome 1561*4a5d661aSToomas Soome /* checksum functions */ 1562*4a5d661aSToomas Soome 1563*4a5d661aSToomas Soome /* 1564*4a5d661aSToomas Soome These functions are not related to compression but are exported 1565*4a5d661aSToomas Soome anyway because they might be useful in applications using the compression 1566*4a5d661aSToomas Soome library. 1567*4a5d661aSToomas Soome */ 1568*4a5d661aSToomas Soome 1569*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); 1570*4a5d661aSToomas Soome /* 1571*4a5d661aSToomas Soome Update a running Adler-32 checksum with the bytes buf[0..len-1] and 1572*4a5d661aSToomas Soome return the updated checksum. If buf is Z_NULL, this function returns the 1573*4a5d661aSToomas Soome required initial value for the checksum. 1574*4a5d661aSToomas Soome 1575*4a5d661aSToomas Soome An Adler-32 checksum is almost as reliable as a CRC32 but can be computed 1576*4a5d661aSToomas Soome much faster. 1577*4a5d661aSToomas Soome 1578*4a5d661aSToomas Soome Usage example: 1579*4a5d661aSToomas Soome 1580*4a5d661aSToomas Soome uLong adler = adler32(0L, Z_NULL, 0); 1581*4a5d661aSToomas Soome 1582*4a5d661aSToomas Soome while (read_buffer(buffer, length) != EOF) { 1583*4a5d661aSToomas Soome adler = adler32(adler, buffer, length); 1584*4a5d661aSToomas Soome } 1585*4a5d661aSToomas Soome if (adler != original_adler) error(); 1586*4a5d661aSToomas Soome */ 1587*4a5d661aSToomas Soome 1588*4a5d661aSToomas Soome /* 1589*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, 1590*4a5d661aSToomas Soome z_off_t len2)); 1591*4a5d661aSToomas Soome 1592*4a5d661aSToomas Soome Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 1593*4a5d661aSToomas Soome and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for 1594*4a5d661aSToomas Soome each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of 1595*4a5d661aSToomas Soome seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note 1596*4a5d661aSToomas Soome that the z_off_t type (like off_t) is a signed integer. If len2 is 1597*4a5d661aSToomas Soome negative, the result has no meaning or utility. 1598*4a5d661aSToomas Soome */ 1599*4a5d661aSToomas Soome 1600*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); 1601*4a5d661aSToomas Soome /* 1602*4a5d661aSToomas Soome Update a running CRC-32 with the bytes buf[0..len-1] and return the 1603*4a5d661aSToomas Soome updated CRC-32. If buf is Z_NULL, this function returns the required 1604*4a5d661aSToomas Soome initial value for the crc. Pre- and post-conditioning (one's complement) is 1605*4a5d661aSToomas Soome performed within this function so it shouldn't be done by the application. 1606*4a5d661aSToomas Soome 1607*4a5d661aSToomas Soome Usage example: 1608*4a5d661aSToomas Soome 1609*4a5d661aSToomas Soome uLong crc = crc32(0L, Z_NULL, 0); 1610*4a5d661aSToomas Soome 1611*4a5d661aSToomas Soome while (read_buffer(buffer, length) != EOF) { 1612*4a5d661aSToomas Soome crc = crc32(crc, buffer, length); 1613*4a5d661aSToomas Soome } 1614*4a5d661aSToomas Soome if (crc != original_crc) error(); 1615*4a5d661aSToomas Soome */ 1616*4a5d661aSToomas Soome 1617*4a5d661aSToomas Soome /* 1618*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2)); 1619*4a5d661aSToomas Soome 1620*4a5d661aSToomas Soome Combine two CRC-32 check values into one. For two sequences of bytes, 1621*4a5d661aSToomas Soome seq1 and seq2 with lengths len1 and len2, CRC-32 check values were 1622*4a5d661aSToomas Soome calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32 1623*4a5d661aSToomas Soome check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and 1624*4a5d661aSToomas Soome len2. 1625*4a5d661aSToomas Soome */ 1626*4a5d661aSToomas Soome 1627*4a5d661aSToomas Soome 1628*4a5d661aSToomas Soome /* various hacks, don't look :) */ 1629*4a5d661aSToomas Soome 1630*4a5d661aSToomas Soome /* deflateInit and inflateInit are macros to allow checking the zlib version 1631*4a5d661aSToomas Soome * and the compiler's view of z_stream: 1632*4a5d661aSToomas Soome */ 1633*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level, 1634*4a5d661aSToomas Soome const char *version, int stream_size)); 1635*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm, 1636*4a5d661aSToomas Soome const char *version, int stream_size)); 1637*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method, 1638*4a5d661aSToomas Soome int windowBits, int memLevel, 1639*4a5d661aSToomas Soome int strategy, const char *version, 1640*4a5d661aSToomas Soome int stream_size)); 1641*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits, 1642*4a5d661aSToomas Soome const char *version, int stream_size)); 1643*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits, 1644*4a5d661aSToomas Soome unsigned char FAR *window, 1645*4a5d661aSToomas Soome const char *version, 1646*4a5d661aSToomas Soome int stream_size)); 1647*4a5d661aSToomas Soome #define deflateInit(strm, level) \ 1648*4a5d661aSToomas Soome deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream)) 1649*4a5d661aSToomas Soome #define inflateInit(strm) \ 1650*4a5d661aSToomas Soome inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream)) 1651*4a5d661aSToomas Soome #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ 1652*4a5d661aSToomas Soome deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ 1653*4a5d661aSToomas Soome (strategy), ZLIB_VERSION, (int)sizeof(z_stream)) 1654*4a5d661aSToomas Soome #define inflateInit2(strm, windowBits) \ 1655*4a5d661aSToomas Soome inflateInit2_((strm), (windowBits), ZLIB_VERSION, \ 1656*4a5d661aSToomas Soome (int)sizeof(z_stream)) 1657*4a5d661aSToomas Soome #define inflateBackInit(strm, windowBits, window) \ 1658*4a5d661aSToomas Soome inflateBackInit_((strm), (windowBits), (window), \ 1659*4a5d661aSToomas Soome ZLIB_VERSION, (int)sizeof(z_stream)) 1660*4a5d661aSToomas Soome 1661*4a5d661aSToomas Soome #ifndef Z_SOLO 1662*4a5d661aSToomas Soome 1663*4a5d661aSToomas Soome /* gzgetc() macro and its supporting function and exposed data structure. Note 1664*4a5d661aSToomas Soome * that the real internal state is much larger than the exposed structure. 1665*4a5d661aSToomas Soome * This abbreviated structure exposes just enough for the gzgetc() macro. The 1666*4a5d661aSToomas Soome * user should not mess with these exposed elements, since their names or 1667*4a5d661aSToomas Soome * behavior could change in the future, perhaps even capriciously. They can 1668*4a5d661aSToomas Soome * only be used by the gzgetc() macro. You have been warned. 1669*4a5d661aSToomas Soome */ 1670*4a5d661aSToomas Soome struct gzFile_s { 1671*4a5d661aSToomas Soome unsigned have; 1672*4a5d661aSToomas Soome unsigned char *next; 1673*4a5d661aSToomas Soome z_off64_t pos; 1674*4a5d661aSToomas Soome }; 1675*4a5d661aSToomas Soome ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */ 1676*4a5d661aSToomas Soome #ifdef Z_PREFIX_SET 1677*4a5d661aSToomas Soome # undef z_gzgetc 1678*4a5d661aSToomas Soome # define z_gzgetc(g) \ 1679*4a5d661aSToomas Soome ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) 1680*4a5d661aSToomas Soome #else 1681*4a5d661aSToomas Soome # define gzgetc(g) \ 1682*4a5d661aSToomas Soome ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) 1683*4a5d661aSToomas Soome #endif 1684*4a5d661aSToomas Soome 1685*4a5d661aSToomas Soome /* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or 1686*4a5d661aSToomas Soome * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if 1687*4a5d661aSToomas Soome * both are true, the application gets the *64 functions, and the regular 1688*4a5d661aSToomas Soome * functions are changed to 64 bits) -- in case these are set on systems 1689*4a5d661aSToomas Soome * without large file support, _LFS64_LARGEFILE must also be true 1690*4a5d661aSToomas Soome */ 1691*4a5d661aSToomas Soome #ifdef Z_LARGE64 1692*4a5d661aSToomas Soome ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); 1693*4a5d661aSToomas Soome ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int)); 1694*4a5d661aSToomas Soome ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile)); 1695*4a5d661aSToomas Soome ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile)); 1696*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t)); 1697*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t)); 1698*4a5d661aSToomas Soome #endif 1699*4a5d661aSToomas Soome 1700*4a5d661aSToomas Soome #if !defined(ZLIB_INTERNAL) && defined(Z_WANT64) 1701*4a5d661aSToomas Soome # ifdef Z_PREFIX_SET 1702*4a5d661aSToomas Soome # define z_gzopen z_gzopen64 1703*4a5d661aSToomas Soome # define z_gzseek z_gzseek64 1704*4a5d661aSToomas Soome # define z_gztell z_gztell64 1705*4a5d661aSToomas Soome # define z_gzoffset z_gzoffset64 1706*4a5d661aSToomas Soome # define z_adler32_combine z_adler32_combine64 1707*4a5d661aSToomas Soome # define z_crc32_combine z_crc32_combine64 1708*4a5d661aSToomas Soome # else 1709*4a5d661aSToomas Soome # define gzopen gzopen64 1710*4a5d661aSToomas Soome # define gzseek gzseek64 1711*4a5d661aSToomas Soome # define gztell gztell64 1712*4a5d661aSToomas Soome # define gzoffset gzoffset64 1713*4a5d661aSToomas Soome # define adler32_combine adler32_combine64 1714*4a5d661aSToomas Soome # define crc32_combine crc32_combine64 1715*4a5d661aSToomas Soome # endif 1716*4a5d661aSToomas Soome # ifndef Z_LARGE64 1717*4a5d661aSToomas Soome ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); 1718*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int)); 1719*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile)); 1720*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile)); 1721*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t)); 1722*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t)); 1723*4a5d661aSToomas Soome # endif 1724*4a5d661aSToomas Soome #else 1725*4a5d661aSToomas Soome ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *)); 1726*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int)); 1727*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gztell OF((gzFile)); 1728*4a5d661aSToomas Soome ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile)); 1729*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); 1730*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); 1731*4a5d661aSToomas Soome #endif 1732*4a5d661aSToomas Soome 1733*4a5d661aSToomas Soome #else /* Z_SOLO */ 1734*4a5d661aSToomas Soome 1735*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); 1736*4a5d661aSToomas Soome ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); 1737*4a5d661aSToomas Soome 1738*4a5d661aSToomas Soome #endif /* !Z_SOLO */ 1739*4a5d661aSToomas Soome 1740*4a5d661aSToomas Soome /* hack for buggy compilers */ 1741*4a5d661aSToomas Soome #if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL) 1742*4a5d661aSToomas Soome struct internal_state {int dummy;}; 1743*4a5d661aSToomas Soome #endif 1744*4a5d661aSToomas Soome 1745*4a5d661aSToomas Soome /* undocumented functions */ 1746*4a5d661aSToomas Soome ZEXTERN const char * ZEXPORT zError OF((int)); 1747*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp)); 1748*4a5d661aSToomas Soome ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void)); 1749*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int)); 1750*4a5d661aSToomas Soome ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp)); 1751*4a5d661aSToomas Soome ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp)); 1752*4a5d661aSToomas Soome #if defined(_WIN32) && !defined(Z_SOLO) 1753*4a5d661aSToomas Soome ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path, 1754*4a5d661aSToomas Soome const char *mode)); 1755*4a5d661aSToomas Soome #endif 1756*4a5d661aSToomas Soome #if defined(STDC) || defined(Z_HAVE_STDARG_H) 1757*4a5d661aSToomas Soome # ifndef Z_SOLO 1758*4a5d661aSToomas Soome ZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file, 1759*4a5d661aSToomas Soome const char *format, 1760*4a5d661aSToomas Soome va_list va)); 1761*4a5d661aSToomas Soome # endif 1762*4a5d661aSToomas Soome #endif 1763*4a5d661aSToomas Soome 1764*4a5d661aSToomas Soome #ifdef __cplusplus 1765*4a5d661aSToomas Soome } 1766*4a5d661aSToomas Soome #endif 1767*4a5d661aSToomas Soome 1768*4a5d661aSToomas Soome #endif /* ZLIB_H */ 1769