1a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 2*dce3d797SGiuseppe CONDORELLI * This file is derived from zlib.h and zconf.h from the zlib-1.2.3 3a31e091aSJean-Christophe PLAGNIOL-VILLARD * distribution by Jean-loup Gailly and Mark Adler, with some additions 4a31e091aSJean-Christophe PLAGNIOL-VILLARD * by Paul Mackerras to aid in implementing Deflate compression and 5a31e091aSJean-Christophe PLAGNIOL-VILLARD * decompression for PPP packets. 6a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 7a31e091aSJean-Christophe PLAGNIOL-VILLARD 8a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 9a31e091aSJean-Christophe PLAGNIOL-VILLARD * ==FILEVERSION 960122== 10a31e091aSJean-Christophe PLAGNIOL-VILLARD * 11a31e091aSJean-Christophe PLAGNIOL-VILLARD * This marker is used by the Linux installation script to determine 12a31e091aSJean-Christophe PLAGNIOL-VILLARD * whether an up-to-date version of this file is already installed. 13a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 14a31e091aSJean-Christophe PLAGNIOL-VILLARD 15a31e091aSJean-Christophe PLAGNIOL-VILLARD /* zlib.h -- interface of the 'zlib' general purpose compression library 16*dce3d797SGiuseppe CONDORELLI version 1.2.3, July 18th, 2005 17a31e091aSJean-Christophe PLAGNIOL-VILLARD 18*dce3d797SGiuseppe CONDORELLI Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler 19a31e091aSJean-Christophe PLAGNIOL-VILLARD 20a31e091aSJean-Christophe PLAGNIOL-VILLARD This software is provided 'as-is', without any express or implied 21a31e091aSJean-Christophe PLAGNIOL-VILLARD warranty. In no event will the authors be held liable for any damages 22a31e091aSJean-Christophe PLAGNIOL-VILLARD arising from the use of this software. 23a31e091aSJean-Christophe PLAGNIOL-VILLARD 24a31e091aSJean-Christophe PLAGNIOL-VILLARD Permission is granted to anyone to use this software for any purpose, 25a31e091aSJean-Christophe PLAGNIOL-VILLARD including commercial applications, and to alter it and redistribute it 26a31e091aSJean-Christophe PLAGNIOL-VILLARD freely, subject to the following restrictions: 27a31e091aSJean-Christophe PLAGNIOL-VILLARD 28a31e091aSJean-Christophe PLAGNIOL-VILLARD 1. The origin of this software must not be misrepresented; you must not 29a31e091aSJean-Christophe PLAGNIOL-VILLARD claim that you wrote the original software. If you use this software 30a31e091aSJean-Christophe PLAGNIOL-VILLARD in a product, an acknowledgment in the product documentation would be 31a31e091aSJean-Christophe PLAGNIOL-VILLARD appreciated but is not required. 32a31e091aSJean-Christophe PLAGNIOL-VILLARD 2. Altered source versions must be plainly marked as such, and must not be 33a31e091aSJean-Christophe PLAGNIOL-VILLARD misrepresented as being the original software. 34a31e091aSJean-Christophe PLAGNIOL-VILLARD 3. This notice may not be removed or altered from any source distribution. 35a31e091aSJean-Christophe PLAGNIOL-VILLARD 36a31e091aSJean-Christophe PLAGNIOL-VILLARD Jean-loup Gailly Mark Adler 37*dce3d797SGiuseppe CONDORELLI jloup@gzip.org madler@alumni.caltech.edu 38*dce3d797SGiuseppe CONDORELLI 39*dce3d797SGiuseppe CONDORELLI 40*dce3d797SGiuseppe CONDORELLI The data format used by the zlib library is described by RFCs (Request for 41*dce3d797SGiuseppe CONDORELLI Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt 42*dce3d797SGiuseppe CONDORELLI (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format). 43a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 44a31e091aSJean-Christophe PLAGNIOL-VILLARD 45*dce3d797SGiuseppe CONDORELLI #ifndef ZLIB_H 46*dce3d797SGiuseppe CONDORELLI #define ZLIB_H 47*dce3d797SGiuseppe CONDORELLI 48*dce3d797SGiuseppe CONDORELLI #ifdef __cplusplus 49*dce3d797SGiuseppe CONDORELLI extern "C" { 50*dce3d797SGiuseppe CONDORELLI #endif 51*dce3d797SGiuseppe CONDORELLI 52*dce3d797SGiuseppe CONDORELLI #define ZLIB_VERSION "1.2.3" 53*dce3d797SGiuseppe CONDORELLI #define ZLIB_VERNUM 0x1230 54a31e091aSJean-Christophe PLAGNIOL-VILLARD 55a31e091aSJean-Christophe PLAGNIOL-VILLARD /* #include "zconf.h" */ /* included directly here */ 56a31e091aSJean-Christophe PLAGNIOL-VILLARD /* zconf.h -- configuration of the zlib compression library 57*dce3d797SGiuseppe CONDORELLI * Copyright (C) 1995-2005 Jean-loup Gailly. 58a31e091aSJean-Christophe PLAGNIOL-VILLARD * For conditions of distribution and use, see copyright notice in zlib.h 59a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 60a31e091aSJean-Christophe PLAGNIOL-VILLARD 61*dce3d797SGiuseppe CONDORELLI /* Begin of new zconf.h */ 62a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 63*dce3d797SGiuseppe CONDORELLI * If you *really* need a unique prefix for all types and library functions, 64*dce3d797SGiuseppe CONDORELLI * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it. 65a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 66*dce3d797SGiuseppe CONDORELLI #ifdef Z_PREFIX 67*dce3d797SGiuseppe CONDORELLI # define deflateInit_ z_deflateInit_ 68*dce3d797SGiuseppe CONDORELLI # define deflate z_deflate 69*dce3d797SGiuseppe CONDORELLI # define deflateEnd z_deflateEnd 70*dce3d797SGiuseppe CONDORELLI # define inflateInit_ z_inflateInit_ 71*dce3d797SGiuseppe CONDORELLI # define inflate z_inflate 72*dce3d797SGiuseppe CONDORELLI # define inflateEnd z_inflateEnd 73*dce3d797SGiuseppe CONDORELLI # define deflateInit2_ z_deflateInit2_ 74*dce3d797SGiuseppe CONDORELLI # define deflateSetDictionary z_deflateSetDictionary 75*dce3d797SGiuseppe CONDORELLI # define deflateCopy z_deflateCopy 76*dce3d797SGiuseppe CONDORELLI # define deflateReset z_deflateReset 77*dce3d797SGiuseppe CONDORELLI # define deflateParams z_deflateParams 78*dce3d797SGiuseppe CONDORELLI # define deflateBound z_deflateBound 79*dce3d797SGiuseppe CONDORELLI # define deflatePrime z_deflatePrime 80*dce3d797SGiuseppe CONDORELLI # define inflateInit2_ z_inflateInit2_ 81*dce3d797SGiuseppe CONDORELLI # define inflateSetDictionary z_inflateSetDictionary 82*dce3d797SGiuseppe CONDORELLI # define inflateSync z_inflateSync 83*dce3d797SGiuseppe CONDORELLI # define inflateSyncPoint z_inflateSyncPoint 84*dce3d797SGiuseppe CONDORELLI # define inflateCopy z_inflateCopy 85*dce3d797SGiuseppe CONDORELLI # define inflateReset z_inflateReset 86*dce3d797SGiuseppe CONDORELLI # define inflateBack z_inflateBack 87*dce3d797SGiuseppe CONDORELLI # define inflateBackEnd z_inflateBackEnd 88*dce3d797SGiuseppe CONDORELLI # define compress z_compress 89*dce3d797SGiuseppe CONDORELLI # define compress2 z_compress2 90*dce3d797SGiuseppe CONDORELLI # define compressBound z_compressBound 91*dce3d797SGiuseppe CONDORELLI # define uncompress z_uncompress 92*dce3d797SGiuseppe CONDORELLI # define adler32 z_adler32 93*dce3d797SGiuseppe CONDORELLI # define crc32 z_crc32 94*dce3d797SGiuseppe CONDORELLI # define get_crc_table z_get_crc_table 95*dce3d797SGiuseppe CONDORELLI # define zError z_zError 96*dce3d797SGiuseppe CONDORELLI 97*dce3d797SGiuseppe CONDORELLI # define alloc_func z_alloc_func 98*dce3d797SGiuseppe CONDORELLI # define free_func z_free_func 99*dce3d797SGiuseppe CONDORELLI # define in_func z_in_func 100*dce3d797SGiuseppe CONDORELLI # define out_func z_out_func 101*dce3d797SGiuseppe CONDORELLI # define Byte z_Byte 102*dce3d797SGiuseppe CONDORELLI # define uInt z_uInt 103*dce3d797SGiuseppe CONDORELLI # define uLong z_uLong 104*dce3d797SGiuseppe CONDORELLI # define Bytef z_Bytef 105*dce3d797SGiuseppe CONDORELLI # define charf z_charf 106*dce3d797SGiuseppe CONDORELLI # define intf z_intf 107*dce3d797SGiuseppe CONDORELLI # define uIntf z_uIntf 108*dce3d797SGiuseppe CONDORELLI # define uLongf z_uLongf 109*dce3d797SGiuseppe CONDORELLI # define voidpf z_voidpf 110*dce3d797SGiuseppe CONDORELLI # define voidp z_voidp 111*dce3d797SGiuseppe CONDORELLI #endif 112*dce3d797SGiuseppe CONDORELLI 113*dce3d797SGiuseppe CONDORELLI #if defined(__MSDOS__) && !defined(MSDOS) 114*dce3d797SGiuseppe CONDORELLI # define MSDOS 115*dce3d797SGiuseppe CONDORELLI #endif 116*dce3d797SGiuseppe CONDORELLI #if (defined(OS_2) || defined(__OS2__)) && !defined(OS2) 117*dce3d797SGiuseppe CONDORELLI # define OS2 118*dce3d797SGiuseppe CONDORELLI #endif 119*dce3d797SGiuseppe CONDORELLI #if defined(_WINDOWS) && !defined(WINDOWS) 120*dce3d797SGiuseppe CONDORELLI # define WINDOWS 121*dce3d797SGiuseppe CONDORELLI #endif 122*dce3d797SGiuseppe CONDORELLI #if defined(_WIN32) || defined(_WIN32_WCE) || defined(__WIN32__) 123*dce3d797SGiuseppe CONDORELLI # ifndef WIN32 124*dce3d797SGiuseppe CONDORELLI # define WIN32 125*dce3d797SGiuseppe CONDORELLI # endif 126*dce3d797SGiuseppe CONDORELLI #endif 127*dce3d797SGiuseppe CONDORELLI #if (defined(MSDOS) || defined(OS2) || defined(WINDOWS)) && !defined(WIN32) 128*dce3d797SGiuseppe CONDORELLI # if !defined(__GNUC__) && !defined(__FLAT__) && !defined(__386__) 129*dce3d797SGiuseppe CONDORELLI # ifndef SYS16BIT 130*dce3d797SGiuseppe CONDORELLI # define SYS16BIT 131*dce3d797SGiuseppe CONDORELLI # endif 132*dce3d797SGiuseppe CONDORELLI # endif 133*dce3d797SGiuseppe CONDORELLI #endif 134a31e091aSJean-Christophe PLAGNIOL-VILLARD 135a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 136a31e091aSJean-Christophe PLAGNIOL-VILLARD * Compile with -DMAXSEG_64K if the alloc function cannot allocate more 137a31e091aSJean-Christophe PLAGNIOL-VILLARD * than 64k bytes at a time (needed on systems with 16-bit int). 138a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 139*dce3d797SGiuseppe CONDORELLI #ifdef SYS16BIT 140*dce3d797SGiuseppe CONDORELLI # define MAXSEG_64K 141*dce3d797SGiuseppe CONDORELLI #endif 142*dce3d797SGiuseppe CONDORELLI #ifdef MSDOS 143*dce3d797SGiuseppe CONDORELLI # define UNALIGNED_OK 144*dce3d797SGiuseppe CONDORELLI #endif 145b201171fSGiuseppe CONDORELLI 146*dce3d797SGiuseppe CONDORELLI #ifdef __STDC_VERSION__ 147b201171fSGiuseppe CONDORELLI # ifndef STDC 148f33b325aSWolfgang Denk # define STDC 149b201171fSGiuseppe CONDORELLI # endif 150*dce3d797SGiuseppe CONDORELLI # if __STDC_VERSION__ >= 199901L 151*dce3d797SGiuseppe CONDORELLI # ifndef STDC99 152*dce3d797SGiuseppe CONDORELLI # define STDC99 153*dce3d797SGiuseppe CONDORELLI # endif 154*dce3d797SGiuseppe CONDORELLI # endif 155*dce3d797SGiuseppe CONDORELLI #endif 156*dce3d797SGiuseppe CONDORELLI #if !defined(STDC) && (defined(__STDC__) || defined(__cplusplus)) 157*dce3d797SGiuseppe CONDORELLI # define STDC 158*dce3d797SGiuseppe CONDORELLI #endif 159*dce3d797SGiuseppe CONDORELLI #if !defined(STDC) && (defined(__GNUC__) || defined(__BORLANDC__)) 160*dce3d797SGiuseppe CONDORELLI # define STDC 161*dce3d797SGiuseppe CONDORELLI #endif 162*dce3d797SGiuseppe CONDORELLI #if !defined(STDC) && (defined(MSDOS) || defined(WINDOWS) || defined(WIN32)) 163*dce3d797SGiuseppe CONDORELLI # define STDC 164*dce3d797SGiuseppe CONDORELLI #endif 165*dce3d797SGiuseppe CONDORELLI #if !defined(STDC) && (defined(OS2) || defined(__HOS_AIX__)) 166*dce3d797SGiuseppe CONDORELLI # define STDC 167b201171fSGiuseppe CONDORELLI #endif 168b201171fSGiuseppe CONDORELLI 169*dce3d797SGiuseppe CONDORELLI #if defined(__OS400__) && !defined(STDC) /* iSeries (formerly AS/400). */ 170*dce3d797SGiuseppe CONDORELLI # define STDC 171*dce3d797SGiuseppe CONDORELLI #endif 172*dce3d797SGiuseppe CONDORELLI 173*dce3d797SGiuseppe CONDORELLI #ifndef STDC 174*dce3d797SGiuseppe CONDORELLI # ifndef const /* cannot use !defined(STDC) && !defined(const) on Mac */ 175*dce3d797SGiuseppe CONDORELLI # define const /* note: need a more gentle solution here */ 176*dce3d797SGiuseppe CONDORELLI # endif 177*dce3d797SGiuseppe CONDORELLI #endif 178*dce3d797SGiuseppe CONDORELLI 179*dce3d797SGiuseppe CONDORELLI /* Some Mac compilers merge all .h files incorrectly: */ 180*dce3d797SGiuseppe CONDORELLI #if defined(__MWERKS__)||defined(applec)||defined(THINK_C)||defined(__SC__) 181*dce3d797SGiuseppe CONDORELLI # define NO_DUMMY_DECL 182a31e091aSJean-Christophe PLAGNIOL-VILLARD #endif 183a31e091aSJean-Christophe PLAGNIOL-VILLARD 184a31e091aSJean-Christophe PLAGNIOL-VILLARD /* Maximum value for memLevel in deflateInit2 */ 185a31e091aSJean-Christophe PLAGNIOL-VILLARD #ifndef MAX_MEM_LEVEL 186a31e091aSJean-Christophe PLAGNIOL-VILLARD # ifdef MAXSEG_64K 187a31e091aSJean-Christophe PLAGNIOL-VILLARD # define MAX_MEM_LEVEL 8 188a31e091aSJean-Christophe PLAGNIOL-VILLARD # else 189a31e091aSJean-Christophe PLAGNIOL-VILLARD # define MAX_MEM_LEVEL 9 190a31e091aSJean-Christophe PLAGNIOL-VILLARD # endif 191a31e091aSJean-Christophe PLAGNIOL-VILLARD #endif 192a31e091aSJean-Christophe PLAGNIOL-VILLARD 193*dce3d797SGiuseppe CONDORELLI /* Maximum value for windowBits in deflateInit2 and inflateInit2. 194*dce3d797SGiuseppe CONDORELLI * WARNING: reducing MAX_WBITS makes minigzip unable to extract .gz files 195*dce3d797SGiuseppe CONDORELLI * created by gzip. (Files created by minigzip can still be extracted by 196*dce3d797SGiuseppe CONDORELLI * gzip.) 197*dce3d797SGiuseppe CONDORELLI */ 198a31e091aSJean-Christophe PLAGNIOL-VILLARD #ifndef MAX_WBITS 199a31e091aSJean-Christophe PLAGNIOL-VILLARD # define MAX_WBITS 15 /* 32K LZ77 window */ 200a31e091aSJean-Christophe PLAGNIOL-VILLARD #endif 201a31e091aSJean-Christophe PLAGNIOL-VILLARD 202a31e091aSJean-Christophe PLAGNIOL-VILLARD /* The memory requirements for deflate are (in bytes): 203*dce3d797SGiuseppe CONDORELLI (1 << (windowBits+2)) + (1 << (memLevel+9)) 204a31e091aSJean-Christophe PLAGNIOL-VILLARD that is: 128K for windowBits=15 + 128K for memLevel = 8 (default values) 205a31e091aSJean-Christophe PLAGNIOL-VILLARD plus a few kilobytes for small objects. For example, if you want to reduce 206a31e091aSJean-Christophe PLAGNIOL-VILLARD the default memory requirements from 256K to 128K, compile with 207a31e091aSJean-Christophe PLAGNIOL-VILLARD make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7" 208a31e091aSJean-Christophe PLAGNIOL-VILLARD Of course this will generally degrade compression (there's no free lunch). 209a31e091aSJean-Christophe PLAGNIOL-VILLARD 210a31e091aSJean-Christophe PLAGNIOL-VILLARD The memory requirements for inflate are (in bytes) 1 << windowBits 211a31e091aSJean-Christophe PLAGNIOL-VILLARD that is, 32K for windowBits=15 (default value) plus a few kilobytes 212a31e091aSJean-Christophe PLAGNIOL-VILLARD for small objects. 213a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 214a31e091aSJean-Christophe PLAGNIOL-VILLARD 215a31e091aSJean-Christophe PLAGNIOL-VILLARD /* Type declarations */ 216a31e091aSJean-Christophe PLAGNIOL-VILLARD 217a31e091aSJean-Christophe PLAGNIOL-VILLARD #ifndef OF /* function prototypes */ 218a31e091aSJean-Christophe PLAGNIOL-VILLARD # ifdef STDC 219a31e091aSJean-Christophe PLAGNIOL-VILLARD # define OF(args) args 220a31e091aSJean-Christophe PLAGNIOL-VILLARD # else 221a31e091aSJean-Christophe PLAGNIOL-VILLARD # define OF(args) () 222a31e091aSJean-Christophe PLAGNIOL-VILLARD # endif 223a31e091aSJean-Christophe PLAGNIOL-VILLARD #endif 224a31e091aSJean-Christophe PLAGNIOL-VILLARD 225*dce3d797SGiuseppe CONDORELLI /* The following definitions for FAR are needed only for MSDOS mixed 226*dce3d797SGiuseppe CONDORELLI * model programming (small or medium model with some far allocations). 227*dce3d797SGiuseppe CONDORELLI * This was tested only with MSC; for other MSDOS compilers you may have 228*dce3d797SGiuseppe CONDORELLI * to define NO_MEMCPY in zutil.h. If you don't need the mixed model, 229*dce3d797SGiuseppe CONDORELLI * just define FAR to be empty. 230*dce3d797SGiuseppe CONDORELLI */ 231*dce3d797SGiuseppe CONDORELLI #ifdef SYS16BIT 232*dce3d797SGiuseppe CONDORELLI # if defined(M_I86SM) || defined(M_I86MM) 233*dce3d797SGiuseppe CONDORELLI /* MSC small or medium model */ 234*dce3d797SGiuseppe CONDORELLI # define SMALL_MEDIUM 235*dce3d797SGiuseppe CONDORELLI # ifdef _MSC_VER 236*dce3d797SGiuseppe CONDORELLI # define FAR _far 237*dce3d797SGiuseppe CONDORELLI # else 238*dce3d797SGiuseppe CONDORELLI # define FAR far 239*dce3d797SGiuseppe CONDORELLI # endif 240*dce3d797SGiuseppe CONDORELLI # endif 241*dce3d797SGiuseppe CONDORELLI # if (defined(__SMALL__) || defined(__MEDIUM__)) 242*dce3d797SGiuseppe CONDORELLI /* Turbo C small or medium model */ 243*dce3d797SGiuseppe CONDORELLI # define SMALL_MEDIUM 244*dce3d797SGiuseppe CONDORELLI # ifdef __BORLANDC__ 245*dce3d797SGiuseppe CONDORELLI # define FAR _far 246*dce3d797SGiuseppe CONDORELLI # else 247*dce3d797SGiuseppe CONDORELLI # define FAR far 248*dce3d797SGiuseppe CONDORELLI # endif 249*dce3d797SGiuseppe CONDORELLI # endif 250*dce3d797SGiuseppe CONDORELLI #endif 251*dce3d797SGiuseppe CONDORELLI 252*dce3d797SGiuseppe CONDORELLI #if defined(WINDOWS) || defined(WIN32) 253*dce3d797SGiuseppe CONDORELLI /* If building or using zlib as a DLL, define ZLIB_DLL. 254*dce3d797SGiuseppe CONDORELLI * This is not mandatory, but it offers a little performance increase. 255*dce3d797SGiuseppe CONDORELLI */ 256*dce3d797SGiuseppe CONDORELLI # ifdef ZLIB_DLL 257*dce3d797SGiuseppe CONDORELLI # if defined(WIN32) && (!defined(__BORLANDC__) || (__BORLANDC__ >= 0x500)) 258*dce3d797SGiuseppe CONDORELLI # ifdef ZLIB_INTERNAL 259*dce3d797SGiuseppe CONDORELLI # define ZEXTERN extern __declspec(dllexport) 260*dce3d797SGiuseppe CONDORELLI # else 261*dce3d797SGiuseppe CONDORELLI # define ZEXTERN extern __declspec(dllimport) 262*dce3d797SGiuseppe CONDORELLI # endif 263*dce3d797SGiuseppe CONDORELLI # endif 264*dce3d797SGiuseppe CONDORELLI # endif /* ZLIB_DLL */ 265*dce3d797SGiuseppe CONDORELLI /* If building or using zlib with the WINAPI/WINAPIV calling convention, 266*dce3d797SGiuseppe CONDORELLI * define ZLIB_WINAPI. 267*dce3d797SGiuseppe CONDORELLI * Caution: the standard ZLIB1.DLL is NOT compiled using ZLIB_WINAPI. 268*dce3d797SGiuseppe CONDORELLI */ 269*dce3d797SGiuseppe CONDORELLI # ifdef ZLIB_WINAPI 270*dce3d797SGiuseppe CONDORELLI # ifdef FAR 271*dce3d797SGiuseppe CONDORELLI # undef FAR 272*dce3d797SGiuseppe CONDORELLI # endif 273*dce3d797SGiuseppe CONDORELLI # include <windows.h> 274*dce3d797SGiuseppe CONDORELLI /* No need for _export, use ZLIB.DEF instead. */ 275*dce3d797SGiuseppe CONDORELLI /* For complete Windows compatibility, use WINAPI, not __stdcall. */ 276*dce3d797SGiuseppe CONDORELLI # define ZEXPORT WINAPI 277*dce3d797SGiuseppe CONDORELLI # ifdef WIN32 278*dce3d797SGiuseppe CONDORELLI # define ZEXPORTVA WINAPIV 279*dce3d797SGiuseppe CONDORELLI # else 280*dce3d797SGiuseppe CONDORELLI # define ZEXPORTVA FAR CDECL 281*dce3d797SGiuseppe CONDORELLI # endif 282*dce3d797SGiuseppe CONDORELLI # endif 283*dce3d797SGiuseppe CONDORELLI #endif 284*dce3d797SGiuseppe CONDORELLI 285*dce3d797SGiuseppe CONDORELLI #if defined (__BEOS__) 286*dce3d797SGiuseppe CONDORELLI # ifdef ZLIB_DLL 287*dce3d797SGiuseppe CONDORELLI # ifdef ZLIB_INTERNAL 288*dce3d797SGiuseppe CONDORELLI # define ZEXPORT __declspec(dllexport) 289*dce3d797SGiuseppe CONDORELLI # define ZEXPORTVA __declspec(dllexport) 290*dce3d797SGiuseppe CONDORELLI # else 291*dce3d797SGiuseppe CONDORELLI # define ZEXPORT __declspec(dllimport) 292*dce3d797SGiuseppe CONDORELLI # define ZEXPORTVA __declspec(dllimport) 293*dce3d797SGiuseppe CONDORELLI # endif 294*dce3d797SGiuseppe CONDORELLI # endif 295*dce3d797SGiuseppe CONDORELLI #endif 296*dce3d797SGiuseppe CONDORELLI 297*dce3d797SGiuseppe CONDORELLI #ifndef ZEXTERN 298*dce3d797SGiuseppe CONDORELLI # define ZEXTERN extern 299*dce3d797SGiuseppe CONDORELLI #endif 300*dce3d797SGiuseppe CONDORELLI #ifndef ZEXPORT 301*dce3d797SGiuseppe CONDORELLI # define ZEXPORT 302*dce3d797SGiuseppe CONDORELLI #endif 303*dce3d797SGiuseppe CONDORELLI #ifndef ZEXPORTVA 304*dce3d797SGiuseppe CONDORELLI # define ZEXPORTVA 305*dce3d797SGiuseppe CONDORELLI #endif 306*dce3d797SGiuseppe CONDORELLI 307*dce3d797SGiuseppe CONDORELLI #ifndef FAR 308*dce3d797SGiuseppe CONDORELLI # define FAR 309*dce3d797SGiuseppe CONDORELLI #endif 310*dce3d797SGiuseppe CONDORELLI 311*dce3d797SGiuseppe CONDORELLI #if !defined(__MACTYPES__) 312a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef unsigned char Byte; /* 8 bits */ 313*dce3d797SGiuseppe CONDORELLI #endif 314a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef unsigned int uInt; /* 16 bits or more */ 315a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef unsigned long uLong; /* 32 bits or more */ 316a31e091aSJean-Christophe PLAGNIOL-VILLARD 317*dce3d797SGiuseppe CONDORELLI #ifdef SMALL_MEDIUM 318*dce3d797SGiuseppe CONDORELLI /* Borland C/C++ and some old MSC versions ignore FAR inside typedef */ 319*dce3d797SGiuseppe CONDORELLI # define Bytef Byte FAR 320*dce3d797SGiuseppe CONDORELLI #else 321a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef Byte FAR Bytef; 322*dce3d797SGiuseppe CONDORELLI #endif 323a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef char FAR charf; 324a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef int FAR intf; 325a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef uInt FAR uIntf; 326a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef uLong FAR uLongf; 327a31e091aSJean-Christophe PLAGNIOL-VILLARD 328a31e091aSJean-Christophe PLAGNIOL-VILLARD #ifdef STDC 329*dce3d797SGiuseppe CONDORELLI typedef void const *voidpc; 330a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef void FAR *voidpf; 331a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef void *voidp; 332a31e091aSJean-Christophe PLAGNIOL-VILLARD #else 333*dce3d797SGiuseppe CONDORELLI typedef Byte const *voidpc; 334a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef Byte FAR *voidpf; 335a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef Byte *voidp; 336a31e091aSJean-Christophe PLAGNIOL-VILLARD #endif 337a31e091aSJean-Christophe PLAGNIOL-VILLARD 338*dce3d797SGiuseppe CONDORELLI # ifdef VMS 339*dce3d797SGiuseppe CONDORELLI # include <unixio.h> /* for off_t */ 340*dce3d797SGiuseppe CONDORELLI # endif 341*dce3d797SGiuseppe CONDORELLI # define z_off_t off_t 342*dce3d797SGiuseppe CONDORELLI #ifndef SEEK_SET 343*dce3d797SGiuseppe CONDORELLI # define SEEK_SET 0 /* Seek from beginning of file. */ 344*dce3d797SGiuseppe CONDORELLI # define SEEK_CUR 1 /* Seek from current position. */ 345*dce3d797SGiuseppe CONDORELLI # define SEEK_END 2 /* Set file pointer to EOF plus "offset" */ 346*dce3d797SGiuseppe CONDORELLI #endif 347*dce3d797SGiuseppe CONDORELLI #ifndef z_off_t 348*dce3d797SGiuseppe CONDORELLI # define z_off_t long 349*dce3d797SGiuseppe CONDORELLI #endif 350a31e091aSJean-Christophe PLAGNIOL-VILLARD 351*dce3d797SGiuseppe CONDORELLI #if defined(__OS400__) 352*dce3d797SGiuseppe CONDORELLI # define NO_vsnprintf 353*dce3d797SGiuseppe CONDORELLI #endif 354*dce3d797SGiuseppe CONDORELLI 355*dce3d797SGiuseppe CONDORELLI #if defined(__MVS__) 356*dce3d797SGiuseppe CONDORELLI # define NO_vsnprintf 357*dce3d797SGiuseppe CONDORELLI # ifdef FAR 358*dce3d797SGiuseppe CONDORELLI # undef FAR 359*dce3d797SGiuseppe CONDORELLI # endif 360*dce3d797SGiuseppe CONDORELLI #endif 361*dce3d797SGiuseppe CONDORELLI 362*dce3d797SGiuseppe CONDORELLI /* MVS linker does not support external names larger than 8 bytes */ 363*dce3d797SGiuseppe CONDORELLI #if defined(__MVS__) 364*dce3d797SGiuseppe CONDORELLI # pragma map(deflateInit_,"DEIN") 365*dce3d797SGiuseppe CONDORELLI # pragma map(deflateInit2_,"DEIN2") 366*dce3d797SGiuseppe CONDORELLI # pragma map(deflateEnd,"DEEND") 367*dce3d797SGiuseppe CONDORELLI # pragma map(deflateBound,"DEBND") 368*dce3d797SGiuseppe CONDORELLI # pragma map(inflateInit_,"ININ") 369*dce3d797SGiuseppe CONDORELLI # pragma map(inflateInit2_,"ININ2") 370*dce3d797SGiuseppe CONDORELLI # pragma map(inflateEnd,"INEND") 371*dce3d797SGiuseppe CONDORELLI # pragma map(inflateSync,"INSY") 372*dce3d797SGiuseppe CONDORELLI # pragma map(inflateSetDictionary,"INSEDI") 373*dce3d797SGiuseppe CONDORELLI # pragma map(compressBound,"CMBND") 374*dce3d797SGiuseppe CONDORELLI # pragma map(inflate_table,"INTABL") 375*dce3d797SGiuseppe CONDORELLI # pragma map(inflate_fast,"INFA") 376*dce3d797SGiuseppe CONDORELLI # pragma map(inflate_copyright,"INCOPY") 377*dce3d797SGiuseppe CONDORELLI #endif 378*dce3d797SGiuseppe CONDORELLI /* End of new zconf.h */ 379a31e091aSJean-Christophe PLAGNIOL-VILLARD 380a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 381a31e091aSJean-Christophe PLAGNIOL-VILLARD The 'zlib' compression library provides in-memory compression and 382a31e091aSJean-Christophe PLAGNIOL-VILLARD decompression functions, including integrity checks of the uncompressed 383a31e091aSJean-Christophe PLAGNIOL-VILLARD data. This version of the library supports only one compression method 384*dce3d797SGiuseppe CONDORELLI (deflation) but other algorithms will be added later and will have the same 385a31e091aSJean-Christophe PLAGNIOL-VILLARD stream interface. 386a31e091aSJean-Christophe PLAGNIOL-VILLARD 387a31e091aSJean-Christophe PLAGNIOL-VILLARD Compression can be done in a single step if the buffers are large 388a31e091aSJean-Christophe PLAGNIOL-VILLARD enough (for example if an input file is mmap'ed), or can be done by 389a31e091aSJean-Christophe PLAGNIOL-VILLARD repeated calls of the compression function. In the latter case, the 390a31e091aSJean-Christophe PLAGNIOL-VILLARD application must provide more input and/or consume the output 391a31e091aSJean-Christophe PLAGNIOL-VILLARD (providing more output space) before each call. 392*dce3d797SGiuseppe CONDORELLI 393*dce3d797SGiuseppe CONDORELLI The compressed data format used by default by the in-memory functions is 394*dce3d797SGiuseppe CONDORELLI the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped 395*dce3d797SGiuseppe CONDORELLI around a deflate stream, which is itself documented in RFC 1951. 396*dce3d797SGiuseppe CONDORELLI 397*dce3d797SGiuseppe CONDORELLI The library also supports reading and writing files in gzip (.gz) format 398*dce3d797SGiuseppe CONDORELLI with an interface similar to that of stdio using the functions that start 399*dce3d797SGiuseppe CONDORELLI with "gz". The gzip format is different from the zlib format. gzip is a 400*dce3d797SGiuseppe CONDORELLI gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. 401*dce3d797SGiuseppe CONDORELLI 402*dce3d797SGiuseppe CONDORELLI This library can optionally read and write gzip streams in memory as well. 403*dce3d797SGiuseppe CONDORELLI 404*dce3d797SGiuseppe CONDORELLI The zlib format was designed to be compact and fast for use in memory 405*dce3d797SGiuseppe CONDORELLI and on communications channels. The gzip format was designed for single- 406*dce3d797SGiuseppe CONDORELLI file compression on file systems, has a larger header than zlib to maintain 407*dce3d797SGiuseppe CONDORELLI directory information, and uses a different, slower check method than zlib. 408*dce3d797SGiuseppe CONDORELLI 409*dce3d797SGiuseppe CONDORELLI The library does not install any signal handler. The decoder checks 410*dce3d797SGiuseppe CONDORELLI the consistency of the compressed data, so the library should never 411*dce3d797SGiuseppe CONDORELLI crash even in case of corrupted input. 412a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 413a31e091aSJean-Christophe PLAGNIOL-VILLARD 414a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); 415*dce3d797SGiuseppe CONDORELLI typedef void (*free_func) OF((voidpf opaque, voidpf address, uInt size)); 416a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef void (*cb_func) OF((Bytef *buf, uInt len)); 417a31e091aSJean-Christophe PLAGNIOL-VILLARD 418a31e091aSJean-Christophe PLAGNIOL-VILLARD struct internal_state; 419a31e091aSJean-Christophe PLAGNIOL-VILLARD 420a31e091aSJean-Christophe PLAGNIOL-VILLARD typedef struct z_stream_s { 421a31e091aSJean-Christophe PLAGNIOL-VILLARD Bytef *next_in; /* next input byte */ 422a31e091aSJean-Christophe PLAGNIOL-VILLARD uInt avail_in; /* number of bytes available at next_in */ 423a31e091aSJean-Christophe PLAGNIOL-VILLARD uLong total_in; /* total nb of input bytes read so far */ 424a31e091aSJean-Christophe PLAGNIOL-VILLARD Bytef *next_out; /* next output byte should be put there */ 425a31e091aSJean-Christophe PLAGNIOL-VILLARD uInt avail_out; /* remaining free space at next_out */ 426a31e091aSJean-Christophe PLAGNIOL-VILLARD uLong total_out; /* total nb of bytes output so far */ 427a31e091aSJean-Christophe PLAGNIOL-VILLARD char *msg; /* last error message, NULL if no error */ 428a31e091aSJean-Christophe PLAGNIOL-VILLARD struct internal_state FAR *state; /* not visible by applications */ 429a31e091aSJean-Christophe PLAGNIOL-VILLARD alloc_func zalloc; /* used to allocate the internal state */ 430a31e091aSJean-Christophe PLAGNIOL-VILLARD free_func zfree; /* used to free the internal state */ 431*dce3d797SGiuseppe CONDORELLI voidpf opaque; /* private data object passed to zalloc and zfree */ 432*dce3d797SGiuseppe CONDORELLI int data_type; /* best guess about the data type: 433*dce3d797SGiuseppe CONDORELLI binary or text */ 434a31e091aSJean-Christophe PLAGNIOL-VILLARD cb_func outcb; /* called regularly just before blocks of output */ 435*dce3d797SGiuseppe CONDORELLI uLong adler; /* adler32 value of the uncompressed data */ 436*dce3d797SGiuseppe CONDORELLI uLong reserved; /* reserved for future use */ 437a31e091aSJean-Christophe PLAGNIOL-VILLARD } z_stream; 438a31e091aSJean-Christophe PLAGNIOL-VILLARD 439*dce3d797SGiuseppe CONDORELLI typedef z_stream FAR *z_streamp; 440*dce3d797SGiuseppe CONDORELLI 441a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 442*dce3d797SGiuseppe CONDORELLI gzip header information passed to and from zlib routines. See RFC 1952 443*dce3d797SGiuseppe CONDORELLI for more details on the meanings of these fields. 444f33b325aSWolfgang Denk */ 445*dce3d797SGiuseppe CONDORELLI typedef struct gz_header_s { 446*dce3d797SGiuseppe CONDORELLI int text; /* true if compressed data believed to be text */ 447*dce3d797SGiuseppe CONDORELLI uLong time; /* modification time */ 448*dce3d797SGiuseppe CONDORELLI int xflags; /* extra flags (not used when writing a gzip file) */ 449*dce3d797SGiuseppe CONDORELLI int os; /* operating system */ 450*dce3d797SGiuseppe CONDORELLI Bytef *extra; /* pointer to extra field or Z_NULL if none */ 451*dce3d797SGiuseppe CONDORELLI uInt extra_len; /* extra field length (valid if extra != Z_NULL) */ 452*dce3d797SGiuseppe CONDORELLI uInt extra_max; /* space at extra (only when reading header) */ 453*dce3d797SGiuseppe CONDORELLI Bytef *name; /* pointer to zero-terminated file name or Z_NULL */ 454*dce3d797SGiuseppe CONDORELLI uInt name_max; /* space at name (only when reading header) */ 455*dce3d797SGiuseppe CONDORELLI Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */ 456*dce3d797SGiuseppe CONDORELLI uInt comm_max; /* space at comment (only when reading header) */ 457*dce3d797SGiuseppe CONDORELLI int hcrc; /* true if there was or will be a header crc */ 458*dce3d797SGiuseppe CONDORELLI int done; /* true when done reading gzip header (not used 459*dce3d797SGiuseppe CONDORELLI when writing a gzip file) */ 460*dce3d797SGiuseppe CONDORELLI } gz_header; 461*dce3d797SGiuseppe CONDORELLI 462*dce3d797SGiuseppe CONDORELLI typedef gz_header FAR *gz_headerp; 463a31e091aSJean-Christophe PLAGNIOL-VILLARD 464a31e091aSJean-Christophe PLAGNIOL-VILLARD /* constants */ 465a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_NO_FLUSH 0 466*dce3d797SGiuseppe CONDORELLI #define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */ 467*dce3d797SGiuseppe CONDORELLI #define Z_SYNC_FLUSH 2 468*dce3d797SGiuseppe CONDORELLI #define Z_FULL_FLUSH 3 469a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_FINISH 4 470*dce3d797SGiuseppe CONDORELLI #define Z_BLOCK 5 471*dce3d797SGiuseppe CONDORELLI /* Allowed flush values; see deflate() and inflate() below for details */ 472a31e091aSJean-Christophe PLAGNIOL-VILLARD 473a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_OK 0 474a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_STREAM_END 1 475*dce3d797SGiuseppe CONDORELLI #define Z_NEED_DICT 2 476a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_ERRNO (-1) 477a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_STREAM_ERROR (-2) 478a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_DATA_ERROR (-3) 479a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_MEM_ERROR (-4) 480a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_BUF_ERROR (-5) 481*dce3d797SGiuseppe CONDORELLI #define Z_VERSION_ERROR (-6) 482*dce3d797SGiuseppe CONDORELLI /* Return codes for the compression/decompression functions. Negative 483*dce3d797SGiuseppe CONDORELLI * values are errors, positive values are used for special but normal events. 484*dce3d797SGiuseppe CONDORELLI */ 485a31e091aSJean-Christophe PLAGNIOL-VILLARD 486*dce3d797SGiuseppe CONDORELLI #define Z_NO_COMPRESSION 0 487a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_BEST_SPEED 1 488a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_BEST_COMPRESSION 9 489a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_DEFAULT_COMPRESSION (-1) 490a31e091aSJean-Christophe PLAGNIOL-VILLARD /* compression levels */ 491a31e091aSJean-Christophe PLAGNIOL-VILLARD 492a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_FILTERED 1 493a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_HUFFMAN_ONLY 2 494*dce3d797SGiuseppe CONDORELLI #define Z_RLE 3 495*dce3d797SGiuseppe CONDORELLI #define Z_FIXED 4 496a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_DEFAULT_STRATEGY 0 497*dce3d797SGiuseppe CONDORELLI /* compression strategy; see deflateInit2() below for details */ 498a31e091aSJean-Christophe PLAGNIOL-VILLARD 499a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_BINARY 0 500*dce3d797SGiuseppe CONDORELLI #define Z_TEXT 1 501*dce3d797SGiuseppe CONDORELLI #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ 502a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_UNKNOWN 2 503*dce3d797SGiuseppe CONDORELLI /* Possible values of the data_type field (though see inflate()) */ 504*dce3d797SGiuseppe CONDORELLI 505*dce3d797SGiuseppe CONDORELLI #define Z_DEFLATED 8 506*dce3d797SGiuseppe CONDORELLI /* The deflate compression method (the only one supported in this version) */ 507a31e091aSJean-Christophe PLAGNIOL-VILLARD 508a31e091aSJean-Christophe PLAGNIOL-VILLARD #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ 509a31e091aSJean-Christophe PLAGNIOL-VILLARD 510f33b325aSWolfgang Denk /* basic functions */ 511a31e091aSJean-Christophe PLAGNIOL-VILLARD 512*dce3d797SGiuseppe CONDORELLI /* The application can compare zlibVersion and ZLIB_VERSION for consistency. 513*dce3d797SGiuseppe CONDORELLI If the first character differs, the library code actually used is 514*dce3d797SGiuseppe CONDORELLI not compatible with the zlib.h header file used by the application. 515*dce3d797SGiuseppe CONDORELLI This check is automatically made by deflateInit and inflateInit. 516f33b325aSWolfgang Denk */ 517f33b325aSWolfgang Denk 518*dce3d797SGiuseppe CONDORELLI ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm, const char *version, 519*dce3d797SGiuseppe CONDORELLI int stream_size)); 520f33b325aSWolfgang Denk 521*dce3d797SGiuseppe CONDORELLI ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush)); 522f33b325aSWolfgang Denk /* 523*dce3d797SGiuseppe CONDORELLI inflate decompresses as much data as possible, and stops when the input 524*dce3d797SGiuseppe CONDORELLI buffer becomes empty or the output buffer becomes full. It may introduce 525*dce3d797SGiuseppe CONDORELLI some output latency (reading input without producing any output) except when 526*dce3d797SGiuseppe CONDORELLI forced to flush. 527*dce3d797SGiuseppe CONDORELLI 528*dce3d797SGiuseppe CONDORELLI The detailed semantics are as follows. inflate performs one or both of the 529*dce3d797SGiuseppe CONDORELLI following actions: 530a31e091aSJean-Christophe PLAGNIOL-VILLARD 531a31e091aSJean-Christophe PLAGNIOL-VILLARD - Decompress more input starting at next_in and update next_in and avail_in 532a31e091aSJean-Christophe PLAGNIOL-VILLARD accordingly. If not all input can be processed (because there is not 533a31e091aSJean-Christophe PLAGNIOL-VILLARD enough room in the output buffer), next_in is updated and processing 534a31e091aSJean-Christophe PLAGNIOL-VILLARD will resume at this point for the next call of inflate(). 535a31e091aSJean-Christophe PLAGNIOL-VILLARD 536a31e091aSJean-Christophe PLAGNIOL-VILLARD - Provide more output starting at next_out and update next_out and avail_out 537*dce3d797SGiuseppe CONDORELLI accordingly. inflate() provides as much output as possible, until there 538*dce3d797SGiuseppe CONDORELLI is no more input data or no more space in the output buffer (see below 539*dce3d797SGiuseppe CONDORELLI about the flush parameter). 540a31e091aSJean-Christophe PLAGNIOL-VILLARD 541a31e091aSJean-Christophe PLAGNIOL-VILLARD Before the call of inflate(), the application should ensure that at least 542a31e091aSJean-Christophe PLAGNIOL-VILLARD one of the actions is possible, by providing more input and/or consuming 543a31e091aSJean-Christophe PLAGNIOL-VILLARD more output, and updating the next_* and avail_* values accordingly. 544a31e091aSJean-Christophe PLAGNIOL-VILLARD The application can consume the uncompressed output when it wants, for 545a31e091aSJean-Christophe PLAGNIOL-VILLARD example when the output buffer is full (avail_out == 0), or after each 546*dce3d797SGiuseppe CONDORELLI call of inflate(). If inflate returns Z_OK and with zero avail_out, it 547*dce3d797SGiuseppe CONDORELLI must be called again after making room in the output buffer because there 548*dce3d797SGiuseppe CONDORELLI might be more output pending. 549a31e091aSJean-Christophe PLAGNIOL-VILLARD 550*dce3d797SGiuseppe CONDORELLI The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, 551*dce3d797SGiuseppe CONDORELLI Z_FINISH, or Z_BLOCK. Z_SYNC_FLUSH requests that inflate() flush as much 552*dce3d797SGiuseppe CONDORELLI output as possible to the output buffer. Z_BLOCK requests that inflate() stop 553*dce3d797SGiuseppe CONDORELLI if and when it gets to the next deflate block boundary. When decoding the 554*dce3d797SGiuseppe CONDORELLI zlib or gzip format, this will cause inflate() to return immediately after 555*dce3d797SGiuseppe CONDORELLI the header and before the first block. When doing a raw inflate, inflate() 556*dce3d797SGiuseppe CONDORELLI will go ahead and process the first block, and will return when it gets to 557*dce3d797SGiuseppe CONDORELLI the end of that block, or when it runs out of data. 558*dce3d797SGiuseppe CONDORELLI 559*dce3d797SGiuseppe CONDORELLI The Z_BLOCK option assists in appending to or combining deflate streams. 560*dce3d797SGiuseppe CONDORELLI Also to assist in this, on return inflate() will set strm->data_type to the 561*dce3d797SGiuseppe CONDORELLI number of unused bits in the last byte taken from strm->next_in, plus 64 562*dce3d797SGiuseppe CONDORELLI if inflate() is currently decoding the last block in the deflate stream, 563*dce3d797SGiuseppe CONDORELLI plus 128 if inflate() returned immediately after decoding an end-of-block 564*dce3d797SGiuseppe CONDORELLI code or decoding the complete header up to just before the first byte of the 565*dce3d797SGiuseppe CONDORELLI deflate stream. The end-of-block will not be indicated until all of the 566*dce3d797SGiuseppe CONDORELLI uncompressed data from that block has been written to strm->next_out. The 567*dce3d797SGiuseppe CONDORELLI number of unused bits may in general be greater than seven, except when 568*dce3d797SGiuseppe CONDORELLI bit 7 of data_type is set, in which case the number of unused bits will be 569*dce3d797SGiuseppe CONDORELLI less than eight. 570a31e091aSJean-Christophe PLAGNIOL-VILLARD 571a31e091aSJean-Christophe PLAGNIOL-VILLARD inflate() should normally be called until it returns Z_STREAM_END or an 572a31e091aSJean-Christophe PLAGNIOL-VILLARD error. However if all decompression is to be performed in a single step 573a31e091aSJean-Christophe PLAGNIOL-VILLARD (a single call of inflate), the parameter flush should be set to 574a31e091aSJean-Christophe PLAGNIOL-VILLARD Z_FINISH. In this case all pending input is processed and all pending 575a31e091aSJean-Christophe PLAGNIOL-VILLARD output is flushed; avail_out must be large enough to hold all the 576a31e091aSJean-Christophe PLAGNIOL-VILLARD uncompressed data. (The size of the uncompressed data may have been saved 577a31e091aSJean-Christophe PLAGNIOL-VILLARD by the compressor for this purpose.) The next operation on this stream must 578a31e091aSJean-Christophe PLAGNIOL-VILLARD be inflateEnd to deallocate the decompression state. The use of Z_FINISH 579*dce3d797SGiuseppe CONDORELLI is never required, but can be used to inform inflate that a faster approach 580a31e091aSJean-Christophe PLAGNIOL-VILLARD may be used for the single inflate() call. 581a31e091aSJean-Christophe PLAGNIOL-VILLARD 582*dce3d797SGiuseppe CONDORELLI In this implementation, inflate() always flushes as much output as 583*dce3d797SGiuseppe CONDORELLI possible to the output buffer, and always uses the faster approach on the 584*dce3d797SGiuseppe CONDORELLI first call. So the only effect of the flush parameter in this implementation 585*dce3d797SGiuseppe CONDORELLI is on the return value of inflate(), as noted below, or when it returns early 586*dce3d797SGiuseppe CONDORELLI because Z_BLOCK is used. 587a31e091aSJean-Christophe PLAGNIOL-VILLARD 588*dce3d797SGiuseppe CONDORELLI If a preset dictionary is needed after this call (see inflateSetDictionary 589*dce3d797SGiuseppe CONDORELLI below), inflate sets strm->adler to the adler32 checksum of the dictionary 590*dce3d797SGiuseppe CONDORELLI chosen by the compressor and returns Z_NEED_DICT; otherwise it sets 591*dce3d797SGiuseppe CONDORELLI strm->adler to the adler32 checksum of all output produced so far (that is, 592*dce3d797SGiuseppe CONDORELLI total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described 593*dce3d797SGiuseppe CONDORELLI below. At the end of the stream, inflate() checks that its computed adler32 594*dce3d797SGiuseppe CONDORELLI checksum is equal to that saved by the compressor and returns Z_STREAM_END 595*dce3d797SGiuseppe CONDORELLI only if the checksum is correct. 596a31e091aSJean-Christophe PLAGNIOL-VILLARD 597*dce3d797SGiuseppe CONDORELLI inflate() will decompress and check either zlib-wrapped or gzip-wrapped 598*dce3d797SGiuseppe CONDORELLI deflate data. The header type is detected automatically. Any information 599*dce3d797SGiuseppe CONDORELLI contained in the gzip header is not retained, so applications that need that 600*dce3d797SGiuseppe CONDORELLI information should instead use raw inflate, see inflateInit2() below, or 601*dce3d797SGiuseppe CONDORELLI inflateBack() and perform their own processing of the gzip header and 602*dce3d797SGiuseppe CONDORELLI trailer. 603*dce3d797SGiuseppe CONDORELLI 604*dce3d797SGiuseppe CONDORELLI inflate() returns Z_OK if some progress has been made (more input processed 605*dce3d797SGiuseppe CONDORELLI or more output produced), Z_STREAM_END if the end of the compressed data has 606*dce3d797SGiuseppe CONDORELLI been reached and all uncompressed output has been produced, Z_NEED_DICT if a 607*dce3d797SGiuseppe CONDORELLI preset dictionary is needed at this point, Z_DATA_ERROR if the input data was 608*dce3d797SGiuseppe CONDORELLI corrupted (input stream not conforming to the zlib format or incorrect check 609*dce3d797SGiuseppe CONDORELLI value), Z_STREAM_ERROR if the stream structure was inconsistent (for example 610*dce3d797SGiuseppe CONDORELLI if next_in or next_out was NULL), Z_MEM_ERROR if there was not enough memory, 611*dce3d797SGiuseppe CONDORELLI Z_BUF_ERROR if no progress is possible or if there was not enough room in the 612*dce3d797SGiuseppe CONDORELLI output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and 613*dce3d797SGiuseppe CONDORELLI inflate() can be called again with more input and more output space to 614*dce3d797SGiuseppe CONDORELLI continue decompressing. If Z_DATA_ERROR is returned, the application may then 615*dce3d797SGiuseppe CONDORELLI call inflateSync() to look for a good compression block if a partial recovery 616*dce3d797SGiuseppe CONDORELLI of the data is desired. 617*dce3d797SGiuseppe CONDORELLI */ 618*dce3d797SGiuseppe CONDORELLI 619*dce3d797SGiuseppe CONDORELLI ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm)); 620a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 621a31e091aSJean-Christophe PLAGNIOL-VILLARD All dynamically allocated data structures for this stream are freed. 622a31e091aSJean-Christophe PLAGNIOL-VILLARD This function discards any unprocessed input and does not flush any 623a31e091aSJean-Christophe PLAGNIOL-VILLARD pending output. 624a31e091aSJean-Christophe PLAGNIOL-VILLARD 625a31e091aSJean-Christophe PLAGNIOL-VILLARD inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state 626a31e091aSJean-Christophe PLAGNIOL-VILLARD was inconsistent. In the error case, msg may be set but then points to a 627a31e091aSJean-Christophe PLAGNIOL-VILLARD static string (which must not be deallocated). 628a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 629a31e091aSJean-Christophe PLAGNIOL-VILLARD 630*dce3d797SGiuseppe CONDORELLI /* Advanced functions */ 631a31e091aSJean-Christophe PLAGNIOL-VILLARD 632*dce3d797SGiuseppe CONDORELLI ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm)); 633f33b325aSWolfgang Denk 634*dce3d797SGiuseppe CONDORELLI /* utility functions */ 635f33b325aSWolfgang Denk 636f33b325aSWolfgang Denk /* 637*dce3d797SGiuseppe CONDORELLI The following utility functions are implemented on top of the 638*dce3d797SGiuseppe CONDORELLI basic stream-oriented functions. To simplify the interface, some 639*dce3d797SGiuseppe CONDORELLI default options are assumed (compression level and memory usage, 640*dce3d797SGiuseppe CONDORELLI standard memory allocation functions). The source code of these 641*dce3d797SGiuseppe CONDORELLI utility functions can easily be modified if you need special options. 642f33b325aSWolfgang Denk */ 643f33b325aSWolfgang Denk 644*dce3d797SGiuseppe CONDORELLI ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); 645a31e091aSJean-Christophe PLAGNIOL-VILLARD /* 646a31e091aSJean-Christophe PLAGNIOL-VILLARD Update a running Adler-32 checksum with the bytes buf[0..len-1] and 647a31e091aSJean-Christophe PLAGNIOL-VILLARD return the updated checksum. If buf is NULL, this function returns 648a31e091aSJean-Christophe PLAGNIOL-VILLARD the required initial value for the checksum. 649a31e091aSJean-Christophe PLAGNIOL-VILLARD An Adler-32 checksum is almost as reliable as a CRC32 but can be computed 650a31e091aSJean-Christophe PLAGNIOL-VILLARD much faster. Usage example: 651a31e091aSJean-Christophe PLAGNIOL-VILLARD 652a31e091aSJean-Christophe PLAGNIOL-VILLARD uLong adler = adler32(0L, Z_NULL, 0); 653a31e091aSJean-Christophe PLAGNIOL-VILLARD 654a31e091aSJean-Christophe PLAGNIOL-VILLARD while (read_buffer(buffer, length) != EOF) { 655a31e091aSJean-Christophe PLAGNIOL-VILLARD adler = adler32(adler, buffer, length); 656a31e091aSJean-Christophe PLAGNIOL-VILLARD } 657a31e091aSJean-Christophe PLAGNIOL-VILLARD if (adler != original_adler) error(); 658a31e091aSJean-Christophe PLAGNIOL-VILLARD */ 659a31e091aSJean-Christophe PLAGNIOL-VILLARD 660*dce3d797SGiuseppe CONDORELLI /* 661*dce3d797SGiuseppe CONDORELLI Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 662*dce3d797SGiuseppe CONDORELLI and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for 663*dce3d797SGiuseppe CONDORELLI each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of 664*dce3d797SGiuseppe CONDORELLI seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. 665*dce3d797SGiuseppe CONDORELLI */ 666*dce3d797SGiuseppe CONDORELLI 667*dce3d797SGiuseppe CONDORELLI ZEXTERN uInt ZEXPORT crc32 OF((uInt crc, const Bytef *buf, uInt len)); 668*dce3d797SGiuseppe CONDORELLI /* 669*dce3d797SGiuseppe CONDORELLI Update a running CRC-32 with the bytes buf[0..len-1] and return the 670*dce3d797SGiuseppe CONDORELLI updated CRC-32. If buf is NULL, this function returns the required initial 671*dce3d797SGiuseppe CONDORELLI value for the for the crc. Pre- and post-conditioning (one's complement) is 672*dce3d797SGiuseppe CONDORELLI performed within this function so it shouldn't be done by the application. 673*dce3d797SGiuseppe CONDORELLI Usage example: 674*dce3d797SGiuseppe CONDORELLI 675*dce3d797SGiuseppe CONDORELLI uLong crc = crc32(0L, Z_NULL, 0); 676*dce3d797SGiuseppe CONDORELLI 677*dce3d797SGiuseppe CONDORELLI while (read_buffer(buffer, length) != EOF) { 678*dce3d797SGiuseppe CONDORELLI crc = crc32(crc, buffer, length); 679*dce3d797SGiuseppe CONDORELLI } 680*dce3d797SGiuseppe CONDORELLI if (crc != original_crc) error(); 681*dce3d797SGiuseppe CONDORELLI */ 682*dce3d797SGiuseppe CONDORELLI 683*dce3d797SGiuseppe CONDORELLI ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits, 684*dce3d797SGiuseppe CONDORELLI const char *version, int stream_size)); 685*dce3d797SGiuseppe CONDORELLI #define inflateInit(strm) \ 686*dce3d797SGiuseppe CONDORELLI inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream)) 687*dce3d797SGiuseppe CONDORELLI #define inflateInit2(strm, windowBits) \ 688*dce3d797SGiuseppe CONDORELLI inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream)) 689*dce3d797SGiuseppe CONDORELLI 690*dce3d797SGiuseppe CONDORELLI #if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL) 691a31e091aSJean-Christophe PLAGNIOL-VILLARD struct internal_state {int dummy;}; /* hack for buggy compilers */ 692a31e091aSJean-Christophe PLAGNIOL-VILLARD #endif 693a31e091aSJean-Christophe PLAGNIOL-VILLARD 694*dce3d797SGiuseppe CONDORELLI #ifdef __cplusplus 695*dce3d797SGiuseppe CONDORELLI } 696*dce3d797SGiuseppe CONDORELLI #endif 697*dce3d797SGiuseppe CONDORELLI 698*dce3d797SGiuseppe CONDORELLI #endif /* ZLIB_H */ 699