Class PsdImageParser

java.lang.Object

org.apache.commons.imaging.common.BinaryFileParser

org.apache.commons.imaging.AbstractImageParser<PsdImagingParameters>

org.apache.commons.imaging.formats.psd.PsdImageParser

All Implemented Interfaces:

XmpEmbeddable

public class PsdImageParser
extends AbstractImageParser<PsdImagingParameters>
implements XmpEmbeddable

Field Summary

Fields

Modifier and Type	Field	Description
private static final String[]	ACCEPTED_EXTENSIONS
static final String	BLOCK_NAME_XMP
private static final int	COLOR_MODE_INDEXED
private static final String	DEFAULT_EXTENSION
static final int	IMAGE_RESOURCE_ID_ICC_PROFILE
static final int	IMAGE_RESOURCE_ID_XMP
private static final int	PSD_HEADER_LENGTH
private static final int	PSD_SECTION_COLOR_MODE
private static final int	PSD_SECTION_HEADER
private static final int	PSD_SECTION_IMAGE_DATA
private static final int	PSD_SECTION_IMAGE_RESOURCES
private static final int	PSD_SECTION_LAYER_AND_MASK_DATA

Constructor Summary

Constructors

Constructor	Description
PsdImageParser()	Constructs a new instance with the big-endian byte order.

Method Summary

Modifier and Type	Method	Description
boolean	dumpImageFile(PrintWriter pw, ByteSource byteSource)	Writes the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter
protected String[]	getAcceptedExtensions()	Gets an array of all accepted extensions
protected ImageFormat[]	getAcceptedTypes()	Gets an array of ImageFormat objects describing all accepted types
BufferedImage	getBufferedImage(ByteSource byteSource, PsdImagingParameters params)	Gets a buffered image specified by the byte source (for sources that specify multiple images, choice of which image is returned is implementation dependent).
private int	getChannelsPerMode(int mode)
private byte[]	getData(ByteSource byteSource, int section)
String	getDefaultExtension()	Gets the default extension for the format specified by an implementation of ImageParser.
PsdImagingParameters	getDefaultParameters()	Gets a default parameters instance for this parser.
byte[]	getIccProfileBytes(ByteSource byteSource, PsdImagingParameters params)	Gets an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource.
ImageInfo	getImageInfo(ByteSource byteSource, PsdImagingParameters params)	Gets image information from the specified ByteSource.
Dimension	getImageSize(ByteSource byteSource, PsdImagingParameters params)	Gets the size of the image described by the specified ByteSource.
private InputStream	getInputStream(ByteSource byteSource, int section)
ImageMetadata	getMetadata(ByteSource byteSource, PsdImagingParameters params)	Gets image metadata from the specified byte source.
String	getName()	Gets a descriptive name for the implementation of an ImageParser.
String	getXmpXml(ByteSource byteSource, XmpImagingParameters params)	Extracts embedded XML metadata as XML string.
private boolean	keepImageResourceBlock(int id, int[] imageResourceIDs)
private PsdHeaderInfo	readHeader(InputStream is)
private PsdHeaderInfo	readHeader(ByteSource byteSource)
private PsdImageContents	readImageContents(InputStream is)
private PsdImageContents	readImageContents(ByteSource byteSource)
private List<ImageResourceBlock>	readImageResourceBlocks(byte[] bytes, int[] imageResourceIDs, int maxBlocksToRead)
private List<ImageResourceBlock>	readImageResourceBlocks(InputStream is, int[] imageResourceIDs, int maxBlocksToRead, int available)
private List<ImageResourceBlock>	readImageResourceBlocks(ByteSource byteSource, int[] imageResourceIDs, int maxBlocksToRead)

Methods inherited from class AbstractImageParser

canAcceptExtension, canAcceptExtension, canAcceptType, dumpImageFile, dumpImageFile, dumpImageFile, getAllBufferedImages, getAllBufferedImages, getAllBufferedImages, getAllImageParsers, getBufferedImage, getBufferedImage, getBufferedImageFactory, getFormatCompliance, getFormatCompliance, getFormatCompliance, getIccProfileBytes, getIccProfileBytes, getIccProfileBytes, getIccProfileBytes, getImageInfo, getImageInfo, getImageInfo, getImageSize, getImageSize, getImageSize, getImageSize, getMetadata, getMetadata, getMetadata, getMetadata, getMetadata, writeImage

