Support reading the installed game off the SD card directly

Extensions/TkSharp.Extensions.LibHac/Extensions/FileSystemExtensions.cs

@@ -17,6 +17,10 @@ public static class FileSystemExtensions
 {
     public static SwitchFs GetSwitchFs(this IStorage storage, string filePath, KeySet keys)
     {
+        if (storage is ConcatenationStorage) {
+            return IsXci(storage) ? OpenXci(keys, storage) : OpenNsp(keys, storage);
+        }
+
         ReadOnlySpan<char> extension = Path.GetExtension(filePath.AsSpan());
 
         return extension switch {
@@ -25,7 +29,14 @@ public static SwitchFs GetSwitchFs(this IStorage storage, string filePath, KeySe
             _ => throw new ArgumentException($"Unsupported file extension: '{extension}'", nameof(filePath)),
         };
     }
-
+
+    private static bool IsXci(IStorage storage)
+    {
+        Span<byte> buffer = stackalloc byte[4];
+        storage.Read(0x100, buffer).ThrowIfFailure();
+        return buffer.SequenceEqual("HEAD"u8);
+    }
+
     private static SwitchFs OpenNsp(KeySet keys, IStorage storage)
     {
         SharedRef<IStorage> storageShared = new(storage);

Extensions/TkSharp.Extensions.LibHac/Helpers/FileRomHelper.cs

@@ -0,0 +1,25 @@
+using LibHac.Common.Keys;
+using LibHac.Fs;
+using LibHac.FsSystem;
+using LibHac.Tools.Fs;
+using TkSharp.Extensions.LibHac.Extensions;
+
+namespace TkSharp.Extensions.LibHac.Helpers
+{
+    public class FileRomHelper : ILibHacRomHelper
+    {
+        private IStorage? _storage;
+
+        public SwitchFs Initialize(string filePath, KeySet keys)
+        {
+            _storage = new LocalStorage(filePath, FileAccess.Read);
+            return _storage.GetSwitchFs(filePath, keys);
+        }
+
+        public void Dispose()
+        {
+            _storage?.Dispose();
+            GC.SuppressFinalize(this);
+        }
+    }
+} 

Extensions/TkSharp.Extensions.LibHac/Helpers/ILibHacRomHelper.cs

@@ -0,0 +1,9 @@
+using LibHac.Common.Keys;
+using LibHac.Tools.Fs;
+
+namespace TkSharp.Extensions.LibHac.Helpers;
+
+public interface ILibHacRomHelper : IDisposable
+{
+    SwitchFs Initialize(string path, KeySet keys);
+}

Extensions/TkSharp.Extensions.LibHac/Helpers/SdRomHelper.cs

@@ -0,0 +1,37 @@
+using LibHac.Common;
+using LibHac.Common.Keys;
+using LibHac.Fs;
+using LibHac.Fs.Fsa;
+using LibHac.FsSystem;
+using LibHac.Tools.Fs;
+using LibHac.Tools.FsSystem;
+
+namespace TkSharp.Extensions.LibHac.Helpers;
+
+public class SdRomHelper : ILibHacRomHelper
+{
+    private UniqueRef<IAttributeFileSystem> _localFsRef;
+
+    public SwitchFs Initialize(string sdCardPath, KeySet keys)
+    {
+        LocalFileSystem.Create(out LocalFileSystem? localFs, sdCardPath).ThrowIfFailure();
+        _localFsRef = new UniqueRef<IAttributeFileSystem>(localFs);
+
+        var concatFs = new ConcatenationFileSystem(ref _localFsRef);
+
+        using var contentDirPath = new global::LibHac.Fs.Path();
+        PathFunctions.SetUpFixedPath(ref contentDirPath.Ref(), "/Nintendo/Contents"u8).ThrowIfFailure();
+
+        var contentDirFs = new SubdirectoryFileSystem(concatFs);
+        contentDirFs.Initialize(in contentDirPath).ThrowIfFailure();
+
+        var encFs = new AesXtsFileSystem(contentDirFs, keys.SdCardEncryptionKeys[1].DataRo.ToArray(), 0x4000);
+        return new SwitchFs(keys, encFs, null);
+    }
+
+    public void Dispose()
+    {
+        _localFsRef.Destroy();
+        GC.SuppressFinalize(this);
+    }
+}

Extensions/TkSharp.Extensions.LibHac/Helpers/SplitRomHelper.cs

@@ -0,0 +1,30 @@
+using LibHac.Common.Keys;
+using LibHac.Fs;
+using LibHac.FsSystem;
+using LibHac.Tools.FsSystem;
+using LibHac.Tools.Fs;
+using TkSharp.Extensions.LibHac.Extensions;
+
+namespace TkSharp.Extensions.LibHac.Helpers
+{
+    public class SplitRomHelper : ILibHacRomHelper
+    {
+        private ConcatenationStorage? _storage;
+
+        public SwitchFs Initialize(string splitDirectory, KeySet keys)
+        {
+            IList<IStorage> splitFiles = [.. Directory.EnumerateFiles(splitDirectory)
+                .OrderBy(f => f)
+                .Select(f => new LocalStorage(f, FileAccess.Read))];
+
+            _storage = new ConcatenationStorage(splitFiles, true);
+            return _storage.GetSwitchFs("rom", keys);
+        }
+
+        public void Dispose()
+        {
+            _storage?.Dispose();
+            GC.SuppressFinalize(this);
+        }
+    }
+} 

Extensions/TkSharp.Extensions.LibHac/LibHacRomProvider.cs

@@ -0,0 +1,71 @@
+using LibHac.Common.Keys;
+using LibHac.Fs.Fsa;
+using LibHac.Tools.Fs;
+using LibHac.Tools.FsSystem;
+using LibHac.Tools.FsSystem.NcaUtils;
+using TkSharp.Core;
+using TkSharp.Extensions.LibHac.Helpers;
+
+namespace TkSharp.Extensions.LibHac;
+
+public class LibHacRomProvider : IDisposable
+{
+    public const ulong EX_KING_APP_ID = 0x0100F2C0115B6000;
+
+    private SwitchFs? _baseFs;
+    private SwitchFs? _updateFs;
+    private IFileSystem? _fileSystem;
+    private ILibHacRomHelper? _helper;
+
+    public TkRom CreateRom(TkChecksums checksums, KeySet keys, LibHacRomSourceType baseSourceType, string basePath, LibHacRomSourceType updateSourceType, string updatePath)
+    {
+        if (baseSourceType is LibHacRomSourceType.SdCard && updateSourceType is LibHacRomSourceType.SdCard && basePath == updatePath) {
+            _helper = new SdRomHelper();
+            _baseFs = _helper.Initialize(basePath, keys);
+            _fileSystem = InitializeLayeredFs(_baseFs, _baseFs);
+        }
+        else {
+            _baseFs = CreateSwitchFs(baseSourceType, basePath, keys);
+            _updateFs = CreateSwitchFs(updateSourceType, updatePath, keys);
+            _fileSystem = InitializeLayeredFs(_baseFs, _updateFs);
+        }
+
+        return new TkRom(checksums, _fileSystem);
+    }
+
+    private SwitchFs CreateSwitchFs(LibHacRomSourceType sourceType, string path, KeySet keys)
+    {
+        _helper = sourceType switch {
+            LibHacRomSourceType.File => new FileRomHelper(),
+            LibHacRomSourceType.SdCard => new SdRomHelper(),
+            LibHacRomSourceType.SplitFiles => new SplitRomHelper(),
+            _ => throw new ArgumentException($"Invalid source: {sourceType}")
+        };
+
+        return _helper.Initialize(path, keys);
+    }
+
+    private static IFileSystem InitializeLayeredFs(SwitchFs baseFs, SwitchFs updateFs)
+    {
+        return baseFs.Applications[EX_KING_APP_ID].Main.MainNca.Nca
+            .OpenFileSystemWithPatch(updateFs.Applications[EX_KING_APP_ID].Patch.MainNca.Nca,
+                NcaSectionType.Data, IntegrityCheckLevel.ErrorOnInvalid);
+    }
+
+    public void Dispose()
+    {
+        _fileSystem?.Dispose();
+        _baseFs?.Dispose();
+        _updateFs?.Dispose();
+        _helper?.Dispose();
+
+        GC.SuppressFinalize(this);
+    }
+}
+
+public enum LibHacRomSourceType
+{
+    File, // XCI or NSP file
+    SdCard, // From SD card
+    SplitFiles // Split files in a directory
+}

Extensions/TkSharp.Extensions.LibHac/PackedTkRom.cs → Extensions/TkSharp.Extensions.LibHac/TkRom.cs

@@ -1,26 +1,15 @@
 using LibHac.Common;
-using LibHac.Common.Keys;
 using LibHac.Fs;
 using LibHac.Fs.Fsa;
-using LibHac.FsSystem;
-using LibHac.Tools.Fs;
-using LibHac.Tools.FsSystem;
-using LibHac.Tools.FsSystem.NcaUtils;
 using TkSharp.Core;
 using TkSharp.Core.IO.Buffers;
 using TkSharp.Core.IO.Parsers;
 using TkSharp.Extensions.LibHac.Extensions;
-using Path = System.IO.Path;
 
 namespace TkSharp.Extensions.LibHac;
 
-public sealed class PackedTkRom : ITkRom, IDisposable
+public class TkRom : ITkRom, IDisposable
 {
-    public const ulong EX_KING_APP_ID = 0x0100F2C0115B6000;
-
-    private readonly IStorage _baseStorage, _updateStorage;
-    private readonly SwitchFs _baseSwitchFs, _updateSwitchFs;
-
     private readonly TkChecksums _checksums;
     private readonly IFileSystem _fileSystem;
 
@@ -36,46 +25,33 @@ public sealed class PackedTkRom : ITkRom, IDisposable
 
     public Dictionary<string, string>.AlternateLookup<ReadOnlySpan<char>> EffectVersions { get; }
 
-    public PackedTkRom(TkChecksums checksums, KeySet keys, string baseGameFilePath, string gameUpdateFilePath)
+    public TkRom(TkChecksums checksums, IFileSystem fileSystem)
     {
         _checksums = checksums;
+        _fileSystem = fileSystem;
 
-        _baseStorage = new LocalStorage(baseGameFilePath, FileAccess.Read);
-        _baseSwitchFs = _baseStorage.GetSwitchFs(baseGameFilePath, keys);
-
-        _updateStorage = new LocalStorage(gameUpdateFilePath, FileAccess.Read);
-        _updateSwitchFs = _updateStorage.GetSwitchFs(gameUpdateFilePath, keys);
-
-        _fileSystem = _baseSwitchFs.Applications[EX_KING_APP_ID].Main.MainNca.Nca
-            .OpenFileSystemWithPatch(_updateSwitchFs.Applications[EX_KING_APP_ID].Patch.MainNca.Nca, NcaSectionType.Data, IntegrityCheckLevel.ErrorOnInvalid);
-
-        {
-            using Stream regionLangMaskFs = _fileSystem.OpenFileStream("/System/RegionLangMask.txt");
-            using RentedBuffer<byte> regionLangMask = RentedBuffer<byte>.Allocate(regionLangMaskFs);
+        using (Stream regionLangMaskFs = _fileSystem.OpenFileStream("/System/RegionLangMask.txt"))
+        using (RentedBuffer<byte> regionLangMask = RentedBuffer<byte>.Allocate(regionLangMaskFs)) {
             GameVersion = RegionLangMaskParser.ParseVersion(regionLangMask.Span, out string nsoBinaryId);
             NsoBinaryId = nsoBinaryId;
         }
 
-        {
-            using Stream zsDicFs = _fileSystem.OpenFileStream("/Pack/ZsDic.pack.zs");
+        using (Stream zsDicFs = _fileSystem.OpenFileStream("/Pack/ZsDic.pack.zs")) {
             Zstd = new TkZstd(zsDicFs);
         }
 
-        {
-            using Stream addressTableFs = _fileSystem.OpenFileStream($"/System/AddressTable/Product.{GameVersion}.Nin_NX_NVN.atbl.byml.zs");
-            using RentedBuffer<byte> addressTableBuffer = RentedBuffer<byte>.Allocate(addressTableFs);
+        using (Stream addressTableFs = _fileSystem.OpenFileStream($"/System/AddressTable/Product.{GameVersion}.Nin_NX_NVN.atbl.byml.zs"))
+        using (RentedBuffer<byte> addressTableBuffer = RentedBuffer<byte>.Allocate(addressTableFs)) {
             AddressTable = AddressTableParser.ParseAddressTable(addressTableBuffer.Span, Zstd);
         }
 
-        {
-            using Stream eventFlowFileEntryFs = _fileSystem.OpenFileStream($"/{AddressTable["Event/EventFlow/EventFlowFileEntry.Product.byml"]}.zs");
-            using RentedBuffer<byte> eventFlowFileEntryBuffer = RentedBuffer<byte>.Allocate(eventFlowFileEntryFs);
+        using (Stream eventFlowFileEntryFs = _fileSystem.OpenFileStream($"/{AddressTable["Event/EventFlow/EventFlowFileEntry.Product.byml"]}.zs"))
+        using (RentedBuffer<byte> eventFlowFileEntryBuffer = RentedBuffer<byte>.Allocate(eventFlowFileEntryFs)) {
             EventFlowVersions = EventFlowFileEntryParser.ParseFileEntry(eventFlowFileEntryBuffer.Span, Zstd);
         }
 
-        {
-            using Stream effectInfoFs = _fileSystem.OpenFileStream($"/{AddressTable["Effect/EffectFileInfo.Product.Nin_NX_NVN.byml"]}.zs");
-            using RentedBuffer<byte> effectInfoBuffer = RentedBuffer<byte>.Allocate(effectInfoFs);
+        using (Stream effectInfoFs = _fileSystem.OpenFileStream($"/{AddressTable["Effect/EffectFileInfo.Product.Nin_NX_NVN.byml"]}.zs"))
+        using (RentedBuffer<byte> effectInfoBuffer = RentedBuffer<byte>.Allocate(effectInfoFs)) {
             EffectVersions = EffectInfoParser.ParseFileEntry(effectInfoBuffer.Span, Zstd);
         }
     }
@@ -87,7 +63,8 @@ public RentedBuffer<byte> GetVanilla(string relativeFilePath)
         UniqueRef<IFile> file = new();
         _fileSystem.OpenFile(ref file, relativeFilePath.ToU8Span(), OpenMode.Read);
 
-        if (!file.HasValue) {
+        if (!file.HasValue)
+        {
             return default;
         }
 
@@ -97,16 +74,19 @@ public RentedBuffer<byte> GetVanilla(string relativeFilePath)
         file.Get.Read(out _, offset: 0, raw);
         file.Destroy();
 
-        if (!TkZstd.IsCompressed(raw)) {
+        if (!TkZstd.IsCompressed(raw))
+        {
             return rawBuffer;
         }
 
-        try {
+        try
+        {
             RentedBuffer<byte> decompressed = RentedBuffer<byte>.Allocate(TkZstd.GetDecompressedSize(raw)); 
             Zstd.Decompress(raw, decompressed.Span);
             return decompressed;
         }
-        finally {
+        finally
+        {
             rawBuffer.Dispose();
         }
     }
@@ -118,10 +98,7 @@ public bool IsVanilla(ReadOnlySpan<char> canonical, Span<byte> src, int fileVers
 
     public void Dispose()
     {
-        _baseStorage.Dispose();
-        _updateStorage.Dispose();
-        _baseSwitchFs.Dispose();
-        _updateSwitchFs.Dispose();
         _fileSystem.Dispose();
+        GC.SuppressFinalize(this);
     }
-}
+} 

TkSharp.Debug/DebugRomProvider.cs

@@ -1,22 +1,40 @@
+using LibHac.Common.Keys;
+using LibHac.FsSystem;
+using LibHac.Tools.FsSystem;
 using TkSharp.Core;
 using TkSharp.Core.Common;
-using TkSharp.Core.IO;
 using TkSharp.Data.Embedded;
+using TkSharp.Extensions.LibHac;
 
 namespace TkSharp.Debug;
 
-public sealed class DebugRomProvider : Singleton<DebugRomProvider>, ITkRomProvider
+public sealed class DebugRomProvider : Singleton<DebugRomProvider>, ITkRomProvider, IDisposable
 {
+    private LibHacRomProvider? _romProvider;
+
     public ITkRom GetRom()
     {
-        return new ExtractedTkRom(@"F:\Games\RomFS\Totk\1.2.1",
-            TkChecksums.FromStream(TkEmbeddedDataSource.GetChecksumsBin())
-        );
+        // return new ExtractedTkRom(@"F:\Games\RomFS\Totk\1.2.1",
+        //     TkChecksums.FromStream(TkEmbeddedDataSource.GetChecksumsBin())
+        // );
 
         // return new PackedTkRom(
         //     TkChecksums.FromStream(TkEmbeddedDataSource.GetChecksumsBin()),
         //     @"C:\Users\ArchLeaders\AppData\Roaming\Ryujinx\system",
         //     @"D:\Games\Emulation\Packaged\Tears-of-the-Kingdom\TotK-1.0.0.xci",
         //     @"D:\Games\Emulation\Packaged\Tears-of-the-Kingdom\TotK-1.2.1.nsp");
+
+        _romProvider = new LibHacRomProvider();
+        return _romProvider.CreateRom(
+            TkChecksums.FromStream(TkEmbeddedDataSource.GetChecksumsBin()),
+            ExternalKeyReader.ReadKeyFile(@"F:\TOTK\SDCardTest\switch\prod.keys", @"F:\TOTK\SDCardTest\switch\title.keys"),
+            LibHacRomSourceType.SplitFiles, @"F:\TOTK\SDCardTest\TOTKSPLIT",
+            LibHacRomSourceType.SdCard, @"F:\TOTK\SDCardTest");
+    }
+
+    public void Dispose()
+    {
+        _romProvider?.Dispose();
+        _romProvider = null;
     }
-}
+}