Class PsdImageParser
- java.lang.Object
-
- org.apache.commons.imaging.common.BinaryFileParser
-
- org.apache.commons.imaging.ImageParser
-
- org.apache.commons.imaging.formats.psd.PsdImageParser
-
- All Implemented Interfaces:
XmpEmbeddable
public class PsdImageParser extends ImageParser implements XmpEmbeddable
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String[]
ACCEPTED_EXTENSIONS
static java.lang.String
BLOCK_NAME_XMP
private static int
COLOR_MODE_INDEXED
private static java.lang.String
DEFAULT_EXTENSION
static int
IMAGE_RESOURCE_ID_ICC_PROFILE
static int
IMAGE_RESOURCE_ID_XMP
private static int
PSD_HEADER_LENGTH
private static int
PSD_SECTION_COLOR_MODE
private static int
PSD_SECTION_HEADER
private static int
PSD_SECTION_IMAGE_DATA
private static int
PSD_SECTION_IMAGE_RESOURCES
private static int
PSD_SECTION_LAYER_AND_MASK_DATA
-
Constructor Summary
Constructors Constructor Description PsdImageParser()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
dumpImageFile(java.io.PrintWriter pw, ByteSource byteSource)
Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriterprotected java.lang.String[]
getAcceptedExtensions()
Get an array of all accepted extensionsprotected ImageFormat[]
getAcceptedTypes()
Get an array of ImageFormat objects describing all accepted typesjava.awt.image.BufferedImage
getBufferedImage(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> 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)
java.lang.String
getDefaultExtension()
Get the default extension for the format specified by an implementation of ImageParser.byte[]
getICCProfileBytes(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params)
Get 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, java.util.Map<java.lang.String,java.lang.Object> params)
Get image information from the specified ByteSource.java.awt.Dimension
getImageSize(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params)
Get the size of the image described by the specified ByteSource.private java.io.InputStream
getInputStream(ByteSource byteSource, int section)
ImageMetadata
getMetadata(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params)
Get image metadata from the specified byte source.java.lang.String
getName()
Get a descriptive name for the implementation of an ImageParser.java.lang.String
getXmpXml(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params)
Extracts embedded XML metadata as XML string.private boolean
keepImageResourceBlock(int ID, int[] imageResourceIDs)
private PsdHeaderInfo
readHeader(java.io.InputStream is)
private PsdHeaderInfo
readHeader(ByteSource byteSource)
private PsdImageContents
readImageContents(java.io.InputStream is)
private PsdImageContents
readImageContents(ByteSource byteSource)
private java.util.List<ImageResourceBlock>
readImageResourceBlocks(byte[] bytes, int[] imageResourceIDs, int maxBlocksToRead)
private java.util.List<ImageResourceBlock>
readImageResourceBlocks(java.io.InputStream is, int[] imageResourceIDs, int maxBlocksToRead, int available)
private java.util.List<ImageResourceBlock>
readImageResourceBlocks(ByteSource byteSource, int[] imageResourceIDs, int maxBlocksToRead)
-
Methods inherited from class org.apache.commons.imaging.ImageParser
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, isStrict, writeImage
-
Methods inherited from class org.apache.commons.imaging.common.BinaryFileParser
debugNumber, debugNumber, getByteOrder, setByteOrder
-
-
-
-
Field Detail
-
DEFAULT_EXTENSION
private static final java.lang.String DEFAULT_EXTENSION
- See Also:
- Constant Field Values
-
ACCEPTED_EXTENSIONS
private static final java.lang.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 java.lang.String BLOCK_NAME_XMP
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from class:ImageParser
Get a descriptive name for the implementation of an ImageParser.- Specified by:
getName
in classImageParser
- Returns:
- a valid, subject-matter-specific string.
-
getDefaultExtension
public java.lang.String getDefaultExtension()
Description copied from class:ImageParser
Get 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 classImageParser
- Returns:
- A valid string.
-
getAcceptedExtensions
protected java.lang.String[] getAcceptedExtensions()
Description copied from class:ImageParser
Get an array of all accepted extensions- Specified by:
getAcceptedExtensions
in classImageParser
- Returns:
- A valid array of one or more elements.
-
getAcceptedTypes
protected ImageFormat[] getAcceptedTypes()
Description copied from class:ImageParser
Get an array of ImageFormat objects describing all accepted types- Specified by:
getAcceptedTypes
in classImageParser
- Returns:
- A valid array of one or more elements.
-
readHeader
private PsdHeaderInfo readHeader(ByteSource byteSource) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
readHeader
private PsdHeaderInfo readHeader(java.io.InputStream is) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
readImageContents
private PsdImageContents readImageContents(java.io.InputStream is) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
readImageResourceBlocks
private java.util.List<ImageResourceBlock> readImageResourceBlocks(byte[] bytes, int[] imageResourceIDs, int maxBlocksToRead) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
keepImageResourceBlock
private boolean keepImageResourceBlock(int ID, int[] imageResourceIDs)
-
readImageResourceBlocks
private java.util.List<ImageResourceBlock> readImageResourceBlocks(java.io.InputStream is, int[] imageResourceIDs, int maxBlocksToRead, int available) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
readImageResourceBlocks
private java.util.List<ImageResourceBlock> readImageResourceBlocks(ByteSource byteSource, int[] imageResourceIDs, int maxBlocksToRead) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
getInputStream
private java.io.InputStream getInputStream(ByteSource byteSource, int section) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
getData
private byte[] getData(ByteSource byteSource, int section) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
readImageContents
private PsdImageContents readImageContents(ByteSource byteSource) throws ImageReadException, java.io.IOException
- Throws:
ImageReadException
java.io.IOException
-
getICCProfileBytes
public byte[] getICCProfileBytes(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params) throws ImageReadException, java.io.IOException
Description copied from class:ImageParser
Get 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 classImageParser
- 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:
ImageReadException
- In the event that the specified content does not conform to the format of the specific parser implementation.java.io.IOException
- In the event of unsuccessful read or access operation.
-
getImageSize
public java.awt.Dimension getImageSize(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params) throws ImageReadException, java.io.IOException
Description copied from class:ImageParser
Get the size of the image described by the specified ByteSource.- Specified by:
getImageSize
in classImageParser
- 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:
ImageReadException
- In the event that the specified content does not conform to the format of the specific parser implementation.java.io.IOException
- In the event of unsuccessful read or access operation.
-
getMetadata
public ImageMetadata getMetadata(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params) throws ImageReadException, java.io.IOException
Description copied from class:ImageParser
Get 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 classImageParser
- 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:
ImageReadException
- In the event that the ByteSource content does not conform to the format of the specific parser implementation.java.io.IOException
- In the event of unsuccessful data read operation.
-
getChannelsPerMode
private int getChannelsPerMode(int mode)
-
getImageInfo
public ImageInfo getImageInfo(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params) throws ImageReadException, java.io.IOException
Description copied from class:ImageParser
Get 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 classImageParser
- Parameters:
byteSource
- A valid ByteSource objectparams
- 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:
ImageReadException
- In the event that the specified content does not conform to the format of the specific parser implementation.java.io.IOException
- In the event of unsuccessful data access operation.
-
dumpImageFile
public boolean dumpImageFile(java.io.PrintWriter pw, ByteSource byteSource) throws ImageReadException, java.io.IOException
Description copied from class:ImageParser
Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter- Overrides:
dumpImageFile
in classImageParser
- Parameters:
pw
- print writer used for writing the ImageInfobyteSource
- A valid byte source.- Returns:
- A valid PrintWriter.
- Throws:
ImageReadException
- In the event that the specified content does not conform to the format of the specific parser implementation.java.io.IOException
- In the event of unsuccessful read or access operation.
-
getBufferedImage
public java.awt.image.BufferedImage getBufferedImage(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params) throws ImageReadException, java.io.IOException
Description copied from class:ImageParser
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 classImageParser
- Parameters:
byteSource
- A valid instance of ByteSourceparams
- 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:
ImageReadException
- In the event that the specified content does not conform to the format of the specific parser implementation.java.io.IOException
- In the event of unsuccessful read or access operation.
-
getXmpXml
public java.lang.String getXmpXml(ByteSource byteSource, java.util.Map<java.lang.String,java.lang.Object> params) throws ImageReadException, java.io.IOException
Extracts embedded XML metadata as XML string.- Specified by:
getXmpXml
in interfaceXmpEmbeddable
- 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:
ImageReadException
- In the event that the specified content does not conform to the format of the specific parser implementation.java.io.IOException
- In the event of unsuccessful read or access operation.
-
-