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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String[]
static final String
private static final int
private static final String
static final int
static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
dumpImageFile
(PrintWriter pw, ByteSource byteSource) Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriterprotected String[]
Get an array of all accepted extensionsprotected ImageFormat[]
Get an array of ImageFormat objects describing all accepted typesgetBufferedImage
(ByteSource byteSource, Map<String, 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) Get the default extension for the format specified by an implementation of ImageParser.byte[]
getICCProfileBytes
(ByteSource byteSource, Map<String, 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.getImageInfo
(ByteSource byteSource, Map<String, Object> params) Get image information from the specified ByteSource.getImageSize
(ByteSource byteSource, Map<String, Object> params) Get the size of the image described by the specified ByteSource.private InputStream
getInputStream
(ByteSource byteSource, int section) getMetadata
(ByteSource byteSource, Map<String, Object> params) Get image metadata from the specified byte source.getName()
Get a descriptive name for the implementation of an ImageParser.getXmpXml
(ByteSource byteSource, Map<String, Object> params) Extracts embedded XML metadata as XML string.private boolean
keepImageResourceBlock
(int ID, int[] imageResourceIDs) private PsdHeaderInfo
private PsdHeaderInfo
readHeader
(ByteSource byteSource) private PsdImageContents
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 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 Details
-
DEFAULT_EXTENSION
- See Also:
-
ACCEPTED_EXTENSIONS
-
PSD_SECTION_HEADER
private static final int PSD_SECTION_HEADER- See Also:
-
PSD_SECTION_COLOR_MODE
private static final int PSD_SECTION_COLOR_MODE- See Also:
-
PSD_SECTION_IMAGE_RESOURCES
private static final int PSD_SECTION_IMAGE_RESOURCES- See Also:
-
PSD_SECTION_LAYER_AND_MASK_DATA
private static final int PSD_SECTION_LAYER_AND_MASK_DATA- See Also:
-
PSD_SECTION_IMAGE_DATA
private static final int PSD_SECTION_IMAGE_DATA- See Also:
-
PSD_HEADER_LENGTH
private static final int PSD_HEADER_LENGTH- See Also:
-
COLOR_MODE_INDEXED
private static final int COLOR_MODE_INDEXED- See Also:
-
IMAGE_RESOURCE_ID_ICC_PROFILE
public static final int IMAGE_RESOURCE_ID_ICC_PROFILE- See Also:
-
IMAGE_RESOURCE_ID_XMP
public static final int IMAGE_RESOURCE_ID_XMP- See Also:
-
BLOCK_NAME_XMP
- See Also:
-
-
Constructor Details
-
PsdImageParser
public PsdImageParser()
-
-
Method Details
-
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
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
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
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
- Throws:
ImageReadException
IOException
-
readHeader
- Throws:
ImageReadException
IOException
-
readImageContents
- Throws:
ImageReadException
IOException
-
readImageResourceBlocks
private List<ImageResourceBlock> readImageResourceBlocks(byte[] bytes, int[] imageResourceIDs, int maxBlocksToRead) throws ImageReadException, IOException - Throws:
ImageReadException
IOException
-
keepImageResourceBlock
private boolean keepImageResourceBlock(int ID, int[] imageResourceIDs) -
readImageResourceBlocks
private List<ImageResourceBlock> readImageResourceBlocks(InputStream is, int[] imageResourceIDs, int maxBlocksToRead, int available) throws ImageReadException, IOException - Throws:
ImageReadException
IOException
-
readImageResourceBlocks
private List<ImageResourceBlock> readImageResourceBlocks(ByteSource byteSource, int[] imageResourceIDs, int maxBlocksToRead) throws ImageReadException, IOException - Throws:
ImageReadException
IOException
-
getInputStream
private InputStream getInputStream(ByteSource byteSource, int section) throws ImageReadException, IOException - Throws:
ImageReadException
IOException
-
getData
- Throws:
ImageReadException
IOException
-
readImageContents
private PsdImageContents readImageContents(ByteSource byteSource) throws ImageReadException, IOException - Throws:
ImageReadException
IOException
-
getICCProfileBytes
public byte[] getICCProfileBytes(ByteSource byteSource, Map<String, Object> params) throws ImageReadException, IOExceptionDescription 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.IOException
- In the event of unsuccessful read or access operation.
-
getImageSize
public Dimension getImageSize(ByteSource byteSource, Map<String, Object> params) throws ImageReadException, IOExceptionDescription 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.IOException
- In the event of unsuccessful read or access operation.
-
getMetadata
public ImageMetadata getMetadata(ByteSource byteSource, Map<String, Object> params) throws ImageReadException, IOExceptionDescription 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.IOException
- In the event of unsuccessful data read operation.
-
getChannelsPerMode
private int getChannelsPerMode(int mode) -
getImageInfo
public ImageInfo getImageInfo(ByteSource byteSource, Map<String, Object> params) throws ImageReadException, IOExceptionDescription 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.IOException
- In the event of unsuccessful data access operation.
-
dumpImageFile
public boolean dumpImageFile(PrintWriter pw, ByteSource byteSource) throws ImageReadException, 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.IOException
- In the event of unsuccessful read or access operation.
-
getBufferedImage
public BufferedImage getBufferedImage(ByteSource byteSource, Map<String, Object> params) throws ImageReadException, IOExceptionDescription 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.IOException
- In the event of unsuccessful read or access operation.
-
getXmpXml
public String getXmpXml(ByteSource byteSource, Map<String, Object> params) throws ImageReadException, IOExceptionExtracts 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.IOException
- In the event of unsuccessful read or access operation.
-