org.icepdf.core.pobjects

Class ImageUtility

java.lang.Object

org.icepdf.core.pobjects.ImageUtility

public class ImageUtility
extends java.lang.Object

Utility methods for applying various colour models and masks to image data.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static int[]	GRAY_1_BIT_INDEX_TO_RGB
protected static int[]	GRAY_1_BIT_INDEX_TO_RGB_REVERSED
protected static int[]	GRAY_2_BIT_INDEX_TO_RGB
protected static int[]	GRAY_4_BIT_INDEX_TO_RGB
protected static int	JPEG_ENC_CMYK
protected static int	JPEG_ENC_GRAY
protected static int	JPEG_ENC_RGB
protected static int	JPEG_ENC_UNKNOWN_PROBABLY_YCbCr
protected static int	JPEG_ENC_YCbCr
protected static int	JPEG_ENC_YCCK

Method Summary

Modifier and Type	Method and Description
protected static java.awt.image.BufferedImage	alterBufferedImageAlpha(java.awt.image.BufferedImage bi, int[] maskMinRGB, int[] maskMaxRGB)
protected static java.awt.image.WritableRaster	alterRasterRGBA(java.awt.image.WritableRaster wr, java.awt.image.BufferedImage smaskImage, java.awt.image.BufferedImage maskImage, int[] maskMinRGB, int[] maskMaxRGB)
static java.awt.image.BufferedImage	applyBlendingMode(java.awt.image.BufferedImage baseImage, Name blendingMode, java.awt.Color blendColor) Blending mode colour transparency test.
static java.awt.image.BufferedImage	applyExplicitMask(java.awt.image.BufferedImage baseImage, java.awt.image.BufferedImage maskImage) (see 8.9.6.3, "Explicit Masking") Explicit Masking algorithm, as of PDF 1.3.
protected static java.awt.image.BufferedImage	applyExplicitMask(java.awt.image.BufferedImage baseImage, java.awt.Color fill) Treats the base image as as mask data applying the specified fill colour to the flagged bytes and a transparency value otherwise.
static java.awt.image.BufferedImage	applyExplicitSMask(java.awt.image.BufferedImage baseImage, java.awt.image.BufferedImage sMaskImage) (see 11.6.5.3, "Soft-Mask Images") A subsidiary image XObject defining a soft-mask image that shall be used as a source of mask shape or mask opacity values in the transparent imaging model.
static java.awt.image.BufferedImage	applyGrayDecode(java.awt.image.BufferedImage rgbImage, int bitsPerComponent, float[] decode)
protected static java.awt.image.BufferedImage	applyIndexColourModel(java.awt.image.WritableRaster wr, PColorSpace colourSpace, int bitsPerComponent) Temporarily pulled out the index colur model application for images from the raw image decode.
static java.awt.image.BufferedImage	convertCmykToRgb(java.awt.image.Raster cmykRaster, float[] decode) Utility method to convert an CMYK based raster to RGB.
static java.awt.image.BufferedImage	convertGrayToRgb(java.awt.image.Raster grayRaster, float[] decode)
static java.awt.image.BufferedImage	convertSpaceToRgb(java.awt.image.Raster colourRaster, PColorSpace colorSpace, float[] decode)
static java.awt.image.BufferedImage	convertYCbCrToRGB(java.awt.image.Raster yCbCrRaster, float[] decode)
static java.awt.image.BufferedImage	convertYCCKToRgb(java.awt.image.Raster ycckRaster, float[] decode)
static java.awt.image.BufferedImage	createBufferedImage(java.awt.Image imageIn)
static java.awt.image.BufferedImage	createBufferedImage(java.awt.Image imageIn, int imageType)
static void	displayImage(java.awt.image.BufferedImage bufferedImage, java.lang.String title)
static ImageUtility	getInstance()
protected static int	getJPEGEncoding(byte[] data, int dataLength)
protected static void	getNormalizedComponents(byte[] pixels, float[] decode, float[] out) Apply the Decode Array domain for each colour component.
static boolean	hasAlpha(java.awt.Image image)
protected static java.awt.image.BufferedImage	jbig2Decode(byte[] data, java.util.HashMap decodeParms, Stream globalsStream)
protected static java.awt.image.BufferedImage	makeBufferedImage(java.awt.image.Raster raster)
protected static java.awt.image.BufferedImage	makeGrayBufferedImage(java.awt.image.WritableRaster wr)
protected static java.awt.image.BufferedImage	makeImageWithRasterFromBytes(PColorSpace colourSpace, GraphicsState graphicsState, int width, int height, int colorSpaceCompCount, int bitsPerComponent, boolean imageMask, float[] decode, java.awt.image.BufferedImage smaskImage, java.awt.image.BufferedImage maskImage, int[] maskMinRGB, int[] maskMaxRGB, int maskMinIndex, int maskMaxIndex, byte[] data, int dataLength)
protected static java.awt.image.BufferedImage	makeRGBABufferedImage(java.awt.image.WritableRaster wr) Utility to build an RGBA buffered image using the specified raster and a Transparency.OPAQUE transparency model.
protected static java.awt.image.BufferedImage	makeRGBABufferedImage(java.awt.image.WritableRaster wr, int transparency) Utility to build an RGBA buffered image using the specified raster and transparency type.
protected static java.awt.image.BufferedImage	makeRGBABufferedImageFromImage(java.awt.Image image)
protected static java.awt.image.BufferedImage	makeRGBBufferedImage(java.awt.image.WritableRaster wr)
protected static java.awt.image.BufferedImage	proJbig2Decode(javax.imageio.stream.ImageInputStream imageInputStream, java.util.HashMap decodeParms, Stream globalsStream)
static java.awt.image.BufferedImage[]	scaleImagesToSameSize(java.awt.image.BufferedImage baseImage, java.awt.image.BufferedImage maskImage) Utility method to scale the two provided images.

