Skip to content

Commit

Permalink
zlib 1.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
madler committed Sep 10, 2011
1 parent 423eb40 commit e26a448
Show file tree
Hide file tree
Showing 22 changed files with 379 additions and 119 deletions.
10 changes: 10 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@

ChangeLog file for zlib

Changes in 1.0.2 (23 May 96)
- added Windows DLL support
- added a function zlibVersion (for the DLL support)
- fixed declarations using Bytef in infutil.c (pb with MSDOS medium model)
- Bytef is define's instead of typedef'd only for Borland C
- avoid reading uninitialized memory in example.c
- mention in README that the zlib format is now RFC1950
- updated Makefile.dj2
- added algorithm.doc

Changes in 1.0.1 (20 May 96) [1.0 skipped to avoid confusion]
- fix array overlay in deflate.c which sometimes caused bad compressed data
- fix inflate bug with empty stored block
Expand Down
4 changes: 4 additions & 0 deletions INDEX
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,12 @@ Makefile.sas makefile for Amiga SAS/C
Makefile.tc makefile for Turbo C
Makefile.wat makefile for Watcom C
README guess what
algorithm.doc description of the compression & decompression algorithms
configure configure script for Unix
descrip.mms makefile for Vax/VMS
zlib.def definition file for Windows DLL
zlib.rc definition file for Windows DLL


zlib public header files (must be kept):
zconf.h
Expand Down
9 changes: 5 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ CFLAGS=-O
LDFLAGS=-L. -lz
LDSHARED=$(CC)

VER=1.0.1
VER=1.0.2
LIBS=libz.a

AR=ar rc
Expand All @@ -37,7 +37,8 @@ OBJS = adler32.o compress.o crc32.o gzio.o uncompr.o deflate.o trees.o \

TEST_OBJS = example.o minigzip.o

DISTFILES = README INDEX ChangeLog configure Make*[a-z0-9] descrip.mms *.[ch]
DISTFILES = README INDEX ChangeLog configure Make*[a-z0-9] descrip.mms \
zlib.def zlib.rc algorithm.doc *.[ch]

all: example minigzip

Expand Down Expand Up @@ -85,8 +86,8 @@ clean:

zip:
mv Makefile Makefile~; cp -p Makefile.in Makefile
v=`sed -n -e 's/\./-/g' -e '/VERSION "/s/.*"\(.*\)".*/\1/p' < zlib.h`;\
zip -ul9 zlib-$$v $(DISTFILES)
v=`sed -n -e 's/\.//g' -e '/VERSION "/s/.*"\(.*\)".*/\1/p' < zlib.h`;\
zip -ul9 zlib$$v $(DISTFILES)
mv Makefile~ Makefile

dist:
Expand Down
61 changes: 40 additions & 21 deletions Makefile.dj2
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,51 @@
# Copyright (C) 1995-1996 Jean-loup Gailly.
# For conditions of distribution and use, see copyright notice in zlib.h

# To compile and test, type:
# To compile, or to compile and test, type:
#
# make -fmakefile.dj2; make test -fmakefile.dj2

#
# To install libz.a, zconf.h and zlib.h in the djgpp directories, type:
#
# make install -fmakefile.dj2
# after first defining LIBRARY_PATH and INCLUDE_PATH in djgpp.env for [make].
# Alternately these variables may be defined below.
#
# after first defining LIBRARY_PATH and INCLUDE_PATH in djgpp.env as
# in the sample below if the pattern of the DJGPP distribution is to
# be followed. Remember that, while <sp>'es around <=> are ignored in
# makefiles, they are *not* in batch files or in djgpp.env.
# - - - - -
# [make]
# INCLUDE_PATH=%\>;INCLUDE_PATH%%\DJDIR%\include
# LIBRARY_PATH=%\>;LIBRARY_PATH%%\DJDIR%\lib
# BUTT=-m486
# - - - - -
# Alternately, these variables may be defined below, overriding the values
# in djgpp.env, as
INCLUDE_PATH=c:\usr\include

CC=gcc

#CFLAGS=-MMD -O
#CFLAGS=-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7
#CFLAGS=-MMD -g -DDEBUG
CFLAGS=-MMD -O3 -Wall -Wwrite-strings -Wpointer-arith -Wconversion \
-Wstrict-prototypes -Wmissing-prototypes
CFLAGS=-MMD -O3 $(BUTT) -Wall -Wwrite-strings -Wpointer-arith -Wconversion \
-Wstrict-prototypes -Wmissing-prototypes

