Basic gzip/gunzip in memory buffer examples using zlib code.

Dependencies:   mbed-rtos mbed

There are small changes needed to the zconf.h file in the zlib distribution (I used 1.2.7). The zlib license applies to the zlib code - I have only imported a subset of the source.

The MBED has limited memory, so we need the following (near the top of zconf.h) to restrict memory allocation sizes:

#define    MAX_MEM_LEVEL    3
#define    MAX_WBITS        10

Because MAX_MEM_LEVEL and MAX_WBITS are so much lower than the default, there is a danger that the mbed cannot gunzip data compressed by a 'normal' zlib build. My use-case is to gzip on the mbed more than gunzip on the mbed so I have not given much time to this issue.

I also included this (also near the top of zconf.h) to prefix defines with Z_

#define    Z_PREFIX

In zconf.h, in the zlib distribution, the includes for <fcntl.h> and <sys/types.h> need commenting out when using the online compiler. No need when using GCC4MBED.

I also looked at miniz. I chose zlib because I needed the gzip headers and miniz does not implement them.

The sample main.cpp reads source data, compresses it, decompresses it, and finally compares the input data with the output data to confirm they are the same.

    unsigned char input_data[2048];
    unsigned long input_data_length = 0;
    FILE *ifp = fopen("/local/src.txt", "r");
    if (ifp) {
        int br = fread(input_data, 1, sizeof(input_data), ifp);
        fclose(ifp);
        input_data_length = br;
    }
    printf("%s:%d: input_data_length:%lu%s", __FILE__, __LINE__, input_data_length, newline);
 
 
    unsigned char gzip_data[2048];
    unsigned long gzip_data_length = 0;
    if (input_data_length > 0) {
        gzip_data_length = sizeof(gzip_data);
        int rv = gzip(gzip_data, &gzip_data_length, input_data, input_data_length);
        if (Z_OK == rv) {
            FILE *ofp = fopen("/local/dst.gz", "w");
            if (ofp) {
                int bw = fwrite(gzip_data, 1, gzip_data_length, ofp);
                fclose(ofp);
            }
        } else {
            printf("%s:%d: %d%s", __FILE__, __LINE__, rv, newline);
        }
    }
    printf("%s:%d: gzip_data_length:%lu%s", __FILE__, __LINE__, gzip_data_length, newline);
 
 
    unsigned char output_data[2048];
    unsigned long output_data_length = 0;
    if (gzip_data_length > 0) {
        output_data_length = sizeof(output_data);
        int rv = gunzip(output_data, &output_data_length, gzip_data, gzip_data_length);
        if (Z_OK != rv) {
            printf("%s:%d: %d%s", __FILE__, __LINE__, rv, newline);
        }
    }
    printf("%s:%d: output_data_length:%lu%s", __FILE__, __LINE__, output_data_length, newline);
 
 
    if (input_data_length > 0 and input_data_length > 0) {
        bool input_matches_output = false;
        if (input_data_length == output_data_length) {
            input_matches_output = true;
            for ( size_t i = 0 ; input_matches_output && i < input_data_length ; i++ ) {
                if (input_data[i] != output_data[i]) {
                    input_matches_output = false;
                }
            }
        }
        printf("%s:%d: input (%lu bytes) %s output (%lu bytes)%s", __FILE__, __LINE__, input_data_length, input_matches_output?"matches":"does not match", output_data_length, newline);
    } else {
        printf("%s:%d: input and/or output length is 0%s", __FILE__, __LINE__, newline);
    }
Committer:
jonathonfletcher
Date:
Sun Oct 21 07:46:41 2012 +0000
Revision:
0:54f5be781526
initial checkin

Who changed what in which revision?

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