List and edit in-memory sounds in soundbanks

tests/synth.py

@@ -89,9 +89,10 @@ def pack(media):
     return bytes(hdr) + bank, bytes(payload)
 
 
-def bank(bank_id, media, name=None, extra_sources=()):
+def bank(bank_id, media, name=None, extra_sources=(), prefetch=()):
     """A v56 soundbank holding `media` {id: wem} in memory (DIDX/DATA, 16-byte aligned) with one HIRC
-    Sound object per media; extra_sources: [(media id, bank id, off, size)] for sources of other banks."""
+    Sound object per media; extra_sources: [(media id, bank id, off, size)] for sources of other banks;
+    media ids in `prefetch` get a prefetch source (their DIDX data is the head of a streamed WEM)."""
     data = bytearray()
     didx = b""
     for m in sorted(media):
@@ -104,11 +105,12 @@ def bank(bank_id, media, name=None, extra_sources=()):
     objs = []
     for i, m in enumerate(sorted(media)):
         off = struct.unpack_from("<I", didx, 12 * i + 4)[0]
-        objs.append((m, bank_id, data_pos + off, len(media[m])))
-    objs += list(extra_sources)
+        objs.append((m, bank_id if m not in prefetch else 0x1234, data_pos + off, len(media[m]),
+                     2 if m in prefetch else 0))
+    objs += [x + (0,) for x in extra_sources]
     hirc = struct.pack("<I", len(objs))
-    for i, (m, b, off, size) in enumerate(objs):
-        body = struct.pack("<7I", 0x100 + i, 0x00040001, 0, m, b, off, size) + bytes(6)
+    for i, (m, b, off, size, stream) in enumerate(objs):
+        body = struct.pack("<7I", 0x100 + i, 0x00040001, stream, m, b, off, size) + bytes(6)
         hirc += bytes([2]) + struct.pack("<I", len(body)) + body
     out = head + b"DATA" + struct.pack("<I", len(data)) + bytes(data) + b"HIRC" + struct.pack("<I", len(hirc)) + hirc
     if name:
@@ -172,4 +174,44 @@ def make_game(root):
     originals = {"%08X:%d" % (SPEECH_ENTRY, i): w for i, w in enumerate(v)}
     originals["%08X" % SINGLE_ENTRY] = single
     originals.update({"%08X/%08X" % (PACK_ID, m): w for m, w in music.items()})
+    originals.update(make_banks(cooked, v))
     return originals
+
+
+# soundbanks (docs/formats/banks.md): media ids of the in-memory sounds
+FOOT = (0x0A000001, 0x0A000002)       # loose bank CHR_SynthFootsteps_Media
+FOLEY = (0x0B000001, 0x0B000002)      # bank CHR_SynthFoley, copied into both packages
+GUI = (0x0C000001,)                   # bank GUI_Synth (package B only)
+LINE_MEDIA = (0x0D000000, 0x0D000001, 0x0D000002)   # INT media ids of the SPEECH_ENTRY variations
+HEAD = 0x200                          # prefetch head size of variation 1
+
+
+def make_banks(cooked, speech_wems):
+    """Loose bank + two packages (one bank in both) + a prefetch head of INT SPEECH_ENTRY variation 1."""
+    from ackit.bnk import fnv1
+    names = ["Init", "CHR_SynthFootsteps_Media", "CHR_SynthFoley", "GUI_Synth", "Speech_Synth"]
+    with open(os.path.join(cooked, "CookedBanks.txt"), "w", newline="\r\n") as f:
+        f.write("\n".join(names) + "\n")
+    foot = {FOOT[0]: wem(0.4, 800), FOOT[1]: wem(0.3, 900)}
+    foley = {FOLEY[0]: wem(0.5, 1000), FOLEY[1]: wem(0.6, 1100, 32000)}
+    gui = {GUI[0]: wem(0.5, 1200)}
+    open(os.path.join(cooked, "SFX", "%08X.bnk" % fnv1(names[1])), "wb").write(
+        bank(fnv1(names[1]), foot, name=names[1]))
+    # BKPK table of SPEECH_ENTRY for INT (media ids differ per language; offsets as in the WAD entry)
+    offs, pos = [], 0
+    for w in speech_wems:
+        pos = _a(pos, 0x800)
+        offs.append(pos)
+        pos += len(w)
+    tbl = bytearray(0x48)
+    struct.pack_into("<4sII", tbl, 0, b"BKPK", 0x01020000, SPEECH_ENTRY)
+    struct.pack_into("<IIIIII", tbl, 0x10, 3, 0, 36, 0x48, _a(pos, 0x800), 0)
+    tbl += b"".join(struct.pack("<III", m, len(w), o) for m, w, o in zip(LINE_MEDIA, speech_wems, offs))
+    speech = bank(fnv1(names[4]), {LINE_MEDIA[1]: speech_wems[1][:HEAD]}, prefetch=(LINE_MEDIA[1],))
+    filler = bytes(range(256)) * 9
+    synth_a = filler + bank(fnv1(names[2]), foley) + filler[:777] + bytes(tbl) + speech + filler
+    synth_b = filler[:1000] + bank(fnv1(names[3]), gui) + filler + bank(fnv1(names[2]), foley) + filler
+    package(os.path.join(cooked, "Synth_A.upk"), synth_a)
+    package(os.path.join(cooked, "Synth_B.upk"), synth_b)
+    out = {"%08X" % m: w for m, w in list(foot.items()) + list(foley.items()) + list(gui.items())}
+    return out