src/image.c

   1 /*
   2  *  2ooM: The Master of Orion II Reverse Engineering Project
   3  *  Library for working with LBX image files.
   4  *  Copyright (C) 2006-2008 Nick Bowler
   5  *
   6  *  This program is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19 #ifdef HAVE_CONFIG_H
  20 #       include "config.h"
  21 #endif
  22
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <assert.h>
  26 #include <errno.h>
  27
  28 #include "pack.h"
  29 #include "misc.h"
  30 #include "lbx.h"
  31 #include "image.h"
  32
  33 #define FLAG_RAW       0x0100 /* Image is stored as a flat array of bytes. */
  34 #define FLAG_OVERWRITE 0x0400 /* Draw each frame on a clean slate (unsure). */
  35 #define FLAG_BUILDING  0x0800 /* Buildings have this, related to shadow? */
  36 #define FLAG_PALETTE   0x1000 /* Image contains embedded palette. */
  37 #define FLAG_LOOPING   0x2000 /* Loop over all frames in the image (unsure). */
  38
  39 #define FLAG_ALL (FLAG_RAW|FLAG_OVERWRITE|FLAG_BUILDING|FLAG_PALETTE|FLAG_LOOPING)
  40
  41 #define HDR_LEN 12
  42
  43 struct lbx_image {
  44         unsigned short width, height;
  45         unsigned short wtf, flags;
  46         unsigned char  frames, wtf2, leadin, chunk;
  47         unsigned short palstart, palcount;
  48
  49         const struct lbx_file_ops *fops;
  50         int (*dtor)(void *handle);
  51         void *f;
  52
  53         long paloff;
  54
  55         int currentframe;
  56         int currentx, currenty;
  57         unsigned char **framedata;
  58         unsigned char **mask;
  59
  60         unsigned long offsets[];
  61 };
  62
  63 static struct lbx_image *lbximg_init(unsigned char hdr[static HDR_LEN])
  64 {
  65         unsigned short nframes = unpack_16_le(hdr+6);
  66         struct lbx_image *img;
  67
  68         img = malloc(sizeof *img + sizeof img->offsets[0] * (nframes+1));
  69         if (!img) {
  70                 lbx_errno = -errno;
  71                 return NULL;
  72         }
  73
  74         *img = (struct lbx_image) {
  75                 .width  = unpack_16_le(hdr+0),
  76                 .height = unpack_16_le(hdr+2),
  77                 .wtf    = unpack_16_le(hdr+4),
  78                 .frames = hdr[6],
  79                 .wtf2   = hdr[7],
  80                 .leadin = hdr[8],
  81                 .chunk  = hdr[9],
  82                 .flags  = unpack_16_le(hdr+10),
  83
  84                 .currentframe = -1,
  85         };
  86
  87         return img;
  88 }
  89
  90 struct lbx_image *lbximg_open(void *f, const struct lbx_file_ops *fops,
  91                               int (*destructor)(void *))
  92 {
  93         unsigned char hdr_buf[HDR_LEN];
  94         struct lbx_image *img;
  95
  96         if (fops->read(hdr_buf, sizeof hdr_buf, f) != sizeof hdr_buf) {
  97                 lbx_errno = -errno;
  98                 if (fops->eof(f))
  99                         lbx_errno = LBX_EEOF;
 100                 return NULL;
 101         }
 102
 103         img = lbximg_init(hdr_buf);
 104         if (!img)
 105                 return NULL;
 106
 107         img->f    = f;
 108         img->fops = fops;
 109         img->dtor = destructor;
 110
 111         /*
 112          * DEBUG ONLY.  These assertions exist to catch otherwise valid image
 113          * files which differ from what I believe to be true of all LBX images.
 114          * When we can decode every image, then these assertions should be
 115          * replaced with constraints.
 116          */
 117         _lbx_assert(img->wtf  == 0); /* version? */
 118         _lbx_assert(img->wtf2 == 0); /* very likely is simply reserved. */
 119         _lbx_assert(img->frames > img->leadin);
 120         _lbx_assert(!(img->flags & ~FLAG_ALL));
 121
 122         /* Read all offsets.  Should be merged with identical code in lbx.c */
 123         for (unsigned i = 0; i <= img->frames; i++) {
 124                 unsigned char buf[4];
 125
 126                 if (fops->read(buf, sizeof buf, f) != sizeof buf) {
 127                         lbx_errno = -errno;
 128                         if (fops->eof(f))
 129                                 lbx_errno = LBX_EEOF;
 130                         free(img);
 131                         return NULL;
 132                 }
 133
 134                 img->offsets[i] = unpack_32_le(buf);
 135         }
 136
 137         if (img->flags & FLAG_PALETTE) {
 138                 unsigned char buf[4];
 139
 140                 if (fops->read(buf, sizeof buf, f) != sizeof buf) {
 141                         lbx_errno = -errno;
 142                         if (fops->eof(f))
 143                                 lbx_errno = LBX_EEOF;
 144                         free(img);
 145                         return NULL;
 146                 }
 147
 148                 img->palstart = unpack_16_le(buf+0);
 149                 img->palcount = unpack_16_le(buf+2);
 150                 img->paloff   = fops->tell(f);
 151
 152                 if (img->palstart + img->palcount > 256) {
 153                         lbx_errno = LBX_EFORMAT;
 154                         free(img);
 155                         return NULL;
 156                 }
 157         }
 158
 159         return img;
 160 }
 161
 162 struct lbx_image *lbximg_fopen(FILE *f)
 163 {
 164         return lbximg_open(f, &lbx_default_fops, NULL);
 165 }
 166
 167 static int _lbx_drawrow(int first, struct lbx_image *img)
 168 {
 169         unsigned short type, count, yval, xval;
 170         unsigned char buf[4];
 171         unsigned char *pos;
 172         size_t rc;
 173
 174         assert(img->framedata);
 175         assert(img->mask);
 176
 177         if (img->fops->read(buf, sizeof buf, img->f) != sizeof buf)
 178                 goto readerr;
 179         type = unpack_16_le(buf+0);
 180
 181         if (first) {
 182                 img->currentx = 0;
 183                 img->currenty = 0;
 184                 type = 0;
 185         }
 186
 187         if (type == 0) {
 188                 yval = unpack_16_le(buf+2);
 189                 if (yval == 1000)
 190                         return 1;
 191
 192                 if (img->fops->read(buf, sizeof buf, img->f) != sizeof buf)
 193                         goto readerr;
 194                 count = unpack_16_le(buf+0);
 195
 196                 xval = unpack_16_le(buf+2);
 197                 if (xval == 1000)
 198                         return 1;
 199
 200                 /* Ensure that the row fits in the image. */
 201                 if (img->height - img->currenty <= yval || xval >= img->width) {
 202                         lbx_errno = LBX_EFORMAT;
 203                         return -1;
 204                 }
 205
 206                 img->currenty += yval;
 207                 img->currentx  = xval;
 208         } else {
 209                 xval = unpack_16_le(buf+2);
 210
 211                 if (img->width - img->currentx <= xval) {
 212                         lbx_errno = LBX_EFORMAT;
 213                         return -1;
 214                 }
 215                 img->currentx += xval;
 216
 217                 count = type;
 218         }
 219
 220         if (count > img->width - img->currentx) {
 221                 lbx_errno = LBX_EFORMAT;
 222                 return -1;
 223         }
 224
 225         memset(&img->mask[img->currenty][img->currentx], 1, count);
 226
 227         pos = &img->framedata[img->currenty][img->currentx];
 228         rc  = img->fops->read(pos, count, img->f);
 229         img->currentx += rc;
 230
 231         if (rc < count)
 232                 goto readerr;
 233
 234         if (count % 2) {
 235                 if (img->fops->read(buf, 1, img->f) != 1)
 236                         goto readerr;
 237         }
 238
 239         return 0;
 240 readerr:
 241         lbx_errno = -errno;
 242         if (img->fops->eof(img->f))
 243                 lbx_errno = LBX_EEOF;
 244         return -1;
 245 }
 246
 247 static unsigned char **allocframebuffer(size_t width, size_t height)
 248 {
 249         unsigned char **new, *tmp;
 250         size_t i;
 251
 252         tmp = calloc(height, width);
 253         if (!tmp) {
 254                 lbx_errno = -errno;
 255                 return NULL;
 256         }
 257
 258         new = malloc(height * sizeof *new);
 259         if (!new) {
 260                 lbx_errno = -errno;
 261                 free(tmp);
 262                 return NULL;
 263         }
 264
 265         for (i = 0; i < height; i++) {
 266                 new[i] = tmp + i * width;
 267         }
 268
 269         return new;
 270 }
 271
 272 static unsigned char **read_raw_frame(struct lbx_image *img, int frame)
 273 {
 274         unsigned long size = img->width * img->height;
 275
 276         assert(img->flags & FLAG_RAW);
 277
 278         if (img->fops->seek(img->f, img->offsets[frame], SEEK_SET)) {
 279                 lbx_errno = -errno;
 280                 return NULL;
 281         }
 282
 283         if (img->fops->read(img->framedata[0], size, img->f) != size) {
 284                 lbx_errno = -errno;
 285                 if (img->fops->eof(img->f))
 286                         lbx_errno = LBX_EEOF;
 287                 return NULL;
 288         }
 289         memset(img->mask[0], 1, size);
 290
 291         if (img->fops->tell(img->f) > img->offsets[frame+1]) {
 292                 lbx_errno = LBX_EFORMAT;
 293                 return NULL;
 294         }
 295
 296         return img->framedata;
 297 }
 298
 299 unsigned char **lbximg_getframe(struct lbx_image *img, int frame)
 300 {
 301         if (frame >= img->frames || frame < 0) {
 302                 lbx_errno = LBX_ERANGE;
 303                 return NULL;
 304         }
 305
 306         if (!img->framedata) {
 307                 img->framedata = allocframebuffer(img->width, img->height);
 308                 if (!img->framedata)
 309                         return NULL;
 310         }
 311
 312         if (!img->mask) {
 313                 img->mask = allocframebuffer(img->width, img->height);
 314                 if (!img->mask)
 315                         return NULL;
 316         }
 317
 318         if (img->flags & FLAG_RAW)
 319                 return read_raw_frame(img, frame);
 320
 321         if ((img->flags & FLAG_OVERWRITE)
 322              || (img->chunk && !(frame % img->chunk))) {
 323                 /* Clear the slate. */
 324                 img->currentframe = -1;
 325                 memset(img->framedata[0], 0, img->width * img->height);
 326                 memset(img->mask[0],      0, img->width * img->height);
 327         } else {
 328                 /* Start over if we are backtracking. */
 329                 if (img->currentframe > frame) {
 330                         memset(img->mask[0], 0, img->width * img->height);
 331                         img->currentframe = -1;
 332                 }
 333
 334                 /* We must have previous frame decoded to continue. */
 335                 if (frame > img->currentframe + 1) {
 336                         if (!lbximg_getframe(img, frame-1))
 337                                 return NULL;
 338                 }
 339         }
 340
 341         if (img->currentframe != frame) {
 342                 int rc, first = 1;
 343
 344                 if (img->fops->seek(img->f, img->offsets[frame], SEEK_SET)) {
 345                         lbx_errno = -errno;
 346                         return NULL;
 347                 }
 348
 349                 do {
 350                         rc = _lbx_drawrow(first, img);
 351                         if (rc == -1)
 352                                 return NULL;
 353                         first = 0;
 354
 355                         if (img->fops->tell(img->f) > img->offsets[frame+1]) {
 356                                 lbx_errno = LBX_EFORMAT;
 357                                 return NULL;
 358                         }
 359                 } while (!rc);
 360         }
 361
 362         img->currentframe = frame;
 363         return img->framedata;
 364 }
 365
 366 int
 367 lbximg_loadpalette(void *f, const struct lbx_file_ops *fops,
 368                    struct lbx_colour palette[static 256])
 369 {
 370         unsigned char entry[4];
 371         int i;
 372
 373         for (i = 0; i < 256; i++) {
 374                 if (fops->read(entry, sizeof entry, f) != sizeof entry) {
 375                         lbx_errno = (feof(f)) ? LBX_EEOF : -errno;
 376                         return -1;
 377                 }
 378
 379                 if (entry[0] != 1) {
 380                         lbx_errno = LBX_EFORMAT;
 381                         return -1;
 382                 }
 383
 384                 palette[i] = (struct lbx_colour) {
 385                         .red    = entry[1] << 2,
 386                         .green  = entry[2] << 2,
 387                         .blue   = entry[3] << 2,
 388                         .active = 1,
 389                 };
 390         }
 391
 392         return 0;
 393 }
 394
 395 int
 396 lbximg_getpalette(struct lbx_image *img, struct lbx_colour palette[static 256])
 397 {
 398         unsigned char entry[4];
 399         unsigned int i;
 400         size_t rc;
 401
 402         /* Do nothing if the image doesn't have embedded palette data. */
 403         if (!(img->flags & FLAG_PALETTE))
 404                 return 0;
 405
 406         if (img->fops->seek(img->f, img->paloff, SEEK_SET)) {
 407                 lbx_errno = -errno;
 408                 return -1;
 409         }
 410
 411         for (i = 0; i < img->palcount; i++) {
 412                 rc = img->fops->read(entry, sizeof entry, img->f);
 413                 if (rc < sizeof entry) {
 414                         goto readerr;
 415                 }
 416
 417                 if (entry[0] != 0) {
 418                         lbx_errno = LBX_EFORMAT;
 419                         return -1;
 420                 }
 421
 422                 palette[img->palstart + i] = (struct lbx_colour){
 423                         .red    = entry[1] << 2,
 424                         .green  = entry[2] << 2,
 425                         .blue   = entry[3] << 2,
 426                         .active = 1,
 427                 };
 428         }
 429
 430         return 0;
 431 readerr:
 432         lbx_errno = img->fops->eof(img->f) ? LBX_EEOF : -errno;
 433         return -1;
 434 }
 435
 436 void lbximg_getinfo(struct lbx_image *img, struct lbx_imginfo *info)
 437 {
 438         *info = (struct lbx_imginfo) {
 439                 .width      = img->width,
 440                 .height     = img->height,
 441                 .nframes    = img->frames,
 442                 .chunk      = img->chunk,
 443                 .palettesz  = (img->flags & FLAG_PALETTE) ? img->palcount : 0,
 444         };
 445
 446         /* There seems to be two ways of specifying that an image loops. */
 447         if (img->flags & FLAG_LOOPING) {
 448                 info->loopstart = 0;
 449                 info->looping   = 1;
 450         } else if (img->leadin != img->frames - 1) {
 451                 info->loopstart = img->leadin;
 452                 info->looping   = 1;
 453         }
 454 }
 455
 456 unsigned char **lbximg_getmask(struct lbx_image *img)
 457 {
 458         return img->mask;
 459 }
 460
 461 int lbximg_close(struct lbx_image *img)
 462 {
 463         int rc = 0;
 464
 465         if (img) {
 466                 if (img->framedata) {
 467                         free(img->framedata[0]);
 468                         free(img->framedata);
 469                 }
 470
 471                 if (img->mask) {
 472                         free(img->mask[0]);
 473                         free(img->mask);
 474                 }
 475
 476                 if (img && img->dtor) {
 477                         rc = img->dtor(img->f);
 478                 }
 479
 480                 free(img);
 481         }
 482
 483         return rc;
 484 }