net.sf.image4j.codec.bmp
Class BMPDecoder

java.lang.Object
  net.sf.image4j.codec.bmp.BMPDecoder

public class BMPDecoder
extends java.lang.Object

Decodes images in BMP format.

Author:

Ian McDonagh

Constructor Summary

BMPDecoder(java.io.InputStream in)
Creates a new instance of BMPDecoder and reads the BMP data from the source.

Method Summary

java.awt.image.BufferedImage	getBufferedImage() The decoded image read from the source input.
InfoHeader	getInfoHeader() The InfoHeader structure, which provides information about the BMP data.
static java.awt.image.BufferedImage	read(java.io.File file) Reads and decodes BMP data from the source file.
static java.awt.image.BufferedImage	read(InfoHeader infoHeader, LittleEndianInputStream lis) Reads the BMP data from the given InputStream using the information contained in the InfoHeader.
static java.awt.image.BufferedImage	read(InfoHeader infoHeader, LittleEndianInputStream lis, ColorEntry[] colorTable) Reads the BMP data from the given InputStream using the information contained in the InfoHeader.
static java.awt.image.BufferedImage	read(java.io.InputStream in) Reads and decodes BMP data from the source input.
static java.awt.image.BufferedImage	read1(InfoHeader infoHeader, LittleEndianInputStream lis, ColorEntry[] colorTable) Reads 1-bit uncompressed bitmap raster data, which may be monochrome depending on the palette entries in colorTable.
static java.awt.image.BufferedImage	read24(InfoHeader infoHeader, LittleEndianInputStream lis) Reads 24-bit uncompressed bitmap raster data.
static java.awt.image.BufferedImage	read32(InfoHeader infoHeader, LittleEndianInputStream lis) Reads 32-bit uncompressed bitmap raster data, with transparency.
static java.awt.image.BufferedImage	read4(InfoHeader infoHeader, LittleEndianInputStream lis, ColorEntry[] colorTable) Reads 4-bit uncompressed bitmap raster data, which is interpreted based on the colours specified in the palette.
static java.awt.image.BufferedImage	read8(InfoHeader infoHeader, LittleEndianInputStream lis, ColorEntry[] colorTable) Reads 8-bit uncompressed bitmap raster data, which is interpreted based on the colours specified in the palette.
static ColorEntry[]	readColorTable(InfoHeader infoHeader, LittleEndianInputStream lis) Reads the ColorEntry table from the given InputStream using the information contained in the given infoHeader.
static BMPImage	readExt(java.io.File file) Reads and decodes BMP data from the source file, together with metadata.
static BMPImage	readExt(java.io.InputStream in) Reads and decodes BMP data from the source input, together with metadata.
static InfoHeader	readInfoHeader(LittleEndianInputStream lis) Reads the BMP info header structure from the given InputStream.
static InfoHeader	readInfoHeader(LittleEndianInputStream lis, int infoSize)

Methods inherited from class java.lang.Object

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

Constructor Detail

BMPDecoder

public BMPDecoder(java.io.InputStream in)
           throws java.io.IOException

Creates a new instance of BMPDecoder and reads the BMP data from the source.

Parameters:

in - the source InputStream from which to read the BMP data

Throws:

java.io.IOException - if an error occurs

Method Detail

getInfoHeader

public InfoHeader getInfoHeader()

The InfoHeader structure, which provides information about the BMP data.

Returns:

the InfoHeader structure that was read from the source data when this BMPDecoder was created.

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage()

The decoded image read from the source input.

Returns:

the BufferedImage representing the BMP image.

readInfoHeader

public static InfoHeader readInfoHeader(LittleEndianInputStream lis)
                                 throws java.io.IOException

Reads the BMP info header structure from the given InputStream.

Parameters:

lis - the InputStream to read

Returns:

the InfoHeader structure

Throws:

java.io.IOException - if an error occurred

readInfoHeader

public static InfoHeader readInfoHeader(LittleEndianInputStream lis,
                                        int infoSize)
                                 throws java.io.IOException

Throws:

java.io.IOException

Since:

0.6

read

public static java.awt.image.BufferedImage read(InfoHeader infoHeader,
                                                LittleEndianInputStream lis)
                                         throws java.io.IOException

Reads the BMP data from the given InputStream using the information contained in the InfoHeader.

Parameters:

lis - the source input

