Bugfix #3797: 24-bit BMP images weren't read properly. Standard apparently
[blender.git] / source / blender / imbuf / intern / bmp.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32
33 #include "BLI_blenlib.h"
34
35 #include "imbuf.h"
36 #include "imbuf_patch.h"
37
38 #include "IMB_imbuf_types.h"
39 #include "IMB_imbuf.h"
40 #include "IMB_allocimbuf.h"
41 #include "IMB_cmap.h"
42 #include "IMB_bmp.h"
43
44 /* some code copied from article on microsoft.com, copied
45   here for enhanced BMP support in the future
46   http://www.microsoft.com/msj/defaultframe.asp?page=/msj/0197/mfcp1/mfcp1.htm&nav=/msj/0197/newnav.htm
47 */
48
49 typedef struct BMPINFOHEADER{
50         unsigned int    biSize;
51         unsigned int    biWidth;
52         unsigned int    biHeight;
53         unsigned short  biPlanes;
54         unsigned short  biBitCount;
55         unsigned int    biCompression;
56         unsigned int    biSizeImage;
57         unsigned int    biXPelsPerMeter;
58         unsigned int    biYPelsPerMeter;
59         unsigned int    biClrUsed;
60         unsigned int    biClrImportant;
61 } BMPINFOHEADER;
62
63 typedef struct BMPHEADER {
64         unsigned short biType;
65         unsigned int biSize;
66         unsigned short biRes1;
67         unsigned short biRes2;
68         unsigned int biOffBits;
69 } BMPHEADER;
70
71 #define BMP_FILEHEADER_SIZE 14
72
73 static int checkbmp(unsigned char *mem)
74 {
75         int ret_val = 0;
76         BMPINFOHEADER bmi;
77         unsigned int u;
78
79         if (mem) {
80                 if ((mem[0] == 'B') && (mem[1] == 'M')) {
81                         /* skip fileheader */
82                         mem += BMP_FILEHEADER_SIZE;
83                 } else {
84                 }
85
86                 /* for systems where an int needs to be 4 bytes aligned */
87                 memcpy(&bmi, mem, sizeof(bmi));
88
89                 u = LITTLE_LONG(bmi.biSize);
90                 /* we only support uncompressed 24 or 32 bits images for now */
91                 if (u >= sizeof(BMPINFOHEADER)) {
92                         if ((bmi.biCompression == 0) && (bmi.biClrUsed == 0)) {
93                                 u = LITTLE_SHORT(bmi.biBitCount);
94                                 if (u >= 16) {
95                                         ret_val = 1;
96                                 }
97                         }
98                 }
99         }
100
101         return(ret_val);
102 }
103
104 int imb_is_a_bmp(void *buf) {
105         
106         return checkbmp(buf);
107 }
108
109 struct ImBuf *imb_bmp_decode(unsigned char *mem, int size, int flags)
110 {
111         struct ImBuf *ibuf = 0;
112         BMPINFOHEADER bmi;
113         int x, y, depth, skip, i;
114         unsigned char *bmp, *rect;
115         unsigned short col;
116
117         if (checkbmp(mem) == 0) return(0);
118
119         if ((mem[0] == 'B') && (mem[1] == 'M')) {
120                 /* skip fileheader */
121                 mem += BMP_FILEHEADER_SIZE;
122         }
123
124         /* for systems where an int needs to be 4 bytes aligned */
125         memcpy(&bmi, mem, sizeof(bmi));
126
127         skip = LITTLE_LONG(bmi.biSize);
128         x = LITTLE_LONG(bmi.biWidth);
129         y = LITTLE_LONG(bmi.biHeight);
130         depth = LITTLE_SHORT(bmi.biBitCount);
131
132         /* printf("skip: %d, x: %d y: %d, depth: %d (%x)\n", skip, x, y, 
133                 depth, bmi.biBitCount); */
134         /* printf("skip: %d, x: %d y: %d, depth: %d (%x)\n", skip, x, y, 
135                 depth, bmi.biBitCount); */
136         if (flags & IB_test) {
137                 ibuf = IMB_allocImBuf(x, y, depth, 0, 0);
138         } else {
139                 ibuf = IMB_allocImBuf(x, y, depth, IB_rect, 0);
140                 bmp = mem + skip;
141                 rect = (unsigned char *) ibuf->rect;
142
143                 if (depth == 16) {
144                         for (i = x * y; i > 0; i--) {
145                                 col = bmp[0] + (bmp[1] << 8);
146                                 rect[0] = ((col >> 10) & 0x1f) << 3;
147                                 rect[1] = ((col >>  5) & 0x1f) << 3;
148                                 rect[2] = ((col >>  0) & 0x1f) << 3;
149                                 
150                                 rect[3] = 255;
151                                 rect += 4; bmp += 2;
152                         }
153
154                 } else if (depth == 24) {
155                         for (i = y; i > 0; i--) {
156                                 int j;
157                                 for (j = x ; j > 0; j--) {
158                                         rect[0] = bmp[2];
159                                         rect[1] = bmp[1];
160                                         rect[2] = bmp[0];
161                                         
162                                         rect[3] = 255;
163                                         rect += 4; bmp += 3;
164                                 }
165                                 /* for 24-bit images, rows are padded to multiples of 4 */
166                                 bmp += x % 4;   
167                         }
168                 } else if (depth == 32) {
169                         for (i = x * y; i > 0; i--) {
170                                 rect[0] = bmp[0];
171                                 rect[1] = bmp[1];
172                                 rect[2] = bmp[2];
173                                 rect[3] = bmp[3];
174                                 rect += 4; bmp += 4;
175                         }
176                 }
177         }
178
179         if (ibuf) {
180                 ibuf->ftype = BMP;
181         }
182         
183         return(ibuf);
184 }
185
186 /* Couple of helper functions for writing our data */
187 static int putIntLSB(unsigned int ui,FILE *ofile) { 
188         putc((ui>>0)&0xFF,ofile); 
189         putc((ui>>8)&0xFF,ofile); 
190         putc((ui>>16)&0xFF,ofile); 
191         return putc((ui>>24)&0xFF,ofile); 
192 }
193
194 static int putShortLSB(unsigned short us,FILE *ofile) { 
195         putc((us>>0)&0xFF,ofile); 
196         return putc((us>>8)&0xFF,ofile); 
197
198
199 /* Found write info at http://users.ece.gatech.edu/~slabaugh/personal/c/bitmapUnix.c */
200 short imb_savebmp(struct ImBuf *ibuf, char *name, int flags) {
201
202         BMPINFOHEADER infoheader;
203         int bytesize, extrabytes, x, y, t, ptr;
204         uchar *data;
205         FILE *ofile;
206
207         extrabytes = (4 - ibuf->x*3 % 4) % 4;
208         bytesize = (ibuf->x * 3 + extrabytes) * ibuf->y;
209
210         data = (uchar *) ibuf->rect;
211         ofile = fopen(name,"wb");
212         if (!ofile) return 0;
213
214         putShortLSB(19778,ofile); /* "BM" */
215         putIntLSB(0,ofile); /* This can be 0 for BI_RGB bitmaps */
216         putShortLSB(0,ofile); /* Res1 */
217         putShortLSB(0,ofile); /* Res2 */
218         putIntLSB(BMP_FILEHEADER_SIZE + sizeof(infoheader),ofile); 
219
220         putIntLSB(sizeof(infoheader),ofile);
221         putIntLSB(ibuf->x,ofile);
222         putIntLSB(ibuf->y,ofile);
223         putShortLSB(1,ofile);
224         putShortLSB(24,ofile);
225         putIntLSB(0,ofile);
226         putIntLSB(bytesize + BMP_FILEHEADER_SIZE + sizeof(infoheader),ofile);
227         putIntLSB(0,ofile);
228         putIntLSB(0,ofile);
229         putIntLSB(0,ofile);
230         putIntLSB(0,ofile);
231
232         /* Need to write out padded image data in bgr format */
233         for (y=0;y<ibuf->y;y++) {
234                 for (x=0;x<ibuf->x;x++) {
235                         ptr=(x + y * ibuf->x) * 4;
236                         if (putc(data[ptr+2],ofile) == EOF) return 0;
237                         if (putc(data[ptr+1],ofile) == EOF) return 0;
238                         if (putc(data[ptr],ofile) == EOF) return 0;
239                 }
240                 /* add padding here */
241                 for (t=0;t<extrabytes;t++) if (putc(0,ofile) == EOF) return 0;
242         }
243         if (ofile) {
244                 fflush(ofile);
245                 fclose(ofile);
246         }
247         return 1;
248 }