Class BMPImageReader

java.lang.Object

javax.imageio.ImageReader

com.github.jaiimageio.impl.plugins.bmp.BMPImageReader

All Implemented Interfaces:

BMPConstants

public class BMPImageReader
extends ImageReader
implements BMPConstants

This class is the Java Image IO plugin reader for BMP images. It may subsample the image, clip the image, select sub-bands, and shift the decoded image origin if the proper decoding parameter are set in the provided ImageReadParam. This class supports Microsoft Windows Bitmap Version 3-5, as well as OS/2 Bitmap Version 2.x (for single-image BMP file).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	BMPImageReader.EmbeddedProgressAdapter

Field Summary

Fields

Modifier and Type	Field	Description
private int	alphaMask
private BufferedImage	bi	The destination image.
private long	bitmapFileSize
private long	bitmapOffset
private int	bitsPerPixel
private int	blueMask
private ColorModel	colorModel
private long	compression
private int[]	destBands	source and destination bands.
private Rectangle	destinationRegion	The destination region.
private boolean	gotHeader	Indicates whether the header is read.
private int	greenMask
private int	height	The original image height.
private ImageInputStream	iis	The input stream where reads from
private long	imageDataOffset	The stream position where the image data starts.
private long	imageSize
private int	imageType
private boolean	isBottomUp
private BMPMetadata	metadata	The metadata from the stream.
private boolean	noTransform	Indicates whether subsampled, subregion is required, and offset is defined
private int	numBands
private ColorModel	originalColorModel
private SampleModel	originalSampleModel
private byte[]	palette
private int	redMask
private SampleModel	sampleModel
private int	scaleX	The scaling factors.
private int	scaleY	The scaling factors.
private boolean	seleBand	Indicates whether subband is selected.
private int[]	sourceBands	source and destination bands.
private Rectangle	sourceRegion	The source region.
private static final int	VERSION_2_1_BIT
private static final int	VERSION_2_24_BIT
private static final int	VERSION_2_4_BIT
private static final int	VERSION_2_8_BIT
private static final int	VERSION_3_1_BIT
private static final int	VERSION_3_24_BIT
private static final int	VERSION_3_4_BIT
private static final int	VERSION_3_8_BIT
private static final int	VERSION_3_NT_16_BIT
private static final int	VERSION_3_NT_32_BIT
private static final int	VERSION_3_XP_EMBEDDED
private static final int	VERSION_4_1_BIT
private static final int	VERSION_4_16_BIT
private static final int	VERSION_4_24_BIT
private static final int	VERSION_4_32_BIT
private static final int	VERSION_4_4_BIT
private static final int	VERSION_4_8_BIT
private static final int	VERSION_4_XP_EMBEDDED
private static final int	VERSION_5_XP_EMBEDDED
private int	width	The original image width.

Fields inherited from class ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Fields inherited from interface BMPConstants

BI_BITFIELDS, BI_JPEG, BI_PNG, BI_RGB, BI_RLE4, BI_RLE8, compressionTypeNames, LCS_CALIBRATED_RGB, LCS_sRGB, LCS_WINDOWS_COLOR_SPACE, PROFILE_EMBEDDED, PROFILE_LINKED, VERSION_2, VERSION_3, VERSION_3_NT, VERSION_4, VERSION_5

Constructor Summary

Constructors

Constructor	Description
BMPImageReader(ImageReaderSpi originator)	Constructs BMPImageReader from the provided ImageReaderSpi.

Method Summary

