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