1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
#include "SoundfontTblFactory.h"
#include "Companion.h"
#include "spdlog/spdlog.h"
#include "types/RawBuffer.h"
#include "utils/Decompressor.h"
#include <cstdint>
#include <cstring>
#include <stdexcept>
#include <unordered_set>
namespace BK64 {
namespace {
uint16_t ReadU16BE(const uint8_t* p) {
return (uint16_t)((p[0] << 8) | p[1]);
}
int16_t ReadS16BE(const uint8_t* p) {
return (int16_t)ReadU16BE(p);
}
uint32_t ReadU32BE(const uint8_t* p) {
return ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16) | ((uint32_t)p[2] << 8) | (uint32_t)p[3];
}
int32_t ReadS32BE(const uint8_t* p) {
return (int32_t)ReadU32BE(p);
}
// Walk an N64 ALBankFile binary (big-endian, 32-bit offsets relative to ctl
// start) and return max(wavetable.base + wavetable.len) over every wavetable
// reachable from the file's banks. Throws on any structural inconsistency —
// silent fallbacks would just produce a wrong-size tbl and reproduce the bug
// we're fixing.
//
// ALBankFile: [0] s16 revision, [2] s16 bankCount, [4+] u32 bankOffsets[]
// ALBank: [0] s16 instCount, [4] s32 sampleRate, [8] u32 percussion,
// [12+] u32 instOffsets[]
// ALInstrument:[14] s16 soundCount, [16+] u32 soundOffsets[]
// ALSound: [8] u32 wavetable
// ALWaveTable: [0] u32 base, [4] s32 len
size_t ComputeTblSize(const uint8_t* ctl, size_t ctlSize, uint32_t ctlRomOffset, bool quiet = false) {
auto check = [&](uint32_t off, size_t need, const char* what) {
if ((size_t)off + need > ctlSize) {
if (!quiet) {
SPDLOG_ERROR(
"SoundfontTblFactory: ctl walk OOB reading {} (ctl@0x{:X} size=0x{:X} off=0x{:X} need=0x{:X})",
what, ctlRomOffset, ctlSize, off, need);
}
throw std::runtime_error("SoundfontTblFactory: ctl walk OOB");
}
};
check(0, 4, "header");
int16_t bankCount = ReadS16BE(ctl + 2);
if (bankCount <= 0) {
throw std::runtime_error("SoundfontTblFactory: bankCount <= 0");
}
uint64_t maxEnd = 0;
std::unordered_set<uint32_t> seenWt;
for (int b = 0; b < bankCount; b++) {
check(4 + b * 4, 4, "bankArray entry");
uint32_t bankOff = ReadU32BE(ctl + 4 + b * 4);
if (bankOff == 0) {
continue;
}
check(bankOff, 12, "ALBank header");
int16_t instCount = ReadS16BE(ctl + bankOff + 0);
uint32_t percOff = ReadU32BE(ctl + bankOff + 8);
auto visitInst = [&](uint32_t instOff) {
if (instOff == 0) {
return;
}
check(instOff, 16, "ALInstrument header");
int16_t soundCount = ReadS16BE(ctl + instOff + 14);
for (int s = 0; s < soundCount; s++) {
check(instOff + 16 + s * 4, 4, "ALInstrument soundArray entry");
uint32_t sndOff = ReadU32BE(ctl + instOff + 16 + s * 4);
if (sndOff == 0) {
continue;
}
check(sndOff, 12, "ALSound header");
uint32_t wtOff = ReadU32BE(ctl + sndOff + 8);
if (wtOff == 0 || !seenWt.insert(wtOff).second) {
continue;
}
check(wtOff, 8, "ALWaveTable header");
uint32_t base = ReadU32BE(ctl + wtOff + 0);
int32_t len = ReadS32BE(ctl + wtOff + 4);
if (len < 0) {
throw std::runtime_error("SoundfontTblFactory: negative wavetable len");
}
uint64_t end = (uint64_t)base + (uint64_t)len;
if (end > maxEnd) {
maxEnd = end;
}
}
};
visitInst(percOff);
for (int i = 0; i < instCount; i++) {
check(bankOff + 12 + i * 4, 4, "ALBank instArray entry");
visitInst(ReadU32BE(ctl + bankOff + 12 + i * 4));
}
}
if (maxEnd == 0) {
throw std::runtime_error("SoundfontTblFactory: ctl referenced no wavetables");
}
// Round up to BK's 16-byte ROM alignment.
return (size_t)((maxEnd + 0xF) & ~(uint64_t)0xF);
}
// AL_BANK_VERSION magic
constexpr uint16_t kAlBankRevision = 0x4231;
bool ValidateCtl(const uint8_t* ctl, size_t ctlSize) {
if (ctlSize < 8) {
return false;
}
if (ReadU16BE(ctl) != kAlBankRevision) {
return false;
}
int16_t bankCount = ReadS16BE(ctl + 2);
if (bankCount <= 0 || bankCount > 16) {
return false;
}
uint32_t bank0 = ReadU32BE(ctl + 4);
if (bank0 != 0 && (bank0 < 4u + 4u * bankCount || bank0 >= ctlSize)) {
return false;
}
try {
ComputeTblSize(ctl, ctlSize, 0, /*quiet=*/true);
} catch (...) {
return false;
}
return true;
}
} // namespace
uint32_t LocateSoundfontCtl(const std::vector<uint8_t>& rom, uint32_t ctlOffset, uint32_t ctlSize) {
if ((size_t)ctlOffset + ctlSize <= rom.size() && ValidateCtl(rom.data() + ctlOffset, ctlSize)) {
return ctlOffset;
}
// Romhacks can shift the whole audio region; hunt
// for the real ALBankFile header instead of failing.
std::vector<uint32_t> candidates;
for (size_t i = 0; i + 8 <= rom.size(); i += 8) {
if (rom[i] != 0x42 || rom[i + 1] != 0x31) {
continue;
}
size_t avail = std::min<size_t>(ctlSize, rom.size() - i);
if (ValidateCtl(rom.data() + i, avail)) {
candidates.push_back((uint32_t)i);
}
}
if (candidates.empty()) {
SPDLOG_ERROR("SoundfontCtl: no valid ALBankFile found anywhere in ROM (vanilla ctl@0x{:X} size=0x{:X})",
ctlOffset, ctlSize);
throw std::runtime_error("SoundfontCtl: soundfont ctl not found in ROM");
}
uint32_t best = candidates[0];
for (uint32_t c : candidates) {
auto dist = [&](uint32_t off) { return off > ctlOffset ? off - ctlOffset : ctlOffset - off; };
if (dist(c) < dist(best)) {
best = c;
}
}
SPDLOG_WARN("SoundfontCtl: ctl not at vanilla offset 0x{:X}; relocated to 0x{:X} (delta 0x{:X}, {} candidates)",
ctlOffset, best, (uint32_t)(best - ctlOffset), candidates.size());
return best;
}
std::optional<std::shared_ptr<IParsedData>> SoundfontCtlFactory::parse(std::vector<uint8_t>& buffer, YAML::Node& node) {
const auto offset = GetSafeNode<uint32_t>(node, "offset");
const auto size = GetSafeNode<uint32_t>(node, "size");
const uint32_t realOffset = LocateSoundfontCtl(buffer, offset, size);
if ((size_t)realOffset + size > buffer.size()) {
throw std::runtime_error("SoundfontCtlFactory: ctl exceeds ROM size");
}
return std::make_shared<RawBuffer>(buffer.data() + realOffset, size);
}
std::optional<std::shared_ptr<IParsedData>> SoundfontTblFactory::parse(std::vector<uint8_t>& buffer, YAML::Node& node) {
const auto tblOffset = GetSafeNode<uint32_t>(node, "offset");
const auto ctlOffset = GetSafeNode<uint32_t>(node, "ctl_offset");
const auto ctlSize = GetSafeNode<uint32_t>(node, "ctl_size");
// The tbl sits right after the ctl, so it shifts by
// the same delta when a romhack relocates the audio region.
const uint32_t realCtlOffset = LocateSoundfontCtl(buffer, ctlOffset, ctlSize);
const uint32_t realTblOffset = tblOffset + (realCtlOffset - ctlOffset);
if ((size_t)realCtlOffset + ctlSize > buffer.size()) {
throw std::runtime_error("SoundfontTblFactory: ctl_offset + ctl_size exceeds ROM size");
}
const size_t tblSize = ComputeTblSize(buffer.data() + realCtlOffset, ctlSize, realCtlOffset);
if ((size_t)realTblOffset + tblSize > buffer.size()) {
throw std::runtime_error("SoundfontTblFactory: computed tbl size exceeds ROM bounds");
}
SPDLOG_INFO("SoundfontTbl: tbl@0x{:X} size 0x{:X} (computed from ctl@0x{:X})", realTblOffset, tblSize,
realCtlOffset);
return std::make_shared<RawBuffer>(buffer.data() + realTblOffset, tblSize);
}
} // namespace BK64
|