Methods inherited from class java.lang.Object

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

Field Detail

GRAY_1_BIT_INDEX_TO_RGB_REVERSED

protected static final int[] GRAY_1_BIT_INDEX_TO_RGB_REVERSED

GRAY_1_BIT_INDEX_TO_RGB

protected static final int[] GRAY_1_BIT_INDEX_TO_RGB

GRAY_2_BIT_INDEX_TO_RGB

protected static final int[] GRAY_2_BIT_INDEX_TO_RGB

GRAY_4_BIT_INDEX_TO_RGB

protected static final int[] GRAY_4_BIT_INDEX_TO_RGB

JPEG_ENC_UNKNOWN_PROBABLY_YCbCr

protected static final int JPEG_ENC_UNKNOWN_PROBABLY_YCbCr

See Also:

Constant Field Values

JPEG_ENC_RGB

protected static final int JPEG_ENC_RGB

See Also:

Constant Field Values

JPEG_ENC_CMYK

protected static final int JPEG_ENC_CMYK

See Also:

Constant Field Values

JPEG_ENC_YCbCr

protected static final int JPEG_ENC_YCbCr

See Also:

Constant Field Values

JPEG_ENC_YCCK

protected static final int JPEG_ENC_YCCK

See Also:

Constant Field Values

JPEG_ENC_GRAY

protected static final int JPEG_ENC_GRAY

See Also:

Constant Field Values

Method Detail

getInstance

public static ImageUtility getInstance()

alterBufferedImageAlpha

protected static java.awt.image.BufferedImage alterBufferedImageAlpha(java.awt.image.BufferedImage bi,
                                                                      int[] maskMinRGB,
                                                                      int[] maskMaxRGB)

displayImage

public static void displayImage(java.awt.image.BufferedImage bufferedImage,
                                java.lang.String title)

makeRGBABufferedImage

protected static java.awt.image.BufferedImage makeRGBABufferedImage(java.awt.image.WritableRaster wr)

Utility to build an RGBA buffered image using the specified raster and a Transparency.OPAQUE transparency model.

Parameters:

wr - writable raster of image.

Returns:

constructed image.

makeRGBABufferedImage

protected static java.awt.image.BufferedImage makeRGBABufferedImage(java.awt.image.WritableRaster wr,
                                                                    int transparency)

