src/lbximg.c

   1 /*
   2  *  2ooM: The Master of Orion II Reverse Engineering Project
   3  *  Simple command-line tool to convert an LBX image to a set of PNGs.
   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 #include <config.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <limits.h>
  24 #include <assert.h>
  25 #include <getopt.h>
  26 #include <errno.h>
  27
  28 #include <png.h>
  29
  30 #include "tools.h"
  31 #include "image.h"
  32 #include "lbx.h"
  33
  34 /* Global flags */
  35 static int verbose = 0;
  36 static char *outname = "out";
  37 static int usepalette = 1;
  38
  39 static void printusage(void)
  40 {
  41         puts("usage: lbximg [-i|-d] [-v] [-p palette_file] [-O override_file]"
  42                           " [-f path]");
  43         puts("              [frameno ...]");
  44 }
  45
  46 static void printhelp(void)
  47 {
  48         printusage();
  49         puts("For now, see the man page for detailed help.");
  50 }
  51
  52 static const char *progname;
  53 #define errmsg(fmt, ...) (\
  54         fprintf(stderr, "%s: " fmt, progname, __VA_ARGS__)\
  55 )
  56
  57 enum {
  58         MODE_NONE,
  59         MODE_DECODE,
  60         MODE_IDENT,
  61 };
  62
  63 int parserange(struct lbx_imginfo *info, char *str, unsigned char *bits)
  64 {
  65         unsigned long start, end;
  66         unsigned int i;
  67         char *endptr;
  68
  69         start = strtoul(str, &endptr, 0);
  70         if (start >= info->nframes) {
  71                 errmsg("frame %lu out of range.\n", start);
  72                 return -1;
  73         }
  74
  75         if (endptr == str) {
  76                 errmsg("invalid frame range: %s.\n", str);
  77                 return -1;
  78         }
  79
  80         switch (*endptr) {
  81         case '\0':
  82                 end = start;
  83                 break;
  84         case '-':
  85                 end = strtoul(endptr+1, &endptr, 0);
  86                 if (end >= info->nframes) {
  87                         errmsg("frame %lu out of range.\n", end);
  88                         return -1;
  89                 }
  90
  91                 if (endptr == str)
  92                         end = info->nframes - 1;
  93                 break;
  94         default:
  95                 errmsg("invalid frame range: %s.\n", str);
  96                 return -1;
  97         }
  98
  99         if (end < start) {
 100                 errmsg("invalid frame range: %s.\n", str);
 101                 return -1;
 102         }
 103
 104         for (i = start; i <= end; i++) {
 105                 bits[i / CHAR_BIT] |= 1 << (i % CHAR_BIT);
 106         }
 107
 108         return 0;
 109 }
 110
 111 static int ismasked(unsigned char **mask, unsigned width, unsigned height)
 112 {
 113         unsigned y, x;
 114         for (y = 0; y < height; y++) {
 115                 for (x = 0; x < width; x++) {
 116                         if (mask[y][x] == 0) return 1;
 117                 }
 118         }
 119
 120         return 0;
 121 }
 122
 123 int outpng(unsigned int frameno,
 124            unsigned char **framedata, unsigned char **mask,
 125            unsigned int width, unsigned int height,
 126            struct lbx_colour palette[static 256])
 127 {
 128         char name[strlen(outname) + sizeof ".65535.png"];
 129         unsigned char *row;
 130         unsigned int x, y;
 131         FILE *of;
 132
 133         png_structp png;
 134         png_infop   info;
 135
 136         assert(frameno < 65536);
 137         snprintf(name, sizeof name, "%s.%03d.png", outname, frameno);
 138
 139         row = malloc(4 * width);
 140         if (!row) {
 141                 errmsg("failed to allocate row buffer: %s\n", strerror(errno));
 142                 return -1;
 143         }
 144
 145         of = fopen(name, "wb");
 146         if (!of) {
 147                 errmsg("failed to open %s: %s.\n", name, strerror(errno));
 148                 free(row);
 149                 return -1;
 150         }
 151
 152         png = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
 153         if (!png) {
 154                 errmsg("failed to init libpng.\n", 0);
 155                 goto err;
 156         }
 157
 158         info = png_create_info_struct(png);
 159         if (!info) {
 160                 errmsg("failed to init libpng.\n", 0);
 161                 png_destroy_write_struct(&png, NULL);
 162                 goto err;
 163         }
 164
 165         if (setjmp(png_jmpbuf(png))) {
 166                 png_destroy_write_struct(&png, &info);
 167                 goto err;
 168         }
 169
 170         png_init_io(png, of);
 171
 172         if (!ismasked(mask, width, height)) {
 173                 /*
 174                  * This case is easy; we can just feed the palette and pixel
 175                  * data to libpng and let it do its magic.
 176                  */
 177
 178                 png_color png_palette[256];
 179                 for (unsigned i = 0; i < 256; i++) {
 180                         png_palette[i].red   = palette[i].red;
 181                         png_palette[i].green = palette[i].green;
 182                         png_palette[i].blue  = palette[i].blue;
 183                 }
 184
 185                 png_set_IHDR(png, info, width, height, 8,
 186                              PNG_COLOR_TYPE_PALETTE, PNG_INTERLACE_NONE,
 187                              PNG_COMPRESSION_TYPE_DEFAULT,
 188                              PNG_FILTER_TYPE_DEFAULT);
 189
 190                 png_set_PLTE(png, info, png_palette, 256);
 191                 png_set_rows(png, info, framedata);
 192                 png_write_png(png, info, PNG_TRANSFORM_IDENTITY, NULL);
 193         } else {
 194                 /*
 195                  * Unfortunately, LBX doesn't translate nicely to PNG here.
 196                  * LBX has a 256 colour palette _plus_ transparency.
 197                  * We'll form an RGBA PNG to deal with this.
 198                  */
 199
 200                 png_set_IHDR(png, info, width, height, 8,
 201                              PNG_COLOR_TYPE_RGB_ALPHA, PNG_INTERLACE_NONE,
 202                              PNG_COMPRESSION_TYPE_DEFAULT,
 203                              PNG_FILTER_TYPE_DEFAULT);
 204
 205                 png_write_info(png, info);
 206
 207                 for (y = 0; y < height; y++) {
 208                         for (x = 0; x < width; x++) {
 209                                 row[4*x+0] = palette[framedata[y][x]].red;
 210                                 row[4*x+1] = palette[framedata[y][x]].green;
 211                                 row[4*x+2] = palette[framedata[y][x]].blue;
 212                                 row[4*x+3] = (mask[y][x]) ? -1 : 0;
 213                         }
 214
 215                         png_write_row(png, row);
 216                 }
 217
 218                 png_write_end(png, NULL);
 219         }
 220
 221         png_destroy_write_struct(&png, &info);
 222         fclose(of);
 223         free(row);
 224
 225         if (verbose)
 226                 printf("wrote %s\n", name);
 227         return 0;
 228 err:
 229         fclose(of);
 230         remove(name);
 231         free(row);
 232         return -1;
 233 }
 234
 235 static int loadoverride(FILE *f, struct lbx_colour palette[static 256])
 236 {
 237         LBX_IMG *overimg = lbximg_fopen(f);
 238         struct lbx_imginfo info;
 239
 240         if (!overimg) {
 241                 errmsg("failed to open override image: %s\n", lbx_strerror());
 242                 return -1;
 243         }
 244         lbximg_getinfo(overimg, &info);
 245
 246         if (!info.palettesz) {
 247                 errmsg("override image has no palette.\n", 0);
 248                 lbximg_close(overimg);
 249                 return -1;
 250         }
 251
 252         if (lbximg_getpalette(overimg, palette) == -1) {
 253                 errmsg("error reading override palette: %s\n", lbx_strerror());
 254                 lbximg_close(overimg);
 255                 return -1;
 256         }
 257
 258         lbximg_close(overimg);
 259         return 0;
 260 }
 261
 262 static int loadpalette(LBX_IMG *img, struct lbx_imginfo *info,
 263                        FILE *palf, FILE *override,
 264                        struct lbx_colour palette[static 256])
 265 {
 266         int i;
 267
 268         /* In no-palette mode, use palette indices for colour. */
 269         if (!usepalette) {
 270                 for (i = 0; i < 256; i++) {
 271                         palette[i] = (struct lbx_colour){i,i,i};
 272                 }
 273
 274                 return 0;
 275         }
 276
 277         /* For sanity. */
 278         if (!palf && !info->palettesz && !override) {
 279                 errmsg("no palette available.\n", 0);
 280                 return -1;
 281         }
 282
 283         /* Default the palette to a wonderful pink. */
 284         for (i = 0; i < 256; i++) {
 285                 palette[i] = (struct lbx_colour){0xff, 0x00, 0xff};
 286         }
 287
 288         /* Read the external palette, if any. */
 289         if (palf && lbximg_loadpalette(palf, &lbx_default_fops, palette) != 0) {
 290                 errmsg("error reading external palette: %s\n", lbx_strerror());
 291                 return -1;
 292         }
 293
 294         /* Read the embedded palette, if any. */
 295         if (info->palettesz && lbximg_getpalette(img, palette) == -1) {
 296                 errmsg("error reading embedded palette: %s\n", lbx_strerror());
 297                 return -1;
 298         }
 299
 300         /* Read the override palette, if any. */
 301         if (override && loadoverride(override, palette) == -1) {
 302                 return -1;
 303         }
 304
 305         return 0;
 306 }
 307
 308 int decode(LBX_IMG *img, FILE *palf, FILE *override, char **argv)
 309 {
 310         unsigned char *framebits;
 311         struct lbx_colour palette[256];
 312         struct lbx_imginfo info;
 313         int extracted = 0;
 314         unsigned int i;
 315
 316         lbximg_getinfo(img, &info);
 317
 318         framebits = calloc(1, info.nframes / CHAR_BIT + 1);
 319         if (!framebits) {
 320                 return EXIT_FAILURE;
 321         }
 322
 323         /* Figure out what images we're extracting. */
 324         if (!argv[0]) {
 325                 /* extract all images by default. */
 326                 memset(framebits, -1, info.nframes / CHAR_BIT + 1);
 327         } else {
 328                 for (i = 0; argv[i]; i++) {
 329                         parserange(&info, argv[i], framebits);
 330                 }
 331         }
 332
 333         if (loadpalette(img, &info, palf, override, palette) == -1) {
 334                 goto err;
 335         }
 336
 337         /* Extract the images, in order. */
 338         for (i = 0; i < info.nframes; i++) {
 339                 unsigned char **data;
 340                 unsigned char **mask;
 341
 342                 if (!(framebits[i / CHAR_BIT] & (1 << (i % CHAR_BIT))))
 343                         continue;
 344
 345                 data = lbximg_getframe(img, i);
 346                 if (!data) {
 347                         errmsg("error in frame %u: %s\n", i, lbx_strerror());
 348                         continue;
 349                 }
 350
 351                 mask = lbximg_getmask(img);
 352
 353                 if (!outpng(i, data, mask, info.width, info.height, palette)) {
 354                         extracted = 1;
 355                 }
 356         }
 357
 358         if (!extracted) {
 359                 errmsg("no frames extracted.\n", 0);
 360                 goto err;
 361         }
 362
 363         free(framebits);
 364         return EXIT_SUCCESS;
 365 err:
 366         free(framebits);
 367         return EXIT_FAILURE;
 368 }
 369
 370 int main(int argc, char **argv)
 371 {
 372         int mode = MODE_NONE, opt, rc = EXIT_FAILURE;
 373         struct lbx_pipe_state state = { .f = stdin };
 374         FILE *palf = NULL, *overf = NULL;
 375         const char *name = "stdin";
 376         LBX_IMG *img;
 377
 378         static const char *sopts = "idvf:p:O:V";
 379         static const struct option lopts[] = {
 380                 { "ident",    0, NULL, 'i' },
 381                 { "decode",   0, NULL, 'd' },
 382                 { "verbose",  0, NULL, 'v' },
 383                 { "file",     1, NULL, 'f' },
 384                 { "palette",  1, NULL, 'p' },
 385                 { "override", 1, NULL, 'p' },
 386
 387                 { "version",  0, NULL, 'V' },
 388                 { "usage",    0, NULL, 'U' },
 389                 { "help",     0, NULL, 'H' },
 390
 391                 { "nopalette", 0, &usepalette, 0 },
 392
 393                 { 0 }
 394         };
 395
 396         progname = "lbximg"; /* argv[0]; */
 397         while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
 398                 switch(opt) {
 399                 case 'i':
 400                         mode = MODE_IDENT;
 401                         break;
 402                 case 'd':
 403                         mode = MODE_DECODE;
 404                         break;
 405                 case 'v':
 406                         verbose = 1;
 407                         break;
 408                 case 'f':
 409                         name = strrchr(optarg, '/');
 410                         name = name ? name+1 : optarg;
 411
 412                         if (!freopen(optarg, "rb", state.f)) {
 413                                 errmsg("failed to open %s: %m\n", optarg);
 414                                 return EXIT_FAILURE;
 415                         }
 416                         break;
 417                 case 'p':
 418                         palf = fopen(optarg, "rb");
 419                         if (!palf) {
 420                                 errmsg("failed to open %s: %m\n", optarg);
 421                                 return EXIT_FAILURE;
 422                         }
 423
 424                         break;
 425                 case 'O':
 426                         overf = fopen(optarg, "rb");
 427                         if (!overf) {
 428                                 errmsg("failed to open %s: %m\n", optarg);
 429                                 return EXIT_FAILURE;
 430                         }
 431                         break;
 432                 case 'V':
 433                         puts(VERSION_BOILERPLATE("lbximg"));
 434                         return EXIT_SUCCESS;
 435                 case 'U':
 436                         printusage();
 437                         return EXIT_SUCCESS;
 438                 case 'H':
 439                         printhelp();
 440                         return EXIT_SUCCESS;
 441                 case '?':
 442                 case ':':
 443                         return EXIT_FAILURE;
 444                 }
 445         }
 446
 447         if (mode == MODE_NONE) {
 448                 errmsg("you must specify a mode.\n", 0);
 449                 return EXIT_FAILURE;
 450         }
 451
 452         if (fseek(state.f, 0, SEEK_CUR) == 0)
 453                 img = lbximg_open(state.f, &lbx_default_fops, NULL);
 454         else
 455                 img = lbximg_open(&state, &lbx_pipe_fops, NULL);
 456
 457         if (!img) {
 458                 errmsg("failed to open image: %s.\n", lbx_strerror());
 459                 return EXIT_FAILURE;
 460         }
 461
 462         if (verbose || mode == MODE_IDENT) {
 463                 struct lbx_imginfo info;
 464                 lbximg_getinfo(img, &info);
 465
 466                 printf("%s is %ux%u LBX image, %u frame(s)%s%s\n",
 467                        name, info.width, info.height, info.nframes,
 468                        info.palettesz ? ", embedded palette" : "",
 469                        info.chunk     ? ", chunked" : "",
 470                        info.looping   ? ", loops" : "");
 471         }
 472
 473         switch (mode) {
 474         case MODE_DECODE:
 475                 rc = decode(img, palf, overf, &argv[optind]);
 476                 break;
 477         }
 478
 479         lbximg_close(img);
 480         return rc;
 481 }