Class PngImageParser

java.lang.Object

org.apache.commons.imaging.common.BinaryFileParser

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

org.apache.commons.imaging.formats.png.PngImageParser

All Implemented Interfaces:

XmpEmbeddable<PngImagingParameters>

public class PngImageParser
extends AbstractImageParser<PngImagingParameters>
implements XmpEmbeddable<PngImagingParameters>

Parses PNG images.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String[]	ACCEPTED_EXTENSIONS
private static final String	DEFAULT_EXTENSION
private static final Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
PngImageParser()	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
private List<PngChunk>	filterChunks(List<PngChunk> chunks, ChunkType type)
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, PngImagingParameters 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).
static String	getChunkTypeName(int chunkType)
List<String>	getChunkTypes(InputStream is)
String	getDefaultExtension()	Gets the default extension for the format specified by an implementation of ImageParser.
PngImagingParameters	getDefaultParameters()	Gets a default parameters instance for this parser.
TiffImageMetadata	getExifMetadata(ByteSource byteSource, TiffImagingParameters params)	Gets TIFF image metadata for a byte source and TIFF parameters.
byte[]	getExifRawData(ByteSource byteSource)	Gets TIFF image metadata for a byte source.
byte[]	getIccProfileBytes(ByteSource byteSource, PngImagingParameters 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, PngImagingParameters params)	Gets image information from the specified ByteSource.
Dimension	getImageSize(ByteSource byteSource, PngImagingParameters params)	Gets the size of the image described by the specified ByteSource.
ImageMetadata	getMetadata(ByteSource byteSource, PngImagingParameters params)	Gets image metadata from the specified byte source.
String	getName()	Gets a descriptive name for the implementation of an ImageParser.
private AbstractTransparencyFilter	getTransparencyFilter(PngColorType pngColorType, PngChunk pngChunktRNS)
String	getXmpXml(ByteSource byteSource, XmpImagingParameters<PngImagingParameters> params)	Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content.
boolean	hasChunkType(ByteSource byteSource, ChunkType chunkType)
private boolean	keepChunk(int chunkType, ChunkType[] chunkTypes)
private List<PngChunk>	readChunks(InputStream is, ChunkType[] chunkTypes, boolean returnAfterFirst)
private List<PngChunk>	readChunks(ByteSource byteSource, ChunkType[] chunkTypes, boolean returnAfterFirst)
void	readSignature(InputStream in)	Reads reads the signature.
void	writeImage(BufferedImage src, OutputStream os, PngImagingParameters params)	Writes the content of a BufferedImage to the specified output stream.

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

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

LOGGER

private static final Logger LOGGER

DEFAULT_EXTENSION

private static final String DEFAULT_EXTENSION

ACCEPTED_EXTENSIONS

private static final String[] ACCEPTED_EXTENSIONS

Constructor Details

PngImageParser

public PngImageParser()

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

Method Details

getChunkTypeName

public static String getChunkTypeName(int chunkType)

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<PngImagingParameters>

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.

filterChunks

private List<PngChunk> filterChunks(List<PngChunk> chunks,
 ChunkType type)

getAcceptedExtensions

protected String[] getAcceptedExtensions()

Description copied from class: AbstractImageParser

Gets an array of all accepted extensions

Specified by:

getAcceptedExtensions in class AbstractImageParser<PngImagingParameters>

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<PngImagingParameters>

Returns:

A valid array of one or more elements.

getBufferedImage

public BufferedImage getBufferedImage(ByteSource byteSource,
 PngImagingParameters 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<PngImagingParameters>

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.

getChunkTypes

public List<String> getChunkTypes(InputStream is)
                           throws ImagingException,
IOException

Parameters:

is - PNG image input stream

Returns:

List of String-formatted chunk types, ie. "tRNs".

Throws:

ImagingException - if it fail to read the PNG chunks

IOException - if it fails to read the input stream data

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<PngImagingParameters>

Returns:

A valid string.

getDefaultParameters

public PngImagingParameters getDefaultParameters()

Description copied from class: AbstractImageParser

Gets a default parameters instance for this parser.

Specified by:

getDefaultParameters in class AbstractImageParser<PngImagingParameters>

Returns:

default parameters instance

getExifMetadata

public TiffImageMetadata getExifMetadata(ByteSource byteSource,
 TiffImagingParameters params)
                                  throws ImagingException,
IOException

Gets TIFF image metadata for a byte source and TIFF parameters.

Parameters:

byteSource - The source of the image.

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

Returns:

TIFF image metadata.

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 read operation.

Since:

1.0-alpha6

getExifRawData

public byte[] getExifRawData(ByteSource byteSource)
                      throws ImagingException,
IOException

Gets TIFF image metadata for a byte source.

Parameters:

byteSource - The source of the image.

Returns:

TIFF image metadata.

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 read operation.

Since:

1.0-alpha6

getIccProfileBytes

public byte[] getIccProfileBytes(ByteSource byteSource,
 PngImagingParameters 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<PngImagingParameters>

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,
 PngImagingParameters 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<PngImagingParameters>

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,
 PngImagingParameters 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<PngImagingParameters>

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.

getMetadata

public ImageMetadata getMetadata(ByteSource byteSource,
 PngImagingParameters 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<PngImagingParameters>

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<PngImagingParameters>

Returns:

a valid, subject-matter-specific string.

getTransparencyFilter

private AbstractTransparencyFilter getTransparencyFilter(PngColorType pngColorType,
 PngChunk pngChunktRNS)
                                                  throws ImagingException,
IOException

Throws:

ImagingException

IOException

getXmpXml

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

Description copied from interface: XmpEmbeddable

Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content. Not all image formats support XMP information and even for those that do, there is no guarantee that such information will be present in an image.

Specified by:

getXmpXml in interface XmpEmbeddable<PngImagingParameters>

Parameters:

byteSource - A valid reference to a ByteSource.

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

Returns:

If XMP metadata is present, a valid string; if it is not present, 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.

hasChunkType

public boolean hasChunkType(ByteSource byteSource,
 ChunkType chunkType)
                     throws ImagingException,
IOException

Throws:

ImagingException

IOException

keepChunk

private boolean keepChunk(int chunkType,
 ChunkType[] chunkTypes)

readChunks

private List<PngChunk> readChunks(ByteSource byteSource,
 ChunkType[] chunkTypes,
 boolean returnAfterFirst)
                           throws ImagingException,
IOException

Throws:

ImagingException

IOException

readChunks

private List<PngChunk> readChunks(InputStream is,
 ChunkType[] chunkTypes,
 boolean returnAfterFirst)
                           throws ImagingException,
IOException

Throws:

ImagingException

IOException

readSignature

public void readSignature(InputStream in)
                   throws ImagingException,
IOException

Reads reads the signature.

Parameters:

in - an input stream.

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 read operation.

writeImage

public void writeImage(BufferedImage src,
 OutputStream os,
 PngImagingParameters params)
                throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Writes the content of a BufferedImage to the specified output stream.

The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will support this capability. Currently, some of the parsers do not check for null arguments.

Overrides:

writeImage in class AbstractImageParser<PngImagingParameters>

Parameters:

src - An image giving the source content for output

os - A valid output stream for storing the formatted image

params - optional parameters, defining format-specific instructions for output (such as selections for data compression, color models, etc.)

Throws:

ImagingException - In the event that the output format cannot handle the input image or invalid params are specified.

IOException - In the event of an write error from the output stream.