Class IFFImageReader

java.lang.Object

javax.imageio.ImageReader

com.twelvemonkeys.imageio.ImageReaderBase

com.twelvemonkeys.imageio.plugins.iff.IFFImageReader

public final class IFFImageReader
extends ImageReaderBase

Reader for Commodore Amiga (Electronic Arts) IFF ILBM (InterLeaved BitMap) and PBM format (Packed BitMap). Also supports IFF RGB8 (Impulse) and IFF DEEP (TVPaint). The IFF format (Interchange File Format) is the standard file format supported by allmost all image software for the Amiga computer.

This reader supports the original palette-based 1-8 bit formats, including EHB (Extra Half-Bright), HAM (Hold and Modify), and the more recent "deep" formats, 8 bit gray, 24 bit RGB and 32 bit ARGB. Uncompressed and ByteRun1 compressed (run length encoding) files are supported.

Palette based images are read as BufferedImage of TYPE_BYTE_INDEXED or BufferedImage# depending on the bit depth. Gray images are read as TYPE_BYTE_GRAY. 24 bit true-color images are read as TYPE_3BYTE_BGR. 32 bit true-color images are read as TYPE_4BYTE_ABGR.

Issues: HAM and HAM8 (Hold and Modify) formats are converted to RGB (24 bit), as it seems to be very hard to create an IndexColorModel subclass that would correctly describe these formats. These formats utilizes the special display hardware in the Amiga computers. HAM (6 bits) needs 12 bits storage/pixel, if unpacked to RGB (4 bits/gun). HAM8 (8 bits) needs 18 bits storage/pixel, if unpacked to RGB (6 bits/gun). See Wikipedia: HAM for more information.
EHB palette is expanded to an IndexColorModel with 64 entries. See Wikipedia: EHB for more information.

Version:

$Id: IFFImageReader.java,v 1.0 29.aug.2004 20:26:58 haku Exp $

See Also:

• Wikipedia: IFF
• Wikipedia: IFF ILBM

Field Summary

Fields

Modifier and Type	Field	Description
private DataInputStream	byteRunStream
(package private) static final boolean	DEBUG
private Form	header

Fields inherited from class ImageReaderBase

imageInput

Fields inherited from class ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Constructor	Description
IFFImageReader(ImageReaderSpi pProvider)

Method Summary

Modifier and Type	Method	Description
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)	Default implementation that always returns null.
Iterator<ImageTypeSpecifier>	getImageTypes(int imageIndex)
int	getNumThumbnails(int imageIndex)
ImageTypeSpecifier	getRawImageType(int pIndex)
int	getThumbnailHeight(int imageIndex, int thumbnailIndex)
int	getThumbnailWidth(int imageIndex, int thumbnailIndex)
int	getWidth(int imageIndex)
private void	hamToRGB(byte[] indexed, IndexColorModel colorModel, byte[] dest, int destOffset)
boolean	hasThumbnails(int imageIndex)
private void	init(int pIndex)
static void	main(String[] args)
private void	multiPaletteToRGB(int row, byte[] indexed, IndexColorModel colorModel, byte[] dest, int destOffset)
private boolean	needsConversionToRGB()
BufferedImage	read(int imageIndex, ImageReadParam param)
private void	readBody(ImageReadParam param, BufferedImage destination)
private void	readChunky(ImageReadParam param, BufferedImage destination, ImageInputStream input)
boolean	readerSupportsThumbnails()
private void	readInterleaved(ImageReadParam param, BufferedImage destination, ImageInputStream input)
private void	readInterleavedIndexed(ImageReadParam param, BufferedImage destination, IndexColorModel palette, ImageInputStream input)
private void	readMeta()
private void	readPlaneData(byte[] destination, int offset, int planeWidth, ImageInputStream input)
BufferedImage	readThumbnail(int imageIndex, int thumbnailIndex)
protected void	resetMembers()	Resets all member variables.

Methods inherited from class ImageReaderBase

assertInput, checkBounds, dispose, fakeAOI, fakeSubsampling, getDestination, getNumImages, getStreamMetadata, hasExplicitDestination, reset, setInput, showIt

