io-bmp.c 15 KB
Newer Older
1 2 3
/* GdkPixbuf library - Windows Bitmap image loader
 *
 * Copyright (C) 1999 The Free Software Foundation
Mark Crichton's avatar
Mark Crichton committed
4
 *
5 6 7 8
 * Authors: Arjan van de Ven <arjan@fenrus.demon.nl>
 *          Federico Mena-Quintero <federico@gimp.org>
 *
 * Based on io-ras.c
Mark Crichton's avatar
Mark Crichton committed
9 10 11 12 13 14 15 16 17 18 19 20
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
21 22 23
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Mark Crichton's avatar
Mark Crichton committed
24 25
 */

26 27 28 29 30 31 32 33
/*

Known bugs:
	* Compressed files don't work yet
	* bi-tonal files aren't tested 

*/

Mark Crichton's avatar
Mark Crichton committed
34 35
#include <config.h>
#include <stdio.h>
36
#include <unistd.h>
37 38 39
#include "gdk-pixbuf.h"
#include "gdk-pixbuf-io.h"

40 41 42 43 44 45 46



struct headerpair {
	guint width;
	guint height;
	guint depth;
47 48
	guint Negative;		/* Negative = 1 -> top down BMP,  
				   Negative = 0 -> bottom up BMP */
49 50
};

51 52 53 54 55 56 57 58
/* 

These structures are actually dummies. These are according to
the "Windows API reference guide volume II" as written by Borland,
but GCC fiddles with the alignment of the internal members.

*/

59
struct BitmapFileHeader {
60 61 62 63
	gushort bfType;
	guint bfSize;
	guint reserverd;
	guint bfOffbits;
64 65 66
};

struct BitmapInfoHeader {
67 68 69 70 71 72 73 74 75 76 77
	guint biSize;
	guint biWidth;
	guint biHeight;
	gushort biPlanes;
	gushort biBitCount;
	guint biCompression;
	guint biSizeImage;
	guint biXPelsPerMeter;
	guint biYPelsPerMeter;
	guint biClrUsed;
	guint biClrImportant;
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
static void DumpBIH(unsigned char *BIH)
{				/* For debugging */
	printf("biSize      = %i \n",
	       (BIH[3] << 24) + (BIH[2] << 16) + (BIH[1] << 8) + (BIH[0]));
	printf("biWidth     = %i \n",
	       (BIH[7] << 24) + (BIH[6] << 16) + (BIH[5] << 8) + (BIH[4]));
	printf("biHeight    = %i \n",
	       (BIH[11] << 24) + (BIH[10] << 16) + (BIH[9] << 8) +
	       (BIH[8]));
	printf("biPlanes    = %i \n", (BIH[13] << 8) + (BIH[12]));
	printf("biBitCount  = %i \n", (BIH[15] << 8) + (BIH[14]));
	printf("biCompress  = %i \n",
	       (BIH[19] << 24) + (BIH[18] << 16) + (BIH[17] << 8) +
	       (BIH[16]));
	printf("biSizeImage = %i \n",
	       (BIH[23] << 24) + (BIH[22] << 16) + (BIH[21] << 8) +
	       (BIH[20]));
	printf("biXPels     = %i \n",
	       (BIH[27] << 24) + (BIH[26] << 16) + (BIH[25] << 8) +
	       (BIH[24]));
	printf("biYPels     = %i \n",
	       (BIH[31] << 24) + (BIH[30] << 16) + (BIH[29] << 8) +
	       (BIH[28]));
	printf("biClrUsed   = %i \n",
	       (BIH[35] << 24) + (BIH[34] << 16) + (BIH[33] << 8) +
	       (BIH[32]));
	printf("biClrImprtnt= %i \n",
	       (BIH[39] << 24) + (BIH[38] << 16) + (BIH[37] << 8) +
	       (BIH[36]));
}

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
/* 
	This does a byte-order swap. Does glib have something like
	be32_to_cpu() ??
*/

static unsigned int le32_to_cpu(guint i)
{
	unsigned int i2;
	return i2;
}

/* 
	Destroy notification function for the libart pixbuf 
*/

static void free_buffer(gpointer user_data, gpointer data)
{
	free(data);
}


132 133 134 135 136 137 138 139 140 141 142 143 144 145
/* Data needed for the "state" during decompression */
struct bmp_compression_state {
	gint phase;		/* 0 = clean, 
				   1 = count received
				   2 = escape received
				   3 = in "raw" run
				   4 = Relative part 1 is next
				   5 = Relative part 2 is next
				   6 = end of image -> No more input allowed
				 */
	gint RunCount;
	gint XDelta;
	gint YDelta;
};
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167

/* Progressive loading */

struct bmp_progressive_state {
	ModulePreparedNotifyFunc prepared_func;
	ModuleUpdatedNotifyFunc updated_func;
	gpointer user_data;

