]> git.draconx.ca Git - liblbx.git/blobdiff - src/image.c
Implement image masks to handle transparency in images.
[liblbx.git] / src / image.c
index ba642d026b740d09b389b3eea195965da90acf3e..f32a66094372eda5de7418afa32450abad9ab2f2 100644 (file)
@@ -4,6 +4,7 @@
 
 #include <stdlib.h>
 #include <stdint.h>
+#include <string.h>
 #include <assert.h>
 #include <errno.h>
 
 #include "lbx.h"
 #include "image.h"
 
+#define FLAG_OVERWRITE 0x0400 /* Draw each frame on a clean slate (unsure). */
+#define FLAG_PALETTE   0x1000 /* Image contains embedded palette. */
+#define FLAG_LOOPING   0x2000 /* Loop over all frames in the image (unsure). */
+
 struct lbx_image {
        uint16_t width, height;
-       uint16_t wtf1, wtf2;
-       uint16_t offs, frames;
+       uint16_t wtf1;
+       uint16_t frames, leadin;
+       uint16_t flags;
 
        FILE *f;
        long foff;
@@ -23,6 +29,7 @@ struct lbx_image {
        int currentframe;
        int currentx, currenty;
        unsigned char **framedata;
+       unsigned char **mask;
 
        uint32_t offsets[];
 };
@@ -30,20 +37,27 @@ struct lbx_image {
 struct lbx_image *lbximg_fopen(FILE *f)
 {
        struct lbx_image tmp = {.f = f}, *new = NULL;
+       size_t rc;
 
        if (fread(&tmp.width,  sizeof tmp.width,   1, f) != 1) goto readerr;
        if (fread(&tmp.height, sizeof tmp.height,  1, f) != 1) goto readerr;
        if (fread(&tmp.wtf1,   sizeof tmp.wtf1,    1, f) != 1) goto readerr;
-       if (fread(&tmp.offs,   sizeof tmp.offs,    1, f) != 1) goto readerr;
        if (fread(&tmp.frames, sizeof tmp.frames,  1, f) != 1) goto readerr;
-       if (fread(&tmp.wtf2,   sizeof tmp.wtf2,    1, f) != 1) goto readerr;
+       if (fread(&tmp.leadin, sizeof tmp.leadin,  1, f) != 1) goto readerr;
+       if (fread(&tmp.flags,  sizeof tmp.flags,   1, f) != 1) goto readerr;
 
        tmp.width  = letohs(tmp.width);  tmp.foff += sizeof tmp.width;
        tmp.height = letohs(tmp.height); tmp.foff += sizeof tmp.height;
        tmp.wtf1   = letohs(tmp.wtf1);   tmp.foff += sizeof tmp.wtf1;
-       tmp.offs   = letohs(tmp.offs);   tmp.foff += sizeof tmp.offs;
        tmp.frames = letohs(tmp.frames); tmp.foff += sizeof tmp.frames;
-       tmp.wtf2   = letohs(tmp.wtf2);   tmp.foff += sizeof tmp.wtf2;
+       tmp.leadin = letohs(tmp.leadin); tmp.foff += sizeof tmp.leadin;
+       tmp.flags  = letohs(tmp.flags);  tmp.foff += sizeof tmp.flags;
+
+       /* Format constraints. */
+       if (tmp.frames <= tmp.leadin) {
+               lbx_errno = LBX_EFORMAT;
+               return NULL;
+       }
 
        /*
         * DEBUG ONLY.  These assertions exist to catch otherwise valid image
@@ -52,9 +66,9 @@ struct lbx_image *lbximg_fopen(FILE *f)
         * assumptions.
         */
        _lbx_assert(tmp.wtf1 == 0);
-       _lbx_assert(tmp.offs == tmp.frames + 1);
+       _lbx_assert(!(tmp.flags & ~(FLAG_PALETTE|FLAG_OVERWRITE|FLAG_LOOPING)));
 
-       new = malloc(sizeof *new + tmp.offs * sizeof *new->offsets);
+       new = malloc(sizeof *new + (tmp.frames+1) * sizeof *new->offsets);
        if (!new) {
                lbx_errno = -errno;
                return NULL;
@@ -63,9 +77,10 @@ struct lbx_image *lbximg_fopen(FILE *f)
        *new = tmp;
        new->currentframe = -1;
 
-       if (fread(new->offsets, sizeof *new->offsets, new->offs, f)!= new->offs)
+       rc = fread(new->offsets, sizeof *new->offsets, new->frames+1, f);
+       if (rc < new->frames+1)
                goto readerr;
-       new->foff += sizeof *new->offsets * new->offs;
+       new->foff += sizeof *new->offsets * (new->frames+1);
 
        return new;
 readerr:
@@ -87,6 +102,7 @@ static int _lbx_drawrow(int first, struct lbx_image *img)
        size_t rc;
 
        assert(img->framedata);
+       assert(img->mask);
 
        if (fread(&type, sizeof type, 1, img->f) != 1) goto readerr;
        type = letohs(type); img->foff += sizeof type;
@@ -100,14 +116,14 @@ static int _lbx_drawrow(int first, struct lbx_image *img)
        if (type == 0) {
                if (fread(&yval,  sizeof yval,  1, img->f) != 1) goto readerr;
                yval = letohs(yval); img->foff += sizeof yval;
-
                if (yval == 1000)
                        return 1;
-
                if (fread(&count, sizeof count, 1, img->f) != 1) goto readerr;
                count = letohs(count); img->foff += sizeof count;
                if (fread(&xval,  sizeof xval,  1, img->f) != 1) goto readerr;
                xval = letohs(xval); img->foff += sizeof xval;
+               if (xval == 1000)
+                       return 1;
 
                /* Ensure that the row fits in the image. */
                if (img->height - img->currenty <= yval || xval >= img->width) {
@@ -136,6 +152,8 @@ static int _lbx_drawrow(int first, struct lbx_image *img)
                return -1;
        }
 
+       memset(&img->mask[img->currenty][img->currentx], 1, count);
+
        pos = &img->framedata[img->currenty][img->currentx];
        rc  = fread(pos, 1, count, img->f);
        img->currentx += rc;
@@ -160,6 +178,31 @@ readerr:
        return -1;
 }
 
+static unsigned char **allocframebuffer(size_t width, size_t height)
+{
+       unsigned char **new, *tmp;
+       size_t i;
+
+       tmp = calloc(height, width);
+       if (!tmp) {
+               lbx_errno = -errno;
+               return NULL;
+       }
+
+       new = malloc(height * sizeof *new);
+       if (!new) {
+               lbx_errno = -errno;
+               free(tmp);
+               return NULL;
+       }
+
+       for (i = 0; i < height; i++) {
+               new[i] = tmp + i * width;
+       }
+
+       return new;
+}
+
 unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
 {
        if (frame >= img->frames || frame < 0) {
@@ -168,35 +211,31 @@ unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
        }
 
        if (!img->framedata) {
-               unsigned char *tmp;
-               int i;
-
-               tmp = malloc(img->width * img->height);
-               if (!tmp) {
-                       lbx_errno = -errno;
+               img->framedata = allocframebuffer(img->width, img->height);
+               if (!img->framedata)
                        return NULL;
-               }
+       }
 
-               img->framedata = malloc(img->height * sizeof *img->framedata);
-               if (!img->framedata) {
-                       lbx_errno = -errno;
-                       free(tmp);
+       if (!img->mask) {
+               img->mask = allocframebuffer(img->width, img->height);
+               if (!img->mask)
                        return NULL;
-               }
-
-               for (i = 0; i < img->height; i++) {
-                       img->framedata[i] = tmp + i * img->width;
-               }
        }
 
        /* Start over if we are backtracking. */
        if (img->currentframe > frame)
                img->currentframe == -1;
 
-       /* We must have previous frame decoded to continue. */
-       if (frame > img->currentframe + 1) {
-               if (!lbximg_getframe(img, frame-1))
-                       return NULL;
+       if (img->flags & FLAG_OVERWRITE) {
+               /* Clear the slate. */
+               memset(img->framedata[0], 0, img->width * img->height);
+               memset(img->mask[0],      0, img->width * img->height);
+       } else {
+               /* We must have previous frame decoded to continue. */
+               if (frame > img->currentframe + 1) {
+                       if (!lbximg_getframe(img, frame-1))
+                               return NULL;
+               }
        }
 
        if (img->currentframe != frame) {
@@ -211,7 +250,7 @@ unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
                                return NULL;
                        first = 0;
 
-                       if (img->foff > img->offsets[frame+1]) {
+                       if (!rc && img->foff > img->offsets[frame+1]) {
                                lbx_errno = LBX_EFORMAT;
                                return NULL;
                        }
@@ -251,18 +290,38 @@ int lbximg_loadpalette(FILE *f, struct lbx_colour palette[static 256])
 int
 lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
 {
-       int index = 0;
+       size_t hdrlen = 6*(sizeof img->wtf1)+(img->frames+1)*(sizeof *img->offsets);
+       unsigned int i;
        size_t rc;
-       size_t hdrlen = 6*(sizeof img->width)
-                       + (img->offs)*(sizeof *img->offsets);
-       
-       uint8_t entry[4];
+
+       uint16_t start, count;
+       uint8_t  entry[4];
+
+       /* Do nothing if the image doesn't have embedded palette data. */
+       if (!(img->flags & FLAG_PALETTE))
+               return 0;
 
        /* Palette data is located right after the header. */
        if (_lbx_fseek(img->f, &img->foff, hdrlen) == -1)
                return -1;
        
-       while (img->foff + sizeof entry <= img->offsets[0]) {
+       /* Palette header */
+       if (fread(&start, sizeof start, 1, img->f) != 1) goto readerr;
+       if (fread(&count, sizeof count, 1, img->f) != 1) goto readerr;
+       start = letohs(start); img->foff += sizeof start;
+       count = letohs(count); img->foff += sizeof count;
+
+       if (start + count > 256) {
+               lbx_errno = LBX_EFORMAT;
+               return -1;
+       }
+
+       if (hdrlen + 2*sizeof start + count*sizeof entry > img->offsets[0]) {
+               lbx_errno = LBX_EFORMAT;
+               return -1;
+       }
+
+       for (i = 0; i < count; i++) {
                rc = fread(entry, 1, sizeof entry, img->f);
                img->foff += rc;
 
@@ -270,13 +329,12 @@ lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
                        goto readerr;
                }
 
-               if (entry[0] == 0) {
-                       index++;
-               } else {
-                       index = entry[0];
+               if (entry[0] != 0) {
+                       lbx_errno = LBX_EFORMAT;
+                       return -1;
                }
 
-               palette[index] = (struct lbx_colour){
+               palette[start + i] = (struct lbx_colour){
                        .red   = entry[1] << 2,
                        .green = entry[2] << 2,
                        .blue  = entry[3] << 2,
@@ -285,20 +343,32 @@ lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
 
        return 0;
 readerr:
-       if (feof(img->f))
-               lbx_errno = LBX_EEOF;
-       else
-               lbx_errno = -errno;
+       lbx_errno = feof(img->f) ? LBX_EEOF : -errno;
        return -1;
 }
 
 void lbximg_getinfo(struct lbx_image *img, struct lbx_imginfo *info)
 {
        *info = (struct lbx_imginfo) {
-               .width   = img->width,
-               .height  = img->height,
-               .nframes = img->frames,
+               .width      = img->width,
+               .height     = img->height,
+               .nframes    = img->frames,
+               .haspalette = (_Bool)(img->flags & FLAG_PALETTE),
        };
+
+       /* There seems to be two ways of specifying that an image loops. */
+       if (img->flags & FLAG_LOOPING) {
+               info->loopstart = 0;
+               info->looping   = 1;
+       } else if (img->leadin != img->frames - 1) {
+               info->loopstart = img->leadin;
+               info->looping   = 1;
+       }
+}
+
+unsigned char **lbximg_getmask(struct lbx_image *img)
+{
+       return img->mask;
 }
 
 void lbximg_close(struct lbx_image *img)
@@ -310,6 +380,11 @@ void lbximg_close(struct lbx_image *img)
                free(img->framedata);
        }
 
+       if (img->mask) {
+               free(img->mask[0]);
+               free(img->mask);
+       }
+
        if (img->f) {
                fclose(img->f);
        }