Utility to build an RGBA buffered image using the specified raster and transparency type.

Parameters:

wr - writable raster of image.

transparency - any valid Transparency interface type. Bitmask, opaque and translucent.

Returns:

constructed image.

makeBufferedImage

protected static java.awt.image.BufferedImage makeBufferedImage(java.awt.image.Raster raster)

makeRGBBufferedImage

protected static java.awt.image.BufferedImage makeRGBBufferedImage(java.awt.image.WritableRaster wr)

makeGrayBufferedImage

protected static java.awt.image.BufferedImage makeGrayBufferedImage(java.awt.image.WritableRaster wr)

makeRGBABufferedImageFromImage

protected static java.awt.image.BufferedImage makeRGBABufferedImageFromImage(java.awt.Image image)

hasAlpha

public static boolean hasAlpha(java.awt.Image image)

getNormalizedComponents

protected static void getNormalizedComponents(byte[] pixels,
                                              float[] decode,
                                              float[] out)

Apply the Decode Array domain for each colour component. Assumes output range is 0-1f for each value in out.

Parameters:

pixels - colour to process by decode

decode - decode array for colour space

out - return value always (2^{bitsPerComponent} - 1).

alterRasterRGBA

protected static java.awt.image.WritableRaster alterRasterRGBA(java.awt.image.WritableRaster wr,
                                                               java.awt.image.BufferedImage smaskImage,
                                                               java.awt.image.BufferedImage maskImage,
                                                               int[] maskMinRGB,
                                                               int[] maskMaxRGB)

applyExplicitMask

public static java.awt.image.BufferedImage applyExplicitMask(java.awt.image.BufferedImage baseImage,
                                                             java.awt.image.BufferedImage maskImage)

(see 8.9.6.3, "Explicit Masking") Explicit Masking algorithm, as of PDF 1.3. The entry in an image dictionary may be an image mask, as described under "Stencil Masking", which serves as an explicit mask for the primary or base image. The base image and the image mask need not have the same resolution (width, height), but since all images are defined on the unit square in user space, their boundaries on the page will conincide; that is, they will overlay each other.

The image mask indicates indicates which places on the page are to be painted and which are to be masked out (left unchanged). Unmasked areas are painted with the corresponding portions of the base image; masked areas are not.

Parameters:

baseImage - base image in which the mask weill be applied to

maskImage - image mask to be applied to base image.

applyBlendingMode

public static java.awt.image.BufferedImage applyBlendingMode(java.awt.image.BufferedImage baseImage,
                                                             Name blendingMode,
                                                             java.awt.Color blendColor)

Blending mode colour transparency test.

Parameters:

baseImage -

blendingMode -

blendColor -

Returns:

applyExplicitSMask

public static java.awt.image.BufferedImage applyExplicitSMask(java.awt.image.BufferedImage baseImage,
                                                              java.awt.image.BufferedImage sMaskImage)

(see 11.6.5.3, "Soft-Mask Images") A subsidiary image XObject defining a soft-mask image that shall be used as a source of mask shape or mask opacity values in the transparent imaging model. The alpha source parameter in the graphics state determines whether the mask values shall be interpreted as shape or opacity.

If present, this entry shall override the current soft mask in the graphics state, as well as the image’s Mask entry, if any. However, the other transparency-related graphics state parameters—blend mode and alpha constant—shall remain in effect. If SMask is absent, the image shall have no associated soft mask (although the current soft mask in the graphics state may still apply).

Parameters:

baseImage - base image in which the mask weill be applied to

applyExplicitMask

protected static java.awt.image.BufferedImage applyExplicitMask(java.awt.image.BufferedImage baseImage,
                                                                java.awt.Color fill)

Treats the base image as as mask data applying the specified fill colour to the flagged bytes and a transparency value otherwise. This method creates a new BufferedImage with a transparency model so it will cause a memory spike.

Parameters:

baseImage - masking image.

fill - fill value to apply to mask.

Returns:

masked image encoded with the fill colour and transparency.

applyIndexColourModel

