/*
* #%L
* Fork of JAI Image I/O Tools.
* %%
* Copyright (C) 2008 - 2014 Open Microscopy Environment:
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* - University of Dundee
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of any organization.
* #L%
*/
/*
* $RCSfile: LZWCompressor.java,v $
*
*
* Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistribution of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistribution in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of Sun Microsystems, Inc. or the names of
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any
* kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
* WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
* EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
* NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
* USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
* DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
* ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
* CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
* REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
* INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for
* use in the design, construction, operation or maintenance of any
* nuclear facility.
*
* $Revision: 1.1 $
* $Date: 2005/02/11 05:01:22 $
* $State: Exp $
*/
package com.sun.media.imageioimpl.common;
import java.io.IOException;
import java.io.PrintStream;
import javax.imageio.stream.ImageOutputStream;
/**
* Modified from original LZWCompressor to change interface to passing a
* buffer of data to be compressed.
**/
public class LZWCompressor
{
/** base underlying code size of data being compressed 8 for TIFF, 1 to 8 for GIF **/
int codeSize_;
/** reserved clear code based on code size **/
int clearCode_;
/** reserved end of data code based on code size **/
int endOfInfo_;
/** current number bits output for each code **/
int numBits_;
/** limit at which current number of bits code size has to be increased **/
int limit_;
/** the prefix code which represents the predecessor string to current input point **/
short prefix_;
/** output destination for bit codes **/
BitFile bf_;
/** general purpose LZW string table **/
LZWStringTable lzss_;
/** modify the limits of the code values in LZW encoding due to TIFF bug / feature **/
boolean tiffFudge_;
/**
* @param out destination for compressed data
* @param codeSize the initial code size for the LZW compressor
* @param TIFF flag indicating that TIFF lzw fudge needs to be applied
* @exception IOException if underlying output stream error
**/
public LZWCompressor(ImageOutputStream out, int codeSize, boolean TIFF) throws IOException
{
bf_ = new BitFile(out, !TIFF); // set flag for GIF as NOT tiff
codeSize_ = codeSize;
tiffFudge_ = TIFF;
clearCode_ = 1 << codeSize_;
endOfInfo_ = clearCode_ + 1;
numBits_ = codeSize_ + 1;
limit_ = (1 << numBits_) - 1;
if (tiffFudge_)
--limit_;
prefix_ = (short)0xFFFF;
lzss_ = new LZWStringTable();
lzss_.ClearTable(codeSize_);
bf_.writeBits(clearCode_, numBits_);
}
/**
* @param buf data to be compressed to output stream
* @exception IOException if underlying output stream error
**/
public void compress(byte[] buf, int offset, int length)
throws IOException
{
int idx;
byte c;
short index;
int maxOffset = offset + length;
for (idx = offset; idx < maxOffset; ++idx)
{
c = buf[idx];
if ((index = lzss_.FindCharString(prefix_, c)) != -1)
prefix_ = index;
else
{
bf_.writeBits(prefix_, numBits_);
if (lzss_.AddCharString(prefix_, c) > limit_)
{
if (numBits_ == 12)
{
bf_.writeBits(clearCode_, numBits_);
lzss_.ClearTable(codeSize_);
numBits_ = codeSize_ + 1;
}
else
++numBits_;
limit_ = (1 << numBits_) - 1;
if (tiffFudge_)
--limit_;
}
prefix_ = (short)((short)c & 0xFF);
}
}
}
/**
* Indicate to compressor that no more data to go so write out
* any remaining buffered data.
*
* @exception IOException if underlying output stream error
**/
public void flush() throws IOException
{
if (prefix_ != -1)
bf_.writeBits(prefix_, numBits_);
bf_.writeBits(endOfInfo_, numBits_);
bf_.flush();
}
public void dump(PrintStream out)
{
lzss_.dump(out);
}
}