Methods inherited from class ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, getAspectRatio, getAvailableLocales, getDefaultReadParam, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getOriginatingProvider, getSourceRegion, getStreamMetadata, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, isIgnoringMetadata, isImageTiled, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readAsRenderedImage, readRaster, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, setInput, setInput, setLocale

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEBUG

static final boolean DEBUG

header

private Form header

byteRunStream

private DataInputStream byteRunStream

Constructor Details

IFFImageReader

IFFImageReader(ImageReaderSpi pProvider)

Method Details

init

private void init(int pIndex)
           throws IOException

Throws:

IOException

resetMembers

protected void resetMembers()

Description copied from class: ImageReaderBase

Resets all member variables. This method is by default invoked from:

• ImageReaderBase.setInput(Object, boolean, boolean)
• ImageReaderBase.dispose()
• ImageReaderBase.reset()

Specified by:

resetMembers in class ImageReaderBase

readMeta

private void readMeta()
               throws IOException

Throws:

IOException

read

public BufferedImage read(int imageIndex,
 ImageReadParam param)
                   throws IOException

Specified by:

read in class ImageReader

Throws:

IOException

readerSupportsThumbnails

public boolean readerSupportsThumbnails()

Overrides:

readerSupportsThumbnails in class ImageReader

hasThumbnails

public boolean hasThumbnails(int imageIndex)
                      throws IOException

Overrides:

hasThumbnails in class ImageReader

Throws:

IOException

getNumThumbnails

public int getNumThumbnails(int imageIndex)
                     throws IOException

Overrides:

getNumThumbnails in class ImageReader

Throws:

IOException

getThumbnailWidth

public int getThumbnailWidth(int imageIndex,
 int thumbnailIndex)
                      throws IOException

Overrides:

getThumbnailWidth in class ImageReader

Throws:

IOException

getThumbnailHeight

public int getThumbnailHeight(int imageIndex,
 int thumbnailIndex)
                       throws IOException

Overrides:

getThumbnailHeight in class ImageReader

Throws:

IOException

readThumbnail

public BufferedImage readThumbnail(int imageIndex,
 int thumbnailIndex)
                            throws IOException

Overrides:

readThumbnail in class ImageReader

Throws:

IOException

getWidth

public int getWidth(int imageIndex)
             throws IOException

Specified by:

getWidth in class ImageReader

Throws:

IOException

getHeight

public int getHeight(int imageIndex)
              throws IOException

Specified by:

getHeight in class ImageReader

Throws:

IOException

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Description copied from class: ImageReaderBase

Default implementation that always returns null.

Overrides:

getImageMetadata in class ImageReaderBase

Parameters:

imageIndex - ignored, unless overridden

Returns:

null, unless overridden

Throws:

IOException - never, unless overridden.

getImageTypes

public Iterator<ImageTypeSpecifier> getImageTypes(int imageIndex)
                                           throws IOException

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

getRawImageType

public ImageTypeSpecifier getRawImageType(int pIndex)
                                   throws IOException

Overrides:

getRawImageType in class ImageReader

Throws:

IOException

needsConversionToRGB

private boolean needsConversionToRGB()

readBody

private void readBody(ImageReadParam param,
 BufferedImage destination)
               throws IOException

Throws:

IOException

readInterleavedIndexed

private void readInterleavedIndexed(ImageReadParam param,
 BufferedImage destination,
 IndexColorModel palette,
 ImageInputStream input)
                             throws IOException

Throws:

IOException

readChunky

private void readChunky(ImageReadParam param,
 BufferedImage destination,
 ImageInputStream input)
                 throws IOException

Throws:

IOException

readInterleaved

private void readInterleaved(ImageReadParam param,
 BufferedImage destination,
 ImageInputStream input)
                      throws IOException

Throws:

IOException

readPlaneData

private void readPlaneData(byte[] destination,
 int offset,
 int planeWidth,
 ImageInputStream input)
                    throws IOException

Throws:

IOException

multiPaletteToRGB

private void multiPaletteToRGB(int row,
 byte[] indexed,
 IndexColorModel colorModel,
 byte[] dest,
 int destOffset)

hamToRGB

private void hamToRGB(byte[] indexed,
 IndexColorModel colorModel,
 byte[] dest,
 int destOffset)

main

public static void main(String[] args)