Methods inherited from class BinaryFileParser

debugNumber, debugNumber, getByteOrder, setByteOrder

Methods inherited from class Object

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

Field Details

DEFAULT_EXTENSION

private static final String DEFAULT_EXTENSION

ACCEPTED_EXTENSIONS

private static final String[] ACCEPTED_EXTENSIONS

PSD_SECTION_HEADER

private static final int PSD_SECTION_HEADER

See Also:

• Constant Field Values

PSD_SECTION_COLOR_MODE

private static final int PSD_SECTION_COLOR_MODE

See Also:

• Constant Field Values

PSD_SECTION_IMAGE_RESOURCES

private static final int PSD_SECTION_IMAGE_RESOURCES

See Also:

• Constant Field Values

PSD_SECTION_LAYER_AND_MASK_DATA

private static final int PSD_SECTION_LAYER_AND_MASK_DATA

See Also:

• Constant Field Values

PSD_SECTION_IMAGE_DATA

private static final int PSD_SECTION_IMAGE_DATA

See Also:

• Constant Field Values

PSD_HEADER_LENGTH

private static final int PSD_HEADER_LENGTH

See Also:

• Constant Field Values

COLOR_MODE_INDEXED

private static final int COLOR_MODE_INDEXED

See Also:

• Constant Field Values

IMAGE_RESOURCE_ID_ICC_PROFILE

public static final int IMAGE_RESOURCE_ID_ICC_PROFILE

See Also:

• Constant Field Values

IMAGE_RESOURCE_ID_XMP

public static final int IMAGE_RESOURCE_ID_XMP

See Also:

• Constant Field Values

BLOCK_NAME_XMP

public static final String BLOCK_NAME_XMP

See Also:

• Constant Field Values

Constructor Details

PsdImageParser

public PsdImageParser()

Constructs a new instance with the big-endian byte order.

Method Details

dumpImageFile

public boolean dumpImageFile(PrintWriter pw,
 ByteSource byteSource)
                      throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Writes the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter

Overrides:

dumpImageFile in class AbstractImageParser<PsdImagingParameters>

Parameters:

pw - print writer used for writing the ImageInfo

byteSource - A valid byte source.

Returns:

A valid PrintWriter.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getAcceptedExtensions

protected String[] getAcceptedExtensions()

Description copied from class: AbstractImageParser

Gets an array of all accepted extensions

Specified by:

getAcceptedExtensions in class AbstractImageParser<PsdImagingParameters>

Returns:

A valid array of one or more elements.

getAcceptedTypes

protected ImageFormat[] getAcceptedTypes()

Description copied from class: AbstractImageParser

Gets an array of ImageFormat objects describing all accepted types

Specified by:

getAcceptedTypes in class AbstractImageParser<PsdImagingParameters>

Returns:

A valid array of one or more elements.

getBufferedImage

public BufferedImage getBufferedImage(ByteSource byteSource,
 PsdImagingParameters params)
                               throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets a buffered image specified by the byte source (for sources that specify multiple images, choice of which image is returned is implementation dependent).

Specified by:

getBufferedImage in class AbstractImageParser<PsdImagingParameters>

Parameters:

byteSource - A valid instance of ByteSource

params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).

Returns:

A valid instance of BufferedImage.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getChannelsPerMode

private int getChannelsPerMode(int mode)

getData

private byte[] getData(ByteSource byteSource,
 int section)
                throws ImagingException,
IOException

Throws:

ImagingException

IOException

getDefaultExtension

public String getDefaultExtension()

Description copied from class: AbstractImageParser

Gets the default extension for the format specified by an implementation of ImageParser. Some parsers can support more than one extension (i.e. .JPEG, .JPG; .TIF, .TIFF, etc.).

Specified by:

getDefaultExtension in class AbstractImageParser<PsdImagingParameters>

Returns:

A valid string.

getDefaultParameters

public PsdImagingParameters getDefaultParameters()

Description copied from class: AbstractImageParser

Gets a default parameters instance for this parser.

Specified by:

getDefaultParameters in class AbstractImageParser<PsdImagingParameters>

Returns:

default parameters instance

getIccProfileBytes