Modifier and Type	Method	Description
boolean	canReadRaster()
private void	checkIndex(int imageIndex)
private void	decodeRLE4(int imSize, int padding, byte[] values, byte[] bdata)
private void	decodeRLE8(int imSize, int padding, byte[] values, byte[] bdata)
ImageReadParam	getDefaultReadParam()
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)
Iterator	getImageTypes(int imageIndex)
int	getNumImages(boolean allowSearch)	Overrides the method defined in the superclass.
IIOMetadata	getStreamMetadata()
int	getWidth(int imageIndex)
boolean	isRandomAccessEasy(int imageIndex)
BufferedImage	read(int imageIndex, ImageReadParam param)
private void	read16Bit(short[] sdata)
private void	read1Bit(byte[] bdata)
private void	read24Bit(byte[] bdata)
private void	read32Bit(int[] idata)
private void	read4Bit(byte[] bdata)
private void	read8Bit(byte[] bdata)
private BufferedImage	readEmbedded(int type, BufferedImage bi, ImageReadParam bmpParam)	Decodes the jpeg/png image embedded in the bitmap using any jpeg ImageIO-style plugin.
void	readHeader()
Raster	readRaster(int imageIndex, ImageReadParam param)
private void	readRLE4(byte[] bdata)
private void	readRLE8(byte[] bdata)
void	reset()
private void	resetHeaderInfo()
void	setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)	Overrides the method defined in the superclass.

Methods inherited from class ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAspectRatio, getAvailableLocales, getDestination, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, hasThumbnails, isIgnoringMetadata, isImageTiled, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, setInput, setInput, setLocale

Methods inherited from class Object

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

Field Details

VERSION_2_1_BIT

private static final int VERSION_2_1_BIT

See Also:

• Constant Field Values

VERSION_2_4_BIT

private static final int VERSION_2_4_BIT

See Also:

• Constant Field Values

VERSION_2_8_BIT

private static final int VERSION_2_8_BIT

See Also:

• Constant Field Values

VERSION_2_24_BIT

private static final int VERSION_2_24_BIT

See Also:

• Constant Field Values

VERSION_3_1_BIT

private static final int VERSION_3_1_BIT

See Also:

• Constant Field Values

VERSION_3_4_BIT

private static final int VERSION_3_4_BIT

See Also:

• Constant Field Values

VERSION_3_8_BIT

private static final int VERSION_3_8_BIT

See Also:

• Constant Field Values

VERSION_3_24_BIT

private static final int VERSION_3_24_BIT

See Also:

• Constant Field Values

VERSION_3_NT_16_BIT

private static final int VERSION_3_NT_16_BIT

See Also:

• Constant Field Values

VERSION_3_NT_32_BIT

private static final int VERSION_3_NT_32_BIT

See Also:

• Constant Field Values

VERSION_4_1_BIT

private static final int VERSION_4_1_BIT

See Also:

• Constant Field Values

VERSION_4_4_BIT

private static final int VERSION_4_4_BIT

See Also:

• Constant Field Values

VERSION_4_8_BIT

private static final int VERSION_4_8_BIT

See Also:

• Constant Field Values

VERSION_4_16_BIT

private static final int VERSION_4_16_BIT

See Also:

• Constant Field Values

VERSION_4_24_BIT

private static final int VERSION_4_24_BIT

See Also:

• Constant Field Values

VERSION_4_32_BIT

private static final int VERSION_4_32_BIT

See Also:

• Constant Field Values

VERSION_3_XP_EMBEDDED

private static final int VERSION_3_XP_EMBEDDED

See Also:

• Constant Field Values

VERSION_4_XP_EMBEDDED

private static final int VERSION_4_XP_EMBEDDED

See Also:

• Constant Field Values

VERSION_5_XP_EMBEDDED

private static final int VERSION_5_XP_EMBEDDED

See Also:

• Constant Field Values

bitmapFileSize

private long bitmapFileSize

bitmapOffset

private long bitmapOffset

compression

private long compression

imageSize

private long imageSize

palette

private byte[] palette

imageType

private int imageType

numBands

private int numBands

isBottomUp

private boolean isBottomUp

bitsPerPixel

private int bitsPerPixel

redMask

private int redMask

greenMask

private int greenMask

blueMask

private int blueMask

alphaMask

private int alphaMask

sampleModel

private SampleModel sampleModel

originalSampleModel

private SampleModel originalSampleModel

colorModel

private ColorModel colorModel

originalColorModel

private ColorModel originalColorModel

iis

private ImageInputStream iis

The input stream where reads from

gotHeader

private boolean gotHeader

Indicates whether the header is read.

imageDataOffset

private long imageDataOffset

The stream position where the image data starts.

width

private int width

The original image width.

height

private int height

The original image height.

destinationRegion

private Rectangle destinationRegion

