mirror of
https://github.com/SabreTools/SabreTools.Serialization.git
synced 2026-07-08 18:06:41 +00:00
* Add GCZ, WIA/RVZ, and NintendoDisc (GameCube/Wii) format support
Port of DolphinIsoLib into SabreTools.Serialization architecture:
- Data.Models: GCZ/, WIA/, NintendoDisc/ model subdirectories (15 files)
- Serialization.Readers: GCZ, WIA, NintendoDisc readers
- Serialization.Writers: GCZ, WIA writers (structural metadata; full round-trip TODO)
- Wrappers: NintendoDisc, GCZ, WIA wrappers with Encryption partial class
- Wrappers: WiaRvzCompressionHelper (BZip2/LZMA/LZMA2/Zstd, net462+ guarded)
- WrapperType + WrapperFactory: GCZ, WIA, NintendoDisc entries added
GetInnerWrapper() decompression and NintendoDisc.Extraction FST extraction
are stubbed with TODO comments pending full implementation.
* Implement GetInnerWrapper for GCZ and WIA, full NintendoDisc extraction
* Add GCZ/WIA/RVZ write pipeline and Nintendo disc compression helpers
* Add WIA/RVZ table decompression, NintendoDisc/GCZ printing, NintendoDisc detection for .iso files
* Fix NintendoDisc header layout, GC magic, and add embedded disc header to WIA/GCZ printing
- Fix GCMagicWord: 0xC23D3C1F -> 0xC2339F3D (confirmed from Dolphin DiscUtils.h)
- Fix disc header field layout to match Dolphin's confirmed offsets:
MakerCode is bytes 4-5 of the 6-char GameId (no separate field at 0x006),
DiscNumber at 0x006, DiscVersion at 0x007, unused region is 14 bytes (0x00A-0x017)
- Update NintendoDisc reader: derive MakerCode from GameId[4..5], fix skip count
- Add ParseDiscHeaderOnly() to reader for partial (short) stream parsing
- Guard DisableHash/DisableEnc reads at the 0x080 boundary for 128-byte embedded headers
- Guard DOL/FST skip for streams shorter than full 0x440 boot block
- Fix WrapperFactory: NintendoDisc magic detection now precedes .iso -> ISO9660 fallback
- Add GameId-prefix heuristic in WrapperFactory for GC discs lacking magic word
- Add GameId-prefix platform fallback in reader for GC discs without GCMagicWord
- Add DiscHeader property to WIA wrapper (parsed from Header2.DiscHeader bytes)
- Add DiscHeader property to GCZ wrapper (decompresses first block only)
- Add ReadDiscHeader() helper to GCZ for lightweight first-block decompression
- Print embedded disc header (Game ID, Maker, Disc/Rev, Title) in WIA.Printing.cs and GCZ.Printing.cs
* Fix Wii partition extraction: correct IV, FST size shift, partition naming
- Block decryption: IV is at raw block offset 0x3D0 (still-encrypted),
matching Dolphin/DolphinIsoLib WiiPartitionDecryptor.DecryptBlock exactly.
- FST size field at boot.bin 0x428 is also stored >>2 on Wii; apply <<2
to get true byte size.
- Partition folder naming now matches DolphinIsoLib WiiDiscExtractor exactly:
type 0->GM+n, 1->UP+n, 2->CH+n, printable ASCII unknown->raw 4-char string,
non-printable->P{index}. SSBB VC channels extract as HA8E, HA9E, etc.
- ExtractionTool peek buffer increased from 16 to 32 bytes.
Verified: SSBB GM0 extracts 5524 files, boot.bin/fst.bin byte-identical
to Dolphin reference extraction.
* Fix FST extraction: create zero-byte files instead of skipping them
Files with fileSize=0 in the FST were silently skipped. Now they are
created as empty files, matching Dolphin/DolphinIsoLib behavior.
Verified: SSBB now extracts 5958 files with 0 missing, 0 extra,
0 size mismatches, and 0 hash mismatches vs DolphinIsoLib reference.
* Add GCZ/WIA/RVZ virtual stream extraction via NintendoDisc wrapper
* Address PR #85 review comments (Copilot + mnadareski)
* Address PR #85 review comments
* Replace custom endian helpers and SHA1 with SabreTools.IO equivalents
* Update GCZ.Printing.cs
* Update NintendoDisc.Printing.cs
* Update WIA.Printing.cs
* Add WIA/RVZ Wii partition crypto round-trip support
- Add AesCbc internal helper (BouncyCastle AES-CBC encrypt/decrypt)
- Add NintendoDisc.CommonKeyProvider hook for injectable test keys
- Fix sha1.Terminate() missing in all three ComputeSha1 helpers in WIA.cs
- Fix Wii partition dataOff alignment to 0x8000 boundary
- Add WIA.EncryptWiiGroup (internal) for re-encrypting plaintext groups
- Add WIA.DumpIso to WIA.Writing.cs (WIA/RVZ -> flat ISO conversion)
- Add WiaVirtualStream on-demand group decompression
- Add _preDecryptedReader bypass on NintendoDisc for WIA extraction path
- Add WIATests.cs with Wii crypto round-trip test using synthetic data
- Move DumpIso from WIA.Extraction.cs to WIA.Writing.cs
- Bump DumpIso read buffer from 1 MiB to 2 MiB (aligns to WIA chunk size)
- Add InternalsVisibleTo SabreTools.Wrappers.Test in csproj
* Remove hardcoded Wii common keys from NintendoDisc.Encryption
- Delete the embedded WiiCommonKeyRetail and WiiCommonKeyKorean byte
arrays from NintendoDisc.Encryption.cs.
- Make CommonKeyProvider public so any caller (not just tests) can
inject keys; DecryptTitleKey now returns null when no key is
available for the requested index rather than falling back to
hardcoded values.
- Add NintendoDiscEncryptionTests.cs:
- Argument guard and no-provider tests for DecryptTitleKey.
- Fake-key round-trip test (encrypt then decrypt with injected key).
- Integration test that reads TestData/NintendoDisc/keys.json,
verifies each key against hardcoded SHA256 constants, and skips
silently if the file is absent or the keys do not match.
- LoadKeyProvider helper (named JSON format, index-keyed).
- Add [Collection(NintendoDisc)] to both NintendoDiscEncryptionTests
and WIATests to prevent parallel access to the static
CommonKeyProvider from racing between test classes.
- Add TestData/NintendoDisc/keys.json.example documenting the
expected key file format.
- Add Newtonsoft.Json reference to SabreTools.Wrappers.Test.csproj.
* Didn't actually commit the changes. My bad. Fixed.
* Edited a comment
* Added in XUnit outputs that show up in Test Viewer in VS
---------
Co-authored-by: Matt Nadareski <mnadareski@outlook.com>
195 lines
7.2 KiB
C#
195 lines
7.2 KiB
C#
using System.IO;
|
|
using SabreTools.Data.Models.WIA;
|
|
using SabreTools.IO.Extensions;
|
|
using SabreTools.Numerics.Extensions;
|
|
|
|
#pragma warning disable IDE0017 // Simplify object initialization
|
|
namespace SabreTools.Serialization.Readers
|
|
{
|
|
public class WIA : BaseBinaryReader<DiscImage>
|
|
{
|
|
/// <inheritdoc/>
|
|
public override DiscImage? Deserialize(Stream? data)
|
|
{
|
|
// If the data is invalid
|
|
if (data is null || !data.CanRead)
|
|
return null;
|
|
|
|
// Need at least Header1
|
|
if (data.Length - data.Position < Constants.Header1Size)
|
|
return null;
|
|
|
|
try
|
|
{
|
|
long initialOffset = data.Position;
|
|
|
|
var archive = new DiscImage();
|
|
|
|
// Parse Header1
|
|
archive.Header1 = ParseHeader1(data);
|
|
|
|
// Validate magic
|
|
if (archive.Header1.Magic != Constants.WiaMagic && archive.Header1.Magic != Constants.RvzMagic)
|
|
return null;
|
|
|
|
// Parse Header2
|
|
archive.Header2 = ParseHeader2(data);
|
|
|
|
// Parse partition entries (Wii discs only)
|
|
if (archive.Header2.NumberOfPartitionEntries > 0
|
|
&& archive.Header2.PartitionEntriesOffset > 0)
|
|
{
|
|
data.Seek(initialOffset + (long)archive.Header2.PartitionEntriesOffset, SeekOrigin.Begin);
|
|
archive.PartitionEntries = ParsePartitionEntries(
|
|
data, (int)archive.Header2.NumberOfPartitionEntries);
|
|
}
|
|
|
|
// Parse raw data entries
|
|
if (archive.Header2.NumberOfRawDataEntries > 0
|
|
&& archive.Header2.RawDataEntriesOffset > 0)
|
|
{
|
|
data.Seek(initialOffset + (long)archive.Header2.RawDataEntriesOffset, SeekOrigin.Begin);
|
|
archive.RawDataEntries = ParseRawDataEntries(
|
|
data, (int)archive.Header2.NumberOfRawDataEntries);
|
|
}
|
|
|
|
// Parse group entries
|
|
if (archive.Header2.NumberOfGroupEntries > 0
|
|
&& archive.Header2.GroupEntriesOffset > 0)
|
|
{
|
|
data.Seek(initialOffset + (long)archive.Header2.GroupEntriesOffset, SeekOrigin.Begin);
|
|
if (archive.Header1.Magic == Constants.RvzMagic)
|
|
archive.RvzGroupEntries = ParseRvzGroupEntries(
|
|
data, (int)archive.Header2.NumberOfGroupEntries);
|
|
else
|
|
archive.GroupEntries = ParseWiaGroupEntries(
|
|
data, (int)archive.Header2.NumberOfGroupEntries);
|
|
}
|
|
|
|
return archive;
|
|
}
|
|
catch
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
|
|
#region Header parsing
|
|
|
|
private static WiaHeader1 ParseHeader1(Stream data)
|
|
{
|
|
var h = new WiaHeader1();
|
|
h.Magic = data.ReadUInt32LittleEndian();
|
|
h.Version = data.ReadUInt32BigEndian();
|
|
h.VersionCompatible = data.ReadUInt32BigEndian();
|
|
h.Header2Size = data.ReadUInt32BigEndian();
|
|
h.Header2Hash = data.ReadBytes(20);
|
|
h.IsoFileSize = data.ReadUInt64BigEndian();
|
|
h.WiaFileSize = data.ReadUInt64BigEndian();
|
|
h.Header1Hash = data.ReadBytes(20);
|
|
return h;
|
|
}
|
|
|
|
private static WiaHeader2 ParseHeader2(Stream data)
|
|
{
|
|
var h = new WiaHeader2();
|
|
h.DiscType = (WiaDiscType)data.ReadUInt32BigEndian();
|
|
h.CompressionType = (WiaRvzCompressionType)data.ReadUInt32BigEndian();
|
|
h.CompressionLevel = data.ReadInt32BigEndian();
|
|
h.ChunkSize = data.ReadUInt32BigEndian();
|
|
h.DiscHeader = data.ReadBytes(0x80);
|
|
h.NumberOfPartitionEntries = data.ReadUInt32BigEndian();
|
|
h.PartitionEntrySize = data.ReadUInt32BigEndian();
|
|
h.PartitionEntriesOffset = data.ReadUInt64BigEndian();
|
|
h.PartitionEntriesHash = data.ReadBytes(20);
|
|
h.NumberOfRawDataEntries = data.ReadUInt32BigEndian();
|
|
h.RawDataEntriesOffset = data.ReadUInt64BigEndian();
|
|
h.RawDataEntriesSize = data.ReadUInt32BigEndian();
|
|
h.NumberOfGroupEntries = data.ReadUInt32BigEndian();
|
|
h.GroupEntriesOffset = data.ReadUInt64BigEndian();
|
|
h.GroupEntriesSize = data.ReadUInt32BigEndian();
|
|
h.CompressorDataSize = data.ReadByteValue();
|
|
h.CompressorData = data.ReadBytes(7);
|
|
return h;
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Table parsing
|
|
|
|
private static PartitionEntry[] ParsePartitionEntries(Stream data, int count)
|
|
{
|
|
var entries = new PartitionEntry[count];
|
|
for (int i = 0; i < count; i++)
|
|
{
|
|
var e = new PartitionEntry();
|
|
e.PartitionKey = data.ReadBytes(16);
|
|
e.DataEntry0 = ParsePartitionDataEntry(data);
|
|
e.DataEntry1 = ParsePartitionDataEntry(data);
|
|
entries[i] = e;
|
|
}
|
|
|
|
return entries;
|
|
}
|
|
|
|
private static PartitionDataEntry ParsePartitionDataEntry(Stream data)
|
|
{
|
|
var e = new PartitionDataEntry();
|
|
e.FirstSector = data.ReadUInt32BigEndian();
|
|
e.NumberOfSectors = data.ReadUInt32BigEndian();
|
|
e.GroupIndex = data.ReadUInt32BigEndian();
|
|
e.NumberOfGroups = data.ReadUInt32BigEndian();
|
|
return e;
|
|
}
|
|
|
|
private static RawDataEntry[] ParseRawDataEntries(Stream data, int count)
|
|
{
|
|
var entries = new RawDataEntry[count];
|
|
for (int i = 0; i < count; i++)
|
|
{
|
|
var e = new RawDataEntry();
|
|
e.DataOffset = data.ReadUInt64BigEndian();
|
|
e.DataSize = data.ReadUInt64BigEndian();
|
|
e.GroupIndex = data.ReadUInt32BigEndian();
|
|
e.NumberOfGroups = data.ReadUInt32BigEndian();
|
|
entries[i] = e;
|
|
}
|
|
|
|
return entries;
|
|
}
|
|
|
|
private static WiaGroupEntry[] ParseWiaGroupEntries(Stream data, int count)
|
|
{
|
|
var entries = new WiaGroupEntry[count];
|
|
for (int i = 0; i < count; i++)
|
|
{
|
|
var e = new WiaGroupEntry();
|
|
// DataOffset stored as actual_offset >> 2
|
|
e.DataOffset = (ulong)data.ReadUInt32BigEndian() << 2;
|
|
e.DataSize = data.ReadUInt32BigEndian();
|
|
entries[i] = e;
|
|
}
|
|
|
|
return entries;
|
|
}
|
|
|
|
private static RvzGroupEntry[] ParseRvzGroupEntries(Stream data, int count)
|
|
{
|
|
var entries = new RvzGroupEntry[count];
|
|
for (int i = 0; i < count; i++)
|
|
{
|
|
var e = new RvzGroupEntry();
|
|
// DataOffset stored as actual_offset >> 2
|
|
e.DataOffset = (ulong)data.ReadUInt32BigEndian() << 2;
|
|
e.DataSize = data.ReadUInt32BigEndian();
|
|
e.RvzPackedSize = data.ReadUInt32BigEndian();
|
|
entries[i] = e;
|
|
}
|
|
|
|
return entries;
|
|
}
|
|
|
|
#endregion
|
|
}
|
|
}
|