istereo

annotate libs/zlib/zlib.h @ 43:73813c1176de

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