annotate src/zlib-1.2.8/zlib.h @ 70:9e21af8f0420

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