# If cp.exe is not found, replace with copy /Y .
CP=cp -f
# If install.exe is not found, replace with $(CP).
INSTALL=install
# The default value of RM is "rm -f." If "rm.exe" is not found, uncomment:
# RM=del
LDLIBS=-L. -lz
LD=$(CC) -s -o
LDSHARED=$(CC)

VER=1.0
VER=1.0.2
INCL=zlib.h zconf.h
LIBS=libz.a

AR=ar rcs
# The default value of RM is "rm -f." If "rm.exe" is not found, uncomment:
# RM=del

prefix=/usr/local
exec_prefix = $(prefix)
Expand All @@ -37,10 +56,6 @@ OBJS = adler32.o compress.o crc32.o gzio.o uncompr.o deflate.o trees.o \

TEST_OBJS = example.o minigzip.o

DISTFILES = README Change.Log configur Makefile.in Makefile Makefile.msc \
Makefile.bor Makefile.tc Make_vms.com descrip.mms zlib099.pat \
*.bak *.old *.[ch]

all: example.exe minigzip.exe

test: all
Expand All @@ -55,23 +70,27 @@ libz.a: $(OBJS)

libz.so.$(VER): $(OBJS)
$(LDSHARED) -o $@ $(OBJS)
rm -f libz.so; ln -s $@ libz.so
$(RM) libz.so; ln -s $@ libz.so

%.exe : %.o $(LIBS)
$(LD) $@ $< $(LDLIBS)

# INCLUDE_PATH and LIBRARY_PATH were set for [make] in djgpp.env
# INCLUDE_PATH and LIBRARY_PATH were set for [make] in djgpp.env .

.PHONY : uninstall clean

install: $(LIBS)
$(INSTALL) zlib.h zconf.h $(INCLUDE_PATH)
$(INSTALL) $(LIBS) $(LIBRARY_PATH)
install: $(INCL) $(LIBS)
-@if not exist $(INCLUDE_PATH)\nul mkdir $(INCLUDE_PATH)
-@if not exist $(LIBRARY_PATH)\nul mkdir $(LIBRARY_PATH)
for %%f in ($(INCL)) do $(INSTALL) %%f $(INCLUDE_PATH)
for %%p in ($(LIBS)) do $(INSTALL) %%p $(LIBRARY_PATH)

uninstall:
$(RM) $(LIBRARY_PATH)/$(LIBS)
$(RM) $(INCLUDE_PATH)/zlib.h $(INCLUDE_PATH)/zconf.h
for %%f in ($(INCL)) do $(RM) $(INCLUDE_PATH)\%%f
for %%p in ($(LIBS)) do $(RM) $(LIBRARY_PATH)\%%p

clean:
$(RM) *.d *.o *.~ *.exe libz.a libz.so* foo.gz
for %%p in (*.d *.o *.exe libz.a libz.so*) do $(RM) %%p

DEPS := $(wildcard *.d)
ifneq ($(DEPS),)
Expand Down
9 changes: 5 additions & 4 deletions Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ CFLAGS=-O
LDFLAGS=-L. -lz
LDSHARED=$(CC)

VER=1.0.1
VER=1.0.2
LIBS=libz.a

AR=ar rc
Expand All @@ -37,7 +37,8 @@ OBJS = adler32.o compress.o crc32.o gzio.o uncompr.o deflate.o trees.o \

TEST_OBJS = example.o minigzip.o

DISTFILES = README INDEX ChangeLog configure Make*[a-z0-9] descrip.mms *.[ch]
DISTFILES = README INDEX ChangeLog configure Make*[a-z0-9] descrip.mms \
zlib.def zlib.rc algorithm.doc *.[ch]

all: example minigzip

Expand Down Expand Up @@ -85,8 +86,8 @@ clean:

zip:
mv Makefile Makefile~; cp -p Makefile.in Makefile
v=`sed -n -e 's/\./-/g' -e '/VERSION "/s/.*"\(.*\)".*/\1/p' < zlib.h`;\
zip -ul9 zlib-$$v $(DISTFILES)
v=`sed -n -e 's/\.//g' -e '/VERSION "/s/.*"\(.*\)".*/\1/p' < zlib.h`;\
zip -ul9 zlib$$v $(DISTFILES)
mv Makefile~ Makefile

