1*212397c6Schristos /* zpipe.c: example of proper use of zlib's inflate() and deflate()
2*212397c6Schristos Not copyrighted -- provided to the public domain
3*212397c6Schristos Version 1.4 11 December 2005 Mark Adler */
4*212397c6Schristos
5*212397c6Schristos /* Version history:
6*212397c6Schristos 1.0 30 Oct 2004 First version
7*212397c6Schristos 1.1 8 Nov 2004 Add void casting for unused return values
8*212397c6Schristos Use switch statement for inflate() return values
9*212397c6Schristos 1.2 9 Nov 2004 Add assertions to document zlib guarantees
10*212397c6Schristos 1.3 6 Apr 2005 Remove incorrect assertion in inf()
11*212397c6Schristos 1.4 11 Dec 2005 Add hack to avoid MSDOS end-of-line conversions
12*212397c6Schristos Avoid some compiler warnings for input and output buffers
13*212397c6Schristos */
14*212397c6Schristos
15*212397c6Schristos #include <stdio.h>
16*212397c6Schristos #include <string.h>
17*212397c6Schristos #include <assert.h>
18*212397c6Schristos #include "zlib.h"
19*212397c6Schristos
20*212397c6Schristos #if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(__CYGWIN__)
21*212397c6Schristos # include <fcntl.h>
22*212397c6Schristos # include <io.h>
23*212397c6Schristos # define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
24*212397c6Schristos #else
25*212397c6Schristos # define SET_BINARY_MODE(file)
26*212397c6Schristos #endif
27*212397c6Schristos
28*212397c6Schristos #define CHUNK 16384
29*212397c6Schristos
30*212397c6Schristos /* Compress from file source to file dest until EOF on source.
31*212397c6Schristos def() returns Z_OK on success, Z_MEM_ERROR if memory could not be
32*212397c6Schristos allocated for processing, Z_STREAM_ERROR if an invalid compression
33*212397c6Schristos level is supplied, Z_VERSION_ERROR if the version of zlib.h and the
34*212397c6Schristos version of the library linked do not match, or Z_ERRNO if there is
35*212397c6Schristos an error reading or writing the files. */
def(FILE * source,FILE * dest,int level)36*212397c6Schristos int def(FILE *source, FILE *dest, int level)
37*212397c6Schristos {
38*212397c6Schristos int ret, flush;
39*212397c6Schristos unsigned have;
40*212397c6Schristos z_stream strm;
41*212397c6Schristos unsigned char in[CHUNK];
42*212397c6Schristos unsigned char out[CHUNK];
43*212397c6Schristos
44*212397c6Schristos /* allocate deflate state */
45*212397c6Schristos strm.zalloc = Z_NULL;
46*212397c6Schristos strm.zfree = Z_NULL;
47*212397c6Schristos strm.opaque = Z_NULL;
48*212397c6Schristos ret = deflateInit(&strm, level);
49*212397c6Schristos if (ret != Z_OK)
50*212397c6Schristos return ret;
51*212397c6Schristos
52*212397c6Schristos /* compress until end of file */
53*212397c6Schristos do {
54*212397c6Schristos strm.avail_in = fread(in, 1, CHUNK, source);
55*212397c6Schristos if (ferror(source)) {
56*212397c6Schristos (void)deflateEnd(&strm);
57*212397c6Schristos return Z_ERRNO;
58*212397c6Schristos }
59*212397c6Schristos flush = feof(source) ? Z_FINISH : Z_NO_FLUSH;
60*212397c6Schristos strm.next_in = in;
61*212397c6Schristos
62*212397c6Schristos /* run deflate() on input until output buffer not full, finish
63*212397c6Schristos compression if all of source has been read in */
64*212397c6Schristos do {
65*212397c6Schristos strm.avail_out = CHUNK;
66*212397c6Schristos strm.next_out = out;
67*212397c6Schristos ret = deflate(&strm, flush); /* no bad return value */
68*212397c6Schristos assert(ret != Z_STREAM_ERROR); /* state not clobbered */
69*212397c6Schristos have = CHUNK - strm.avail_out;
70*212397c6Schristos if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
71*212397c6Schristos (void)deflateEnd(&strm);
72*212397c6Schristos return Z_ERRNO;
73*212397c6Schristos }
74*212397c6Schristos } while (strm.avail_out == 0);
75*212397c6Schristos assert(strm.avail_in == 0); /* all input will be used */
76*212397c6Schristos
77*212397c6Schristos /* done when last data in file processed */
78*212397c6Schristos } while (flush != Z_FINISH);
79*212397c6Schristos assert(ret == Z_STREAM_END); /* stream will be complete */
80*212397c6Schristos
81*212397c6Schristos /* clean up and return */
82*212397c6Schristos (void)deflateEnd(&strm);
83*212397c6Schristos return Z_OK;
84*212397c6Schristos }
85*212397c6Schristos
86*212397c6Schristos /* Decompress from file source to file dest until stream ends or EOF.
87*212397c6Schristos inf() returns Z_OK on success, Z_MEM_ERROR if memory could not be
88*212397c6Schristos allocated for processing, Z_DATA_ERROR if the deflate data is
89*212397c6Schristos invalid or incomplete, Z_VERSION_ERROR if the version of zlib.h and
90*212397c6Schristos the version of the library linked do not match, or Z_ERRNO if there
91*212397c6Schristos is an error reading or writing the files. */
inf(FILE * source,FILE * dest)92*212397c6Schristos int inf(FILE *source, FILE *dest)
93*212397c6Schristos {
94*212397c6Schristos int ret;
95*212397c6Schristos unsigned have;
96*212397c6Schristos z_stream strm;
97*212397c6Schristos unsigned char in[CHUNK];
98*212397c6Schristos unsigned char out[CHUNK];
99*212397c6Schristos
100*212397c6Schristos /* allocate inflate state */
101*212397c6Schristos strm.zalloc = Z_NULL;
102*212397c6Schristos strm.zfree = Z_NULL;
103*212397c6Schristos strm.opaque = Z_NULL;
104*212397c6Schristos strm.avail_in = 0;
105*212397c6Schristos strm.next_in = Z_NULL;
106*212397c6Schristos ret = inflateInit(&strm);
107*212397c6Schristos if (ret != Z_OK)
108*212397c6Schristos return ret;
109*212397c6Schristos
110*212397c6Schristos /* decompress until deflate stream ends or end of file */
111*212397c6Schristos do {
112*212397c6Schristos strm.avail_in = fread(in, 1, CHUNK, source);
113*212397c6Schristos if (ferror(source)) {
114*212397c6Schristos (void)inflateEnd(&strm);
115*212397c6Schristos return Z_ERRNO;
116*212397c6Schristos }
117*212397c6Schristos if (strm.avail_in == 0)
118*212397c6Schristos break;
119*212397c6Schristos strm.next_in = in;
120*212397c6Schristos
121*212397c6Schristos /* run inflate() on input until output buffer not full */
122*212397c6Schristos do {
123*212397c6Schristos strm.avail_out = CHUNK;
124*212397c6Schristos strm.next_out = out;
125*212397c6Schristos ret = inflate(&strm, Z_NO_FLUSH);
126*212397c6Schristos assert(ret != Z_STREAM_ERROR); /* state not clobbered */
127*212397c6Schristos switch (ret) {
128*212397c6Schristos case Z_NEED_DICT:
129*212397c6Schristos ret = Z_DATA_ERROR; /* and fall through */
130*212397c6Schristos case Z_DATA_ERROR:
131*212397c6Schristos case Z_MEM_ERROR:
132*212397c6Schristos (void)inflateEnd(&strm);
133*212397c6Schristos return ret;
134*212397c6Schristos }
135*212397c6Schristos have = CHUNK - strm.avail_out;
136*212397c6Schristos if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
137*212397c6Schristos (void)inflateEnd(&strm);
138*212397c6Schristos return Z_ERRNO;
139*212397c6Schristos }
140*212397c6Schristos } while (strm.avail_out == 0);
141*212397c6Schristos
142*212397c6Schristos /* done when inflate() says it's done */
143*212397c6Schristos } while (ret != Z_STREAM_END);
144*212397c6Schristos
145*212397c6Schristos /* clean up and return */
146*212397c6Schristos (void)inflateEnd(&strm);
147*212397c6Schristos return ret == Z_STREAM_END ? Z_OK : Z_DATA_ERROR;
148*212397c6Schristos }
149*212397c6Schristos
150*212397c6Schristos /* report a zlib or i/o error */
zerr(int ret)151*212397c6Schristos void zerr(int ret)
152*212397c6Schristos {
153*212397c6Schristos fputs("zpipe: ", stderr);
154*212397c6Schristos switch (ret) {
155*212397c6Schristos case Z_ERRNO:
156*212397c6Schristos if (ferror(stdin))
157*212397c6Schristos fputs("error reading stdin\n", stderr);
158*212397c6Schristos if (ferror(stdout))
159*212397c6Schristos fputs("error writing stdout\n", stderr);
160*212397c6Schristos break;
161*212397c6Schristos case Z_STREAM_ERROR:
162*212397c6Schristos fputs("invalid compression level\n", stderr);
163*212397c6Schristos break;
164*212397c6Schristos case Z_DATA_ERROR:
165*212397c6Schristos fputs("invalid or incomplete deflate data\n", stderr);
166*212397c6Schristos break;
167*212397c6Schristos case Z_MEM_ERROR:
168*212397c6Schristos fputs("out of memory\n", stderr);
169*212397c6Schristos break;
170*212397c6Schristos case Z_VERSION_ERROR:
171*212397c6Schristos fputs("zlib version mismatch!\n", stderr);
172*212397c6Schristos }
173*212397c6Schristos }
174*212397c6Schristos
175*212397c6Schristos /* compress or decompress from stdin to stdout */
main(int argc,char ** argv)176*212397c6Schristos int main(int argc, char **argv)
177*212397c6Schristos {
178*212397c6Schristos int ret;
179*212397c6Schristos
180*212397c6Schristos /* avoid end-of-line conversions */
181*212397c6Schristos SET_BINARY_MODE(stdin);
182*212397c6Schristos SET_BINARY_MODE(stdout);
183*212397c6Schristos
184*212397c6Schristos /* do compression if no arguments */
185*212397c6Schristos if (argc == 1) {
186*212397c6Schristos ret = def(stdin, stdout, Z_DEFAULT_COMPRESSION);
187*212397c6Schristos if (ret != Z_OK)
188*212397c6Schristos zerr(ret);
189*212397c6Schristos return ret;
190*212397c6Schristos }
191*212397c6Schristos
192*212397c6Schristos /* do decompression if -d specified */
193*212397c6Schristos else if (argc == 2 && strcmp(argv[1], "-d") == 0) {
194*212397c6Schristos ret = inf(stdin, stdout);
195*212397c6Schristos if (ret != Z_OK)
196*212397c6Schristos zerr(ret);
197*212397c6Schristos return ret;
198*212397c6Schristos }
199*212397c6Schristos
200*212397c6Schristos /* otherwise, report usage */
201*212397c6Schristos else {
202*212397c6Schristos fputs("zpipe usage: zpipe [-d] < source > dest\n", stderr);
203*212397c6Schristos return 1;
204*212397c6Schristos }
205*212397c6Schristos }
206