The destination region.

sourceRegion

private Rectangle sourceRegion

The source region.

metadata

private BMPMetadata metadata

The metadata from the stream.

bi

private BufferedImage bi

The destination image.

noTransform

private boolean noTransform

Indicates whether subsampled, subregion is required, and offset is defined

seleBand

private boolean seleBand

Indicates whether subband is selected.

scaleX

private int scaleX

The scaling factors.

scaleY

private int scaleY

The scaling factors.

sourceBands

private int[] sourceBands

source and destination bands.

destBands

private int[] destBands

source and destination bands.

Constructor Details

BMPImageReader

public BMPImageReader(ImageReaderSpi originator)

Constructs BMPImageReader from the provided ImageReaderSpi.

Method Details

setInput

public void setInput(Object input,
 boolean seekForwardOnly,
 boolean ignoreMetadata)

Overrides the method defined in the superclass.

Overrides:

setInput in class ImageReader

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Overrides the method defined in the superclass.

Specified by:

getNumImages in class ImageReader

Throws:

IOException

getWidth

public int getWidth(int imageIndex)
             throws IOException

Specified by:

getWidth in class ImageReader

Throws:

IOException

getHeight

public int getHeight(int imageIndex)
              throws IOException

Specified by:

getHeight in class ImageReader

Throws:

IOException

checkIndex

private void checkIndex(int imageIndex)

readHeader

public void readHeader()
                throws IOException

Throws:

IOException

getImageTypes

public Iterator getImageTypes(int imageIndex)
                       throws IOException

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

getDefaultReadParam

public ImageReadParam getDefaultReadParam()

Overrides:

getDefaultReadParam in class ImageReader

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Specified by:

getImageMetadata in class ImageReader

Throws:

IOException

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IOException

Specified by:

getStreamMetadata in class ImageReader

Throws:

IOException

isRandomAccessEasy

public boolean isRandomAccessEasy(int imageIndex)
                           throws IOException

Overrides:

isRandomAccessEasy in class ImageReader

Throws:

IOException

read

public BufferedImage read(int imageIndex,
 ImageReadParam param)
                   throws IOException

Specified by:

read in class ImageReader

Throws:

IOException

canReadRaster

public boolean canReadRaster()

Overrides:

canReadRaster in class ImageReader

readRaster

public Raster readRaster(int imageIndex,
 ImageReadParam param)
                  throws IOException

Overrides:

readRaster in class ImageReader

Throws:

IOException

resetHeaderInfo

private void resetHeaderInfo()

reset

public void reset()

Overrides:

reset in class ImageReader

read1Bit

private void read1Bit(byte[] bdata)
               throws IOException

Throws:

IOException

read4Bit

private void read4Bit(byte[] bdata)
               throws IOException

Throws:

IOException

read8Bit

private void read8Bit(byte[] bdata)
               throws IOException

Throws:

IOException

read24Bit

private void read24Bit(byte[] bdata)
                throws IOException

Throws:

IOException

read16Bit

private void read16Bit(short[] sdata)
                throws IOException

Throws:

IOException

read32Bit

private void read32Bit(int[] idata)
                throws IOException

Throws:

IOException

readRLE8

private void readRLE8(byte[] bdata)
               throws IOException

Throws:

IOException

decodeRLE8

private void decodeRLE8(int imSize,
 int padding,
 byte[] values,
 byte[] bdata)
                 throws IOException

Throws:

IOException

readRLE4

private void readRLE4(byte[] bdata)
               throws IOException

Throws:

IOException

decodeRLE4

private void decodeRLE4(int imSize,
 int padding,
 byte[] values,
 byte[] bdata)
                 throws IOException

Throws:

IOException

readEmbedded

private BufferedImage readEmbedded(int type,
 BufferedImage bi,
 ImageReadParam bmpParam)
                            throws IOException

Decodes the jpeg/png image embedded in the bitmap using any jpeg ImageIO-style plugin.

Parameters:

bi - The destination BufferedImage.

bmpParam - The ImageReadParam for decoding this BMP image. The parameters for subregion, band selection and subsampling are used in decoding the jpeg image.

Throws:

IOException