ref: 493b94919f06da05ce20b8ecae74e867a61f646e
dir: /src/gfx/main.cpp/
/* * This file is part of RGBDS. * * Copyright (c) 2022, Eldred Habert and RGBDS contributors. * * SPDX-License-Identifier: MIT */ #include "gfx/main.hpp" #include <algorithm> #include <assert.h> #include <cinttypes> #include <ctype.h> #include <limits> #include <numeric> #include <stdarg.h> #include <stdint.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include "extern/getopt.h" #include "platform.h" #include "version.h" #include "gfx/convert.hpp" using namespace std::literals::string_view_literals; Options options; static uintmax_t nbErrors; void warning(char const *fmt, ...) { va_list ap; fputs("warning: ", stderr); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); putc('\n', stderr); } void error(char const *fmt, ...) { va_list ap; fputs("error: ", stderr); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); putc('\n', stderr); if (nbErrors != std::numeric_limits<decltype(nbErrors)>::max()) nbErrors++; } [[noreturn]] void fatal(char const *fmt, ...) { va_list ap; fputs("FATAL: ", stderr); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); putc('\n', stderr); if (nbErrors != std::numeric_limits<decltype(nbErrors)>::max()) nbErrors++; fprintf(stderr, "Conversion aborted after %ju error%s\n", nbErrors, nbErrors == 1 ? "" : "s"); exit(1); } void Options::verbosePrint(uint8_t level, char const *fmt, ...) const { if (verbosity >= level) { va_list ap; va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); } } // Short options static char const *optstring = "Aa:b:Cc:Dd:FfhL:mN:n:o:Pp:s:Tt:U:uVvx:Z"; /* * Equivalent long options * Please keep in the same order as short opts * * Also, make sure long opts don't create ambiguity: * A long opt's name should start with the same letter as its short opt, * except if it doesn't create any ambiguity (`verbose` versus `version`). * This is because long opt matching, even to a single char, is prioritized * over short opt matching */ static struct option const longopts[] = { {"output-attr-map", no_argument, NULL, 'A'}, {"attr-map", required_argument, NULL, 'a'}, {"base-tiles", required_argument, NULL, 'b'}, {"color-curve", no_argument, NULL, 'C'}, {"colors", required_argument, NULL, 'c'}, {"debug", no_argument, NULL, 'D'}, // Ignored {"depth", required_argument, NULL, 'd'}, {"fix", no_argument, NULL, 'f'}, {"fix-and-save", no_argument, NULL, 'F'}, // Deprecated {"horizontal", no_argument, NULL, 'h'}, // Deprecated {"slice", required_argument, NULL, 'L'}, {"mirror-tiles", no_argument, NULL, 'm'}, {"nb-tiles", required_argument, NULL, 'N'}, {"nb-palettes", required_argument, NULL, 'n'}, {"output", required_argument, NULL, 'o'}, {"output-palette", no_argument, NULL, 'P'}, {"palette", required_argument, NULL, 'p'}, {"output-tilemap", no_argument, NULL, 'T'}, {"tilemap", required_argument, NULL, 't'}, {"unit-size", required_argument, NULL, 'U'}, {"unique-tiles", no_argument, NULL, 'u'}, {"version", no_argument, NULL, 'V'}, {"verbose", no_argument, NULL, 'v'}, {"trim-end", required_argument, NULL, 'x'}, {"columns", no_argument, NULL, 'Z'}, {NULL, no_argument, NULL, 0 } }; static void printUsage(void) { fputs("Usage: rgbgfx [-CfmuVZ] [-v [-v ...]] [-a <attr_map> | -A] [-b base_ids]\n" " [-c color_spec] [-d <depth>] [-L slice] [-N nb_tiles] [-n nb_pals]\n" " [-o <out_file>] [-p <pal_file> | -P] [-s nb_colors] [-t <tile_map> | -T]\n" " [-U unit_size] [-x <tiles>] <file>\n" "Useful options:\n" " -m, --mirror-tiles optimize out mirrored tiles\n" " -o, --output <path> set the output binary file\n" " -t, --tilemap <path> set the output tilemap file\n" " -u, --unique-tiles optimize out identical tiles\n" " -V, --version print RGBGFX version and exit\n" "\n" "For help, use `man rgbgfx' or go to https://rgbds.gbdev.io/docs/\n", stderr); exit(1); } /** * Parses a number at the beginning of a string, moving the pointer to skip the parsed characters * Returns the provided errVal on error */ static uint16_t parseNumber(char *&string, char const *errPrefix, uint16_t errVal = -1) { uint8_t base = 10; if (*string == '\0') { error("%s: expected number, but found nothing", errPrefix); return errVal; } else if (*string == '$') { base = 16; ++string; } else if (*string == '%') { base = 2; ++string; } else if (*string == '0' && string[1] != '\0') { // Check if we have a "0x" or "0b" here if (string[1] == 'x' || string[1] == 'X') { base = 16; string += 2; } else if (string[1] == 'b' || string[1] == 'B') { base = 2; string += 2; } } /** * Turns a digit into its numeric value in the current base, if it has one. * Maximum is inclusive. The string_view is modified to "consume" all digits. * Returns -1 (255) on parse failure (including wrong char for base), in which case * the string_view may be pointing on garbage. */ auto charIndex = [&base](unsigned char c) -> uint8_t { unsigned char index = c - '0'; // Use wrapping semantics if (base == 2 && index >= 2) { return -1; } else if (index < 10) { return index; } else if (base != 16) { return -1; // Letters are only valid in hex } index = tolower(c) - 'a'; // OK because we pass an `unsigned char` if (index < 6) { return index + 10; } return -1; }; if (charIndex(*string) == (uint8_t)-1) { error("%s: expected digit%s, but found nothing", errPrefix, base != 10 ? " after base" : ""); return errVal; } uint16_t number = 0; do { // Read a character, and check if it's valid in the given base number *= base; uint8_t index = charIndex(*string); if (index == (uint8_t)-1) { break; // Found an invalid character, end } ++string; number += index; // The lax check covers the addition on top of the multiplication if (number >= UINT16_MAX / base) { error("%s: the number is too large!", errPrefix); return errVal; } } while (*string != '\0'); // No more characters? return number; } static void skipWhitespace(char *&arg) { arg += strcspn(arg, " \t"); } static void parsePaletteSpec(char const *arg) { if (arg[0] == '#') { // List of #rrggbb/#rgb colors, comma-separated, palettes are separated by colons options.palSpecType = Options::EXPLICIT; // TODO } else if (strcasecmp(arg, "embedded") == 0) { // Use PLTE, error out if missing options.palSpecType = Options::EMBEDDED; } else { // `fmt:path`, parse the file according to the given format // TODO: split both parts, error out if malformed or file not found options.palSpecType = Options::EXPLICIT; // TODO } } int main(int argc, char *argv[]) { int opt; bool autoAttrmap = false, autoTilemap = false, autoPalettes = false; while ((opt = musl_getopt_long_only(argc, argv, optstring, longopts, nullptr)) != -1) { char *arg = musl_optarg; // Make a copy for scanning switch (opt) { case 'A': autoAttrmap = true; break; case 'a': autoAttrmap = false; options.attrmap = musl_optarg; break; case 'b': options.baseTileIDs[0] = parseNumber(arg, "Bank 0 base tile ID", 0); if (options.baseTileIDs[0] >= 256) { error("Bank 0 base tile ID must be below 256"); } if (*arg == '\0') { options.baseTileIDs[1] = 0; break; } skipWhitespace(arg); if (*arg != ',') { error("Base tile IDs must be one or two comma-separated numbers, not \"%s\"", musl_optarg); break; } skipWhitespace(arg); options.baseTileIDs[1] = parseNumber(arg, "Bank 1 base tile ID", 0); if (options.baseTileIDs[1] >= 256) { error("Bank 1 base tile ID must be below 256"); } if (*arg != '\0') { error("Base tile IDs must be one or two comma-separated numbers, not \"%s\"", musl_optarg); break; } break; case 'C': options.useColorCurve = true; break; case 'c': parsePaletteSpec(musl_optarg); break; case 'D': warning("Ignoring retired option `-D`"); break; case 'd': options.bitDepth = parseNumber(arg, "Bit depth", 2); if (*arg != '\0') { error("Bit depth (-b) argument must be a valid number, not \"%s\"", musl_optarg); } else if (options.bitDepth != -1 && options.bitDepth != 1 && options.bitDepth != 2) { error("Bit depth must be 1 or 2, not %" PRIu8); options.bitDepth = 2; } break; case 'F': warning("`-F` is now deprecated, and behaves like `-f`"); [[fallthrough]]; case 'f': options.fixInput = true; break; case 'L': options.inputSlice = {0, 0, 0, 0}; // TODO break; case 'm': options.allowMirroring = true; [[fallthrough]]; // Imply `-u` case 'u': options.allowDedup = true; break; case 'N': options.maxNbTiles[0] = parseNumber(arg, "Number of tiles in bank 0", 256); if (options.maxNbTiles[0] > 256) { error("Bank 0 cannot contain more than 256 tiles"); } if (*arg == '\0') { options.maxNbTiles[1] = 0; break; } skipWhitespace(arg); if (*arg != ',') { error("Bank capacity must be one or two comma-separated numbers, not \"%s\"", musl_optarg); break; } skipWhitespace(arg); options.maxNbTiles[1] = parseNumber(arg, "Number of tiles in bank 1", 256); if (options.maxNbTiles[1] > 256) { error("Bank 1 cannot contain more than 256 tiles"); } if (*arg != '\0') { error("Bank capacity must be one or two comma-separated numbers, not \"%s\"", musl_optarg); break; } break; case 'n': options.nbPalettes = parseNumber(arg, "Number of palettes", 8); break; case 'o': options.output = musl_optarg; break; case 'P': autoPalettes = true; break; case 'p': autoPalettes = false; options.palettes = musl_optarg; break; case 's': options.nbColorsPerPal = parseNumber(arg, "Number of colors per palette", 4); if (*arg != '\0') { error("Palette size (-s) argument must be a valid number, not \"%s\"", musl_optarg); } break; case 'T': autoTilemap = true; break; case 't': autoTilemap = false; options.tilemap = musl_optarg; break; case 'V': printf("rgbgfx %s\n", get_package_version_string()); exit(0); case 'v': if (options.verbosity < Options::VERB_VVVVVV) { ++options.verbosity; } break; case 'x': options.trim = parseNumber(arg, "Number of tiles to trim", 0); if (*arg != '\0') { error("Tile trim (-x) argument must be a valid number, not \"%s\"", musl_optarg); } break; case 'h': warning("`-h` is deprecated, use `-Z` instead"); [[fallthrough]]; case 'Z': options.columnMajor = true; break; default: printUsage(); exit(1); } } if (options.nbColorsPerPal == 0) { options.nbColorsPerPal = 1u << options.bitDepth; } else if (options.nbColorsPerPal > 1u << options.bitDepth) { error("%" PRIu8 "bpp palettes can only contain %u colors, not %" PRIu8, options.bitDepth, 1u << options.bitDepth, options.nbColorsPerPal); } if (musl_optind == argc) { fputs("FATAL: No input image specified\n", stderr); printUsage(); exit(1); } else if (argc - musl_optind != 1) { fprintf(stderr, "FATAL: %d input images were specified instead of 1\n", argc - musl_optind); printUsage(); exit(1); } options.input = argv[argc - 1]; auto autoOutPath = [](bool autoOptEnabled, std::string &path, char const *extension) { if (autoOptEnabled) { constexpr std::string_view chars = // Both must start with a dot! #if defined(_MSC_VER) || defined(__MINGW32__) "./\\"sv; #else "./"sv; #endif size_t len = options.input.npos; size_t i = options.input.find_last_of(chars); if (i != options.input.npos && options.input[i] == '.') { // We found the last dot, but check if it's part of a stem // (There must be a non-path separator character before it) if (i != 0 && chars.find(options.input[i - 1], 1) == chars.npos) { // We can replace the extension len = i; } } path.assign(options.input, 0, len); path.append(extension); } }; autoOutPath(autoAttrmap, options.attrmap, ".attrmap"); autoOutPath(autoTilemap, options.tilemap, ".tilemap"); autoOutPath(autoPalettes, options.palettes, ".pal"); if (options.verbosity >= Options::VERB_CFG) { fprintf(stderr, "rgbgfx %s\n", get_package_version_string()); if (options.verbosity >= Options::VERB_VVVVVV) { fputc('\n', stderr); static std::array<uint16_t, 21> gfx{ 0x1FE, 0x3FF, 0x399, 0x399, 0x3FF, 0x3FF, 0x381, 0x3C3, 0x1FE, 0x078, 0x1FE, 0x3FF, 0x3FF, 0x3FF, 0x37B, 0x37B, 0x0FC, 0x0CC, 0x1CE, 0x1CE, 0x1CE, }; static std::array<char const *, 3> textbox{ " ,----------------------------------------.", " | Augh, dimensional interference again?! |", " `----------------------------------------'"}; for (size_t i = 0; i < gfx.size(); ++i) { uint16_t row = gfx[i]; for (uint8_t _ = 0; _ < 10; ++_) { unsigned char c = row & 1 ? '0' : ' '; fputc(c, stderr); // Double the pixel horizontally, otherwise the aspect ratio looks wrong fputc(c, stderr); row >>= 1; } if (i < textbox.size()) { fputs(textbox[i], stderr); } fputc('\n', stderr); } fputc('\n', stderr); } fputs("Options:\n", stderr); if (options.fixInput) fputs("\tConvert input to indexed\n", stderr); if (options.columnMajor) fputs("\tVisit image in column-major order\n", stderr); if (options.allowMirroring) fputs("\tAllow mirroring tiles\n", stderr); if (options.allowDedup) fputs("\tAllow deduplicating tiles\n", stderr); if (options.useColorCurve) fputs("\tUse color curve\n", stderr); fprintf(stderr, "\tBit depth: %" PRIu8 "bpp\n", options.bitDepth); if (options.trim != 0) fprintf(stderr, "\tTrim the last %" PRIu64 " tiles\n", options.trim); fprintf(stderr, "\tMaximum %" PRIu8 " palettes\n", options.nbPalettes); fprintf(stderr, "\tPalettes contain %" PRIu8 " colors\n", options.nbColorsPerPal); fprintf(stderr, "\t%s palette spec\n", []() { switch (options.palSpecType) { case Options::NO_SPEC: return "No"; case Options::EXPLICIT: return "Explicit"; case Options::EMBEDDED: return "Embedded"; } return "???"; }()); fprintf(stderr, "\tDedup unit: %" PRIu16 "x%" PRIu16 " tiles\n", options.unitSize[0], options.unitSize[1]); fprintf(stderr, "\tInput image slice: %" PRIu32 "x%" PRIu32 " pixels from (%" PRIu32 ", %" PRIu32 ")\n", options.inputSlice[2], options.inputSlice[3], options.inputSlice[0], options.inputSlice[1]); fprintf(stderr, "\tBase tile IDs: [%" PRIu8 ", %" PRIu8 "]\n", options.baseTileIDs[0], options.baseTileIDs[1]); fprintf(stderr, "\tMaximum %" PRIu16 " tiles in bank 0, %" PRIu16 " in bank 1\n", options.maxNbTiles[0], options.maxNbTiles[1]); auto printPath = [](char const *name, std::string const &path) { if (!path.empty()) { fprintf(stderr, "\t%s: %s\n", name, path.c_str()); } }; printPath("Input image", options.input); printPath("Output tile data", options.output); printPath("Output tilemap", options.tilemap); printPath("Output attrmap", options.attrmap); printPath("Output palettes", options.palettes); fputs("Ready.\n", stderr); } process(); return 0; } void Palette::addColor(uint16_t color) { for (size_t i = 0; true; ++i) { assert(i < colors.size()); // The packing should guarantee this if (colors[i] == color) { // The color is already present break; } else if (colors[i] == UINT16_MAX) { // Empty slot colors[i] = color; break; } } } uint8_t Palette::indexOf(uint16_t color) const { return std::find(colors.begin(), colors.end(), color) - colors.begin(); } auto Palette::begin() -> decltype(colors)::iterator { return colors.begin(); } auto Palette::end() -> decltype(colors)::iterator { return std::find(colors.begin(), colors.end(), UINT16_MAX); } auto Palette::begin() const -> decltype(colors)::const_iterator { return colors.begin(); } auto Palette::end() const -> decltype(colors)::const_iterator { return std::find(colors.begin(), colors.end(), UINT16_MAX); } uint8_t Palette::size() const { return indexOf(UINT16_MAX); }