X-Git-Url: http://git.draconx.ca/gitweb/liblbx.git/blobdiff_plain/84050ee438ba1661047709f3c8b95b126ca10f93..38a465378241d4c74b07fd7e4deaf2af09ff2bcb:/src/image.c

diff --git a/src/image.c b/src/image.c
index c8a7165..f407a2d 100644
--- a/src/image.c
+++ b/src/image.c
@@ -1,25 +1,22 @@
 /*
- *  2ooM: The Master of Orion II Reverse Engineering Project
- *  Library for working with LBX image files.
- *  Copyright (C) 2006-2008 Nick Bowler
+ * 2ooM: The Master of Orion II Reverse Engineering Project
+ * Library for working with LBX image files.
+ * Copyright © 2006-2011 Nick Bowler
  *
- *  This program is free software: you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation, either version 3 of the License, or
- *  (at your option) any later version.
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
  *
- *  This program 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 General Public License for more details.
+ * This program 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 General Public License for more details.
  *
- *  You should have received a copy of the GNU General Public License
- *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#ifdef HAVE_CONFIG_H
-#	include "config.h"
-#endif
-
+#include <config.h>
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
@@ -28,19 +25,24 @@
 #include "pack.h"
 #include "misc.h"
 #include "lbx.h"
+#include "error.h"
 #include "image.h"
 
+#define FLAG_RAW       0x0100 /* Image is stored as a flat array of bytes. */
 #define FLAG_OVERWRITE 0x0400 /* Draw each frame on a clean slate (unsure). */
+#define FLAG_BUILDING  0x0800 /* Buildings have this, related to shadow? */
 #define FLAG_PALETTE   0x1000 /* Image contains embedded palette. */
 #define FLAG_LOOPING   0x2000 /* Loop over all frames in the image (unsure). */
-#define FLAG_ALL (FLAG_OVERWRITE|FLAG_PALETTE|FLAG_LOOPING)
+
+#define FLAG_ALL (FLAG_RAW|FLAG_OVERWRITE|FLAG_BUILDING|FLAG_PALETTE|FLAG_LOOPING)
 
 #define HDR_LEN 12
 
