-
Notifications
You must be signed in to change notification settings - Fork 37
/
BMPFormat.java
436 lines (343 loc) · 11.5 KB
/
BMPFormat.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/*
* #%L
* SCIFIO library for reading and converting scientific file formats.
* %%
* Copyright (C) 2011 - 2015 Board of Regents of the University of
* Wisconsin-Madison
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package io.scif.formats;
import io.scif.AbstractChecker;
import io.scif.AbstractFormat;
import io.scif.AbstractMetadata;
import io.scif.AbstractParser;
import io.scif.ByteArrayPlane;
import io.scif.ByteArrayReader;
import io.scif.Format;
import io.scif.FormatException;
import io.scif.HasColorTable;
import io.scif.ImageMetadata;
import io.scif.MetaTable;
import io.scif.MetadataLevel;
import io.scif.UnsupportedCompressionException;
import io.scif.codec.BitBuffer;
import io.scif.config.SCIFIOConfig;
import io.scif.io.RandomAccessInputStream;
import io.scif.util.FormatTools;
import io.scif.util.ImageTools;
import java.io.IOException;
import net.imagej.axis.Axes;
import net.imglib2.display.ColorTable;
import net.imglib2.display.ColorTable8;
import org.scijava.plugin.Plugin;
/**
* BMPReader is the file format reader for <a
* href="https://en.wikipedia.org/wiki/BMP_file_format">Microsoft Bitmap
* (BMP)</a> files.
*
* @author Mark Hiner
*/
@Plugin(type = Format.class, name = "Windows Bitmap")
public class BMPFormat extends AbstractFormat {
// -- Constants --
public static final String BMP_MAGIC_STRING = "BM";
// -- Compression types --
private static final int RAW = 0;
private static final int RLE_8 = 1;
private static final int RLE_4 = 2;
private static final int RGB_MASK = 3;
// -- AbstractFormat Methods --
@Override
protected String[] makeSuffixArray() {
return new String[] { "bmp" };
}
// -- Nested Classes --
public static class Metadata extends AbstractMetadata implements
HasColorTable
{
// -- Fields --
/** The palette for indexed color images. */
private ColorTable8 palette;
/** Compression type */
private int compression;
/** Offset to image data. */
private long global;
private boolean invertY = false;
// -- Getters and Setters --
public int getCompression() {
return compression;
}
public void setCompression(final int compression) {
this.compression = compression;
}
public long getGlobal() {
return global;
}
public void setGlobal(final long global) {
this.global = global;
}
public boolean isInvertY() {
return invertY;
}
public void setInvertY(final boolean invertY) {
this.invertY = invertY;
}
// -- Metadata API Methods --
@Override
public void populateImageMetadata() {
log().info("Populating metadata");
int bpp = get(0).getBitsPerPixel();
final ImageMetadata iMeta = get(0);
iMeta.setAxisTypes(Axes.X, Axes.Y);
iMeta.setPlanarAxisCount(2);
int sizeC = bpp != 24 ? 1 : 3;
if (bpp == 32) sizeC = 4;
if (bpp > 8) bpp /= sizeC;
iMeta.setBitsPerPixel(bpp);
switch (bpp) {
case 16:
iMeta.setPixelType(FormatTools.UINT16);
break;
case 32:
iMeta.setPixelType(FormatTools.UINT32);
break;
default:
iMeta.setPixelType(FormatTools.UINT8);
}
iMeta.setLittleEndian(true);
iMeta.setMetadataComplete(true);
iMeta.setIndexed(getColorTable(0, 0) != null);
if (iMeta.isIndexed()) {
sizeC = 1;
}
if (sizeC > 1 || iMeta.isIndexed()) {
iMeta.addAxis(Axes.CHANNEL, sizeC);
if (sizeC > 1) iMeta.setAxisTypes(Axes.CHANNEL, Axes.X, Axes.Y);
iMeta.setPlanarAxisCount(3);
}
iMeta.setFalseColor(false);
}
// -- HasSource API Methods --
@Override
public void close(final boolean fileOnly) throws IOException {
super.close(fileOnly);
if (!fileOnly) {
compression = 0;
global = 0;
palette = null;
invertY = false;
}
}
// -- HasColorTable API Methods --
@Override
public ColorTable
getColorTable(final int imageIndex, final long planeIndex)
{
return palette;
}
}
public static class Checker extends AbstractChecker {
@Override
public boolean isFormat(final RandomAccessInputStream stream)
throws IOException
{
final int blockLen = 2;
if (!FormatTools.validStream(stream, blockLen, false)) return false;
return stream.readString(blockLen).startsWith(BMP_MAGIC_STRING);
}
}
public static class Parser extends AbstractParser<Metadata> {
@Override
protected void typedParse(final RandomAccessInputStream stream,
final Metadata meta, final SCIFIOConfig config) throws IOException,
FormatException
{
meta.createImageMetadata(1);
final ImageMetadata iMeta = meta.get(0);
final MetaTable globalTable = meta.getTable();
stream.order(true);
// read the first header - 14 bytes
globalTable.put("Magic identifier", getSource().readString(2));
globalTable.put("File size (in bytes)", getSource().readInt());
getSource().skipBytes(4);
meta.setGlobal(getSource().readInt());
// read the second header - 40 bytes
getSource().skipBytes(4);
int sizeX = 0, sizeY = 0;
// get the dimensions
sizeX = getSource().readInt();
sizeY = getSource().readInt();
iMeta.addAxis(Axes.X, sizeX);
iMeta.addAxis(Axes.Y, sizeY);
if (sizeX < 1) {
log().trace("Invalid width: " + sizeX + "; using the absolute value");
sizeX = Math.abs(sizeX);
}
if (sizeY < 1) {
log().trace("Invalid height: " + sizeY + "; using the absolute value");
sizeY = Math.abs(sizeY);
meta.setInvertY(true);
}
globalTable.put("Color planes", getSource().readShort());
final short bpp = getSource().readShort();
iMeta.setBitsPerPixel(bpp);
meta.setCompression(getSource().readInt());
getSource().skipBytes(4);
final int pixelSizeX = getSource().readInt();
final int pixelSizeY = getSource().readInt();
int nColors = getSource().readInt();
if (nColors == 0 && bpp != 32 && bpp != 24) {
nColors = bpp < 8 ? 1 << bpp : 256;
}
getSource().skipBytes(4);
// read the palette, if it exists
if (nColors != 0 && bpp == 8) {
final byte[][] palette = new byte[3][256];
for (int i = 0; i < nColors; i++) {
for (int j = palette.length - 1; j >= 0; j--) {
palette[j][i] = getSource().readByte();
}
getSource().skipBytes(1);
}
meta.palette = new ColorTable8(palette);
}
else if (nColors != 0) getSource().skipBytes(nColors * 4);
if (config.parserGetLevel() != MetadataLevel.MINIMUM) {
globalTable.put("Indexed color", meta.getColorTable(0, 0) != null);
globalTable.put("Image width", sizeX);
globalTable.put("Image height", sizeY);
globalTable.put("Bits per pixel", bpp);
String comp = "invalid";
switch (meta.getCompression()) {
case RAW:
comp = "None";
break;
case RLE_8:
comp = "8 bit run length encoding";
break;
case RLE_4:
comp = "4 bit run length encoding";
break;
case RGB_MASK:
comp = "RGB bitmap with mask";
break;
}
globalTable.put("Compression type", comp);
globalTable.put("X resolution", pixelSizeX);
globalTable.put("Y resolution", pixelSizeY);
}
}
}
public static class Reader extends ByteArrayReader<Metadata> {
// -- AbstractReader API Methods --
@Override
protected String[] createDomainArray() {
return new String[] { FormatTools.GRAPHICS_DOMAIN };
}
// -- Reader API Methods --
@Override
public ByteArrayPlane openPlane(final int imageIndex,
final long planeIndex, final ByteArrayPlane plane, final long[] planeMin,
final long[] planeMax, final SCIFIOConfig config) throws FormatException,
IOException
{
final Metadata meta = getMetadata();
final int xIndex = meta.get(imageIndex).getAxisIndex(Axes.X);
final int yIndex = meta.get(imageIndex).getAxisIndex(Axes.Y);
final int x = (int) planeMin[xIndex], y = (int) planeMin[yIndex], w =
(int) planeMax[xIndex], h = (int) planeMax[yIndex];
final byte[] buf = plane.getData();
final int compression = meta.getCompression();
final int bpp = meta.get(imageIndex).getBitsPerPixel();
final int sizeX = (int) meta.get(imageIndex).getAxisLength(Axes.X);
final int sizeY = (int) meta.get(imageIndex).getAxisLength(Axes.Y);
final int sizeC = (int) meta.get(imageIndex).getAxisLength(Axes.CHANNEL);
FormatTools.checkPlaneForReading(meta, imageIndex, planeIndex,
buf.length, planeMin, planeMax);
if (compression != RAW &&
getStream().length() < FormatTools.getPlaneSize(this, imageIndex))
{
throw new UnsupportedCompressionException(compression +
" not supported");
}
final int rowsToSkip = meta.isInvertY() ? y : sizeY - (h + y);
final int rowLength =
sizeX * (meta.get(imageIndex).isIndexed() ? 1 : sizeC);
getStream().seek(meta.getGlobal() + rowsToSkip * rowLength);
int pad = ((rowLength * bpp) / 8) % 2;
if (pad == 0) pad = ((rowLength * bpp) / 8) % 4;
else pad *= sizeC;
int planeSize = sizeX * sizeC * h;
if (bpp >= 8) planeSize *= (bpp / 8);
else planeSize /= (8 / bpp);
planeSize += pad * h;
if (planeSize + getStream().getFilePointer() > getStream().length()) {
planeSize -= (pad * h);
// sometimes we have RGB images with a single padding byte
if (planeSize + sizeY + getStream().getFilePointer() <= getStream()
.length())
{
pad = 1;
planeSize += h;
}
else {
pad = 0;
}
}
getStream().skipBytes(rowsToSkip * pad);
final byte[] rawPlane = new byte[planeSize];
getStream().read(rawPlane);
final BitBuffer bb = new BitBuffer(rawPlane);
final ColorTable palette = meta.getColorTable(0, 0);
plane.setColorTable(palette);
final int effectiveC =
palette != null && palette.getLength() > 0 ? 1 : sizeC;
for (int row = h - 1; row >= 0; row--) {
final int rowIndex = meta.isInvertY() ? h - 1 - row : row;
bb.skipBits(x * bpp * effectiveC);
for (int i = 0; i < w * effectiveC; i++) {
if (bpp <= 8) {
buf[rowIndex * w * effectiveC + i] =
(byte) (bb.getBits(bpp) & 0xff);
}
else {
for (int b = 0; b < bpp / 8; b++) {
buf[(bpp / 8) * (rowIndex * w * effectiveC + i) + b] =
(byte) (bb.getBits(8) & 0xff);
}
}
}
if (row > 0) {
bb.skipBits((sizeX - w - x) * bpp * effectiveC + pad * 8);
}
}
if (meta.get(imageIndex).getAxisLength(Axes.CHANNEL) > 1) {
ImageTools.bgrToRgb(buf,
meta.get(imageIndex).getInterleavedAxisCount() > 0, 1, (int) meta
.get(imageIndex).getAxisLength(Axes.CHANNEL));
}
return plane;
}
}
}