dist:
Expand Down
29 changes: 19 additions & 10 deletions README
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
zlib 1.0.1 is a general purpose data compression library. All the code
zlib 1.0.2 is a general purpose data compression library. All the code
is reentrant (thread safe). The data format used by the zlib library
is described in the files zlib-3.3.doc, deflate-1.3.doc and
gzip-4.3.doc, available in various formats from
ftp://swrinde.nde.swri.edu/pub/png/documents/zlib/
is described by RFCs (Request for Comments) 1950 to 1952 in the files
ftp://ds.internic.net/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate
format) and rfc1952.txt (gzip format). These documents are also available in
other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html

All functions of the compression library are documented in the file
zlib.h. A usage example of the library is given in the file example.c
Expand All @@ -18,9 +19,8 @@ makefiles such as Makefile.msc; for VMS, use Make_vms.com or descrip.mms.
Questions about zlib should be sent to <zlib@quest.jpl.nasa.gov> or,
if this fails, to the addresses given below in the Copyright section.

The changes made in version 1.0.1 are documented in the file ChangeLog.
Version number 1.0 was skipped to avoid confusion with version 0.99
which had some references to 1.0 already. The main changes since 0.99 are:
The changes made in version 1.0.2 are documented in the file ChangeLog.
The main changes since 0.99 are:

- fix array overlay in deflate.c which sometimes caused bad compressed data
- fix inflate bug with empty stored block
Expand All @@ -30,6 +30,14 @@ which had some references to 1.0 already. The main changes since 0.99 are:
- new makefiles for DJGPP (Makefile.dj2), 32-bit Borland (Makefile.b32),
Watcom (Makefile.wat), Amiga SAS/C (Makefile.sas)
- several portability improvements
- added algorithm.doc
- added Windows DLL support
- added a function zlibVersion (for the DLL support)

A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk>
is in the CPAN (Comprehensive Perl Archive Network) sites, such as:
ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*


Notes for some targets:

Expand All @@ -46,9 +54,10 @@ Notes for some targets:
- zlib doesn't work on HP-UX 9.05 with one cc compiler (the one not
accepting the -O option). It works with the other cc compiler.

A Perl interface to zlib written by Paul Marquess <pmarquess@bfsec.bt.co.uk>
is in the CPAN (Comprehensive Perl Archive Network) sites, such as:
ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*
- To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc
and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL
For help on building a zlib DLL, contact Alessandro Iacopetti
<iaco@cicladi.unial.it>


Acknowledgments:
Expand Down
2 changes: 1 addition & 1 deletion adler32.c
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* For conditions of distribution and use, see copyright notice in zlib.h
*/

/* $Id: adler32.c,v 1.9 1996/01/30 21:59:09 me Exp $ */
/* $Id: adler32.c,v 1.10 1996/05/22 11:52:18 me Exp $ */

#include "zlib.h"

Expand Down
105 changes: 105 additions & 0 deletions algorithm.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
1. Compression algorithm (deflate)

The deflation algorithm used by zlib (also zip and gzip) is a variation of
LZ77 (Lempel-Ziv 1977, see reference below). It finds duplicated strings in
the input data. The second occurrence of a string is replaced by a
pointer to the previous string, in the form of a pair (distance,
length). Distances are limited to 32K bytes, and lengths are limited
to 258 bytes. When a string does not occur anywhere in the previous
32K bytes, it is emitted as a sequence of literal bytes. (In this
description, 'string' must be taken as an arbitrary sequence of bytes,
and is not restricted to printable characters.)

Literals or match lengths are compressed with one Huffman tree, and
match distances are compressed with another tree. The trees are stored
in a compact form at the start of each block. The blocks can have any
size (except that the compressed data for one block must fit in
available memory). A block is terminated when deflate() determines that
it would be useful to start another block with fresh trees. (This is
somewhat similar to compress.)

Duplicated strings are found using a hash table. All input strings of
length 3 are inserted in the hash table. A hash index is computed for
the next 3 bytes. If the hash chain for this index is not empty, all
strings in the chain are compared with the current input string, and
the longest match is selected.