infoHeader - an InfoHeader that was read by a call to readInfoHeader().

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if an error occurs

read

public static java.awt.image.BufferedImage read(InfoHeader infoHeader,
                                                LittleEndianInputStream lis,
                                                ColorEntry[] colorTable)
                                         throws java.io.IOException

Reads the BMP data from the given InputStream using the information contained in the InfoHeader.

Parameters:

colorTable - ColorEntry array containing palette

infoHeader - an InfoHeader that was read by a call to readInfoHeader().

lis - the source input

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if any error occurs

readColorTable

public static ColorEntry[] readColorTable(InfoHeader infoHeader,
                                          LittleEndianInputStream lis)
                                   throws java.io.IOException

Reads the ColorEntry table from the given InputStream using the information contained in the given infoHeader.

Parameters:

infoHeader - the InfoHeader structure, which was read using readInfoHeader()

lis - the InputStream to read

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if an error occurs

read1

public static java.awt.image.BufferedImage read1(InfoHeader infoHeader,
                                                 LittleEndianInputStream lis,
                                                 ColorEntry[] colorTable)
                                          throws java.io.IOException

Reads 1-bit uncompressed bitmap raster data, which may be monochrome depending on the palette entries in colorTable.

Parameters:

infoHeader - the InfoHeader structure, which was read using readInfoHeader()

lis - the source input

colorTable - ColorEntry array specifying the palette, which must not be null.

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if an error occurs

read4

public static java.awt.image.BufferedImage read4(InfoHeader infoHeader,
                                                 LittleEndianInputStream lis,
                                                 ColorEntry[] colorTable)
                                          throws java.io.IOException

Reads 4-bit uncompressed bitmap raster data, which is interpreted based on the colours specified in the palette.

Parameters:

infoHeader - the InfoHeader structure, which was read using readInfoHeader()

lis - the source input

colorTable - ColorEntry array specifying the palette, which must not be null.

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if an error occurs

read8

public static java.awt.image.BufferedImage read8(InfoHeader infoHeader,
                                                 LittleEndianInputStream lis,
                                                 ColorEntry[] colorTable)
                                          throws java.io.IOException

Reads 8-bit uncompressed bitmap raster data, which is interpreted based on the colours specified in the palette.

Parameters:

infoHeader - the InfoHeader structure, which was read using readInfoHeader()

lis - the source input

colorTable - ColorEntry array specifying the palette, which must not be null.

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if an error occurs

read24

public static java.awt.image.BufferedImage read24(InfoHeader infoHeader,
                                                  LittleEndianInputStream lis)
                                           throws java.io.IOException

Reads 24-bit uncompressed bitmap raster data.

Parameters:

lis - the source input

infoHeader - the InfoHeader structure, which was read using readInfoHeader()

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if an error occurs

read32

public static java.awt.image.BufferedImage read32(InfoHeader infoHeader,
                                                  LittleEndianInputStream lis)
                                           throws java.io.IOException

Reads 32-bit uncompressed bitmap raster data, with transparency.

Parameters:

lis - the source input

infoHeader - the InfoHeader structure, which was read using readInfoHeader()

Returns:

the decoded image read from the source input

Throws:

java.io.IOException - if an error occurs

read

public static java.awt.image.BufferedImage read(java.io.File file)
                                         throws java.io.IOException

Reads and decodes BMP data from the source file.

Parameters:

file - the source file

Returns:

the decoded image read from the source file

Throws:

java.io.IOException - if an error occurs

read

public static java.awt.image.BufferedImage read(java.io.InputStream in)
                                         throws java.io.IOException

Reads and decodes BMP data from the source input.

Parameters:

in - the source input

Returns:

the decoded image read from the source file

Throws:

java.io.IOException - if an error occurs

readExt

public static BMPImage readExt(java.io.File file)
                        throws java.io.IOException

Reads and decodes BMP data from the source file, together with metadata.

Parameters:

file - the source file

Returns:

the decoded image read from the source file

Throws:

java.io.IOException - if an error occurs

Since:

0.7

readExt

public static BMPImage readExt(java.io.InputStream in)
                        throws java.io.IOException

Reads and decodes BMP data from the source input, together with metadata.

Parameters:

in - the source input

Returns:

the decoded image read from the source file

Throws:

java.io.IOException - if an error occurs

Since:

0.7