1 /* $Id: tif_zip.c,v 1.1 2005/06/17 13:54:52 vp153 Exp $ */
4 * Copyright (c) 1995-1997 Sam Leffler
5 * Copyright (c) 1995-1997 Silicon Graphics, Inc.
7 * Permission to use, copy, modify, distribute, and sell this software and
8 * its documentation for any purpose is hereby granted without fee, provided
9 * that (i) the above copyright notices and this permission notice appear in
10 * all copies of the software and related documentation, and (ii) the names of
11 * Sam Leffler and Silicon Graphics may not be used in any advertising or
12 * publicity relating to the software without the specific, prior written
13 * permission of Sam Leffler and Silicon Graphics.
15 * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
17 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
20 * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
21 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
22 * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
32 * ZIP (aka Deflate) Compression Support
34 * This file is simply an interface to the zlib library written by
35 * Jean-loup Gailly and Mark Adler. You must use version 1.0 or later
36 * of the library: this code assumes the 1.0 API and also depends on
37 * the ability to write the zlib header multiple times (one per strip)
38 * which was not possible with versions prior to 0.95. Note also that
39 * older versions of this codec avoided this bug by supressing the header
40 * entirely. This means that files written with the old library cannot
41 * be read; they should be converted to a different compression scheme
42 * and then reconverted.
44 * The data format used by the zlib library is described in the files
45 * zlib-3.1.doc, deflate-1.1.doc and gzip-4.1.doc, available in the
46 * directory ftp://ftp.uu.net/pub/archiving/zip/doc. The library was
47 * last found at ftp://ftp.uu.net/pub/archiving/zip/zlib/zlib-0.99.tar.gz.
49 #include "tif_predict.h"
55 * Sigh, ZLIB_VERSION is defined as a string so there's no
56 * way to do a proper check here. Instead we guess based
57 * on the presence of #defines that were added between the
58 * 0.95 and 1.0 distributions.
60 #if !defined(Z_NO_COMPRESSION) || !defined(Z_DEFLATED)
61 #error "Antiquated ZLIB software; you must use version 1.0 or later"
65 * State block for each open TIFF
66 * file using ZIP compression/decompression.
69 TIFFPredictorState predict;
71 int zipquality; /* compression level */
72 int state; /* state flags */
73 #define ZSTATE_INIT 0x1 /* zlib setup successfully */
75 TIFFVGetMethod vgetparent; /* super-class method */
76 TIFFVSetMethod vsetparent; /* super-class method */
79 #define ZState(tif) ((ZIPState*) (tif)->tif_data)
80 #define DecoderState(tif) ZState(tif)
81 #define EncoderState(tif) ZState(tif)
83 static int ZIPEncode(TIFF*, tidata_t, tsize_t, tsample_t);
84 static int ZIPDecode(TIFF*, tidata_t, tsize_t, tsample_t);
87 ZIPSetupDecode(TIFF* tif)
89 ZIPState* sp = DecoderState(tif);
90 static const char module[] = "ZIPSetupDecode";
93 if (inflateInit(&sp->stream) != Z_OK) {
94 TIFFError(module, "%s: %s", tif->tif_name, sp->stream.msg);
97 sp->state |= ZSTATE_INIT;
103 * Setup state for decoding a strip.
106 ZIPPreDecode(TIFF* tif, tsample_t s)
108 ZIPState* sp = DecoderState(tif);
112 sp->stream.next_in = tif->tif_rawdata;
113 sp->stream.avail_in = tif->tif_rawcc;
114 return (inflateReset(&sp->stream) == Z_OK);
118 ZIPDecode(TIFF* tif, tidata_t op, tsize_t occ, tsample_t s)
120 ZIPState* sp = DecoderState(tif);
121 static const char module[] = "ZIPDecode";
125 sp->stream.next_out = op;
126 sp->stream.avail_out = occ;
128 int state = inflate(&sp->stream, Z_PARTIAL_FLUSH);
129 if (state == Z_STREAM_END)
131 if (state == Z_DATA_ERROR) {
133 "%s: Decoding error at scanline %d, %s",
134 tif->tif_name, tif->tif_row, sp->stream.msg);
135 if (inflateSync(&sp->stream) != Z_OK)
140 TIFFError(module, "%s: zlib error: %s",
141 tif->tif_name, sp->stream.msg);
144 } while (sp->stream.avail_out > 0);
145 if (sp->stream.avail_out != 0) {
147 "%s: Not enough data at scanline %d (short %d bytes)",
148 tif->tif_name, tif->tif_row, sp->stream.avail_out);
155 ZIPSetupEncode(TIFF* tif)
157 ZIPState* sp = EncoderState(tif);
158 static const char module[] = "ZIPSetupEncode";
161 if (deflateInit(&sp->stream, sp->zipquality) != Z_OK) {
162 TIFFError(module, "%s: %s", tif->tif_name, sp->stream.msg);
165 sp->state |= ZSTATE_INIT;
171 * Reset encoding state at the start of a strip.
174 ZIPPreEncode(TIFF* tif, tsample_t s)
176 ZIPState *sp = EncoderState(tif);
180 sp->stream.next_out = tif->tif_rawdata;
181 sp->stream.avail_out = tif->tif_rawdatasize;
182 return (deflateReset(&sp->stream) == Z_OK);
186 * Encode a chunk of pixels.
189 ZIPEncode(TIFF* tif, tidata_t bp, tsize_t cc, tsample_t s)
191 ZIPState *sp = EncoderState(tif);
192 static const char module[] = "ZIPEncode";
195 sp->stream.next_in = bp;
196 sp->stream.avail_in = cc;
198 if (deflate(&sp->stream, Z_NO_FLUSH) != Z_OK) {
199 TIFFError(module, "%s: Encoder error: %s",
200 tif->tif_name, sp->stream.msg);
203 if (sp->stream.avail_out == 0) {
204 tif->tif_rawcc = tif->tif_rawdatasize;
206 sp->stream.next_out = tif->tif_rawdata;
207 sp->stream.avail_out = tif->tif_rawdatasize;
209 } while (sp->stream.avail_in > 0);
214 * Finish off an encoded strip by flushing the last
215 * string and tacking on an End Of Information code.
218 ZIPPostEncode(TIFF* tif)
220 ZIPState *sp = EncoderState(tif);
221 static const char module[] = "ZIPPostEncode";
224 sp->stream.avail_in = 0;
226 state = deflate(&sp->stream, Z_FINISH);
230 if ((int)sp->stream.avail_out != (int)tif->tif_rawdatasize)
233 tif->tif_rawdatasize - sp->stream.avail_out;
235 sp->stream.next_out = tif->tif_rawdata;
236 sp->stream.avail_out = tif->tif_rawdatasize;
240 TIFFError(module, "%s: zlib error: %s",
241 tif->tif_name, sp->stream.msg);
244 } while (state != Z_STREAM_END);
249 ZIPCleanup(TIFF* tif)
251 ZIPState* sp = ZState(tif);
253 if (sp->state&ZSTATE_INIT) {
254 /* NB: avoid problems in the library */
255 if (tif->tif_mode == O_RDONLY)
256 inflateEnd(&sp->stream);
258 deflateEnd(&sp->stream);
261 tif->tif_data = NULL;
266 ZIPVSetField(TIFF* tif, ttag_t tag, va_list ap)
268 ZIPState* sp = ZState(tif);
269 static const char module[] = "ZIPVSetField";
272 case TIFFTAG_ZIPQUALITY:
273 sp->zipquality = va_arg(ap, int);
274 if (tif->tif_mode != O_RDONLY && (sp->state&ZSTATE_INIT)) {
275 if (deflateParams(&sp->stream,
276 sp->zipquality, Z_DEFAULT_STRATEGY) != Z_OK) {
277 TIFFError(module, "%s: zlib error: %s",
278 tif->tif_name, sp->stream.msg);
284 return (*sp->vsetparent)(tif, tag, ap);
290 ZIPVGetField(TIFF* tif, ttag_t tag, va_list ap)
292 ZIPState* sp = ZState(tif);
295 case TIFFTAG_ZIPQUALITY:
296 *va_arg(ap, int*) = sp->zipquality;
299 return (*sp->vgetparent)(tif, tag, ap);
304 static const TIFFFieldInfo zipFieldInfo[] = {
305 { TIFFTAG_ZIPQUALITY, 0, 0, TIFF_ANY, FIELD_PSEUDO,
308 #define N(a) (sizeof (a) / sizeof (a[0]))
311 TIFFInitZIP(TIFF* tif, int scheme)
315 assert( (scheme == COMPRESSION_DEFLATE) || (scheme == COMPRESSION_ADOBE_DEFLATE));
318 * Allocate state block so tag methods have storage to record values.
320 tif->tif_data = (tidata_t) _TIFFmalloc(sizeof (ZIPState));
321 if (tif->tif_data == NULL)
324 sp->stream.zalloc = NULL;
325 sp->stream.zfree = NULL;
326 sp->stream.opaque = NULL;
327 sp->stream.data_type = Z_BINARY;
330 * Merge codec-specific tag information and
331 * override parent get/set field methods.
333 _TIFFMergeFieldInfo(tif, zipFieldInfo, N(zipFieldInfo));
334 sp->vgetparent = tif->tif_tagmethods.vgetfield;
335 tif->tif_tagmethods.vgetfield = ZIPVGetField; /* hook for codec tags */
336 sp->vsetparent = tif->tif_tagmethods.vsetfield;
337 tif->tif_tagmethods.vsetfield = ZIPVSetField; /* hook for codec tags */
339 /* Default values for codec-specific fields */
340 sp->zipquality = Z_DEFAULT_COMPRESSION; /* default comp. level */
344 * Install codec methods.
346 tif->tif_setupdecode = ZIPSetupDecode;
347 tif->tif_predecode = ZIPPreDecode;
348 tif->tif_decoderow = ZIPDecode;
349 tif->tif_decodestrip = ZIPDecode;
350 tif->tif_decodetile = ZIPDecode;
351 tif->tif_setupencode = ZIPSetupEncode;
352 tif->tif_preencode = ZIPPreEncode;
353 tif->tif_postencode = ZIPPostEncode;
354 tif->tif_encoderow = ZIPEncode;
355 tif->tif_encodestrip = ZIPEncode;
356 tif->tif_encodetile = ZIPEncode;
357 tif->tif_cleanup = ZIPCleanup;
359 * Setup predictor setup.
361 (void) TIFFPredictorInit(tif);
364 TIFFError("TIFFInitZIP", "No space for ZIP state block");
367 #endif /* ZIP_SUPORT */
369 /* vim: set ts=8 sts=8 sw=8 noet: */