Class PCXImageReader

java.lang.Object

javax.imageio.ImageReader

com.twelvemonkeys.imageio.ImageReaderBase

com.twelvemonkeys.imageio.plugins.pcx.PCXImageReader

public final class PCXImageReader
extends ImageReaderBase

ImageReader for ZSoft PC Paintbrush (PCX) format.

See Also:

• PCX Graphics

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final boolean	DEBUG
private static final ImageTypeSpecifier	GRAYSCALE	8 bit ImageTypeSpecifer used for reading bitplane images.
private PCXHeader	header
private static final int	MAX_EXPANSION_RATIO	Maximum plausible decoded-to-input expansion ratio for PCX, used to bound the allocation against the input length.
private boolean	readPalette
private IndexColorModel	vgaPalette

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
PCXImageReader(ImageReaderSpi provider)

Method Summary

Modifier and Type	Method	Description
private Raster	clipRowToRect(Raster raster, Rectangle rect, int[] bands, int xSub)
private WritableRaster	clipToRect(WritableRaster raster, Rectangle rect, int[] bands)
private int[]	createIndices(int bands, int increment)
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)	Default implementation that always returns null.
Iterator<ImageTypeSpecifier>	getImageTypes(int imageIndex)
ImageTypeSpecifier	getRawImageType(int imageIndex)
private IndexColorModel	getVGAPalette()
int	getWidth(int imageIndex)
static void	main(String[] args)
BufferedImage	read(int imageIndex, ImageReadParam param)
private void	readHeader()
private void	readRowByte(DataInput input, Rectangle srcRegion, int xSub, int ySub, byte[] rowDataByte, int off, int length, WritableRaster destChannel, Raster srcChannel, int y)
protected void	resetMembers()	Resets all member variables.
private static long	skipToEOF(ImageInputStream stream)

Methods inherited from class ImageReaderBase

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

Methods inherited from class ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, getAspectRatio, getAvailableLocales, getDefaultReadParam, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, hasThumbnails, 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, readerSupportsThumbnails, readRaster, readThumbnail, 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

GRAYSCALE

private static final ImageTypeSpecifier GRAYSCALE

8 bit ImageTypeSpecifer used for reading bitplane images.

MAX_EXPANSION_RATIO

private static final int MAX_EXPANSION_RATIO

Maximum plausible decoded-to-input expansion ratio for PCX, used to bound the allocation against the input length. PCX is uncompressed or run-length encoded; 128:1 leaves margin above RLE's maximum (~64:1 for 8-bit pixels), so no valid image is rejected.

See Also:

• Constant Field Values

header

private PCXHeader header

readPalette

private boolean readPalette

vgaPalette

private IndexColorModel vgaPalette

Constructor Details

PCXImageReader

public PCXImageReader(ImageReaderSpi provider)

Method Details

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

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

getImageTypes

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

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

getRawImageType

public ImageTypeSpecifier getRawImageType(int imageIndex)
                                   throws IOException

Overrides:

getRawImageType in class ImageReader

Throws:

IOException

createIndices

private int[] createIndices(int bands,
 int increment)

read

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

Specified by:

read in class ImageReader

Throws:

IOException

readRowByte

private void readRowByte(DataInput input,
 Rectangle srcRegion,
 int xSub,
 int ySub,
 byte[] rowDataByte,
 int off,
 int length,
 WritableRaster destChannel,
 Raster srcChannel,
 int y)
                  throws IOException

Throws:

IOException

clipRowToRect

private Raster clipRowToRect(Raster raster,
 Rectangle rect,
 int[] bands,
 int xSub)

clipToRect

private WritableRaster clipToRect(WritableRaster raster,
 Rectangle rect,
 int[] bands)

readHeader

private void readHeader()
                 throws IOException

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.

getVGAPalette

private IndexColorModel getVGAPalette()
                               throws IOException

Throws:

IOException

skipToEOF

private static long skipToEOF(ImageInputStream stream)
                       throws IOException

Throws:

IOException

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException