]> git.draconx.ca Git - liblbx.git/blobdiff - src/image.c
liblbx: Implement new image reading API.
[liblbx.git] / src / image.c
index c3abf3f643524d14e9948e54bb24529ab6685b91..0caca9631aec54890711df84047de20dd93a6962 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * 2ooM: The Master of Orion II Reverse Engineering Project
  * Library for working with LBX image files.
- * Copyright © 2006-2011 Nick Bowler
+ * Copyright © 2006-2011, 2013-2014 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
@@ -20,6 +20,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
+#include <inttypes.h>
 #include <errno.h>
 
 #include "pack.h"
 
 #define HDR_LEN 12
 
+/* States for image readout */
+enum {
+       READ_STATE_INIT,
+       READ_STATE_HEADER,
+       READ_STATE_DATA,
+       READ_STATE_DONE,
+};
+
 struct lbx_image_priv {
        struct lbx_image pub;
 
        unsigned short wtf, flags;
-       unsigned char  wtf2, leadin;
+       unsigned char  wtf2;
        unsigned short palstart, palcount;
 
        const struct lbx_file_ops *fops;
@@ -51,8 +60,11 @@ struct lbx_image_priv {
 
        long paloff;
 
+       /* State of frame readout */
+       unsigned currentx, currenty, currentn;
+       int read_state;
+
        int currentframe;
-       int currentx, currenty;
        unsigned char **framedata;
        unsigned char **mask;
 
@@ -76,13 +88,19 @@ static struct lbx_image_priv *lbx_img_init(unsigned char hdr[static HDR_LEN])
                .wtf        = unpack_16_le(hdr+4),
                .pub.frames = hdr[6],
                .wtf2       = hdr[7],
-               .leadin     = hdr[8],
+               .pub.leadin = hdr[8],
                .pub.chunk  = hdr[9],
                .flags      = unpack_16_le(hdr+10),
 
                .currentframe = -1,
        };
 
+       if (img->flags & FLAG_OVERWRITE)
+               img->pub.chunk = 1;
+
+       if (img->flags & FLAG_LOOPING)
+               img->pub.leadin = 0;
+
        return img;
 }
 
@@ -114,7 +132,7 @@ struct lbx_image *lbx_img_open(void *f, const struct lbx_file_ops *fops,
         */
        _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->pub.frames > img->pub.leadin);
        _lbx_assert(!(img->flags & ~FLAG_ALL));
 
        /* Read all offsets.  Should be merged with identical code in lbx.c */
@@ -176,14 +194,17 @@ struct lbx_image *lbx_img_fopen(const char *file)
        FILE *f;
 
        f = fopen(file, "rb");
-       if (!f)
+       if (!f) {
+               lbx_error_raise(-errno);
                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) {
+               lbx_error_raise(LBX_ENOMEM);
                fclose(f);
                return NULL;
        }
@@ -192,120 +213,212 @@ struct lbx_image *lbx_img_fopen(const char *file)
        return lbx_img_open(p, &lbx_pipe_fops, pipe_close);
 }
 
-static int _lbx_drawrow(int first, struct lbx_image_priv *img)
+static int _lbx_drawrow(struct lbx_image_priv *img)
 {
-       unsigned short type, count, yval, xval;
-       unsigned char buf[4];
        unsigned char *pos;
-       size_t rc;
+       unsigned x, y;
+       long rc;
 
        assert(img->framedata);
        assert(img->mask);
 
-       if (img->fops->read(buf, sizeof buf, img->f) != sizeof buf)
-               goto readerr;
-       type = unpack_16_le(buf+0);
+       rc = lbx_img_read_row_header(&img->pub, &x, &y);
+       if (rc == 0)
+               return 1;
+       else if (rc < 0)
+               return -1;
 
-       if (first) {
-               img->currentx = 0;
-               img->currenty = 0;
-               type = 0;
+       pos = &img->framedata[y][x];
+       rc = lbx_img_read_row_data(&img->pub, pos);
+       if (rc < 0)
+               return -1;
+       memset(&img->mask[y][x], 1, rc);
+
+       return 0;
+}
+
+static unsigned char **allocframebuffer(size_t width, size_t height)
+{
+       unsigned char **new, *tmp;
+       size_t i;
+
+       if (height > SIZE_MAX / sizeof *new) {
+               lbx_error_raise(LBX_ENOMEM);
+               return NULL;
        }
 
-       if (type == 0) {
-               yval = unpack_16_le(buf+2);
-               if (yval == 1000)
-                       return 1;
+       /* Ensure that there is at least one row in the framebuffer. */
+       if (height == 0 || width == 0)
+               width = height = 1;
 
-               if (img->fops->read(buf, sizeof buf, img->f) != sizeof buf)
-                       goto readerr;
-               count = unpack_16_le(buf+0);
+       tmp = calloc(height, width);
+       if (!tmp) {
+               lbx_error_raise(LBX_ENOMEM);
+               return NULL;
+       }
+
+       new = malloc(height * sizeof *new);
+       if (!new) {
+               lbx_error_raise(LBX_ENOMEM);
+               free(tmp);
+               return NULL;
+       }
 
-               xval = unpack_16_le(buf+2);
-               if (xval == 1000)
-                       return 1;
+       for (i = 0; i < height; i++) {
+               new[i] = tmp + i * width;
+       }
 
-               /* Ensure that the row fits in the image. */
-               if (img->pub.height - img->currenty <= yval
-                   || xval >= img->pub.width) {
-                       lbx_error_raise(LBX_EFORMAT);
+       return new;
+}
+
+int lbx_img_seek(struct lbx_image *pub, unsigned frame)
+{
+       struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
+
+       if (frame >= pub->frames) {
+               lbx_error_raise(LBX_EINVAL);
+               return -1;
+       }
+
+       if (img->fops->seek(img->f, img->offsets[frame], SEEK_SET)) {
+               return -1;
+       }
+
+       if (!(img->flags & FLAG_RAW)) {
+               unsigned char buf[4];
+
+               /* Read frame header */
+               if (img->fops->read(buf, 4, img->f) != 4) {
+                       if (img->fops->eof(img->f))
+                               lbx_error_raise(LBX_EEOF);
                        return -1;
                }
 
-               img->currenty += yval;
-               img->currentx  = xval;
-       } else {
-               xval = unpack_16_le(buf+2);
-
-               if (img->pub.width - img->currentx <= xval) {
+               if (unpack_16_le(buf) != 1) {
                        lbx_error_raise(LBX_EFORMAT);
                        return -1;
                }
-               img->currentx += xval;
 
-               count = type;
+               img->currentx = 0;
+               img->currenty = unpack_16_le(buf+2);
+               if (img->currenty > img->pub.height) {
+                       lbx_error_raise(LBX_EFORMAT);
+                       return -1;
+               }
        }
 
-       if (count > img->pub.width - img->currentx) {
-               lbx_error_raise(LBX_EFORMAT);
+       img->read_state = READ_STATE_HEADER;
+       return 0;
+}
+
+long lbx_img_read_row_header(struct lbx_image *pub, unsigned *x, unsigned *y)
+{
+       struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
+       unsigned short length, offset;
+       unsigned char buf[4];
+
+       if (img->read_state != READ_STATE_HEADER) {
+               lbx_error_raise(LBX_EINVAL);
                return -1;
        }
 
-       memset(&img->mask[img->currenty][img->currentx], 1, count);
+       /* Raw images have no row headers */
+       if (img->flags & FLAG_RAW) {
+               img->currentn = img->pub.width;
+               *y = img->currenty++;
+               *x = 0;
+
+               if (*y < img->pub.height) {
+                       img->read_state = READ_STATE_DATA;
+                       return img->currentn;
+               } else {
+                       img->read_state = READ_STATE_DONE;
+                       return 0;
+               }
+       }
+
+       do {
+               if (img->fops->read(buf, sizeof buf, img->f) != sizeof buf) {
+                       if (img->fops->eof(img->f))
+                               lbx_error_raise(LBX_EEOF);
+                       return -1;
+               }
+
+               length = unpack_16_le(buf+0);
+               offset = unpack_16_le(buf+2);
 
-       pos = &img->framedata[img->currenty][img->currentx];
-       rc  = img->fops->read(pos, count, img->f);
-       img->currentx += rc;
+               if (length == 0) {
+                       if (offset == 1000) {
+                               img->read_state = READ_STATE_DONE;
+                               return 0;
+                       } else if (offset > img->pub.height - img->currenty) {
+                               lbx_error_raise(LBX_EFORMAT);
+                               return -1;
+                       }
 
-       if (rc < count)
-               goto readerr;
+                       img->currenty += offset;
+                       img->currentx  = 0;
+               }
+       } while (length == 0);
 
-       if (count % 2) {
-               if (img->fops->read(buf, 1, img->f) != 1)
-                       goto readerr;
+       if (offset > img->pub.width - img->currentx) {
+               lbx_error_raise(LBX_EFORMAT);
+               return -1;
        }
+       img->currentx += offset;
 
-       return 0;
-readerr:
-       if (img->fops->eof(img->f))
-               lbx_error_raise(LBX_EEOF);
-       return -1;
+       if (length > img->pub.width - img->currentx) {
+               lbx_error_raise(LBX_EFORMAT);
+               return -1;
+       }
+       img->currentn = length;
+
+       img->read_state = READ_STATE_DATA;
+       *x = img->currentx;
+       *y = img->currenty;
+
+       return img->currentn;
 }
 
-static unsigned char **allocframebuffer(size_t width, size_t height)
+long lbx_img_read_row_data(struct lbx_image *pub, void *buf)
 {
-       unsigned char **new, *tmp;
-       size_t i;
+       struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
 
-       tmp = calloc(height, width);
-       if (!tmp) {
-               lbx_error_raise(LBX_ENOMEM);
-               return NULL;
+       if (img->read_state != READ_STATE_DATA) {
+               lbx_error_raise(LBX_EINVAL);
+               return -1;
        }
 
-       new = malloc(height * sizeof *new);
-       if (!new) {
-               lbx_error_raise(LBX_ENOMEM);
-               free(tmp);
-               return NULL;
+       if (img->fops->read(buf, img->currentn, img->f) != img->currentn) {
+               if (img->fops->eof(img->f))
+                       lbx_error_raise(LBX_EEOF);
+               return -1;
        }
 
-       for (i = 0; i < height; i++) {
-               new[i] = tmp + i * width;
+       if (!(img->flags & FLAG_RAW)) {
+               /* Skip padding byte, if any */
+               if (img->currentn % 2) {
+                       if (img->fops->seek(img->f, 1, SEEK_CUR))
+                               return -1;
+               }
        }
 
-       return new;
+       img->read_state = READ_STATE_HEADER;
+       img->currentx += img->currentn;
+
+       return img->currentn;
 }
 
 static unsigned char **read_raw_frame(struct lbx_image_priv *img, int frame)
 {
        unsigned long size = img->pub.width * img->pub.height;
+       int rc;
 
        assert(img->flags & FLAG_RAW);
 
-       if (img->fops->seek(img->f, img->offsets[frame], SEEK_SET)) {
+       rc = lbx_img_seek(&img->pub, frame);
+       if (rc < 0)
                return NULL;
-       }
 
        if (img->fops->read(img->framedata[0], size, img->f) != size) {
                if (img->fops->eof(img->f))
@@ -325,9 +438,10 @@ static unsigned char **read_raw_frame(struct lbx_image_priv *img, int frame)
 unsigned char **lbx_img_getframe(struct lbx_image *pub, int frame)
 {
        struct lbx_image_priv *img = (struct lbx_image_priv *)pub;
+       unsigned char buf[4];
 
        if (frame >= pub->frames || frame < 0) {
-               lbx_error_raise(LBX_ENOENT);
+               lbx_error_raise(LBX_EINVAL);
                return NULL;
        }
 
@@ -367,17 +481,16 @@ unsigned char **lbx_img_getframe(struct lbx_image *pub, int frame)
        }
 
        if (img->currentframe != frame) {
-               int rc, first = 1;
+               int rc;
 
-               if (img->fops->seek(img->f, img->offsets[frame], SEEK_SET)) {
+               rc = lbx_img_seek(pub, frame);
+               if (rc < 0)
                        return NULL;
-               }
 
                do {
-                       rc = _lbx_drawrow(first, img);
+                       rc = _lbx_drawrow(img);
                        if (rc == -1)
                                return NULL;
-                       first = 0;
 
                        if (img->fops->tell(img->f) > img->offsets[frame+1]) {
                                lbx_error_raise(LBX_EFORMAT);
@@ -410,9 +523,9 @@ lbx_img_loadpalette(void *f, const struct lbx_file_ops *fops,
                }
 
                palette[i] = (struct lbx_colour) {
-                       .red    = entry[1] << 2,
-                       .green  = entry[2] << 2,
-                       .blue   = entry[3] << 2,
+                       .red    = entry[1] & 0x3f,
+                       .green  = entry[2] & 0x3f,
+                       .blue   = entry[3] & 0x3f,
                        .active = 1,
                };
        }
@@ -448,9 +561,9 @@ lbx_img_getpalette(struct lbx_image *pub, struct lbx_colour palette[static 256])
                }
 
                palette[img->palstart + i] = (struct lbx_colour){
-                       .red    = entry[1] << 2,
-                       .green  = entry[2] << 2,
-                       .blue   = entry[3] << 2,
+                       .red    = entry[1],
+                       .green  = entry[2],
+                       .blue   = entry[3],
                        .active = 1,
                };
        }
@@ -467,10 +580,6 @@ 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      = pub->width,
-               .height     = pub->height,
-               .nframes    = pub->frames,
-               .chunk      = pub->chunk,
                .palettesz  = (img->flags & FLAG_PALETTE) ? img->palcount : 0,
        };
 
@@ -478,8 +587,8 @@ void lbx_img_getinfo(struct lbx_image *pub, struct lbx_imginfo *info)
        if (img->flags & FLAG_LOOPING) {
                info->loopstart = 0;
                info->looping   = 1;
-       } else if (img->leadin != pub->frames - 1) {
-               info->loopstart = img->leadin;
+       } else if (img->pub.leadin != pub->frames - 1) {
+               info->loopstart = img->pub.leadin;
                info->looping   = 1;
        }
 }