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