forked from Arisotura/SM64DSe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
NitroROM_patch.cs
741 lines (615 loc) · 32.1 KB
/
NitroROM_patch.cs
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
/*
Copyright 2012 Kuribo64
This file is part of SM64DSe.
SM64DSe is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
SM64DSe is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with SM64DSe. If not, see http://www.gnu.org/licenses/.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.IO;
using System.Globalization;
using System.Resources;
using System.Windows.Forms;
using System.ComponentModel;
namespace SM64DSe
{
public partial class NitroROM
{
public const uint ROM_PATCH_VERSION = 5;
public const uint LEVEL_OVERLAY_SIZE = 32768;
public const int NUM_LEVELS = 52;
public const int NEW_LEVEL_OVERLAYS_START_INDEX = 103;
public uint LevelOvlOffset
{
get
{
switch (m_Version)
{
default:
case NitroROM.Version.EUR:
return 0x214EAA0; // 34925216
case NitroROM.Version.USA_v1:
return 0x2143BA0; // 34880416
case NitroROM.Version.USA_v2:
return 0x2145720; // 34887456
case NitroROM.Version.JAP:
return 0x2143480; // 34878592
}
}
}
private uint ARM_BL(uint src, uint dst) { return (0xEB000000 | (((dst - src - 8) >> 2) & 0x00FFFFFF)); }
private uint ARM_B(uint src, uint dst) { return (0xEA000000 | (((dst - src - 8) >> 2) & 0x00FFFFFF)); }
private ushort CalcCRC16(uint offset, uint len)
{
uint crc = 0xFFFF;
uint[] val = {0xC0C1, 0xC181, 0xC301, 0xC601, 0xCC01, 0xD801, 0xF001, 0xA001};
m_FileStream.Position = offset;
for (uint i = 0; i < len; i++)
{
crc ^= m_BinReader.ReadByte();
for (int j = 0; j < 8; j++)
{
bool carry = ((crc & 0x1) == 0x1);
crc >>= 1;
if (carry)
crc ^= (val[j] << (7 - j));
}
}
return (ushort)crc;
}
public bool NeedsPatch()
{
m_FileStream.Position = 0x1FC;
UInt32 patchversion = m_BinReader.ReadUInt32();
if (patchversion > ROM_PATCH_VERSION)
throw new Exception("This ROM has been patched by a more recent version of "+Program.AppTitle+" and cannot be opened in this version.");
return (patchversion < ROM_PATCH_VERSION);
}
private void Patch_v1(BackgroundWorker lazyman)
{
lazyman.ReportProgress(100);
// read the ARM9 binary, decompress it and write it back
m_FileStream.Position = 0x2C;
int oldsize = (int)(m_BinReader.ReadUInt32() - 0x4000);
m_FileStream.Position = 0x8000;
byte[] binary = m_BinReader.ReadBytes(oldsize);
Jap77.Decompress(ref binary);
lazyman.ReportProgress(150);
int newsize = (binary.Length + 3) & ~3;
int delta = newsize - oldsize;
MakeRoom((uint)(0x8000 + oldsize), (uint)delta);
m_FileStream.Position = 0x8000;
m_BinWriter.Write(binary);
lazyman.ReportProgress(199);
// patch the loader code so that it doesn't try to decompress
// the already decompressed binary
UInt32 nop = 0xE1A00000;
m_FileStream.Position = 0x484C;
m_BinWriter.Write(nop);
m_BinWriter.Write(nop);
m_BinWriter.Write(nop);
int fixstart = 0x8000 + oldsize;
AutoFix(0xFFFF, (uint)fixstart, delta);
// fix the ARM9 binary size - important
uint newarm9size = (uint)(0x4000 + newsize);
m_FileStream.Position = 0x2C;
m_BinWriter.Write(newarm9size);
}
private void Patch_v2(BackgroundWorker lazyman)
{
lazyman.ReportProgress(200);
uint levelptr_table = 0, objbank_table = 0;
uint mempatch1 = 0, mempatch2 = 0;
byte[] loadercode = null;
uint lvl_ovlid_table = 0;
uint unload_patch = 0, unload_branchop = 0;
uint[] ovltable_addr_patch = new uint[4];
uint[] ovltable_size_patch = new uint[4];
uint lvlload_addr_patch = 0, lvlload_code_patch = 0;
uint objbank_addr_patch = 0, objbank_code_patch = 0;
switch (m_Version)
{
case Version.EUR:
levelptr_table = 0x92208;
objbank_table = 0x75998;
mempatch1 = 0x18B60;
mempatch2 = 0x58DE0;
loadercode = Properties.Resources.level_ovl_init_EUR_000;
lvl_ovlid_table = 0x758C8;
unload_patch = 0x2DE80;
unload_branchop = ARM_BL(0x0202DE80, 0x0214EAD8);
ovltable_addr_patch[0] = 0x17E90; ovltable_addr_patch[1] = 0x17F30;
ovltable_addr_patch[2] = 0x17FCC; ovltable_addr_patch[3] = 0x180FC;
ovltable_size_patch[0] = 0x17E80; ovltable_size_patch[1] = 0x17ED0;
ovltable_size_patch[2] = 0x17F70; ovltable_size_patch[3] = 0x180C4;
lvlload_addr_patch = 0x2D62C;
lvlload_code_patch = 0x2D288;
objbank_addr_patch = 0x2E074;
objbank_code_patch = 0x2DFAC;
break;
case Version.JAP:
levelptr_table = 0x902B8;
objbank_table = 0x73C08;
mempatch1 = 0x57368;
mempatch2 = 0xFFFFFFFF;
loadercode = Properties.Resources.level_ovl_init_JAP;
lvl_ovlid_table = 0x73B38;
unload_patch = 0x2CDD8;
unload_branchop = ARM_BL(0x0202CDD8, 0x021434B8);
ovltable_addr_patch[0] = 0x17DE4; ovltable_addr_patch[1] = 0x17E84;
ovltable_addr_patch[2] = 0x17F20; ovltable_addr_patch[3] = 0x18050;
ovltable_size_patch[0] = 0x17DD4; ovltable_size_patch[1] = 0x17E24;
ovltable_size_patch[2] = 0x17EC4; ovltable_size_patch[3] = 0x18018;
lvlload_addr_patch = 0x2C7D4;
lvlload_code_patch = 0x2C430;
objbank_addr_patch = 0x2CFCC;
objbank_code_patch = 0x2CF04;
break;
case Version.USA_v1:
levelptr_table = 0x8FDB0;
objbank_table = 0x73664;
mempatch1 = 0x56EB8;
mempatch2 = 0xFFFFFFFF;
loadercode = Properties.Resources.level_ovl_init_USAv1;
lvl_ovlid_table = 0x73594;
unload_patch = 0x2CB00;
unload_branchop = ARM_BL(0x0202CB00, 0x02143BD8);
ovltable_addr_patch[0] = 0x17D70; ovltable_addr_patch[1] = 0x17E10;
ovltable_addr_patch[2] = 0x17EAC; ovltable_addr_patch[3] = 0x17FDC;
ovltable_size_patch[0] = 0x17D60; ovltable_size_patch[1] = 0x17DB0;
ovltable_size_patch[2] = 0x17E50; ovltable_size_patch[3] = 0x17FA4;
lvlload_addr_patch = 0x2C4FC;
lvlload_code_patch = 0x2C15C;
objbank_addr_patch = 0x2CCF4;
objbank_code_patch = 0x2CC2C;
break;
case Version.USA_v2:
levelptr_table = 0x90ACC;
objbank_table = 0x74384;
mempatch1 = 0x18A44;
mempatch2 = 0x57B30;
loadercode = Properties.Resources.level_ovl_init_USAv2;
lvl_ovlid_table = 0x742B4;
unload_patch = 0x2CE14;
unload_branchop = ARM_BL(0x0202CE14, 0x02145758);
ovltable_addr_patch[0] = 0x17DE4; ovltable_addr_patch[1] = 0x17E84;
ovltable_addr_patch[2] = 0x17F20; ovltable_addr_patch[3] = 0x18050;
ovltable_size_patch[0] = 0x17DD4; ovltable_size_patch[1] = 0x17E24;
ovltable_size_patch[2] = 0x17EC4; ovltable_size_patch[3] = 0x18018;
lvlload_addr_patch = 0x2C810;
lvlload_code_patch = 0x2C46C;
objbank_addr_patch = 0x2D008;
objbank_code_patch = 0x2CF40;
break;
}
// tweak the root heap start address to gain more overlay space :)
m_FileStream.Position = mempatch1;
uint lvl_start = m_BinReader.ReadUInt32();
uint lvl_end = lvl_start + LEVEL_OVERLAY_SIZE;
m_FileStream.Position = mempatch1;
m_BinWriter.Write(lvl_end);
if (mempatch2 != 0xFFFFFFFF)
{
m_FileStream.Position = mempatch2;
m_BinWriter.Write(lvl_end);
}
// patch level overlay unloading
m_FileStream.Position = unload_patch;
m_BinWriter.Write(unload_branchop);
// patch more stuff
foreach (uint addr in ovltable_addr_patch)
{
m_FileStream.Position = addr;
m_BinWriter.Write((uint)(0x02000000 + levelptr_table));
}
foreach (uint addr in ovltable_size_patch)
{
m_FileStream.Position = addr;
uint op = m_BinReader.ReadUInt32();
op = (op & 0xFFFFFF00) | 0x0D;
m_FileStream.Position = addr;
m_BinWriter.Write(op);
}
lazyman.ReportProgress(201);
// for each level, create a new overlay with the loader code and level data
uint dataoffset = (uint)((loadercode.Length + 3) & ~3);
for (int i = 0; i < NUM_LEVELS; i++)
{
uint overlayid = AddOverlay(lvl_start);
m_FileStream.Position = lvl_ovlid_table + (i*4);
uint old_overlayid = m_BinReader.ReadUInt32();
m_FileStream.Position = lvl_ovlid_table + (i*4);
m_BinWriter.Write(overlayid);
NitroOverlay ovl = new NitroOverlay(this, overlayid);
ovl.SetInitializer(lvl_start, 4);
ovl.WriteBlock(0, loadercode);
// write the object bank settings
m_FileStream.Position = objbank_table + (i * 7);
byte[] objbanks = m_BinReader.ReadBytes(7);
ovl.WriteBlock(dataoffset, objbanks);
ovl.Write8(dataoffset + 0x7, 0x00);
ovl.Write32(dataoffset + 0x8, (uint)(i + 1));
// copy level data
{
NitroOverlay oldovl = new NitroOverlay(this, old_overlayid);
uint oldbase = oldovl.GetRAMAddr();
m_FileStream.Position = levelptr_table + (i*4);
uint header_offset = m_BinReader.ReadUInt32() - oldbase;
uint curoffset = dataoffset + 0x40;
// CLPS (collision behaviors) chunk
{
uint clps_addr = oldovl.ReadPointer(header_offset);
ushort clps_num = oldovl.Read16(clps_addr + 0x06);
uint clps_size = (uint)(8 + (clps_num * 8));
byte[] clps = oldovl.ReadBlock(clps_addr, clps_size);
ovl.WriteBlock(curoffset, clps);
ovl.WritePointer(dataoffset + 0x0C, curoffset);
curoffset += clps_size;
}
// misc objects table list
{
uint tables_addr = oldovl.ReadPointer(header_offset + 0x4);
ushort tables_num = oldovl.Read16(tables_addr);
tables_addr = oldovl.ReadPointer(tables_addr + 0x4);
ovl.WritePointer(dataoffset + 0x10, curoffset);
ovl.Write16(curoffset, tables_num);
ovl.WritePointer(curoffset + 0x04, curoffset + 0x8);
curoffset += 0x8;
uint objdata_offset = (uint)(curoffset + (tables_num * 8));
for (ushort t = 0; t < tables_num; t++)
{
uint tbl_part1 = oldovl.Read32(tables_addr);
uint tbl_addr = oldovl.ReadPointer(tables_addr + 0x4);
ovl.Write32(curoffset, tbl_part1);
ovl.WritePointer(curoffset + 0x4, objdata_offset);
tables_addr += 8;
curoffset += 8;
byte tbltype = (byte)(tbl_part1 & 0x1F);
byte numentries = (byte)((tbl_part1 >> 8) & 0xFF);
if ((tbltype == 13) || (tbltype > 14))
throw new Exception(String.Format("Wrong object table type {0} (0x{0:X2}) in level data", tbltype));
int[] datasizes = {16, 16, 6, 6, 14, 8, 8, 8, 8, 12, 14, 2, 2, 0, 4};
int datasize = numentries * datasizes[tbltype];
byte[] data = oldovl.ReadBlock(tbl_addr, (uint)datasize);
ovl.WriteBlock(objdata_offset, data);
objdata_offset += (uint)((datasize + 3) & ~3);
}
curoffset = objdata_offset;
}
// main object table lists
// and that stuff about texture scrolling
{
uint tlists_addr = oldovl.ReadPointer(header_offset + 0x10);
byte tlists_num = oldovl.Read8(header_offset + 0x14);
uint tlists_new_addr = curoffset;
curoffset += (uint)(tlists_num * 12);
ovl.WritePointer(dataoffset + 0x1C, tlists_new_addr);
ovl.Write8(dataoffset + 0x20, tlists_num);
for (byte tl = 0; tl < tlists_num; tl++)
{
uint tables_addr = oldovl.ReadPointer(tlists_addr);
uint texanm_addr = oldovl.ReadPointer(tlists_addr + 0x4);
if (tables_addr != 0xFFFFFFFF)
{
ovl.WritePointer(tlists_new_addr, curoffset);
ushort tables_num = oldovl.Read16(tables_addr);
tables_addr = oldovl.ReadPointer(tables_addr + 0x4);
ovl.Write16(curoffset, tables_num);
ovl.WritePointer(curoffset + 0x04, curoffset + 0x8);
curoffset += 0x8;
uint objdata_offset = (uint)(curoffset + (tables_num * 8));
for (ushort t = 0; t < tables_num; t++)
{
uint tbl_part1 = oldovl.Read32(tables_addr);
uint tbl_addr = oldovl.ReadPointer(tables_addr + 0x4);
ovl.Write32(curoffset, tbl_part1);
ovl.WritePointer(curoffset + 0x4, objdata_offset);
tables_addr += 8;
curoffset += 8;
byte tbltype = (byte)(tbl_part1 & 0x1F);
byte numentries = (byte)((tbl_part1 >> 8) & 0xFF);
if ((tbltype == 13) || (tbltype > 14))
throw new Exception(String.Format("Wrong object table type {0} (0x{0:X2}) in level data", tbltype));
int[] datasizes = { 16, 16, 6, 6, 14, 8, 8, 8, 8, 12, 14, 2, 2, 0, 4 };
int datasize = numentries * datasizes[tbltype];
byte[] data = oldovl.ReadBlock(tbl_addr, (uint)datasize);
ovl.WriteBlock(objdata_offset, data);
objdata_offset += (uint)((datasize + 3) & ~3);
}
curoffset = objdata_offset;
}
else
ovl.Write32(tlists_new_addr, 0);
if (texanm_addr != 0xFFFFFFFF)//If not null
{
ovl.WritePointer(tlists_new_addr + 0x4, curoffset);
uint texanm_new_addr = curoffset;
curoffset += 0x18;
uint textures_addr = oldovl.ReadPointer(texanm_addr + 0x14);
uint numscale = 0, numrot = 0, numtrans = 0;
uint numtextures = oldovl.Read32(texanm_addr + 0x10);
ovl.Write32(texanm_new_addr, oldovl.Read32(texanm_addr));
ovl.Write32(texanm_new_addr + 0x10, numtextures);
uint textures_new_addr = curoffset;
curoffset += (numtextures * 0x1C);
ovl.WritePointer(texanm_new_addr + 0x14, textures_new_addr);
for (uint t = 0; t < numtextures; t++)
{
uint tex_old_addr = textures_addr + (t * 0x1C);
uint tex_new_addr = textures_new_addr + (t * 0x1C);
ushort tex_scalenum = oldovl.Read16(tex_old_addr + 0x0C);
ushort tex_scalestart = oldovl.Read16(tex_old_addr + 0x0E);
ushort tex_rotnum = oldovl.Read16(tex_old_addr + 0x10);
ushort tex_rotstart = oldovl.Read16(tex_old_addr + 0x12);
ushort tex_transxnum = oldovl.Read16(tex_old_addr + 0x14);
ushort tex_transxstart = oldovl.Read16(tex_old_addr + 0x16);
ushort tex_transynum = oldovl.Read16(tex_old_addr + 0x18);
ushort tex_transystart = oldovl.Read16(tex_old_addr + 0x1A);
if ((tex_scalestart + tex_scalenum) > numscale)
numscale = (uint)(tex_scalestart + tex_scalenum);
if ((tex_rotstart + tex_rotnum) > numrot)
numrot = (uint)(tex_rotstart + tex_rotnum);
if ((tex_transxstart + tex_transxnum) > numtrans)
numtrans = (uint)(tex_transxstart + tex_transxnum);
if ((tex_transystart + tex_transynum) > numtrans)
numtrans = (uint)(tex_transystart + tex_transynum);
ovl.Write32(tex_new_addr, oldovl.Read32(tex_old_addr));
ovl.WritePointer(tex_new_addr + 0x4, curoffset);
ovl.Write32(tex_new_addr + 0x8, oldovl.Read32(tex_old_addr + 0x8));
ovl.Write16(tex_new_addr + 0xC, tex_scalenum);
ovl.Write16(tex_new_addr + 0xE, tex_scalestart);
ovl.Write16(tex_new_addr + 0x10, tex_rotnum);
ovl.Write16(tex_new_addr + 0x12, tex_rotstart);
ovl.Write16(tex_new_addr + 0x14, tex_transxnum);
ovl.Write16(tex_new_addr + 0x16, tex_transxstart);
ovl.Write16(tex_new_addr + 0x18, tex_transynum);
ovl.Write16(tex_new_addr + 0x1A, tex_transystart);
string tex_matname = oldovl.ReadString(oldovl.ReadPointer(tex_old_addr + 0x4), 0);
ovl.WriteString(curoffset, tex_matname, 0);
curoffset += (uint)((tex_matname.Length + 3) & ~3);
}
uint scale_addr = oldovl.ReadPointer(texanm_addr + 0x4);
ovl.WritePointer(texanm_new_addr + 0x4, curoffset);
for (uint v = 0; v < numscale; v++)
{
ovl.Write32(curoffset, oldovl.Read32(scale_addr + (v * 4)));
curoffset += 4;
}
uint rot_addr = oldovl.ReadPointer(texanm_addr + 0x8);
ovl.WritePointer(texanm_new_addr + 0x8, curoffset);
for (uint v = 0; v < numrot; v++)
{
ovl.Write16(curoffset, oldovl.Read16(rot_addr + (v * 2)));
curoffset += 2;
}
curoffset = (uint)((curoffset + 3) & ~3);
uint trans_addr = oldovl.ReadPointer(texanm_addr + 0xC);
ovl.WritePointer(texanm_new_addr + 0xC, curoffset);
for (uint v = 0; v < numtrans; v++)
{
ovl.Write32(curoffset, oldovl.Read32(trans_addr + (v * 4)));
curoffset += 4;
}
}
else
ovl.Write32(tlists_new_addr + 0x4, 0);
ovl.Write32(tlists_new_addr + 0x8, oldovl.Read32(tlists_addr + 0x8));
tlists_new_addr += 12;
tlists_addr += 12;
}
}
// misc header pieces
// BMD and KCL file ID's
ovl.Write32(dataoffset + 0x14, oldovl.Read32(header_offset + 0x8));
ovl.Write32(dataoffset + 0x18, oldovl.Read32(header_offset + 0xC));
// minimap ICG and ICL file ID's
ovl.Write16(dataoffset + 0x22, oldovl.Read16(header_offset + 0x16));
ovl.Write8(dataoffset + 0x24, oldovl.Read8(header_offset + 0x18));
// level format and overlay initialiser versions:
// - level format version:
// -- 0: original
// -- 1: fix missing texture animation translation values
// - level initialiser verion:
// -- 0: original
// -- 1: support for "dynamic overlays" (EUR only)
ovl.Write8(dataoffset + 0x2B, Level.k_LevelFormatVersion);
}
ovl.SaveChanges();
lazyman.ReportProgress(201 + (int)((98f / 54f) * i));
}
// fix the level loader as to load from the new overlays
m_FileStream.Position = lvlload_addr_patch;
m_BinWriter.Write((uint)(lvl_start + dataoffset + 0xC));
m_FileStream.Position = lvlload_code_patch;
m_BinWriter.Write((uint)0xE1A00000);
// refill the old level header address table
// to adapt it to its new usages
m_FileStream.Position = levelptr_table;
for (uint i = 0; i < 13; i++)
{
m_BinWriter.Write((uint)0xFFFFFFFF);
m_BinWriter.Write((uint)0x00000000);
m_BinWriter.Write((uint)0x00000000);
}
m_BinWriter.Write((uint)0x00000000);
m_BinWriter.Write((uint)0x00000000);
// fix the object banks thingy
m_FileStream.Position = objbank_addr_patch;
m_BinWriter.Write((uint)(levelptr_table + 0x0200009C));
m_FileStream.Position = objbank_code_patch;
m_BinWriter.Write((uint)0xE1A07001);
// phew! what a goddamn long thing
lazyman.ReportProgress(299);
}
private void Patch_v3(BackgroundWorker lazyman)
{
// this should keep the r4 firmware from trying to decompress
// the ARM9 binary we already decompressed
m_FileStream.Position = 0x4AF4;
m_BinWriter.Write((uint)0);
m_BinWriter.Write((uint)0);
// we never know
m_FileStream.Position = 0x2C;
uint binend = m_BinReader.ReadUInt32() + 0x4000;
m_FileStream.Position = binend;
m_BinWriter.Write((uint)0);
lazyman.ReportProgress(399);
}
private void Patch_v4(BackgroundWorker lazyman)
{
// Music table address
uint music_tbl_addr = 0;
// Store locations of the music bytes (music table address, +1, +2) - update to point to within overlay
uint music_tbl_byte_1_addr = 0, music_tbl_byte_2_addr = 0, music_tbl_byte_3_addr = 0;
// Locations at which offsets into the music table are calculated
uint music_byte_1_offset = 0, music_byte_2_offset = 0, music_byte_3_offset = 0;
switch (m_Version)
{
case Version.EUR:
music_tbl_addr = 0x75768;
music_byte_1_offset = 0x2de28;
music_byte_2_offset = 0x2d184;
music_byte_3_offset = 0x2d360;
music_tbl_byte_1_addr = 0x2de60;
music_tbl_byte_2_addr = 0x2d608;
music_tbl_byte_3_addr = 0x2d644;
break;
case Version.JAP:
music_tbl_addr = 0x739d8;
music_byte_1_offset = 0x2cd80;
music_byte_2_offset = 0x2c32c;
music_byte_3_offset = 0x2c508;
music_tbl_byte_1_addr = 0x2cdb8;
music_tbl_byte_2_addr = 0x2c7b0;
music_tbl_byte_3_addr = 0x2c7ec;
break;
case Version.USA_v1:
music_tbl_addr = 0x73434;
music_byte_1_offset = 0x2caa8;
music_byte_2_offset = 0x2c058;
music_byte_3_offset = 0x2c234;
music_tbl_byte_1_addr = 0x2cae0;
music_tbl_byte_2_addr = 0x2c4d8;
music_tbl_byte_3_addr = 0x2c514;
break;
case Version.USA_v2:
music_tbl_addr = 0x74154;
music_byte_1_offset = 0x2cdbc;
music_byte_2_offset = 0x2c368;
music_byte_3_offset = 0x2c544;
music_tbl_byte_1_addr = 0x2cdf4;
music_tbl_byte_2_addr = 0x2c7ec;
music_tbl_byte_3_addr = 0x2c828;
break;
}
// Copy level music data
for (int i = 0; i < NUM_LEVELS; i++)
{
NitroOverlay ovl = new NitroOverlay(this, (uint)(NEW_LEVEL_OVERLAYS_START_INDEX + i));
m_FileStream.Position = music_tbl_addr + (i * 3);
ovl.Write8(0x7C + 0, m_BinReader.ReadByte());
ovl.Write8(0x7C + 1, m_BinReader.ReadByte());
ovl.Write8(0x7C + 2, m_BinReader.ReadByte());
ovl.SaveChanges();
lazyman.ReportProgress((int)(400 + ((99f / 52f) * i)));
}
// Patch music code to load from overlays
m_FileStream.Position = music_byte_1_offset;// Offset into table generated
m_BinWriter.Write((uint)0xe3a03000);//MOV R3, #0 ;Set offset to 0
m_FileStream.Position = music_tbl_byte_1_addr;// Stores location of music table byte 1
m_BinWriter.Write((uint)(LevelOvlOffset + 0x7C));// Write location in overlay of music data
m_FileStream.Position = music_byte_2_offset;
m_BinWriter.Write((uint)0xe3a02001);//MOV R2, #1 ;Set offset to 1
m_FileStream.Position = music_tbl_byte_2_addr;
m_BinWriter.Write((uint)(LevelOvlOffset + 0x7C));
m_FileStream.Position = music_byte_3_offset;
m_BinWriter.Write((uint)0xe3a01002);//MOV R1, #2 ;Set offset to 0
m_FileStream.Position = music_tbl_byte_3_addr;
m_BinWriter.Write((uint)(LevelOvlOffset + 0x7C));
lazyman.ReportProgress(499);
}
private void Patch_v5(BackgroundWorker lazyman)
{
// Prior to v2.3.2 it was thought that texture animations simply contained a single
// translation component with only offsets 0x14 and 0x16 in the texture animation
// header being used to determine the translation values to be copied to the new
// overlay:
// 14 2 Number of X translation values
// 16 2 Start offset in dwords of the X translations in the translation values table
// 18 2 Number of Y translation values
// 1A 2 Start offset in dwords of the Y translations in the translation values table
//
// The values at offsets 0x18 and 0x1A were still copied however in the case that their
// range fell outside that of the X translation values then the values read were simply
// whichever data came after the translation table in memory.
// This patch checks whether the Y translation values have been correctly copied, indicated
// by a value of "1" for the level format version specified at 0x7F bits 0-3 within the
// level header and if not, will replace missing Y translation values with a value of
// zero. The level is then saved with a level format version of "1". Levels whose level
// format version is already "1" will not be modified.
Level level;
for (int i = 0; i < NUM_LEVELS; i++)
{
level = new Level(i, new NitroOverlay(this, (uint)(NEW_LEVEL_OVERLAYS_START_INDEX + i)));
level.SaveChanges();
lazyman.ReportProgress((int)(500 + ((99f / 52f) * i)));
}
lazyman.ReportProgress(599);
}
public void Patch()
{
// read previous patch version
m_FileStream.Position = 0x1FC;
uint oldversion = m_BinReader.ReadUInt32();
// write patch version to the end of the ROM header
// this place should normally be zero and unused :)
m_FileStream.Position = 0x1FC;
m_BinWriter.Write(ROM_PATCH_VERSION);
BackgroundWorker lazyman = new BackgroundWorker();
ProgressDialog progdlg = new ProgressDialog("Patching ROM", (int)ROM_PATCH_VERSION, oldversion);
lazyman.WorkerReportsProgress = true;
lazyman.WorkerSupportsCancellation = false;
lazyman.DoWork += new DoWorkEventHandler(this.OnPatchRun);
lazyman.ProgressChanged += new ProgressChangedEventHandler(progdlg.RW_ProgressChanged);
lazyman.RunWorkerCompleted += new RunWorkerCompletedEventHandler(progdlg.RW_Completed);
lazyman.RunWorkerAsync(progdlg);
progdlg.ShowDialog();
if (progdlg.Error != null)
throw progdlg.Error;
// [s]fix the secure area CRC16[/s]
// what would care about this?
// also, it may be the CRC16 of the encrypted secure area...
/*m_FileStream.Position = 0x20;
uint sastart = m_BinReader.ReadUInt32();
ushort sacrc = CalcCRC16(sastart, 0x8000 - sastart);
m_FileStream.Position = 0x6C;
m_BinWriter.Write(sacrc);*/
// fix the header CRC16... we never know :P
// as an example NO$GBA won't load the ROM if this CRC16 is wrong
ushort hcrc = CalcCRC16(0, 0x15E);
m_FileStream.Position = 0x15E;
m_BinWriter.Write(hcrc);
}
public void OnPatchRun(object sender, DoWorkEventArgs e)
{
BackgroundWorker lazyman = (BackgroundWorker)sender;
ProgressDialog progdlg = (ProgressDialog)e.Argument;
uint oldversion = (uint)progdlg.UserData;
if (oldversion < 1) Patch_v1(lazyman); // patch v1: decompress the ARM9 binary to make stuff accessible easily
if (oldversion < 2) Patch_v2(lazyman); // patch v2: relocate level data to make it expandable
if (oldversion < 3) Patch_v3(lazyman); // patch v3: fix for R4/acekard flashcarts
if (oldversion < 4) Patch_v4(lazyman); // patch v4: level music data stored in and loaded from level overlays
if (oldversion < 5) Patch_v5(lazyman); // patch v5: fix missing texture animation y translation values
}
}
}