Class PSDImageReader

java.lang.Object

javax.imageio.ImageReader

com.twelvemonkeys.imageio.ImageReaderBase

com.twelvemonkeys.imageio.plugins.psd.PSDImageReader

public final class PSDImageReader
extends ImageReaderBase

ImageReader for Adobe Photoshop Document (PSD) format.

Version:

$Id: PSDImageReader.java,v 1.0 Apr 29, 2008 4:45:52 PM haraldk Exp$

See Also:

• Adobe Photoshop File Formats Specification
• Adobe Photoshop File Format Summary

Field Summary

Fields

Modifier and Type	Field	Description
private ICC_ColorSpace	colorSpace
(package private) static final boolean	DEBUG
private PSDHeader	header
private PSDMetadata	metadata

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
PSDImageReader(ImageReaderSpi originatingProvider)

Method Summary

Modifier and Type	Method	Description
private void	convertToDestinationCS(ColorModel sourceCM, ColorModel destinationCM, WritableRaster raster)
private int[]	createBandList(int numBands)
private static byte	decompose(int pColor, double pAlpha)
private void	decomposeAlpha(ColorModel pModel, DataBuffer pBuffer, int pWidth, int pHeight, int pChannels)
private long	findLayerStartPos(int layerIndex)
private ColorSpace	getEmbeddedColorSpace()
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)	Default implementation that always returns null.
IIOMetadata	getImageMetadata(int imageIndex, String formatName, Set<String> nodeNames)
Iterator<ImageTypeSpecifier>	getImageTypes(int imageIndex)
private int	getLayerHeight(int layerIndex)
private int	getLayerWidth(int layerIndex)
int	getNumImages(boolean allowSearch)	Layer support
int	getNumThumbnails(int imageIndex)
ImageTypeSpecifier	getRawImageType(int imageIndex)
private ImageTypeSpecifier	getRawImageTypeForCompositeLayer()
private ImageTypeSpecifier	getRawImageTypeForLayer(int layerIndex)
private ImageTypeSpecifier	getRawImageTypeInternal(int imageIndex)
IIOMetadata	getStreamMetadata()	Metadata support
int	getThumbnailHeight(int imageIndex, int thumbnailIndex)
private PSDThumbnail	getThumbnailResource(int imageIndex, int thumbnailIndex)
private List<PSDThumbnail>	getThumbnailResources(int imageIndex)
int	getThumbnailWidth(int imageIndex, int thumbnailIndex)
int	getWidth(int imageIndex)
static void	main(String[] pArgs)	Functional testing
private void	processImageProgressForChannel(int channel, int channelCount, int y, int height)
BufferedImage	read(int imageIndex, ImageReadParam param)
private void	read16bitChannel(ImageInputStream stream, int channel, int channelCount, DataBuffer data, int band, int bandCount, int bandOffset, ColorModel sourceColorModel, short[] rowData, Rectangle sourceRect, Rectangle destRect, int xSub, int ySub, int channelWidth, int channelHeight)
private void	read1bitChannel(ImageInputStream stream, int channel, DataBuffer data, byte[] rowData, Rectangle sourceRect, Rectangle destRect, int xSub, int ySub, int channelWidth, int channelHeight)
private void	read32bitChannel(ImageInputStream stream, int channel, int channelCount, DataBuffer data, int band, int bandCount, int bandOffset, ColorModel sourceColorModel, int[] rowData, Rectangle sourceRect, Rectangle destRect, int xSub, int ySub, int channelWidth, int channelHeight)
private void	read8bitChannel(ImageInputStream stream, int channel, int channelCount, DataBuffer data, int band, int bandCount, int bandOffset, ColorModel sourceColorModel, byte[] rowData, Rectangle sourceRect, Rectangle destRect, int xSub, int ySub, int channelWidth, int channelHeight)
boolean	readerSupportsThumbnails()	Thumbnail support
private void	readHeader()
private void	readImageData(BufferedImage destination, ColorModel pSourceCM, Rectangle pSource, Rectangle pDest, int pXSub, int pYSub, int[][] byteCounts, int compression)
private void	readImageResources(boolean pParseData)
private void	readLayerAndMaskInfo(boolean parseData)
private BufferedImage	readLayerData(int layerIndex, ImageReadParam param)
private List<PSDLayerInfo>	readLayerInfo(int layerCount)
private long	readLength(ImageInputStream stream)
private long	readLength(ImageInputStream stream, int resId)
BufferedImage	readThumbnail(int imageIndex, int thumbnailIndex)
protected void	resetMembers()	Resets all member variables.

Methods inherited from class ImageReaderBase

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

Methods inherited from class ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, getAspectRatio, getAvailableLocales, getDefaultReadParam, getFormatName, getInput, getLocale, getMinIndex, getOriginatingProvider, getSourceRegion, getStreamMetadata, 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, 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 PSDHeader header

colorSpace

private ICC_ColorSpace colorSpace

metadata

private PSDMetadata metadata

Constructor Details

PSDImageReader

PSDImageReader(ImageReaderSpi originatingProvider)

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

getLayerWidth

private int getLayerWidth(int layerIndex)
                   throws IOException

Throws:

IOException

getLayerHeight

private int getLayerHeight(int layerIndex)
                    throws IOException

Throws:

IOException

getRawImageType