	gint HeaderSize;	/* The size of the header-part (incl colormap) */
	guchar *HeaderBuf;	/* The buffer for the header (incl colormap) */
	gint HeaderDone;	/* The nr of bytes actually in HeaderBuf */

	gint LineWidth;		/* The width of a line in bytes */
	guchar *LineBuf;	/* Buffer for 1 line */
	gint LineDone;		/* # of bytes in LineBuf */
	gint Lines;		/* # of finished lines */

	gint Type;		/*  
				   24 = RGB
				   8 = 8 bit colormapped
				   1  = 1 bit bitonal 
				 */
168 169
	gint Compressed;
	struct bmp_compression_state compr;
170 171 172 173 174 175 176 177 178 179 180 181 182 183


	struct headerpair Header;	/* Decoded (BE->CPU) header */


	GdkPixbuf *pixbuf;	/* Our "target" */
};

gpointer
image_begin_load(ModulePreparedNotifyFunc prepared_func,
		 ModuleUpdatedNotifyFunc updated_func, gpointer user_data);
void image_stop_load(gpointer data);
gboolean image_load_increment(gpointer data, guchar * buf, guint size);

Mark Crichton's avatar
Mark Crichton committed
184 185 186


/* Shared library entry point */
187
GdkPixbuf *image_load(FILE * f)
Mark Crichton's avatar
Mark Crichton committed
188
{
189 190 191 192
	guchar *membuf;
	size_t length;
	struct bmp_progressive_state *State;
	int fd;
193

194
	GdkPixbuf *pb;
195

196 197
	State = image_begin_load(NULL, NULL, NULL);
	membuf = g_malloc(4096);
198

199
	g_assert(membuf != NULL);
200 201


202 203
	while (feof(f) == 0) {
		length = fread(membuf, 1, 4096, f);
204 205 206 207
		if (length > 0)
			image_load_increment(State, membuf, length);

	}
208 209 210 211 212 213 214 215 216 217
	g_free(membuf);
	if (State->pixbuf != NULL)
		gdk_pixbuf_ref(State->pixbuf);

	pb = State->pixbuf;

	image_stop_load(State);
	return State->pixbuf;
}

218 219
static void DecodeHeader(unsigned char *BFH, unsigned char *BIH,
			 struct bmp_progressive_state *State)
220
{
221 222 223 224 225 226
/*	DumpBIH(BIH);*/
	State->Header.width =
	    (BIH[7] << 24) + (BIH[6] << 16) + (BIH[5] << 8) + (BIH[4]);
	State->Header.height =
	    (BIH[11] << 24) + (BIH[10] << 16) + (BIH[9] << 8) + (BIH[8]);
	State->Header.depth = (BIH[15] << 8) + (BIH[14]);;
227 228

	State->Type = State->Header.depth;	/* This may be less trivial someday */
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
	State->HeaderSize =
	    ((BFH[13] << 24) + (BFH[12] << 16) + (BFH[11] << 8) +
	     (BFH[10]));
	if (State->HeaderSize >= 14 + 40 + 768 + 512)
		State->HeaderSize = 14 + 40 + 768 + 512 - 1;

	if ((BIH[16] != 0) || (BIH[17] != 0) || (BIH[18] != 0)
	    || (BIH[19] != 0)) {
		State->Compressed = 1;
	}

	if (State->Header.height < 0) {
		State->Header.height = -State->Header.height;
		State->Header.Negative = 1;
	}
	if (State->Header.width < 0) {
		State->Header.width = -State->Header.width;
		State->Header.Negative = 0;
	}
248 249 250 251 252 253 254 255 256 257

	if (State->Type == 24)
		State->LineWidth = State->Header.width * 3;
	if (State->Type == 8)
		State->LineWidth = State->Header.width * 1;
	if (State->Type == 1) {
		State->LineWidth = State->Header.width / 8;
		if ((State->Header.width & 7) != 0)
			State->LineWidth++;
	}
258

259
	/* Pad to a 32 bit boundary */
260 261 262
	if (((State->LineWidth % 4) > 0) && (State->Compressed == 0))
		State->LineWidth = (State->LineWidth / 4) * 4 + 4;

263 264 265 266 267 268 269 270 271

	if (State->LineBuf == NULL)
		State->LineBuf = g_malloc(State->LineWidth);

	g_assert(State->LineBuf != NULL);


	if (State->pixbuf == NULL) {
		State->pixbuf =
272 273 274 275
		    gdk_pixbuf_new(ART_PIX_RGB, FALSE, 8,
				   (gint) State->Header.width,
				   (gint) State->Header.height);

276 277 278 279 280 281
		if (State->prepared_func != NULL)
			/* Notify the client that we are ready to go */
			(*State->prepared_func) (State->pixbuf,
						 State->user_data);

	}
282

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
}

/* 
 * func - called when we have pixmap created (but no image data)
 * user_data - passed as arg 1 to func
 * return context (opaque to user)
 */

gpointer
image_begin_load(ModulePreparedNotifyFunc prepared_func,
		 ModuleUpdatedNotifyFunc updated_func, gpointer user_data)
{
	struct bmp_progressive_state *context;

	context = g_new0(struct bmp_progressive_state, 1);
	context->prepared_func = prepared_func;
	context->updated_func = updated_func;
	context->user_data = user_data;

	context->HeaderSize = 54;
303 304
	context->HeaderBuf = g_malloc(14 + 40 + 768 + 512);
	/* 768 for the colormap */
305 306 307 308 309 310 311 312 313 314
	context->HeaderDone = 0;

	context->LineWidth = 0;
	context->LineBuf = NULL;
	context->LineDone = 0;
	context->Lines = 0;

	context->Type = 0;

	memset(&context->Header, 0, sizeof(struct headerpair));
315
	memset(&context->compr, 0, sizeof(struct bmp_compression_state));
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338


	context->pixbuf = NULL;


	return (gpointer) context;
}

/*
 * context - returned from image_begin_load
 *
 * free context, unref gdk_pixbuf
 */
void image_stop_load(gpointer data)
{
	struct bmp_progressive_state *context =
	    (struct bmp_progressive_state *) data;


	g_return_if_fail(context != NULL);

	if (context->LineBuf != NULL)
		g_free(context->LineBuf);
339
	context->LineBuf = NULL;
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
	if (context->HeaderBuf != NULL)
		g_free(context->HeaderBuf);

	if (context->pixbuf)
		gdk_pixbuf_unref(context->pixbuf);

	g_free(context);
}


static void OneLine24(struct bmp_progressive_state *context)
{
	gint X;
	guchar *Pixels;

	X = 0;
356 357 358 359 360 361 362 363
	if (context->Header.Negative == 0)
		Pixels = context->pixbuf->art_pixbuf->pixels +
		    gdk_pixbuf_get_rowstride(context->pixbuf) *
		    (context->Header.height - context->Lines - 1);
	else
		Pixels = context->pixbuf->art_pixbuf->pixels +
		    gdk_pixbuf_get_rowstride(context->pixbuf) *
		    context->Lines;
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
	while (X < context->Header.width) {
		Pixels[X * 3 + 0] = context->LineBuf[X * 3 + 2];
		Pixels[X * 3 + 1] = context->LineBuf[X * 3 + 1];
		Pixels[X * 3 + 2] = context->LineBuf[X * 3 + 0];
		X++;
	}

}

static void OneLine8(struct bmp_progressive_state *context)
{
	gint X;
	guchar *Pixels;

	X = 0;
379 380 381 382 383 384 385 386
	if (context->Header.Negative == 0)
		Pixels = context->pixbuf->art_pixbuf->pixels +
		    gdk_pixbuf_get_rowstride(context->pixbuf) *
		    (context->Header.height - context->Lines - 1);
	else
		Pixels = context->pixbuf->art_pixbuf->pixels +
		    gdk_pixbuf_get_rowstride(context->pixbuf) *
		    context->Lines;
387 388 389
	while (X < context->Header.width) {
		/* The joys of having a BGR byteorder */
		Pixels[X * 3 + 0] =
390
		    context->HeaderBuf[4 * context->LineBuf[X] + 56];
391
		Pixels[X * 3 + 1] =
392
		    context->HeaderBuf[4 * context->LineBuf[X] + 55];
393
		Pixels[X * 3 + 2] =
394
		    context->HeaderBuf[4 * context->LineBuf[X] + 54];
395 396 397 398 399 400 401 402 403 404
		X++;
	}
}

static void OneLine1(struct bmp_progressive_state *context)
{
	gint X;
	guchar *Pixels;

	X = 0;
405 406 407 408 409 410 411 412
	if (context->Header.Negative == 0)
		Pixels = context->pixbuf->art_pixbuf->pixels +
		    gdk_pixbuf_get_rowstride(context->pixbuf) *
		    (context->Header.height - context->Lines - 1);
	else
		Pixels = context->pixbuf->art_pixbuf->pixels +
		    gdk_pixbuf_get_rowstride(context->pixbuf) *
		    context->Lines;
413 414
	while (X < context->Header.width) {
		int Bit;
415 416

		Bit = (context->LineBuf[X / 8]) >> (7 - (X & 7));
417 418
		Bit = Bit & 1;
		/* The joys of having a BGR byteorder */
419 420 421
		Pixels[X * 3 + 0] = context->HeaderBuf[Bit + 32];
		Pixels[X * 3 + 1] = context->HeaderBuf[Bit + 2 + 32];
		Pixels[X * 3 + 2] = context->HeaderBuf[Bit + 4 + 32];
422 423 424 425 426 427 428
		X++;
	}
}


static void OneLine(struct bmp_progressive_state *context)
{
429 430 431 432
	context->LineDone = 0;
	if (context->Lines >= context->Header.height)
		return;

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
	if (context->Type == 24)
		OneLine24(context);
	if (context->Type == 8)
		OneLine8(context);
	if (context->Type == 1)
		OneLine1(context);

	context->Lines++;

	if (context->updated_func != NULL) {
		(*context->updated_func) (context->pixbuf,
					  context->user_data,
					  0,
					  context->Lines,
					  context->Header.width,
					  context->Header.height);

	}
}

/*
 * context - from image_begin_load
 * buf - new image data
 * size - length of new image data
 *
 * append image data onto inrecrementally built output image
 */
gboolean image_load_increment(gpointer data, guchar * buf, guint size)
{
	struct bmp_progressive_state *context =
	    (struct bmp_progressive_state *) data;

	gint BytesToCopy;

	while (size > 0) {
468
		g_assert(context->LineDone >= 0);
469 470 471 472 473 474 475 476 477 478 479 480 481 482
		if (context->HeaderDone < context->HeaderSize) {	/* We still 
									   have headerbytes to do */
			BytesToCopy =
			    context->HeaderSize - context->HeaderDone;
			if (BytesToCopy > size)
				BytesToCopy = size;

			memcpy(context->HeaderBuf + context->HeaderDone,
			       buf, BytesToCopy);

			size -= BytesToCopy;
			buf += BytesToCopy;
			context->HeaderDone += BytesToCopy;

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
		} else if (context->Compressed) {
			/* Compression is done 1 at a time for now */
			switch (context->compr.phase) {
			case 0:
				if (buf[0] != 0) {	/* run count */
					context->compr.phase = 1;
					context->compr.RunCount = buf[0];
				} else {	/* Escape */
					context->compr.phase = 2;
				}
				buf++;
				size--;
				break;
			case 1:	/* Run count received.... */
				while (context->compr.RunCount > 0) {
					BytesToCopy =
					    context->LineWidth -
					    context->LineDone;
					if (BytesToCopy >
					    context->compr.
					    RunCount) BytesToCopy =
						    context->compr.
						    RunCount;
					if (BytesToCopy > 0) {
						memset(context->LineBuf +
						       context->LineDone,
						       buf[0],
						       BytesToCopy);

						context->compr.RunCount -=
						    BytesToCopy;
						context->LineDone +=
						    BytesToCopy;
					}
					if (
					    (context->LineDone >=
					     context->LineWidth)
					    && (context->LineWidth > 0)) {
						OneLine(context);
					}
				}
				context->compr.phase = 0;
				buf++;
				size--;
				break;
			case 2:	/* Escape received */
				if (buf[0] == 0) {	/* End of line */
					context->compr.phase = 0;
					if (context->LineDone > 0)
						OneLine(context);
				} else if (buf[0] == 1) {	/* End of image */
					OneLine(context);
					context->compr.phase = 6;
					size = 0;
					break;
				} else if (buf[0] == 2) {	/* Cursor displacement */
					context->compr.phase = 4;
				} else {
					context->compr.phase = 3;
					context->compr.RunCount = buf[0];
				}
				buf++;
				size--;

				break;
			case 3:
				while ((context->compr.RunCount > 0)
				       && (size > 0)) {
					BytesToCopy =
					    context->LineWidth -
					    context->LineDone;
					if (BytesToCopy >
					    context->compr.
					    RunCount) BytesToCopy =
						    context->compr.
						    RunCount;
					if (BytesToCopy > size)
						BytesToCopy = size;

					if (BytesToCopy > 0) {
						memcpy(context->LineBuf +
						       context->LineDone,
						       buf, BytesToCopy);

						context->compr.RunCount -=
						    BytesToCopy;
						buf += BytesToCopy;
						size -= BytesToCopy;
						context->LineDone +=
						    BytesToCopy;
					}
					if (
					    (context->LineDone >=
					     context->LineWidth)
					    && (context->LineWidth > 0))
						OneLine(context);
				}
				if (context->compr.RunCount <= 0)
					context->compr.phase = 0;

				break;
			case 4:
				context->compr.phase = 5;
				context->compr.XDelta = buf[0];
				buf++;
				size--;
				break;
			case 5:
				context->compr.phase = 0;
				context->compr.YDelta = buf[0];
				g_assert(0);	/* No implementatio of this yet */
				buf++;
				size--;
				break;
			case 6:
				size = 0;
			}

601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
		} else {
			/* Pixeldata only */
			BytesToCopy =
			    context->LineWidth - context->LineDone;
			if (BytesToCopy > size)
				BytesToCopy = size;

			if (BytesToCopy > 0) {
				memcpy(context->LineBuf +
				       context->LineDone, buf,
				       BytesToCopy);

				size -= BytesToCopy;
				buf += BytesToCopy;
				context->LineDone += BytesToCopy;
			}
			if ((context->LineDone >= context->LineWidth) &&
			    (context->LineWidth > 0))
				OneLine(context);


		}

624 625 626
		if (context->HeaderDone >= 14 + 40)
			DecodeHeader(context->HeaderBuf,
				     context->HeaderBuf + 14, context);
Mark Crichton's avatar
Mark Crichton committed
627 628


629
	}
Mark Crichton's avatar
Mark Crichton committed
630

631
	return TRUE;
Mark Crichton's avatar
Mark Crichton committed
632
}