-struct lbx_image {
-	unsigned short width, height;
+struct lbx_image_priv {
+	struct lbx_image pub;
+
 	unsigned short wtf, flags;
-	unsigned short frames, leadin;
+	unsigned char  wtf2, leadin;
 	unsigned short palstart, palcount;
 
 	const struct lbx_file_ops *fops;
@@ -57,24 +59,26 @@ struct lbx_image {
 	unsigned long offsets[];
 };
 
-static struct lbx_image *lbximg_init(unsigned char hdr[static HDR_LEN])
+static struct lbx_image_priv *lbx_img_init(unsigned char hdr[static HDR_LEN])
 {
 	unsigned short nframes = unpack_16_le(hdr+6);
-	struct lbx_image *img;
+	struct lbx_image_priv *img;
 
 	img = malloc(sizeof *img + sizeof img->offsets[0] * (nframes+1));
 	if (!img) {
-		lbx_errno = -errno;
+		lbx_error_raise(LBX_ENOMEM);
 		return NULL;
 	}
 
-	*img = (struct lbx_image) {
-		.width  = unpack_16_le(hdr+0),
-		.height = unpack_16_le(hdr+2),
-		.wtf    = unpack_16_le(hdr+4),
-		.frames = unpack_16_le(hdr+6),
-		.leadin = unpack_16_le(hdr+8),
-		.flags  = unpack_16_le(hdr+10),
+	*img = (struct lbx_image_priv) {
+		.pub.width  = unpack_16_le(hdr+0),
+		.pub.height = unpack_16_le(hdr+2),
+		.wtf        = unpack_16_le(hdr+4),
+		.pub.frames = hdr[6],
+		.wtf2       = hdr[7],
+		.leadin     = hdr[8],
+		.pub.chunk  = hdr[9],
+		.flags      = unpack_16_le(hdr+10),
 
 		.currentframe = -1,
 	};
@@ -82,20 +86,19 @@ static struct lbx_image *lbximg_init(unsigned char hdr[static HDR_LEN])
 	return img;
 }
 
-struct lbx_image *lbximg_open(void *f, const struct lbx_file_ops *fops,
-                              int (*destructor)(void *))
+struct lbx_image *lbx_img_open(void *f, const struct lbx_file_ops *fops,
+                               int (*destructor)(void *))
 {
 	unsigned char hdr_buf[HDR_LEN];
-	struct lbx_image *img;
+	struct lbx_image_priv *img;
 
 	if (fops->read(hdr_buf, sizeof hdr_buf, f) != sizeof hdr_buf) {
-		lbx_errno = -errno;
 		if (fops->eof(f))
-			lbx_errno = LBX_EEOF;
+			lbx_error_raise(LBX_EEOF);
 		return NULL;
 	}
 
-	img = lbximg_init(hdr_buf);
+	img = lbx_img_init(hdr_buf);
 	if (!img)
 		return NULL;
 
@@ -106,21 +109,21 @@ struct lbx_image *lbximg_open(void *f, const struct lbx_file_ops *fops,
 	/*
 	 * DEBUG ONLY.  These assertions exist to catch otherwise valid image
 	 * files which differ from what I believe to be true of all LBX images.
-	 * If we never find any exceptions, we can replace the assertions with
-	 * assumptions.
+	 * When we can decode every image, then these assertions should be
+	 * replaced with constraints.
 	 */
-	_lbx_assert(img->wtf == 0); /* version? */
-	_lbx_assert(img->frames > img->leadin); /* cmbtshp.lbx breaks this. */
+	_lbx_assert(img->wtf  == 0); /* version? */
+	_lbx_assert(img->wtf2 == 0); /* very likely is simply reserved. */
+	_lbx_assert(img->pub.frames > img->leadin);
 	_lbx_assert(!(img->flags & ~FLAG_ALL));
 
 	/* Read all offsets.  Should be merged with identical code in lbx.c */
-	for (unsigned i = 0; i <= img->frames; i++) {
+	for (unsigned i = 0; i <= img->pub.frames; i++) {
 		unsigned char buf[4];
 
 		if (fops->read(buf, sizeof buf, f) != sizeof buf) {
-			lbx_errno = -errno;
 			if (fops->eof(f))
-				lbx_errno = LBX_EEOF;
+				lbx_error_raise(LBX_EEOF);
 			free(img);
 			return NULL;
 		}
@@ -132,9 +135,8 @@ struct lbx_image *lbximg_open(void *f, const struct lbx_file_ops *fops,
 		unsigned char buf[4];
 
 		if (fops->read(buf, sizeof buf, f) != sizeof buf) {
-			lbx_errno = -errno;
 			if (fops->eof(f))
-				lbx_errno = LBX_EEOF;
+				lbx_error_raise(LBX_EEOF);
 			free(img);
 			return NULL;
 		}
@@ -144,21 +146,53 @@ struct lbx_image *lbximg_open(void *f, const struct lbx_file_ops *fops,
 		img->paloff   = fops->tell(f);
 
 		if (img->palstart + img->palcount > 256) {
-			lbx_errno = LBX_EFORMAT;
+			lbx_error_raise(LBX_EFORMAT);
 			free(img);
 			return NULL;
 		}
 	}
 
-	return img;
+	return &img->pub;
 }
 
-struct lbx_image *lbximg_fopen(FILE *f)
+static int pipe_close(void *f)
 {
-	return lbximg_open(f, &lbx_default_fops, NULL);
+	struct lbx_pipe_state *p = f;
+	int rc;
+
+	rc = fclose(p->f);
+	free(p);
+	return rc;
 }
 
-static int _lbx_drawrow(int first, struct lbx_image *img)
+static int file_close(void *f)
+{
+	return fclose((FILE *)f);
+}
+
+struct lbx_image *lbx_img_fopen(const char *file)
+{
+	struct lbx_pipe_state *p;
+	FILE *f;
+
+	f = fopen(file, "rb");
+	if (!f)
+		return NULL;
+
+	if (fseek(f, 0, SEEK_CUR) == 0)
+		return lbx_img_open(f, &lbx_default_fops, file_close);
+
+	p = malloc(sizeof *p);
+	if (!p) {
+		fclose(f);
+		return NULL;
+	}
+
+	*p = (struct lbx_pipe_state) { .f = f };
+	return lbx_img_open(p, &lbx_pipe_fops, pipe_close);
+}
+
+static int _lbx_drawrow(int first, struct lbx_image_priv *img)
 {
 	unsigned short type, count, yval, xval;
 	unsigned char buf[4];
@@ -192,8 +226,9 @@ static int _lbx_drawrow(int first, struct lbx_image *img)
 			return 1;
 
 		/* Ensure that the row fits in the image. */
-		if (img->height - img->currenty <= yval || xval >= img->width) {
-			lbx_errno = LBX_EFORMAT;
+		if (img->pub.height - img->currenty <= yval
+		    || xval >= img->pub.width) {
+			lbx_error_raise(LBX_EFORMAT);
 			return -1;
 		}
 
@@ -202,8 +237,8 @@ static int _lbx_drawrow(int first, struct lbx_image *img)
 	} else {
 		xval = unpack_16_le(buf+2);
 
-		if (img->width - img->currentx <= xval) {
-			lbx_errno = LBX_EFORMAT;
+		if (img->pub.width - img->currentx <= xval) {
+			lbx_error_raise(LBX_EFORMAT);
 			return -1;
 		}
 		img->currentx += xval;
@@ -211,8 +246,8 @@ static int _lbx_drawrow(int first, struct lbx_image *img)
 		count = type;
 	}
 
-	if (count > img->width - img->currentx) {
-		lbx_errno = LBX_EFORMAT;
+	if (count > img->pub.width - img->currentx) {
+		lbx_error_raise(LBX_EFORMAT);
 		return -1;
 	}
 
@@ -232,9 +267,8 @@ static int _lbx_drawrow(int first, struct lbx_image *img)
 
 	return 0;
 readerr:
-	lbx_errno = -errno;
 	if (img->fops->eof(img->f))
-		lbx_errno = LBX_EEOF;
+		lbx_error_raise(LBX_EEOF);
 	return -1;
 }
 
@@ -245,13 +279,13 @@ static unsigned char **allocframebuffer(size_t width, size_t height)
 
 	tmp = calloc(height, width);
 	if (!tmp) {
-		lbx_errno = -errno;
+		lbx_error_raise(LBX_ENOMEM);
 		return NULL;
 	}
 
 	new = malloc(height * sizeof *new);
 	if (!new) {
-		lbx_errno = -errno;
+		lbx_error_raise(LBX_ENOMEM);
 		free(tmp);
 		return NULL;
 	}
@@ -263,38 +297,71 @@ static unsigned char **allocframebuffer(size_t width, size_t height)
 	return new;
 }
 
-unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
+static unsigned char **read_raw_frame(struct lbx_image_priv *img, int frame)
+{
+	unsigned long size = img->pub.width * img->pub.height;
+
+	assert(img->flags & FLAG_RAW);
+
+	if (img->fops->seek(img->f, img->offsets[frame], SEEK_SET)) {
+		return NULL;
+	}
+
+	if (img->fops->read(img->framedata[0], size, img->f) != size) {
+		if (img->fops->eof(img->f))
+			lbx_error_raise(LBX_EEOF);
+		return NULL;
+	}
+	memset(img->mask[0], 1, size);
+
+	if (img->fops->tell(img->f) > img->offsets[frame+1]) {
+		lbx_error_raise(LBX_EFORMAT);
+		return NULL;
+	}
+
+	return img->framedata;
+}
+
+unsigned char **lbx_img_getframe(struct lbx_image *pub, int frame)
 {
-	if (frame >= img->frames || frame < 0) {
-		lbx_errno = LBX_ERANGE;
+	struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
+
+	if (frame >= pub->frames || frame < 0) {
+		lbx_error_raise(LBX_ENOENT);
 		return NULL;
 	}
 
 	if (!img->framedata) {
-		img->framedata = allocframebuffer(img->width, img->height);
+		img->framedata = allocframebuffer(pub->width, pub->height);
 		if (!img->framedata)
 			return NULL;
 	}
 
 	if (!img->mask) {
-		img->mask = allocframebuffer(img->width, img->height);
+		img->mask = allocframebuffer(pub->width, pub->height);
 		if (!img->mask)
 			return NULL;
 	}
 
-	if (img->flags & FLAG_OVERWRITE) {
+	if (img->flags & FLAG_RAW)
+		return read_raw_frame(img, frame);
+
+	if ((img->flags & FLAG_OVERWRITE)
+	     || (pub->chunk && !(frame % pub->chunk))) {
 		/* Clear the slate. */
 		img->currentframe = -1;
-		memset(img->framedata[0], 0, img->width * img->height);
-		memset(img->mask[0],      0, img->width * img->height);
+		memset(img->framedata[0], 0, pub->width * pub->height);
+		memset(img->mask[0],      0, pub->width * pub->height);
 	} else {
 		/* Start over if we are backtracking. */
-		if (img->currentframe > frame)
+		if (img->currentframe > frame) {
+			memset(img->mask[0], 0, pub->width * pub->height);
 			img->currentframe = -1;
+		}
 
 		/* We must have previous frame decoded to continue. */
 		if (frame > img->currentframe + 1) {
-			if (!lbximg_getframe(img, frame-1))
+			if (!lbx_img_getframe(pub, frame-1))
 				return NULL;
 		}
 	}
@@ -303,7 +370,6 @@ unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
 		int rc, first = 1;
 
 		if (img->fops->seek(img->f, img->offsets[frame], SEEK_SET)) {
-			lbx_errno = -errno;
 			return NULL;
 		}
 
@@ -314,7 +380,7 @@ unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
 			first = 0;
 
 			if (img->fops->tell(img->f) > img->offsets[frame+1]) {
-				lbx_errno = LBX_EFORMAT;
+				lbx_error_raise(LBX_EFORMAT);
 				return NULL;
 			}
 		} while (!rc);
@@ -324,23 +390,26 @@ unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
 	return img->framedata;
 }
 
-int lbximg_loadpalette(FILE *f, struct lbx_colour palette[static 256])
+int
+lbx_img_loadpalette(void *f, const struct lbx_file_ops *fops,
+                    struct lbx_colour palette[static 256])
 {
 	unsigned char entry[4];
 	int i;
 
 	for (i = 0; i < 256; i++) {
-		if (fread(entry, sizeof entry, 1, f) != 1) {
-			lbx_errno = (feof(f)) ? LBX_EEOF : -errno;
+		if (fops->read(entry, sizeof entry, f) != sizeof entry) {
+			if (fops->eof(f))
+				lbx_error_raise(LBX_EEOF);
 			return -1;
 		}
 
 		if (entry[0] != 1) {
-			lbx_errno = LBX_EFORMAT;
+			lbx_error_raise(LBX_EFORMAT);
 			return -1;
 		}
 
-		palette[i] = (struct lbx_colour){
+		palette[i] = (struct lbx_colour) {
 			.red    = entry[1] << 2,
 			.green  = entry[2] << 2,
 			.blue   = entry[3] << 2,
@@ -352,8 +421,9 @@ int lbximg_loadpalette(FILE *f, struct lbx_colour palette[static 256])
 }
 
 int
-lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
+lbx_img_getpalette(struct lbx_image *pub, struct lbx_colour palette[static 256])
 {
+	struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
 	unsigned char entry[4];
 	unsigned int i;
 	size_t rc;
@@ -363,7 +433,6 @@ lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
 		return 0;
 
 	if (img->fops->seek(img->f, img->paloff, SEEK_SET)) {
-		lbx_errno = -errno;
 		return -1;
 	}
 
@@ -374,7 +443,7 @@ lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
 		}
 
 		if (entry[0] != 0) {
-			lbx_errno = LBX_EFORMAT;
+			lbx_error_raise(LBX_EFORMAT);
 			return -1;
 		}
 
@@ -388,16 +457,16 @@ lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
 
 	return 0;
 readerr:
-	lbx_errno = img->fops->eof(img->f) ? LBX_EEOF : -errno;
+	if (img->fops->eof(img->f))
+		lbx_error_raise(LBX_EEOF);
 	return -1;
 }
 
-void lbximg_getinfo(struct lbx_image *img, struct lbx_imginfo *info)
+void lbx_img_getinfo(struct lbx_image *pub, struct lbx_imginfo *info)
 {
+	struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
+
 	*info = (struct lbx_imginfo) {
-		.width      = img->width,
-		.height     = img->height,
-		.nframes    = img->frames,
 		.palettesz  = (img->flags & FLAG_PALETTE) ? img->palcount : 0,
 	};
 
@@ -405,19 +474,22 @@ void lbximg_getinfo(struct lbx_image *img, struct lbx_imginfo *info)
 	if (img->flags & FLAG_LOOPING) {
 		info->loopstart = 0;
 		info->looping   = 1;
-	} else if (img->leadin != img->frames - 1) {
+	} else if (img->leadin != pub->frames - 1) {
 		info->loopstart = img->leadin;
 		info->looping   = 1;
 	}
 }
 
-unsigned char **lbximg_getmask(struct lbx_image *img)
+unsigned char **lbx_img_getmask(struct lbx_image *pub)
 {
+	struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
+
 	return img->mask;
 }
 
-int lbximg_close(struct lbx_image *img)
+int lbx_img_close(struct lbx_image *pub)
 {
+	struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
 	int rc = 0;
 
 	if (img) {