BMPReader (JImageReader 1.2.0 API)

java.lang.Object
- com.ajtjp.jImageReader.reader.BMPReader

All Implemented Interfaces:

JImageReader
```
public class BMPReader
extends Object
implements JImageReader
```
Reads many types of Windows and OS/2 bitmap (.bmp) images. Currently supported .bmps by format are:
- Windows 3 bitmaps. This is most of the bitmaps you'll encounter today.
- Windows 2 and OS/2 bitmaps (versions 1 and 2)
- NT 3.1 bitmaps
- Photoshop for Windows NT bitmaps, which have an alpha channel
- Windows 4 and 5 bitmaps can be opened, but their additional features are not supported
Currently unsupported .bmps by format are:
- Windows 1 bitmaps
- Advanced features of Windows 4 and 5 bitmaps
- OS/2 2.x bitmaps with shorter-than-standard headers
- Absolute mode bitmaps
- Bitmaps with embedded PNGs or JPGs
Supported bit depths/compression
- Unencoded bitmaps
- The RGB components (but not alpha) of unencoded 32-bit bitmaps
- RLE encoded bitmaps at 4 and 8 bit depth
- Bitfield encoded bitmaps at 16 and 32 bit depths
- Palette-encoded bitmaps of various depths from 1 bit up (including 4 and 24)
- Bitmaps with more than 8 bits for one or more color components (these are rounded to the nearest possible 8-bit representation)
Unsupported bit depths/compression:
- Two-bit depth bitmaps
- Bitmaps using Huffman encoding (only present on some OS/2 bitmaps)
The test case provides granular examples of precisely what is supported, as well as what is not yet supported.
Since:

March 28, 2011

Author:

Andrew

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class BMPReader.Palette
Class that represents the palette for a bitmap file.

Nested Classes
Modifier and Type	Class and Description
`class`	`BMPReader.Palette` Class that represents the palette for a bitmap file.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BITFIELDS`
`static int`	`COLORSPACE_CALIBRATED_RGB`
`static int`	`COLORSPACE_DEVICE_DEPENDENT_CYMK`
`static int`	`COLORSPACE_DEVICE_DEPENDENT_RGB`
`static int`	`NONE`
`static int`	`OS2_2_BMP`
`static int`	`RLE_4BIT`
`static int`	`RLE_8BIT`
`static short`	`TYPE_WIN1`
`static short`	`TYPE_WIN234`
`static int`	`WINDOWS_2_BMP`
`static int`	`WINDOWS_3_BMP`
`static int`	`WINDOWS_95_BMP`
`static int`	`WINDOWS_NT_ALPHA_BMP`
`static int`	`WINDOWS_NT_BMP`

Constructor Summary

Constructors
Constructor and Description

BMPReader()

BMPReader(String string)

Constructors
Constructor and Description
`BMPReader()`
`BMPReader(String string)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createBitmapFilter(BufferedImage image)` Creates a bitmap from the image.
`void`	`createBufferedImage()`
`void`	`createRawData()` Creates raw binary data for the image portion of the file
`void`	`exportFile(String fileName)`
`void`	`exportImage(BufferedImage image, String fileName)`
`int`	`getBitsPerPixel()`
`int`	`getHeight()` Returns the image's height.
`BufferedImage`	`getImage()` Returns the image that the reader has imported.
`String`	`getMetadataSummary()` Returns a summary of the image's metadata.
`Color[]`	`getPaletteColors()` Returns the colors in the BMP's palette.
`int`	`getPaletteIndexAt(int x, int y)` Returns the color's palette index.
`int`	`getPaletteSize()`
`int`	`getWidth()` Returns the image's width.
`void`	`parse()`
`void`	`processFile()` Processes the file supplied at initialization, and stores the image in the reader.
`void`	`processFile(boolean createImage)` Allows us to process the file and not create an image.
`void`	`readFile()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - WINDOWS_2_BMP
```
public static final int WINDOWS_2_BMP
```
    See Also:
    
    Constant Field Values
  - WINDOWS_3_BMP
```
public static final int WINDOWS_3_BMP
```
    See Also:
    
    Constant Field Values
  - WINDOWS_NT_BMP
```
public static final int WINDOWS_NT_BMP
```
    See Also:
    
    Constant Field Values
  - WINDOWS_NT_ALPHA_BMP
```
public static final int WINDOWS_NT_ALPHA_BMP
```
    See Also:
    
    Constant Field Values
  - OS2_2_BMP
```
public static final int OS2_2_BMP
```
    See Also:
    
    Constant Field Values
  - WINDOWS_95_BMP
```
public static final int WINDOWS_95_BMP
```
    See Also:
    
    Constant Field Values
  - TYPE_WIN1
```
public static final short TYPE_WIN1
```
    See Also:
    
    Constant Field Values
  - TYPE_WIN234
```
public static final short TYPE_WIN234
```
    See Also:
    
    Constant Field Values
  - NONE
