1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 by Linus Nielsen Feltzing
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
23 2005-04-16 Tomas Salfischberger:
24 - New BMP loader function, based on the old one (borrowed a lot of
25 calculations and checks there.)
26 - Conversion part needs some optimization, doing unneeded calulations now.
27 2006-11-18 Jens Arnold: complete rework
28 - All canonical formats supported now (1, 4, 8, 15/16, 24 and 32 bit)
29 - better protection against malformed / non-standard BMPs
30 - code heavily optimised for both size and speed
31 - dithering for 2 bit targets
32 2008-11-02 Akio Idehara: refactor for scaler frontend
33 2008-12-08 Andrew Mahone: partial-line reading, scaler frontend
34 - read_part_line does the actual source BMP reading, return columns read
35 and updates fields in a struct bmp_args with the new data and current
37 - skip_lines_bmp and store_part_bmp implement the scaler callbacks to skip
38 ahead by whole lines, or read the next chunk of the current line
51 #ifdef HAVE_REMOTE_LCD
52 #include "lcd-remote.h"
54 #ifdef ROCKBOX_DEBUG_BMP_LOADER
55 #define BDEBUGF DEBUGF
70 #define STRUCT_PACKED __attribute__((packed))
73 #pragma pack (push, 2)
76 /* BMP header structure */
78 uint16_t type
; /* signature - 'BM' */
79 uint32_t size
; /* file size in bytes */
80 uint16_t reserved1
; /* 0 */
81 uint16_t reserved2
; /* 0 */
82 uint32_t off_bits
; /* offset to bitmap */
83 uint32_t struct_size
; /* size of this struct (40) */
84 int32_t width
; /* bmap width in pixels */
85 int32_t height
; /* bmap height in pixels */
86 uint16_t planes
; /* num planes - always 1 */
87 uint16_t bit_count
; /* bits per pixel */
88 uint32_t compression
; /* compression flag */
89 uint32_t size_image
; /* image size in bytes */
90 int32_t x_pels_per_meter
; /* horz resolution */
91 int32_t y_pels_per_meter
; /* vert resolution */
92 uint32_t clr_used
; /* 0 -> color table size */
93 uint32_t clr_important
; /* important color count */
97 struct { /* Little endian */
101 unsigned char reserved
;
106 /* masks for supported BI_BITFIELDS encodings (16/32 bit) */
107 static const struct uint8_rgb bitfields
[3][3] = {
110 { .blue
= 0x00, .green
= 0x7c, .red
= 0x00 },
111 { .blue
= 0xe0, .green
= 0x03, .red
= 0x00 },
112 { .blue
= 0x1f, .green
= 0x00, .red
= 0x00 },
116 { .blue
= 0x00, .green
= 0xf8, .red
= 0x00 },
117 { .blue
= 0xe0, .green
= 0x07, .red
= 0x00 },
118 { .blue
= 0x1f, .green
= 0x00, .red
= 0x00 },
122 { .blue
= 0x00, .green
= 0x00, .red
= 0xff },
123 { .blue
= 0x00, .green
= 0xff, .red
= 0x00 },
124 { .blue
= 0xff, .green
= 0x00, .red
= 0x00 },
128 #if (LCD_DEPTH > 1) || defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
129 /* the full 16x16 Bayer dither matrix may be calculated quickly with this table
131 const unsigned char dither_table
[16] =
132 { 0,192, 48,240, 12,204, 60,252, 3,195, 51,243, 15,207, 63,255 };
135 #if ((LCD_DEPTH == 2) && (LCD_PIXELFORMAT == VERTICAL_INTERLEAVED)) \
136 || (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH == 2) \
137 && (LCD_REMOTE_PIXELFORMAT == VERTICAL_INTERLEAVED))
138 const unsigned short vi_pattern
[4] = {
139 0x0101, 0x0100, 0x0001, 0x0000
143 /******************************************************************************
146 * Reads a BMP file and puts the data in rockbox format in *bitmap.
148 *****************************************************************************/
149 int read_bmp_file(const char* filename
,
153 const struct custom_format
*cformat
)
156 fd
= open(filename
, O_RDONLY
);
158 /* Exit if file opening failed */
160 DEBUGF("read_bmp_file: can't open '%s', rc: %d\n", filename
, fd
);
164 BDEBUGF("read_bmp_file: '%s' remote: %d resize: %d keep_aspect: %d\n",
165 filename
, !!(format
& FORMAT_REMOTE
), !!(format
& FORMAT_RESIZE
),
166 !!(format
& FORMAT_KEEP_ASPECT
));
167 ret
= read_bmp_fd(fd
, bm
, maxsize
, format
, cformat
);
172 static inline void set_rgb_union(struct uint8_rgb
*dst
, union rgb_union src
)
175 dst
->green
= src
.green
;
176 dst
->blue
= src
.blue
;
185 unsigned char buf
[BM_MAX_WIDTH
* 4];
186 struct uint8_rgb
*palette
;
187 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
191 struct img_part part
;
195 static unsigned int read_part_line(struct bmp_args
*ba
)
197 const int padded_width
= ba
->padded_width
;
198 const int read_width
= ba
->read_width
;
199 const int width
= ba
->width
;
200 const int depth
= ba
->depth
;
201 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
203 int cur_row
= ba
->cur_row
;
204 int cur_col
= ba
->cur_col
;
206 const int fd
= ba
->fd
;
208 struct uint8_rgb
*buf
= (struct uint8_rgb
*)(ba
->buf
);
209 const struct uint8_rgb
*palette
= ba
->palette
;
210 uint32_t component
, data
= data
;
214 #if (LCD_DEPTH > 1) || defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1) || \
216 cols
= MIN(width
- cur_col
,(int)BM_MAX_WIDTH
);
217 BDEBUGF("reading %d cols (width: %d, max: %d)\n",cols
,width
,BM_MAX_WIDTH
);
218 len
= (cols
* (depth
== 15 ? 16 : depth
) + 7) >> 3;
223 ibuf
= ((unsigned char *)buf
) + (BM_MAX_WIDTH
<< 2) - len
;
224 BDEBUGF("read_part_line: cols=%d len=%d\n",cols
,len
);
225 ret
= read(fd
, ibuf
, len
);
228 DEBUGF("read_part_line: error reading image, read returned %d "
229 "expected %d\n", ret
, len
);
230 #if (LCD_DEPTH > 1) || defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1) || \
232 BDEBUGF("cur_row: %d cur_col: %d cols: %d len: %d\n", cur_row
, cur_col
,
237 while (ibuf
< ba
->buf
+ (BM_MAX_WIDTH
<< 2))
243 for (i
= 0; i
< 8; i
++)
245 *buf
++ = palette
[data
& 0x80 ? 1 : 0];
251 *buf
++ = palette
[data
>> 4];
252 *buf
++ = palette
[data
& 0xf];
255 *buf
++ = palette
[*ibuf
++];
259 data
= letoh16(*(uint16_t*)ibuf
);
260 component
= (data
<< 3) & 0xf8;
261 component
|= component
>> 5;
262 buf
->blue
= component
;
266 component
= data
& 0xf8;
267 component
|= component
>> 5;
270 component
= data
& 0xfc;
271 component
|= component
>> 6;
273 buf
->green
= component
;
275 component
= data
& 0xf8;
276 component
|= component
>> 5;
277 buf
->red
= component
;
284 buf
->green
= *ibuf
++;
293 #if (!defined(HAVE_LCD_COLOR) && \
294 (LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1))) || \
297 buf
= (struct uint8_rgb
*)ba
->buf
;
298 while (ibuf
< ba
->buf
+ cols
)
299 *ibuf
++ = brightness(*buf
++);
302 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
305 if (cur_col
== width
)
308 int pad
= padded_width
- read_width
;
311 BDEBUGF("seeking %d bytes to next line\n",pad
);
312 lseek(fd
, pad
, SEEK_CUR
);
314 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
317 BDEBUGF("read_part_line: completed row %d\n", cur_row
);
321 ba
->cur_row
= cur_row
;
322 ba
->cur_col
= cur_col
;
327 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
329 static struct img_part
*store_part_bmp(void *args
)
331 struct bmp_args
*ba
= (struct bmp_args
*)args
;
333 ba
->part
.len
= read_part_line(ba
);
334 #ifdef HAVE_LCD_COLOR
335 ba
->part
.buf
= (struct uint8_rgb
*)ba
->buf
;
337 ba
->part
.buf
= (uint8_t *)ba
->buf
;
346 static inline int rgbcmp(struct uint8_rgb rgb1
, struct uint8_rgb rgb2
)
348 if ((rgb1
.red
== rgb2
.red
) && (rgb1
.green
== rgb2
.green
) &&
349 (rgb1
.blue
== rgb2
.blue
))
355 /******************************************************************************
358 * Reads a BMP file in an open file descriptor and puts the data in rockbox
361 *****************************************************************************/
362 int read_bmp_fd(int fd
,
366 const struct custom_format
*cformat
)
368 struct bmp_header bmph
;
371 int depth
, numcolors
, compression
, totalsize
;
374 unsigned char *bitmap
= bm
->data
;
375 struct uint8_rgb palette
[256];
378 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)) \
380 unsigned int resize
= IMG_NORESIZE
;
382 bool transparent
= false;
384 #ifdef HAVE_REMOTE_LCD
386 if (format
& FORMAT_REMOTE
) {
388 #if LCD_REMOTE_DEPTH == 1
389 format
= FORMAT_MONO
;
392 #endif /* HAVE_REMOTE_LCD */
394 if (format
& FORMAT_RESIZE
) {
398 if (format
& FORMAT_TRANSPARENT
) {
401 if (format
& FORMAT_DITHER
) {
407 #endif /*(LCD_DEPTH > 1) || defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)*/
409 /* read fileheader */
410 ret
= read(fd
, &bmph
, sizeof(struct bmp_header
));
415 if (ret
!= sizeof(struct bmp_header
)) {
416 DEBUGF("read_bmp_fd: can't read BMP header.");
420 src_dim
.width
= letoh32(bmph
.width
);
421 src_dim
.height
= letoh32(bmph
.height
);
422 if (src_dim
.height
< 0) { /* Top-down BMP file */
423 src_dim
.height
= -src_dim
.height
;
425 } else { /* normal BMP */
429 depth
= letoh16(bmph
.bit_count
);
430 /* 4-byte boundary aligned */
431 read_width
= ((src_dim
.width
* (depth
== 15 ? 16 : depth
) + 7) >> 3);
432 padded_width
= (read_width
+ 3) & ~3;
434 BDEBUGF("width: %d height: %d depth: %d padded_width: %d\n", src_dim
.width
,
435 src_dim
.height
, depth
, padded_width
);
437 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1)
438 if ((format
& 3) == FORMAT_ANY
) {
440 format
= (format
& ~3);
442 format
= (format
& ~3) | FORMAT_NATIVE
;
444 bm
->format
= format
& 1;
445 if ((format
& 1) == FORMAT_MONO
)
447 resize
&= ~IMG_RESIZE
;
448 resize
|= IMG_NORESIZE
;
449 #ifdef HAVE_REMOTE_LCD
453 #elif !defined(PLUGIN)
454 if (src_dim
.width
> BM_MAX_WIDTH
)
456 #endif /*(LCD_DEPTH > 1) || defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)*/
458 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
460 if (resize
& IMG_RESIZE
) {
461 if(format
& FORMAT_KEEP_ASPECT
) {
462 /* keep aspect ratio.. */
463 struct dim resize_dim
= {
465 .height
= bm
->height
,
467 if (recalc_dimension(&resize_dim
, &src_dim
))
468 resize
= IMG_NORESIZE
;
469 bm
->width
= resize_dim
.width
;
470 bm
->height
= resize_dim
.height
;
476 if (!(resize
& IMG_RESIZE
)) {
478 /* returning image size */
479 bm
->width
= src_dim
.width
;
480 bm
->height
= src_dim
.height
;
482 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
487 if (rset
.rowstep
> 0) { /* Top-down BMP file */
489 rset
.rowstop
= bm
->height
;
490 } else { /* normal BMP */
491 rset
.rowstart
= bm
->height
- 1;
496 totalsize
= cformat
->get_size(bm
);
498 totalsize
= BM_SIZE(bm
->width
,bm
->height
,format
,remote
);
500 /* Check if this fits the buffer */
501 if (totalsize
> maxsize
) {
502 DEBUGF("read_bmp_fd: Bitmap too large for buffer: "
503 "%d bytes.\n", totalsize
);
507 compression
= letoh32(bmph
.compression
);
509 numcolors
= letoh32(bmph
.clr_used
);
511 numcolors
= 1 << depth
;
513 numcolors
= (compression
== 3) ? 3 : 0;
515 if (numcolors
> 0 && numcolors
<= 256) {
518 for (i
= 0; i
< numcolors
; i
++) {
519 if (read(fd
, &pal
, sizeof(pal
)) != (int)sizeof(pal
))
521 DEBUGF("read_bmp_fd: Can't read color palette\n");
524 set_rgb_union(&palette
[i
], pal
);
531 /* don't dither 16 bit BMP to LCD with same or larger depth */
532 #ifdef HAVE_REMOTE_LCD
537 if (compression
== 0) { /* BI_RGB, i.e. 15 bit */
540 } /* else fall through */
543 if (compression
== 3) { /* BI_BITFIELDS */
547 /* (i == 0) is 15bit, (i == 1) is 16bit, (i == 2) is 32bit */
548 for (i
= 0; i
< ARRAY_SIZE(bitfields
); i
++) {
549 for (j
= 0; j
< ARRAY_SIZE(bitfields
[0]); j
++) {
550 if (!rgbcmp(palette
[j
], bitfields
[i
][j
])) {
558 if (i
== 0) /* 15bit */
565 } /* else fall through */
568 if (compression
!= 0) { /* not BI_RGB */
569 DEBUGF("read_bmp_fd: Unsupported compression (type %d)\n",
576 /* Search to the beginning of the image data */
577 lseek(fd
, (off_t
)letoh32(bmph
.off_bits
), SEEK_SET
);
579 memset(bitmap
, 0, totalsize
);
581 struct bmp_args ba
= {
582 .fd
= fd
, .padded_width
= padded_width
, .read_width
= read_width
,
583 .width
= src_dim
.width
, .depth
= depth
, .palette
= palette
,
584 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
586 .cur_row
= 0, .cur_col
= 0, .part
= {0,0}
590 #if LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1) || \
593 if (resize
|| cformat
)
596 if (resize_on_load(bm
, dither
, &src_dim
, &rset
,
597 bitmap
+ totalsize
, maxsize
- totalsize
,
598 cformat
, store_part_bmp
, &ba
))
604 int fb_width
= BM_WIDTH(bm
->width
,bm
->format
,remote
);
606 #endif /* LCD_DEPTH */
611 /* loop to read rows and put them to buffer */
612 for (row
= rset
.rowstart
; row
!= rset
.rowstop
; row
+= rset
.rowstep
) {
613 #if !defined(HAVE_LCD_COLOR) && \
614 (LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1))
615 uint8_t* qp
= ba
.buf
;
617 struct uint8_rgb
*qp
= (struct uint8_rgb
*)ba
.buf
;
621 if (!read_part_line(&ba
))
624 /* Convert to destination format */
625 #if (LCD_DEPTH > 1) || defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
626 unsigned char dy
= DITHERY(row
);
627 if (format
== FORMAT_NATIVE
) {
628 #if defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
630 #if (LCD_REMOTE_DEPTH == 2) && (LCD_REMOTE_PIXELFORMAT == VERTICAL_INTERLEAVED)
631 /* iAudio X5/M5 remote */
632 fb_remote_data
*dest
= (fb_remote_data
*)bitmap
633 + bm
->width
* (row
>> 3);
638 for (col
= 0; col
< bm
->width
; col
++) {
640 delta
= DITHERXDY(col
,dy
);
641 #if !defined(HAVE_LCD_COLOR) && \
642 (LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1))
645 bright
= brightness(*qp
++);
647 bright
= (3 * bright
+ (bright
>> 6) + delta
) >> 8;
648 *dest
++ |= vi_pattern
[bright
] << shift
;
650 #endif /* LCD_REMOTE_DEPTH / LCD_REMOTE_PIXELFORMAT */
652 #endif /* defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1 */
655 #if LCD_PIXELFORMAT == HORIZONTAL_PACKING
656 /* greyscale iPods */
657 fb_data
*dest
= (fb_data
*)bitmap
+ fb_width
* row
;
663 for (col
= 0; col
< bm
->width
; col
++) {
665 delta
= DITHERXDY(col
,dy
);
667 bright
= (3 * bright
+ (bright
>> 6) + delta
) >> 8;
668 data
|= (~bright
& 3) << shift
;
678 #elif LCD_PIXELFORMAT == VERTICAL_PACKING
680 fb_data
*dest
= (fb_data
*)bitmap
+ fb_width
* (row
>> 2);
681 int shift
= 2 * (row
& 3);
685 for (col
= 0; col
< bm
->width
; col
++) {
687 delta
= DITHERXDY(col
,dy
);
689 bright
= (3 * bright
+ (bright
>> 6) + delta
) >> 8;
690 *dest
++ |= (~bright
& 3) << shift
;
692 #elif LCD_PIXELFORMAT == VERTICAL_INTERLEAVED
694 fb_data
*dest
= (fb_data
*)bitmap
+ fb_width
* (row
>> 3);
699 for (col
= 0; col
< bm
->width
; col
++) {
701 delta
= DITHERXDY(col
,dy
);
703 bright
= (3 * bright
+ (bright
>> 6) + delta
) >> 8;
704 *dest
++ |= vi_pattern
[bright
] << shift
;
706 #endif /* LCD_PIXELFORMAT */
707 #elif LCD_DEPTH == 16
708 /* iriver h300, colour iPods, X5 */
709 fb_data
*dest
= (fb_data
*)bitmap
+ fb_width
* row
;
714 for (col
= 0; col
< bm
->width
; col
++) {
716 delta
= DITHERXDY(col
,dy
);
718 r
= (31 * q0
.red
+ (q0
.red
>> 3) + delta
) >> 8;
719 g
= (63 * q0
.green
+ (q0
.green
>> 2) + delta
) >> 8;
720 b
= (31 * q0
.blue
+ (q0
.blue
>> 3) + delta
) >> 8;
721 *dest
++ = LCD_RGBPACK_LCD(r
, g
, b
);
723 #endif /* LCD_DEPTH */
726 #endif /* (LCD_DEPTH > 1) ||
727 defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1) */
729 p
= bitmap
+ bm
->width
* (row
>> 3);
730 mask
= 1 << (row
& 7);
732 for (col
= 0; col
< bm
->width
; col
++, p
++)
733 #if !defined(HAVE_LCD_COLOR) && \
734 (LCD_DEPTH > 1 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1))
738 if (brightness(*qp
++) < 128)
743 return totalsize
; /* return the used buffer size. */