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