Files
SabreTools.Serialization/SabreTools.Serialization.Writers/WIA.cs
Dimensional 49aa6895b6 Dolphin lib (#85)
* 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>
2026-05-12 10:41:32 -04:00

156 lines
5.4 KiB
C#

using System.IO;
using SabreTools.Data.Models.WIA;
using SabreTools.Numerics.Extensions;
namespace SabreTools.Serialization.Writers
{
// TODO: Full round-trip write (including compressed group data) requires a source
// IBlobReader and compression pipeline. This implementation serializes only
// the structural metadata (Header1, Header2, and all lookup tables).
public class WIA : IFileWriter<DiscImage>
{
/// <inheritdoc/>
public bool Debug { get; set; } = false;
/// <inheritdoc/>
public bool SerializeFile(DiscImage? obj, string? path)
{
if (string.IsNullOrEmpty(path))
return false;
if (obj is null || !ValidateArchive(obj))
return false;
using var fs = File.Open(path, FileMode.Create, FileAccess.Write, FileShare.None);
return SerializeStream(obj, fs);
}
/// <summary>
/// Serialize the WIA / RVZ structural metadata to a stream.
/// Writes Header1, Header2, partition entries, raw data entries, and group entries.
/// The caller is responsible for writing group (compressed block) data.
/// </summary>
public bool SerializeStream(DiscImage? obj, Stream? stream)
{
if (stream is null || !stream.CanWrite)
return false;
if (obj is null || !ValidateArchive(obj))
return false;
WriteHeader1(stream, obj.Header1);
WriteHeader2(stream, obj.Header2);
// Partition entries
if (obj.PartitionEntries != null)
{
foreach (var pe in obj.PartitionEntries)
WritePartitionEntry(stream, pe);
}
// Raw data entries
foreach (var re in obj.RawDataEntries)
WriteRawDataEntry(stream, re);
// Group entries
if (obj.Header1.Magic == Constants.RvzMagic && obj.RvzGroupEntries != null)
{
foreach (var ge in obj.RvzGroupEntries)
WriteRvzGroupEntry(stream, ge);
}
else if (obj.Header1.Magic != Constants.RvzMagic && obj.GroupEntries != null)
{
foreach (var ge in obj.GroupEntries)
WriteWiaGroupEntry(stream, ge);
}
stream.Flush();
return true;
}
private static bool ValidateArchive(DiscImage obj)
{
if (obj.Header1 is null || obj.Header2 is null)
return false;
if (obj.Header1.Magic != Constants.WiaMagic && obj.Header1.Magic != Constants.RvzMagic)
return false;
return true;
}
#region Write helpers
private static void WriteHeader1(Stream s, WiaHeader1 h)
{
s.WriteLittleEndian(h.Magic);
s.WriteBigEndian(h.Version);
s.WriteBigEndian(h.VersionCompatible);
s.WriteBigEndian(h.Header2Size);
s.Write(h.Header2Hash, 0, 20);
s.WriteBigEndian(h.IsoFileSize);
s.WriteBigEndian(h.WiaFileSize);
s.Write(h.Header1Hash, 0, 20);
}
private static void WriteHeader2(Stream s, WiaHeader2 h)
{
s.WriteBigEndian((uint)h.DiscType);
s.WriteBigEndian((uint)h.CompressionType);
s.WriteBigEndian(h.CompressionLevel);
s.WriteBigEndian(h.ChunkSize);
s.Write(h.DiscHeader, 0, 0x80);
s.WriteBigEndian(h.NumberOfPartitionEntries);
s.WriteBigEndian(h.PartitionEntrySize);
s.WriteBigEndian(h.PartitionEntriesOffset);
s.Write(h.PartitionEntriesHash, 0, 20);
s.WriteBigEndian(h.NumberOfRawDataEntries);
s.WriteBigEndian(h.RawDataEntriesOffset);
s.WriteBigEndian(h.RawDataEntriesSize);
s.WriteBigEndian(h.NumberOfGroupEntries);
s.WriteBigEndian(h.GroupEntriesOffset);
s.WriteBigEndian(h.GroupEntriesSize);
s.WriteByte(h.CompressorDataSize);
s.Write(h.CompressorData, 0, 7);
}
private static void WritePartitionDataEntry(Stream s, PartitionDataEntry e)
{
s.WriteBigEndian(e.FirstSector);
s.WriteBigEndian(e.NumberOfSectors);
s.WriteBigEndian(e.GroupIndex);
s.WriteBigEndian(e.NumberOfGroups);
}
private static void WritePartitionEntry(Stream s, PartitionEntry e)
{
s.Write(e.PartitionKey, 0, 16);
WritePartitionDataEntry(s, e.DataEntry0);
WritePartitionDataEntry(s, e.DataEntry1);
}
private static void WriteRawDataEntry(Stream s, RawDataEntry e)
{
s.WriteBigEndian(e.DataOffset);
s.WriteBigEndian(e.DataSize);
s.WriteBigEndian(e.GroupIndex);
s.WriteBigEndian(e.NumberOfGroups);
}
private static void WriteWiaGroupEntry(Stream s, WiaGroupEntry e)
{
// DataOffset stored as actual_offset >> 2
s.WriteBigEndian((uint)(e.DataOffset >> 2));
s.WriteBigEndian(e.DataSize);
}
private static void WriteRvzGroupEntry(Stream s, RvzGroupEntry e)
{
// DataOffset stored as actual_offset >> 2
s.WriteBigEndian((uint)(e.DataOffset >> 2));
s.WriteBigEndian(e.DataSize);
s.WriteBigEndian(e.RvzPackedSize);
}
#endregion
}
}