Package net.sourceforge.jiu.codecs
Class BMPCodec
java.lang.Object
net.sourceforge.jiu.ops.Operation
net.sourceforge.jiu.codecs.ImageCodec
net.sourceforge.jiu.codecs.BMPCodec
A codec to read and write Windows BMP image files.
Typical file extensions are .bmp
and .rle
(the latter is only used for compressed files).
Bounds
This codec supports the bounds concept for loading and saving.
Supported BMP types when loading
- Bilevel, 1 bit per pixel, uncompressed.
BMP supports palettes for bilevel images, but the content of that
palette is ignored and 0 is considered black and 1 white.
Any class implementing
BilevelImage
can be given to the codec and it will load the image to that object (if the image's resolution is sufficient). If no image object is given to the codec, a newMemoryBilevelImage
will be created. - Paletted, 4 bits per pixel, uncompressed or RLE4 compression.
Both types are loaded to a
Paletted8Image
object. This requires 50 % more space than is necessary, but there is no dedicated 4 bit image data class in JIU. - Paletted, 8 bits per pixel, uncompressed or RLE8 compression.
Both types are loaded to a
Paletted8Image
object. - RGB truecolor, 24 bits per pixel, uncompressed.
This is loaded to a
RGB24Image
object.
Supported JIU image data classes when saving to BMP
BilevelImage
objects are stored as 1 bit per pixel BMP files.Gray8Image
andPaletted8Image
objects are stored as paletted 8 bits per pixel files. It doesn't really matter how many entries the palette has, the BMP file's palette will always have 256 entries, filled up with zero entries if necessary.RGB24Image
objects are stored as 24 bpp BMP files.
I/O classes
BMPCodec works with all input and output classes supported by ImageCodec (InputStream
, OutputStream
,
DataInput
, DataOutput
,
RandomAccessFile
).
Problems
The RLE-compressed BMP files that I could test this codec on seem to
have an end-of-line code at the end of every line instead of relying
on the decoder to know when it has unpacked enough bytes for a line.
Whenever this codec encounters an EOL symbol and has a current column
value of 0
, the EOL is ignored.
Usage examples
Write an image to a BMP file.BMPCodec codec = new BMPCodec(); codec.setImage(image); codec.setFile("out.bmp", CodecMode.SAVE); codec.process(); codec.close();Read an image from a BMP file.
BMPCodec codec = new BMPCodec(); codec.setFile("image.bmp", CodecMode.LOAD); codec.process(); codec.close(); PixelImage image = codec.getImage();
- Since:
- 0.7.0
- Author:
- Marco Schmidt
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private int
private int
private int
private int
private DataInput
private DataOutput
private Palette
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns all file extensions that are typical for this file format.Returns the name of the file format supported by this codec.String[]
Return the MIME (Multipurpose Internet Mail Extensions) type strings for this format, ornull
if none are available.boolean
Returns if this codec is able to load images in the file format supported by this codec.boolean
Returns if this codec is able to save images in the file format supported by this codec.private void
load()
private void
private void
private void
private void
private void
private void
private void
private void
private void
void
process()
This method does the actual work of the operation.private void
save()
suggestFileExtension
(PixelImage image) Attempts to suggest a filename extension.private void
writeHeader
(PixelImage image, int filesize, int offset, int numBits) private void
writeInt
(int value) private void
Write the palette associated with the image getImage().private void
writeShort
(int value) private void
Methods inherited from class net.sourceforge.jiu.codecs.ImageCodec
appendComment, checkBounds, checkImageResolution, close, getBoundsHeight, getBoundsWidth, getBoundsX1, getBoundsX2, getBoundsY1, getBoundsY2, getComment, getDataInput, getDataOutput, getDpiX, getDpiY, getImage, getImageIndex, getInputAsDataInput, getInputStream, getMode, getNumComments, getOutputAsDataOutput, getOutputStream, getRandomAccessFile, hasBounds, initModeFromIOObjects, isRowRequired, isTileRequired, removeAllComments, removeBounds, setBounds, setBoundsIfNecessary, setDataInput, setDataOutput, setDpi, setFile, setFile, setImage, setImageIndex, setInputStream, setOutputStream, setRandomAccessFile
Methods inherited from class net.sourceforge.jiu.ops.Operation
addProgressListener, addProgressListeners, getAbort, removeProgressListener, setAbort, setProgress, setProgress
-
Field Details
-
colorDepth
private int colorDepth -
compression
private int compression -
dataOffset
private int dataOffset -
imageHeight
private int imageHeight -
imageWidth
private int imageWidth -
in
-
out
-
palette
-
-
Constructor Details
-
BMPCodec
public BMPCodec()
-
-
Method Details
-
getFileExtensions
Description copied from class:ImageCodec
Returns all file extensions that are typical for this file format. The default implementation in ImageCodec returnsnull
. The file extension strings should include a leading dot and are supposed to be lower case (if that is allowed for the given file format). Example:{".jpg", ".jpeg"}
for the JPEG file format.- Overrides:
getFileExtensions
in classImageCodec
- Returns:
- String array with typical file extensions
-
getFormatName
Description copied from class:ImageCodec
Returns the name of the file format supported by this codec. All classes extendingImageCodec
must override this method. When overriding, leave out any words in a particular language so that this format name can be understood by everyone. Usually it is enough to return the format creator plus a typical abbreviation, e.g.Microsoft BMP
orPortable Anymap (PNM)
.- Specified by:
getFormatName
in classImageCodec
- Returns:
- name of the file format supported by this codec
-
getMimeTypes
Description copied from class:ImageCodec
Return the MIME (Multipurpose Internet Mail Extensions) type strings for this format, ornull
if none are available.- Specified by:
getMimeTypes
in classImageCodec
- Returns:
- MIME type strings or null
-
isLoadingSupported
public boolean isLoadingSupported()Description copied from class:ImageCodec
Returns if this codec is able to load images in the file format supported by this codec. Iftrue
is returned this does not necessarily mean that all files in this format can be read, but at least some.- Specified by:
isLoadingSupported
in classImageCodec
- Returns:
- if loading is supported
-
isSavingSupported
public boolean isSavingSupported()Description copied from class:ImageCodec
Returns if this codec is able to save images in the file format supported by this codec. Iftrue
is returned this does not necessarily mean that all types files in this format can be written, but at least some.- Specified by:
isSavingSupported
in classImageCodec
- Returns:
- if saving is supported
-
load
private void load() throws MissingParameterException, OperationFailedException, UnsupportedTypeException, WrongFileFormatException -
loadCompressedPaletted4Stream
- Throws:
IOException
-
loadCompressedPaletted8Stream
- Throws:
IOException
-
loadHeader
private void loadHeader() throws IOException, MissingParameterException, OperationFailedException, UnsupportedTypeException, WrongFileFormatException -
loadStream
private void loadStream() throws IOException, MissingParameterException, OperationFailedException, UnsupportedTypeException -
loadUncompressedBilevelStream
- Throws:
IOException
OperationFailedException
-
loadUncompressedPaletted4Stream
- Throws:
IOException
-
loadUncompressedPaletted8Stream
- Throws:
IOException
-
loadUncompressedRgb24Stream
- Throws:
IOException
-
loadUncompressedStream
- Throws:
IOException
OperationFailedException
-
process
Description copied from class:Operation
This method does the actual work of the operation. It must be called after all parameters have been given to the operation object.- Overrides:
process
in classOperation
- Throws:
MissingParameterException
- if any mandatory parameter was not given to the operationOperationFailedException
-
save
private void save() throws MissingParameterException, OperationFailedException, UnsupportedTypeException -
suggestFileExtension
Description copied from class:ImageCodec
Attempts to suggest a filename extension. The type of the argument image will be taken into consideration, although this will be necessary for some file formats only (as an example, PNM has different extensions for different image types, seePNMCodec
). This default implementation always returnsnull
.- Overrides:
suggestFileExtension
in classImageCodec
- Parameters:
image
- the image that is to be written to a file- Returns:
- the file extension, including a leading dot, or
null
if no file extension can be recommended
-
writeHeader
private void writeHeader(PixelImage image, int filesize, int offset, int numBits) throws IOException - Throws:
IOException
-
writeInt
- Throws:
IOException
-
writePalette
Write the palette associated with the image getImage(). Required not only for image objects that implement PalettedImage but also for BilevelImage and Grayscale8Image. For the latter two the palette values must be explicitly written into the file.- Throws:
IOException
-
writeShort
- Throws:
IOException
-
writeStream
- Throws:
IOException
-