The hash chains are searched starting with the most recent strings, to
favor small distances and thus take advantage of the Huffman encoding.
The hash chains are singly linked. There are no deletions from the
hash chains, the algorithm simply discards matches that are too old.

To avoid a worst-case situation, very long hash chains are arbitrarily
truncated at a certain length, determined by a runtime option (level
parameter of deflateInit). So deflate() does not always find the longest
possible match but generally finds a match which is long enough.

deflate() also defers the selection of matches with a lazy evaluation
mechanism. After a match of length N has been found, deflate() searches for a
longer match at the next input byte. If a longer match is found, the
previous match is truncated to a length of one (thus producing a single
literal byte) and the longer match is emitted afterwards. Otherwise,
the original match is kept, and the next match search is attempted only
N steps later.

The lazy match evaluation is also subject to a runtime parameter. If
the current match is long enough, deflate() reduces the search for a longer
match, thus speeding up the whole process. If compression ratio is more
important than speed, deflate() attempts a complete second search even if
the first match is already long enough.

The lazy match evaluation is not performed for the fastest compression
modes (level parameter 1 to 3). For these fast modes, new strings
are inserted in the hash table only when no match was found, or
when the match is not too long. This degrades the compression ratio
but saves time since there are both fewer insertions and fewer searches.


2. Decompression algorithm (inflate)

The real question is given a Huffman tree, how to decode fast. The most
important realization is that shorter codes are much more common than
longer codes, so pay attention to decoding the short codes fast, and let
the long codes take longer to decode.

inflate() sets up a first level table that covers some number of bits of
input less than the length of longest code. It gets that many bits from the
stream, and looks it up in the table. The table will tell if the next
code is that many bits or less and how many, and if it is, it will tell
the value, else it will point to the next level table for which inflate()
grabs more bits and tries to decode a longer code.

How many bits to make the first lookup is a tradeoff between the time it
takes to decode and the time it takes to build the table. If building the
table took no time (and if you had infinite memory), then there would only
be a first level table to cover all the way to the longest code. However,
building the table ends up taking a lot longer for more bits since short
codes are replicated many times in such a table. What inflate() does is
simply to make the number of bits in the first table a variable, and set it
for the maximum speed.

inflate() sends new trees relatively often, so it is possibly set for a
smaller first level table than an application that has only one tree for
all the data. For inflate, which has 286 possible codes for the
literal/length tree, the size of the first table is nine bits. Also the
distance trees have 30 possible values, and the size of the first table is
six bits. Note that for each of those cases, the table ended up one bit
longer than the "average" code length, i.e. the code length of an
approximately flat code which would be a little more than eight bits for
286 symbols and a little less than five bits for 30 symbols. It would be
interesting to see if optimizing the first level table for other
applications gave values within a bit or two of the flat code size.


Jean-loup Gailly Mark Adler
gzip@prep.ai.mit.edu madler@alumni.caltech.edu


References:

[LZ77] Ziv J., Lempel A., "A Universal Algorithm for Sequential Data
Compression", IEEE Transactions on Information Theory", Vol. 23, No. 3,
pp. 337-343.

"DEFLATE Compressed Data Format Specification" available in
ftp://ds.internic.net/rfc/rfc1951.txt
5 changes: 3 additions & 2 deletions compress.c
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* For conditions of distribution and use, see copyright notice in zlib.h
*/

/* $Id: compress.c,v 1.9 1996/01/30 21:59:09 me Exp $ */
/* $Id: compress.c,v 1.10 1996/05/23 16:51:12 me Exp $ */

#include "zlib.h"

Expand All @@ -30,9 +30,10 @@ int compress (dest, destLen, source, sourceLen)

stream.next_in = (Bytef*)source;
stream.avail_in = (uInt)sourceLen;
#ifdef MAXSEG_64K
/* Check for source > 64K on 16-bit machine: */
if ((uLong)stream.avail_in != sourceLen) return Z_BUF_ERROR;

#endif
stream.next_out = dest;
stream.avail_out = (uInt)*destLen;
if ((uLong)stream.avail_out != *destLen) return Z_BUF_ERROR;
Expand Down
Loading

0 comments on commit e26a448

Please sign in to comment.