protected static java.awt.image.BufferedImage applyIndexColourModel(java.awt.image.WritableRaster wr,
                                                                    PColorSpace colourSpace,
                                                                    int bitsPerComponent)

Temporarily pulled out the index colur model application for images from the raw image decode. This method is only called from JPEG2000 code for now but will be consolidate as we move to to 5.0

proJbig2Decode

protected static java.awt.image.BufferedImage proJbig2Decode(javax.imageio.stream.ImageInputStream imageInputStream,
                                                             java.util.HashMap decodeParms,
                                                             Stream globalsStream)
                                                      throws java.lang.reflect.InvocationTargetException,
                                                             java.lang.IllegalAccessException,
                                                             java.lang.NoSuchMethodException,
                                                             java.io.IOException,
                                                             java.lang.ClassNotFoundException,
                                                             java.lang.InstantiationException

Throws:

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.NoSuchMethodException

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException

jbig2Decode

protected static java.awt.image.BufferedImage jbig2Decode(byte[] data,
                                                          java.util.HashMap decodeParms,
                                                          Stream globalsStream)

getJPEGEncoding

protected static int getJPEGEncoding(byte[] data,
                                     int dataLength)

applyGrayDecode

public static java.awt.image.BufferedImage applyGrayDecode(java.awt.image.BufferedImage rgbImage,
                                                           int bitsPerComponent,
                                                           float[] decode)

convertSpaceToRgb

public static java.awt.image.BufferedImage convertSpaceToRgb(java.awt.image.Raster colourRaster,
                                                             PColorSpace colorSpace,
                                                             float[] decode)

convertGrayToRgb

public static java.awt.image.BufferedImage convertGrayToRgb(java.awt.image.Raster grayRaster,
                                                            float[] decode)

convertCmykToRgb

public static java.awt.image.BufferedImage convertCmykToRgb(java.awt.image.Raster cmykRaster,
                                                            float[] decode)

Utility method to convert an CMYK based raster to RGB. The can be configured to use to different approaches. The first and more accurate method uses a ICC color profile specified by the DeviceCMYK.java class. This method can be turned off using the system property org.icepdf.core.cmyk.disableICCProfile=true at which point an less precise method is used to calculate the resultan RGB color.

Parameters:

cmykRaster - CMYK base raster to convert to RGB.

Returns:

Buffered image representation of raster.

convertYCbCrToRGB

public static java.awt.image.BufferedImage convertYCbCrToRGB(java.awt.image.Raster yCbCrRaster,
                                                             float[] decode)

convertYCCKToRgb

public static java.awt.image.BufferedImage convertYCCKToRgb(java.awt.image.Raster ycckRaster,
                                                            float[] decode)

makeImageWithRasterFromBytes

protected static java.awt.image.BufferedImage makeImageWithRasterFromBytes(PColorSpace colourSpace,
                                                                           GraphicsState graphicsState,
                                                                           int width,
                                                                           int height,
                                                                           int colorSpaceCompCount,
                                                                           int bitsPerComponent,
                                                                           boolean imageMask,
                                                                           float[] decode,
                                                                           java.awt.image.BufferedImage smaskImage,
                                                                           java.awt.image.BufferedImage maskImage,
                                                                           int[] maskMinRGB,
                                                                           int[] maskMaxRGB,
                                                                           int maskMinIndex,
                                                                           int maskMaxIndex,
                                                                           byte[] data,
                                                                           int dataLength)

createBufferedImage

public static java.awt.image.BufferedImage createBufferedImage(java.awt.Image imageIn)

createBufferedImage

public static java.awt.image.BufferedImage createBufferedImage(java.awt.Image imageIn,
                                                               int imageType)

scaleImagesToSameSize

public static java.awt.image.BufferedImage[] scaleImagesToSameSize(java.awt.image.BufferedImage baseImage,
                                                                   java.awt.image.BufferedImage maskImage)

Utility method to scale the two provided images. There are two modes based on the system property "". The d

Parameters:

baseImage - base image that mask will be applied to

maskImage - mask image that will be applied to base image.

Returns:

array of altered baseImage and maskImage, should be same size on return.