public byte[] getIccProfileBytes(ByteSource byteSource,
 PsdImagingParameters params)
                          throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource. Not all formats support ICC profiles.

Specified by:

getIccProfileBytes in class AbstractImageParser<PsdImagingParameters>

Parameters:

byteSource - A valid ByteSource.

params - Optional instructions for special-handling or interpretation of the input data.

Returns:

If available, a valid array of bytes; otherwise, a null

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getImageInfo

public ImageInfo getImageInfo(ByteSource byteSource,
 PsdImagingParameters params)
                       throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets image information from the specified ByteSource. Format-specific ImageParser implementations are expected to return a valid ImageInfo object or to throw an ImageReadException if unable to process the specified data.

The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

Specified by:

getImageInfo in class AbstractImageParser<PsdImagingParameters>

Parameters:

byteSource - A valid ByteSource object

params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).

Returns:

A valid image information object describing the content extracted from the specified data.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful data access operation.

getImageSize

public Dimension getImageSize(ByteSource byteSource,
 PsdImagingParameters params)
                       throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets the size of the image described by the specified ByteSource.

Specified by:

getImageSize in class AbstractImageParser<PsdImagingParameters>

Parameters:

byteSource - A valid reference to a ByteSource.

params - Optional instructions for special-handling or interpretation of the input data.

Returns:

A valid instance of Dimension.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getInputStream

private InputStream getInputStream(ByteSource byteSource,
 int section)
                            throws ImagingException,
IOException

Throws:

ImagingException

IOException

getMetadata

public ImageMetadata getMetadata(ByteSource byteSource,
 PsdImagingParameters params)
                          throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets image metadata from the specified byte source. Format-specific ImageParser implementations are expected to return a valid IImageMetadata object or to throw an ImageReadException if unable to process the specified byte source.

The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

Specified by:

getMetadata in class AbstractImageParser<PsdImagingParameters>

Parameters:

byteSource - A valid byte source.

params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).

Returns:

A valid, potentially subject-matter-specific implementation of the IImageMetadata interface describing the content extracted from the source content.

Throws:

ImagingException - In the event that the ByteSource content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful data read operation.

getName

public String getName()

Description copied from class: AbstractImageParser

Gets a descriptive name for the implementation of an ImageParser.

Specified by:

getName in class AbstractImageParser<PsdImagingParameters>

Returns:

a valid, subject-matter-specific string.

getXmpXml

public String getXmpXml(ByteSource byteSource,
 XmpImagingParameters params)
                 throws ImagingException,
IOException

Extracts embedded XML metadata as XML string.

Specified by:

getXmpXml in interface XmpEmbeddable

Parameters:

byteSource - File containing image data.

params - Map of optional parameters, defined in ImagingConstants.

Returns:

Xmp Xml as String, if present. Otherwise, returns null.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

keepImageResourceBlock

private boolean keepImageResourceBlock(int id,
 int[] imageResourceIDs)

readHeader

private PsdHeaderInfo readHeader(ByteSource byteSource)
                          throws ImagingException,
IOException

Throws:

ImagingException

IOException

readHeader

private PsdHeaderInfo readHeader(InputStream is)
                          throws ImagingException,
IOException

Throws:

ImagingException

IOException

readImageContents

private PsdImageContents readImageContents(ByteSource byteSource)
                                    throws ImagingException,
IOException

Throws:

ImagingException

IOException

readImageContents

private PsdImageContents readImageContents(InputStream is)
                                    throws ImagingException,
IOException

Throws:

ImagingException

IOException

readImageResourceBlocks

private List<ImageResourceBlock> readImageResourceBlocks(byte[] bytes,
 int[] imageResourceIDs,
 int maxBlocksToRead)
                                                  throws ImagingException,
IOException

Throws:

ImagingException

IOException

readImageResourceBlocks

private List<ImageResourceBlock> readImageResourceBlocks(ByteSource byteSource,
 int[] imageResourceIDs,
 int maxBlocksToRead)
                                                  throws ImagingException,
IOException

Throws:

ImagingException

IOException

readImageResourceBlocks

private List<ImageResourceBlock> readImageResourceBlocks(InputStream is,
 int[] imageResourceIDs,
 int maxBlocksToRead,
 int available)
                                                  throws ImagingException,
IOException

Throws:

ImagingException

IOException