```
public static final int NONE
```
    See Also:
    
    Constant Field Values
  - RLE_8BIT
```
public static final int RLE_8BIT
```
    See Also:
    
    Constant Field Values
  - RLE_4BIT
```
public static final int RLE_4BIT
```
    See Also:
    
    Constant Field Values
  - BITFIELDS
```
public static final int BITFIELDS
```
    See Also:
    
    Constant Field Values
  - COLORSPACE_CALIBRATED_RGB
```
public static final int COLORSPACE_CALIBRATED_RGB
```
    See Also:
    
    Constant Field Values
  - COLORSPACE_DEVICE_DEPENDENT_RGB
```
public static final int COLORSPACE_DEVICE_DEPENDENT_RGB
```
    See Also:
    
    Constant Field Values
  - COLORSPACE_DEVICE_DEPENDENT_CYMK
```
public static final int COLORSPACE_DEVICE_DEPENDENT_CYMK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BMPReader
```
public BMPReader()
```
  - BMPReader
```
public BMPReader(String string)
```
- Method Detail
  - processFile
```
public void processFile(boolean createImage)
```
    Allows us to process the file and not create an image. This could be useful for saving memory.
    
    Parameters:
    
    createImage - Whether the BufferedImage should be created.
  - processFile
```
public void processFile()
                 throws UnsupportedVariantException
```
    Description copied from interface: JImageReader
    
    Processes the file supplied at initialization, and stores the image in the reader.
    
    Specified by:
    
    processFile in interface JImageReader
    
    Throws:
    
    UnsupportedVariantException - If the supplied file is a variant of the reader's format that is not supported.
  - readFile
```
public void readFile()
```
  - parse
```
public void parse()
           throws UnsupportedVariantException
```
    Throws:
    
    UnsupportedVariantException
  - createBufferedImage
```
public void createBufferedImage()
```
  - getImage
```
public BufferedImage getImage()
```
    Description copied from interface: JImageReader
    
    Returns the image that the reader has imported.
    
    Specified by:
    
    getImage in interface JImageReader
    
    Returns:
    
    The image that has been read from the file.
  - getWidth
```
public int getWidth()
```
    Description copied from interface: JImageReader
    
    Returns the image's width.
    
    Specified by:
    
    getWidth in interface JImageReader
    
    Returns:
    
    The image's width.
  - getHeight
```
public int getHeight()
```
    Description copied from interface: JImageReader
    
    Returns the image's height.
    
    Specified by:
    
    getHeight in interface JImageReader
    
    Returns:
    
    The image's height.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - createBitmapFilter
```
public void createBitmapFilter(BufferedImage image)
```
    Creates a bitmap from the image. Right now creates a 24-bit uncompressed Windows 3 bitmap.
    
    Parameters:
    
    image - The AWT BufferedImage that will be converted to a bitmap.
  - createRawData
```
public void createRawData()
```
    Creates raw binary data for the image portion of the file
  - exportFile
```
public void exportFile(String fileName)
```
  - exportImage
```
public void exportImage(BufferedImage image,
                        String fileName)
```
  - getPaletteSize
```
public int getPaletteSize()
```
  - getPaletteColors
```
public Color[] getPaletteColors()
```
    Returns the colors in the BMP's palette. Only valid if this is an indexed BMP.
    
    Returns:
    
    An array of the colors in the BMP's palette.
  - getPaletteIndexAt
```
public int getPaletteIndexAt(int x,
                             int y)
```
    Returns the color's palette index.
    
    Parameters:
    
    x - - Color's x coordinate
    
    y - - Color's y coordinate
    
    Returns:
    
    The color at the provided x, y coordinates.
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
  - getMetadataSummary
```
public String getMetadataSummary()
```
    Description copied from interface: JImageReader
    
    Returns a summary of the image's metadata. This will likely not be a String in future releases.
    
    Specified by:
    
    getMetadataSummary in interface JImageReader
    
    Returns:
    
    A summary fo the image's metadata.

Class BMPReader

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WINDOWS_2_BMP

WINDOWS_3_BMP

WINDOWS_NT_BMP

WINDOWS_NT_ALPHA_BMP

OS2_2_BMP

WINDOWS_95_BMP

TYPE_WIN1

TYPE_WIN234

NONE

RLE_8BIT

RLE_4BIT

BITFIELDS

COLORSPACE_CALIBRATED_RGB

COLORSPACE_DEVICE_DEPENDENT_RGB

COLORSPACE_DEVICE_DEPENDENT_CYMK

Constructor Detail

BMPReader

BMPReader

Method Detail

processFile

processFile

readFile

parse

createBufferedImage

getImage

getWidth

getHeight

toString

createBitmapFilter

createRawData

exportFile

exportImage

getPaletteSize

getPaletteColors

getPaletteIndexAt

getBitsPerPixel

getMetadataSummary