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