public ImageTypeSpecifier getRawImageType(int imageIndex)
                                   throws IOException

Overrides:

getRawImageType in class ImageReader

Throws:

IOException

getRawImageTypeInternal

private ImageTypeSpecifier getRawImageTypeInternal(int imageIndex)
                                            throws IOException

Throws:

IOException

getRawImageTypeForCompositeLayer

private ImageTypeSpecifier getRawImageTypeForCompositeLayer()
                                                     throws IOException

Throws:

IOException

getImageTypes

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

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

getEmbeddedColorSpace

private ColorSpace getEmbeddedColorSpace()
                                  throws IOException

Throws:

IOException

read

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

Specified by:

read in class ImageReader

Throws:

IOException

findLayerStartPos

private long findLayerStartPos(int layerIndex)

readImageData

private void readImageData(BufferedImage destination,
 ColorModel pSourceCM,
 Rectangle pSource,
 Rectangle pDest,
 int pXSub,
 int pYSub,
 int[][] byteCounts,
 int compression)
                    throws IOException

Throws:

IOException

convertToDestinationCS

private void convertToDestinationCS(ColorModel sourceCM,
 ColorModel destinationCM,
 WritableRaster raster)

createBandList

private int[] createBandList(int numBands)

processImageProgressForChannel

private void processImageProgressForChannel(int channel,
 int channelCount,
 int y,
 int height)

read32bitChannel

private void read32bitChannel(ImageInputStream stream,
 int channel,
 int channelCount,
 DataBuffer data,
 int band,
 int bandCount,
 int bandOffset,
 ColorModel sourceColorModel,
 int[] rowData,
 Rectangle sourceRect,
 Rectangle destRect,
 int xSub,
 int ySub,
 int channelWidth,
 int channelHeight)
                       throws IOException

Throws:

IOException

read16bitChannel

private void read16bitChannel(ImageInputStream stream,
 int channel,
 int channelCount,
 DataBuffer data,
 int band,
 int bandCount,
 int bandOffset,
 ColorModel sourceColorModel,
 short[] rowData,
 Rectangle sourceRect,
 Rectangle destRect,
 int xSub,
 int ySub,
 int channelWidth,
 int channelHeight)
                       throws IOException

Throws:

IOException

read8bitChannel

private void read8bitChannel(ImageInputStream stream,
 int channel,
 int channelCount,
 DataBuffer data,
 int band,
 int bandCount,
 int bandOffset,
 ColorModel sourceColorModel,
 byte[] rowData,
 Rectangle sourceRect,
 Rectangle destRect,
 int xSub,
 int ySub,
 int channelWidth,
 int channelHeight)
                      throws IOException

Throws:

IOException

read1bitChannel

private void read1bitChannel(ImageInputStream stream,
 int channel,
 DataBuffer data,
 byte[] rowData,
 Rectangle sourceRect,
 Rectangle destRect,
 int xSub,
 int ySub,
 int channelWidth,
 int channelHeight)
                      throws IOException

Throws:

IOException

decomposeAlpha

private void decomposeAlpha(ColorModel pModel,
 DataBuffer pBuffer,
 int pWidth,
 int pHeight,
 int pChannels)

decompose

private static byte decompose(int pColor,
 double pAlpha)

readHeader

private void readHeader()
                 throws IOException

Throws:

IOException

readImageResources

private void readImageResources(boolean pParseData)
                         throws IOException

Throws:

IOException

readLayerAndMaskInfo

private void readLayerAndMaskInfo(boolean parseData)
                           throws IOException

Throws:

IOException

readLength

private long readLength(ImageInputStream stream)
                 throws IOException

Throws:

IOException

readLength

private long readLength(ImageInputStream stream,
 int resId)
                 throws IOException

Throws:

IOException

readLayerInfo

private List<PSDLayerInfo> readLayerInfo(int layerCount)
                                  throws IOException

Throws:

IOException

readLayerData

private BufferedImage readLayerData(int layerIndex,
 ImageReadParam param)
                             throws IOException

Throws:

IOException

getRawImageTypeForLayer

private ImageTypeSpecifier getRawImageTypeForLayer(int layerIndex)
                                            throws IOException

Throws:

IOException

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Layer support

Overrides:

getNumImages in class ImageReaderBase

Parameters:

allowSearch - ignored, unless overridden

Returns:

1, unless overridden

Throws:

IOException - never, unless overridden

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IOException

Metadata support

Overrides:

getStreamMetadata in class ImageReaderBase

Returns:

null, unless overridden

Throws:

IOException - never, unless overridden.

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.

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex,
 String formatName,
 Set<String> nodeNames)
                             throws IOException

Overrides:

getImageMetadata in class ImageReader

Throws:

IOException

readerSupportsThumbnails

public boolean readerSupportsThumbnails()

Thumbnail support

Overrides:

readerSupportsThumbnails in class ImageReader

getThumbnailResources

private List<PSDThumbnail> getThumbnailResources(int imageIndex)
                                          throws IOException

Throws:

IOException

getNumThumbnails

public int getNumThumbnails(int imageIndex)
                     throws IOException

Overrides:

getNumThumbnails in class ImageReader

Throws:

IOException

getThumbnailResource

private PSDThumbnail getThumbnailResource(int imageIndex,
 int thumbnailIndex)
                                   throws IOException

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

main

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

Functional testing

Throws:

IOException