nitro-patcher 0.2.0 → 0.2.1

package/src/nitro/header.ts

@@ -1,7 +1,7 @@
 // Port of NitroHelper/Header.cs. Copyright Xzonn and upstream contributors, GPL-3.0.
-import { bytes, range } from './binary';
-import { crc16 } from './crc';
-import { encryptSecureArea } from './crypto';
+import { bytes, range } from "./binary";
+import { crc16 } from "./crc";
+import { encryptSecureArea } from "./crypto";
 
 export const UnitCode = Object.freeze({ NDS: 0, NDS_DSi: 2, DSi: 3 });
 
@@ -106,43 +106,30 @@ export class Header {
   declare secureDisable: bigint;
 
   constructor(input: Uint8Array) {
-    const data = bytes(input, 'header');
-    range(data, 0, 0x170, 'header');
+    const data = bytes(input, "header");
+    range(data, 0, 0x170, "header");
     const size = data.readUInt32LE(0x84);
     if (size < 0x170 || size > data.length) throw new RangeError(`Invalid header size: ${size}`);
     this.raw = Buffer.from(data.subarray(0, size));
-    if (this.unitCode & 2 && size > 0x200) range(this.raw, 0, 0x1000, 'DSi header');
-    this.trimmedRom = this.total_rom_size
-      ? this.total_rom_size >= data.length
-      : data.length !== this.size;
+    if (this.unitCode & 2 && size > 0x200) range(this.raw, 0, 0x1000, "DSi header");
+    this.trimmedRom = this.total_rom_size ? this.total_rom_size >= data.length : data.length !== this.size;
     this.doublePadding =
-      (this.ARM9size % 0x400 < 0x200 &&
-        this.ARM7romOffset % 0x400 === 0 &&
-        this.ARM9overlayOffset % 0x400 === 0) ||
-      (this.ARM7size % 0x400 < 0x200 &&
-        this.FNToffset % 0x400 === 0 &&
-        this.ARM7overlayOffset % 0x400 === 0) ||
+      (this.ARM9size % 0x400 < 0x200 && this.ARM7romOffset % 0x400 === 0 && this.ARM9overlayOffset % 0x400 === 0) ||
+      (this.ARM7size % 0x400 < 0x200 && this.FNToffset % 0x400 === 0 && this.ARM7overlayOffset % 0x400 === 0) ||
       (this.FNTsize % 0x400 < 0x200 && this.FAToffset % 0x400 === 0) ||
       (this.FATsize % 0x400 < 0x200 && this.bannerOffset % 0x400 === 0);
     const nitroOffset = this.ARM9romOffset + this.ARM9size;
     this.nitrocode =
-      nitroOffset >= size &&
-      nitroOffset + 4 <= data.length &&
-      data.readUInt32LE(nitroOffset) === 0xdec00621;
+      nitroOffset >= size && nitroOffset + 4 <= data.length && data.readUInt32LE(nitroOffset) === 0xdec00621;
     this.decrypted = data.length >= 0x4008 && data.readBigUInt64LE(0x4000) === 0xe7ffdeffe7ffdeffn;
     this.headerCRC = crc16(this.raw.subarray(0, 0x15e)) === this.headerCRC16;
     this.logoCRC = crc16(this.logo) === this.logoCRC16;
     const secure = data.subarray(0x4000, 0x8000);
     this.secureCRC =
       secure.length > 0 &&
-      crc16(this.decrypted ? encryptSecureArea(this.gameCode, secure) : secure) ===
-        this.secureCRC16;
+      crc16(this.decrypted ? encryptSecureArea(this.gameCode, secure) : secure) === this.secureCRC16;
     this.dlp_signature = Buffer.alloc(0);
-    if (
-      this.ROMsize >= size &&
-      this.ROMsize + 0x88 <= data.length &&
-      data.readUInt32LE(this.ROMsize) === 0x00016361
-    ) {
+    if (this.ROMsize >= size && this.ROMsize + 0x88 <= data.length && data.readUInt32LE(this.ROMsize) === 0x00016361) {
       this.dlp_signature = Buffer.from(data.subarray(this.ROMsize, this.ROMsize + 0x88));
     }
   }
@@ -153,7 +140,7 @@ export class Header {
   set size(value: number) {
     const power = Math.log2(value);
     if (!Number.isInteger(power) || power < 17 || power > 32)
-      throw new RangeError('ROM capacity must be a power of two from 128 KiB to 4 GiB');
+      throw new RangeError("ROM capacity must be a power of two from 128 KiB to 4 GiB");
     this.raw[0x14] = power - 17;
   }
   toBuffer() {
@@ -163,7 +150,7 @@ export class Header {
     return data;
   }
   toString() {
-    return `NDS header: ${this.gameTitle.replace(/\0+$/, '')} (${this.gameCode})`;
+    return `NDS header: ${this.gameTitle.replace(/\0+$/, "")} (${this.gameCode})`;
   }
 }
 
@@ -171,44 +158,44 @@ function field(
   name: string,
   offset: number,
   length: number,
-  type: 'buffer' | 'string' | 'number' = 'buffer',
+  type: "buffer" | "string" | "number" = "buffer",
   dsi = false,
 ) {
   Object.defineProperty(Header.prototype, name, {
     enumerable: true,
     get(this: Header) {
       if (dsi && (!(this.unitCode & 2) || this.raw.length <= 0x200))
-        return type === 'buffer' ? Buffer.alloc(length) : 0;
+        return type === "buffer" ? Buffer.alloc(length) : 0;
       const data = range(this.raw, offset, length, `header ${name}`);
-      if (type === 'string') return data.toString('latin1');
-      if (type === 'buffer') return data;
+      if (type === "string") return data.toString("latin1");
+      if (type === "buffer") return data;
       return length === 8 ? data.readBigUInt64LE() : data.readUIntLE(0, length);
     },
     set(this: Header, value: string | number | bigint | Uint8Array) {
       const target = range(this.raw, offset, length, `header ${name}`);
-      if (type === 'string') {
-        if (typeof value !== 'string' || Buffer.byteLength(value, 'latin1') > length)
+      if (type === "string") {
+        if (typeof value !== "string" || Buffer.byteLength(value, "latin1") > length)
           throw new TypeError(`Invalid ${name}`);
         target.fill(0);
-        target.write(value, 'latin1');
-      } else if (type === 'buffer') {
+        target.write(value, "latin1");
+      } else if (type === "buffer") {
         if (!(value instanceof Uint8Array)) throw new TypeError(`Invalid ${name}`);
         const source = bytes(value, name);
         if (source.length !== length) throw new RangeError(`${name} must contain ${length} bytes`);
         source.copy(target);
       } else if (length === 8) {
-        if (typeof value !== 'bigint') throw new TypeError(`Invalid ${name}`);
+        if (typeof value !== "bigint") throw new TypeError(`Invalid ${name}`);
         target.writeBigUInt64LE(value);
       } else {
-        if (typeof value !== 'number') throw new TypeError(`Invalid ${name}`);
+        if (typeof value !== "number") throw new TypeError(`Invalid ${name}`);
         target.writeUIntLE(value, 0, length);
       }
     },
   });
 }
-field('gameTitle', 0, 12, 'string');
-field('gameCode', 12, 4, 'string');
-field('makerCode', 16, 2, 'string');
+field("gameTitle", 0, 12, "string");
+field("gameCode", 12, 4, "string");
+field("makerCode", 16, 2, "string");
 for (const [name, offset] of Object.entries({
   unitCode: 0x12,
   encryptionSeed: 0x13,
@@ -217,38 +204,38 @@ for (const [name, offset] of Object.entries({
   ROMversion: 0x1e,
   internalFlags: 0x1f,
 }))
-  field(name, offset, 1, 'number');
-field('reserved', 0x15, 7);
+  field(name, offset, 1, "number");
+field("reserved", 0x15, 7);
 const ntr32 =
-  'ARM9romOffset ARM9entryAddress ARM9ramAddress ARM9size ARM7romOffset ARM7entryAddress ARM7ramAddress ARM7size FNToffset FNTsize FAToffset FATsize ARM9overlayOffset ARM9overlaySize ARM7overlayOffset ARM7overlaySize flagsRead flagsInit bannerOffset'.split(
-    ' ',
+  "ARM9romOffset ARM9entryAddress ARM9ramAddress ARM9size ARM7romOffset ARM7entryAddress ARM7ramAddress ARM7size FNToffset FNTsize FAToffset FATsize ARM9overlayOffset ARM9overlaySize ARM7overlayOffset ARM7overlaySize flagsRead flagsInit bannerOffset".split(
+    " ",
   );
-ntr32.forEach((name, i) => field(name, 0x20 + i * 4, 4, 'number'));
-field('secureCRC16', 0x6c, 2, 'number');
-field('ROMtimeout', 0x6e, 2, 'number');
-field('ARM9autoload', 0x70, 4, 'number');
-field('ARM7autoload', 0x74, 4, 'number');
-field('secureDisable', 0x78, 8, 'number');
-field('ROMsize', 0x80, 4, 'number');
-field('headerSize', 0x84, 4, 'number');
-field('reserved2', 0x88, 56);
-field('logo', 0xc0, 156);
-field('logoCRC16', 0x15c, 2, 'number');
-field('headerCRC16', 0x15e, 2, 'number');
-'debug_romOffset debug_size debug_ramAddress reserved3'
-  .split(' ')
-  .forEach((name, i) => field(name, 0x160 + i * 4, 4, 'number'));
-field('appflags', 0x1bc, 4, 'buffer', true);
-'mbk9_wramcnt_setting region_flags access_control scfg_ext_mask'
-  .split(' ')
-  .forEach((name, i) => field(name, 0x1ac + i * 4, 4, 'number', true));
+ntr32.forEach((name, i) => field(name, 0x20 + i * 4, 4, "number"));
+field("secureCRC16", 0x6c, 2, "number");
+field("ROMtimeout", 0x6e, 2, "number");
+field("ARM9autoload", 0x70, 4, "number");
+field("ARM7autoload", 0x74, 4, "number");
+field("secureDisable", 0x78, 8, "number");
+field("ROMsize", 0x80, 4, "number");
+field("headerSize", 0x84, 4, "number");
+field("reserved2", 0x88, 56);
+field("logo", 0xc0, 156);
+field("logoCRC16", 0x15c, 2, "number");
+field("headerCRC16", 0x15e, 2, "number");
+"debug_romOffset debug_size debug_ramAddress reserved3"
+  .split(" ")
+  .forEach((name, i) => field(name, 0x160 + i * 4, 4, "number"));
+field("appflags", 0x1bc, 4, "buffer", true);
+"mbk9_wramcnt_setting region_flags access_control scfg_ext_mask"
+  .split(" ")
+  .forEach((name, i) => field(name, 0x1ac + i * 4, 4, "number", true));
 const twl32 =
-  'dsi9_rom_offset offset_0x1C4 dsi9_ram_address dsi9_size dsi7_rom_offset offset_0x1D4 dsi7_ram_address dsi7_size digest_ntr_start digest_ntr_size digest_twl_start digest_twl_size sector_hashtable_start sector_hashtable_size block_hashtable_start block_hashtable_size digest_sector_size digest_block_sectorcount banner_size offset_0x20C total_rom_size offset_0x214 offset_0x218 offset_0x21C modcrypt1_start modcrypt1_size modcrypt2_start modcrypt2_size tid_low tid_high public_sav_size private_sav_size'.split(
-    ' ',
+  "dsi9_rom_offset offset_0x1C4 dsi9_ram_address dsi9_size dsi7_rom_offset offset_0x1D4 dsi7_ram_address dsi7_size digest_ntr_start digest_ntr_size digest_twl_start digest_twl_size sector_hashtable_start sector_hashtable_size block_hashtable_start block_hashtable_size digest_sector_size digest_block_sectorcount banner_size offset_0x20C total_rom_size offset_0x214 offset_0x218 offset_0x21C modcrypt1_start modcrypt1_size modcrypt2_start modcrypt2_size tid_low tid_high public_sav_size private_sav_size".split(
+    " ",
   );
-twl32.forEach((name, i) => field(name, 0x1c0 + i * 4, 4, 'number', true));
-'hmac_arm9 hmac_arm7 hmac_digest_master hmac_icon_title hmac_arm9i hmac_arm7i'
-  .split(' ')
-  .forEach((name, i) => field(name, 0x300 + i * 20, 20, 'buffer', true));
-field('hmac_arm9_no_secure', 0x3a0, 20, 'buffer', true);
-field('rsa_signature', 0xf80, 0x80, 'buffer', true);
+twl32.forEach((name, i) => field(name, 0x1c0 + i * 4, 4, "number", true));
+"hmac_arm9 hmac_arm7 hmac_digest_master hmac_icon_title hmac_arm9i hmac_arm7i"
+  .split(" ")
+  .forEach((name, i) => field(name, 0x300 + i * 20, 20, "buffer", true));
+field("hmac_arm9_no_secure", 0x3a0, 20, "buffer", true);
+field("rsa_signature", 0xf80, 0x80, "buffer", true);

package/src/nitro/nds-file.ts

@@ -1,13 +1,14 @@
 // Native TypeScript port of NitroHelper/NDSFile.cs, GPL-3.0.
-import { readFile, writeFile } from '#nitro-runtime';
-import { BinaryWriter, bytes, range, DEFAULT_MAX_SIZE } from './binary';
-import { Header } from './header';
-import { Banner } from './banner';
-import { FileAllocationTable, FileNameTable, OverlayTable } from './filesystem';
-import type { NitroFile, NitroFolder } from './filesystem';
-import { crc16 } from './crc';
-import { encryptSecureArea } from './crypto';
-import { TWL } from './twl';
+import { readFile, writeFile } from "#nitro-runtime";
+
+import { Banner } from "./banner";
+import { BinaryWriter, DEFAULT_MAX_SIZE, bytes, range } from "./binary";
+import { crc16 } from "./crc";
+import { encryptSecureArea } from "./crypto";
+import { FileAllocationTable, FileNameTable, OverlayTable } from "./filesystem";
+import type { NitroFile, NitroFolder } from "./filesystem";
+import { Header } from "./header";
+import { TWL } from "./twl";
 
 export interface RomOptions {
   /** Maximum generated ROM size in bytes. Defaults to 1 GiB. */
@@ -22,7 +23,7 @@ export interface RomFileInfo {
   size: number;
 }
 
-const key = (path: string): string => path.replaceAll('\\', '/').toLowerCase();
+const key = (path: string): string => path.replaceAll("\\", "/").toLowerCase();
 
 /** Parsed Nintendo DS ROM. Replacements do not change the input buffer. */
 export class NDSFile {
@@ -40,31 +41,21 @@ export class NDSFile {
   private readonly maxOutputSize: number;
 
   constructor(input: Uint8Array, options: RomOptions = {}) {
-    this.original = bytes(input, 'ROM');
+    this.original = bytes(input, "ROM");
     this.maxOutputSize = options.maxOutputSize ?? DEFAULT_MAX_SIZE;
     this.header = new Header(this.original);
     const h = this.header;
-    range(this.original, h.ARM9romOffset, h.ARM9size + (h.nitrocode ? 12 : 0), 'ARM9');
-    range(this.original, h.ARM7romOffset, h.ARM7size, 'ARM7');
+    range(this.original, h.ARM9romOffset, h.ARM9size + (h.nitrocode ? 12 : 0), "ARM9");
+    range(this.original, h.ARM7romOffset, h.ARM7size, "ARM7");
     this.banner = new Banner(this.original, h.bannerOffset, h.banner_size);
     this.fatTable = new FileAllocationTable(this.original, h.FAToffset, h.FATsize);
     this.fntTable = new FileNameTable(this.fatTable, this.original, h.FNToffset, h.FNTsize);
     this.root = this.fntTable.root;
-    this.overlay9Table = new OverlayTable(
-      this.original,
-      h.ARM9overlayOffset,
-      h.ARM9overlaySize,
-      true,
-    );
-    this.overlay7Table = new OverlayTable(
-      this.original,
-      h.ARM7overlayOffset,
-      h.ARM7overlaySize,
-      false,
-    );
+    this.overlay9Table = new OverlayTable(this.original, h.ARM9overlayOffset, h.ARM9overlaySize, true);
+    this.overlay7Table = new OverlayTable(this.original, h.ARM7overlayOffset, h.ARM7overlaySize, false);
     const arm9Overlays = this.overlay9Table.readBasicOverlays(this.fatTable);
     this.root.folders.push({
-      name: 'overlay',
+      name: "overlay",
       id: 0xffff,
       files: [...arm9Overlays, ...this.overlay7Table.readBasicOverlays(this.fatTable)],
       folders: [],
@@ -73,23 +64,23 @@ export class NDSFile {
       range(this.original, offset, size, name);
       this.root.files.push({ name, id: 0xffff, offset, size });
     };
-    system('header.bin', 0, h.headerSize);
-    system('banner.bin', h.bannerOffset, this.banner.raw.length);
-    system('fnt.bin', h.FNToffset, h.FNTsize);
-    system('fat.bin', h.FAToffset, h.FATsize);
-    system('arm9.bin', h.ARM9romOffset, h.ARM9size + (h.nitrocode ? 12 : 0));
-    system('arm7.bin', h.ARM7romOffset, h.ARM7size);
-    if (h.ARM9overlaySize) system('overarm9.bin', h.ARM9overlayOffset, h.ARM9overlaySize);
-    if (h.ARM7overlaySize) system('overarm7.bin', h.ARM7overlayOffset, h.ARM7overlaySize);
+    system("header.bin", 0, h.headerSize);
+    system("banner.bin", h.bannerOffset, this.banner.raw.length);
+    system("fnt.bin", h.FNToffset, h.FNTsize);
+    system("fat.bin", h.FAToffset, h.FATsize);
+    system("arm9.bin", h.ARM9romOffset, h.ARM9size + (h.nitrocode ? 12 : 0));
+    system("arm7.bin", h.ARM7romOffset, h.ARM7size);
+    if (h.ARM9overlaySize) system("overarm9.bin", h.ARM9overlayOffset, h.ARM9overlaySize);
+    if (h.ARM7overlaySize) system("overarm7.bin", h.ARM7overlayOffset, h.ARM7overlaySize);
     const visit = (folder: NitroFolder, prefix: string): void => {
       for (const file of folder.files) {
         const path = prefix + file.name;
         if (this.paths.has(key(path))) throw new Error(`Duplicate ROM path: ${path}`);
         this.paths.set(key(path), { path, file });
       }
-      for (const child of folder.folders) visit(child, prefix + child.name + '/');
+      for (const child of folder.folders) visit(child, `${prefix + child.name}/`);
     };
-    visit(this.root, '');
+    visit(this.root, "");
     if (h.unitCode & 2 && h.twlInternalFlags & 1 && h.tid_high && h.tid_high !== 0xffffffff) {
       // Upstream silently discarded malformed TWL regions. Preserve valid DSi data,
       // and reject malformed data instead of emitting a ROM with missing sections.
@@ -135,20 +126,13 @@ export class NDSFile {
 
   /** Rebuild offsets, allocation table, CRCs and ROM padding. Safe to call repeatedly. */
   toBuffer(): Buffer {
-    const fntReplacement = this.root.files.find((file) => file.name === 'fnt.bin')?.replacement;
+    const fntReplacement = this.root.files.find((file) => file.name === "fnt.bin")?.replacement;
     if (fntReplacement) {
-      const replacementTree = new FileNameTable(
-        this.fatTable,
-        fntReplacement,
-        0,
-        fntReplacement.length,
-      );
+      const replacementTree = new FileNameTable(this.fatTable, fntReplacement, 0, fntReplacement.length);
       const collect = (folder: NitroFolder): number[] =>
-        [...folder.files.map((file) => file.id), ...folder.folders.flatMap(collect)].sort(
-          (a, b) => a - b,
-        );
-      if (collect(replacementTree.root).join(',') !== collect(this.data).join(','))
-        throw new Error('Replacement FNT must preserve existing file IDs');
+        [...folder.files.map((file) => file.id), ...folder.folders.flatMap(collect)].sort((a, b) => a - b);
+      if (collect(replacementTree.root).join(",") !== collect(this.data).join(","))
+        throw new Error("Replacement FNT must preserve existing file IDs");
     }
     const h = new Header(this.header.toBuffer());
     h.nitrocode = this.header.nitrocode;
@@ -161,7 +145,7 @@ export class NDSFile {
       if (!file) throw new Error(`Missing ROM system file: ${name}`);
       return file;
     };
-    const replacedHeader = system('header.bin').replacement;
+    const replacedHeader = system("header.bin").replacement;
     if (replacedHeader) {
       const replacement = new Header(replacedHeader);
       h.gameTitle = replacement.gameTitle;
@@ -177,13 +161,13 @@ export class NDSFile {
     const overlayIds = new Set<number>();
     const writeOverlays = (arm9: boolean): void => {
       const originalTable = arm9 ? this.overlay9Table : this.overlay7Table;
-      const name = arm9 ? 'overarm9.bin' : 'overarm7.bin';
+      const name = arm9 ? "overarm9.bin" : "overarm7.bin";
       const entry = this.root.files.find((file) => file.name === name);
       if (!entry) return;
       const raw = entry.replacement ?? originalTable.toBuffer();
       const table = new OverlayTable(raw, 0, raw.length, arm9);
       const files = this.overlay.files
-        .filter((file) => file.name.startsWith(arm9 ? 'overlay_' : 'overlay7_'))
+        .filter((file) => file.name.startsWith(arm9 ? "overlay_" : "overlay7_"))
         .sort((a, b) => a.id - b.id);
       for (const file of files) {
         const item = table.entries.find((item) => item.fileId === file.id);
@@ -193,8 +177,7 @@ export class NDSFile {
           item.reserved = ((item.reserved & 0xff000000) | (size & 0xffffff)) >>> 0;
         overlayIds.add(file.id);
       }
-      if (table.entries.length !== files.length)
-        throw new Error('Changing overlay file count is unsupported');
+      if (table.entries.length !== files.length) throw new Error("Changing overlay file count is unsupported");
       const encoded = table.toBuffer();
       if (arm9) {
         h.ARM9overlayOffset = writer.position;
@@ -209,30 +192,29 @@ export class NDSFile {
     };
     writer.position = h.headerSize;
     h.ARM9romOffset = writer.position;
-    const arm9 = system('arm9.bin');
+    const arm9 = system("arm9.bin");
     const arm9Bytes = this.fileBytes(arm9);
     if (arm9.replacement) {
-      h.nitrocode =
-        arm9Bytes.length >= 12 && arm9Bytes.readUInt32LE(arm9Bytes.length - 12) === 0xdec00621;
+      h.nitrocode = arm9Bytes.length >= 12 && arm9Bytes.readUInt32LE(arm9Bytes.length - 12) === 0xdec00621;
     }
     h.ARM9size = arm9Bytes.length - (h.nitrocode ? 12 : 0);
     write(arm9);
     h.ARM9overlayOffset = 0;
     writeOverlays(true);
     h.ARM7romOffset = writer.position;
-    h.ARM7size = this.fileBytes(system('arm7.bin')).length;
-    write(system('arm7.bin'));
+    h.ARM7size = this.fileBytes(system("arm7.bin")).length;
+    write(system("arm7.bin"));
     h.ARM7overlayOffset = 0;
     writeOverlays(false);
     h.FNToffset = writer.position;
-    h.FNTsize = this.fileBytes(system('fnt.bin')).length;
-    write(system('fnt.bin'));
+    h.FNTsize = this.fileBytes(system("fnt.bin")).length;
+    write(system("fnt.bin"));
     h.FAToffset = writer.position;
     h.FATsize = this.fatTable.entries.length * 8;
     writer.write(Buffer.alloc(h.FATsize));
     writer.pad(0x200);
     h.bannerOffset = writer.position;
-    const bannerFile = system('banner.bin');
+    const bannerFile = system("banner.bin");
     const banner = bannerFile.replacement
       ? new Banner(bannerFile.replacement, 0, bannerFile.replacement.length)
       : this.banner;
@@ -265,8 +247,7 @@ export class NDSFile {
     writer.position = logicalEnd;
     // An ARM9 replacement can add or remove the decrypted secure-area marker.
     // Both TWL hashing and the header CRC must use the bytes being serialized.
-    h.decrypted =
-      writer.length >= 0x4008 && writer.buffer.readBigUInt64LE(0x4000) === 0xe7ffdeffe7ffdeffn;
+    h.decrypted = writer.length >= 0x4008 && writer.buffer.readBigUInt64LE(0x4000) === 0xe7ffdeffe7ffdeffn;
     if (this.twl) this.twl.writeTo(writer, h);
     h.ROMsize = writer.position;
     h.size = 2 ** Math.ceil(Math.log2(Math.max(h.ROMsize + h.dlp_signature.length, 0x20000)));