Class BMPImageWriter

java.lang.Object

javax.imageio.ImageWriter

com.github.jaiimageio.impl.plugins.bmp.BMPImageWriter

All Implemented Interfaces:

BMPConstants, ImageTranscoder

public class BMPImageWriter
extends ImageWriter
implements BMPConstants

The Java Image IO plugin writer for encoding a binary RenderedImage into a BMP format. The encoding process may clip, subsample using the parameters specified in the ImageWriteParam.

See Also:

• BMPImageWriteParam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	BMPImageWriter.IIOWriteProgressAdapter

Field Summary

Fields

Modifier and Type	Field	Description
private int[]	bitMasks
private int[]	bitPos
private byte[]	bpixels
private int	compImageSize
private int	compressionType
private ByteArrayOutputStream	embedded_stream
private int	h
private int[]	ipixels
private boolean	isTopDown
private short[]	spixels
private ImageOutputStream	stream	The output stream to write into
private int	w

Fields inherited from class ImageWriter

availableLocales, locale, originatingProvider, output, progressListeners, 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
BMPImageWriter(ImageWriterSpi originator)	Constructs BMPImageWriter based on the provided ImageWriterSpi.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEncodeImage(int compression, ColorModel cm, SampleModel sm)
protected boolean	canEncodeImage(int compression, ImageTypeSpecifier imgType)
boolean	canWriteRasters()
IIOMetadata	convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)
IIOMetadata	convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)
private void	encodeRLE4(byte[] bipixels, int scanlineBytes)
private void	encodeRLE8(byte[] bpixels, int scanlineBytes)
private int	firstLowBit(int num)
(package private) static int	getCompressionType(String typeString)
IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)
IIOMetadata	getDefaultStreamMetadata(ImageWriteParam param)
ImageWriteParam	getDefaultWriteParam()
(package private) static int	getPreferredCompressionType(ColorModel cm, SampleModel sm)
(package private) static int	getPreferredCompressionType(ImageTypeSpecifier imageType)
private void	incCompImageSize(int value)
private boolean	isEven(int number)
void	reset()
private int	roundBpp(int x)
void	setOutput(Object output)
void	write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param)
private void	writeEmbedded(IIOImage image, ImageWriteParam bmpParam)
private void	writeFileHeader(int fileSize, int offset)
private void	writeInfoHeader(int headerSize, int bitsPerPixel)
protected void	writeMaskToPalette(int mask, int i, byte[] r, byte[] g, byte[] b, byte[] a)
private void	writePixels(int l, int scanlineBytes, int bitsPerPixel, int[] pixels, int padding, int numBands, IndexColorModel icm)
private void	writeSize(int dword, int offset)

Methods inherited from class ImageWriter

abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canInsertEmpty, canInsertImage, canRemoveImage, canReplaceImageMetadata, canReplacePixels, canReplaceStreamMetadata, canWriteEmpty, canWriteSequence, clearAbortRequest, dispose, endInsertEmpty, endReplacePixels, endWriteEmpty, endWriteSequence, getAvailableLocales, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, prepareInsertEmpty, prepareReplacePixels, prepareWriteEmpty, prepareWriteSequence, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replacePixels, replacePixels, replaceStreamMetadata, setLocale, write, write, writeInsert, writeToSequence

Methods inherited from class Object

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

Field Details

stream

private ImageOutputStream stream

The output stream to write into

embedded_stream

private ByteArrayOutputStream embedded_stream

compressionType

private int compressionType

isTopDown

private boolean isTopDown

w

private int w

h

private int h

compImageSize

private int compImageSize

bitMasks

private int[] bitMasks

bitPos

private int[] bitPos

bpixels

private byte[] bpixels

spixels

private short[] spixels

ipixels

private int[] ipixels

Constructor Details

BMPImageWriter

public BMPImageWriter(ImageWriterSpi originator)

Constructs BMPImageWriter based on the provided ImageWriterSpi.

Method Details

setOutput

public void setOutput(Object output)

Overrides:

setOutput in class ImageWriter

getDefaultWriteParam

public ImageWriteParam getDefaultWriteParam()

Overrides:

getDefaultWriteParam in class ImageWriter

getDefaultStreamMetadata

public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)

Specified by:

getDefaultStreamMetadata in class ImageWriter

getDefaultImageMetadata

public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType,
 ImageWriteParam param)

Specified by:

getDefaultImageMetadata in class ImageWriter

convertStreamMetadata

public IIOMetadata convertStreamMetadata(IIOMetadata inData,
 ImageWriteParam param)

Specified by:

convertStreamMetadata in interface ImageTranscoder

Specified by:

convertStreamMetadata in class ImageWriter

convertImageMetadata

public IIOMetadata convertImageMetadata(IIOMetadata inData,
 ImageTypeSpecifier imageType,
 ImageWriteParam param)

Specified by:

convertImageMetadata in interface ImageTranscoder

Specified by:

convertImageMetadata in class ImageWriter

canWriteRasters

public boolean canWriteRasters()

Overrides:

canWriteRasters in class ImageWriter

write

public void write(IIOMetadata streamMetadata,
 IIOImage image,
 ImageWriteParam param)
           throws IOException

Specified by:

write in class ImageWriter

Throws:

IOException

writePixels

private void writePixels(int l,
 int scanlineBytes,
 int bitsPerPixel,
 int[] pixels,
 int padding,
 int numBands,
 IndexColorModel icm)
                  throws IOException

Throws:

IOException

encodeRLE8

private void encodeRLE8(byte[] bpixels,
 int scanlineBytes)
                 throws IOException

Throws:

IOException

encodeRLE4

private void encodeRLE4(byte[] bipixels,
 int scanlineBytes)
                 throws IOException

Throws:

IOException

incCompImageSize

private void incCompImageSize(int value)

isEven

private boolean isEven(int number)

writeFileHeader

private void writeFileHeader(int fileSize,
 int offset)
                      throws IOException

Throws:

IOException

writeInfoHeader

private void writeInfoHeader(int headerSize,
 int bitsPerPixel)
                      throws IOException

Throws:

IOException

writeSize

private void writeSize(int dword,
 int offset)
                throws IOException

Throws:

IOException

reset

public void reset()

Overrides:

reset in class ImageWriter

getCompressionType

static int getCompressionType(String typeString)

writeEmbedded

private void writeEmbedded(IIOImage image,
 ImageWriteParam bmpParam)
                    throws IOException

Throws:

IOException

firstLowBit

private int firstLowBit(int num)

getPreferredCompressionType

static int getPreferredCompressionType(ColorModel cm,
 SampleModel sm)

getPreferredCompressionType

static int getPreferredCompressionType(ImageTypeSpecifier imageType)

canEncodeImage

protected boolean canEncodeImage(int compression,
 ColorModel cm,
 SampleModel sm)

canEncodeImage

protected boolean canEncodeImage(int compression,
 ImageTypeSpecifier imgType)

writeMaskToPalette

protected void writeMaskToPalette(int mask,
 int i,
 byte[] r,
 byte[] g,
 byte[] b,
 byte[] a)

roundBpp

private int roundBpp(int x)