Support optional header in STFS, fix endianness in Descriptor (#80)

* Fix endianness in STFS Descriptor

* Support optional header for installer packages

* Fix field types

* Fix syntax

* Fix build

SabreTools.Data.Models/STFS/Constants.cs

@@ -34,8 +34,33 @@ namespace SabreTools.Data.Models.STFS
         public const string MagicStringCON = "CON ";
 
         /// <summary>
-        /// Standard length of an STFS header
+        /// Standard length of all fixed STFS header fields
         /// </summary>
-        public const uint StandardHeaderSize = 0xB000;
+        public const uint MinimumHeaderSize = 0x971A;
+
+        /// <summary>
+        /// System Update installer type magic string
+        /// </summary>
+        public const string InstallerTypeSystemUpdate = "SUPD";
+
+        /// <summary>
+        /// Title Update installer type magic string
+        /// </summary>
+        public const string InstallerTypeTitleUpdate = "TUPD";
+
+        /// <summary>
+        /// System Update Cache installer type magic string
+        /// </summary>
+        public const string InstallerTypeSystemUpdateCache = "P$SU";
+
+        /// <summary>
+        /// Title Update Cache installer type magic string
+        /// </summary>
+        public const string InstallerTypeTitleUpdateCache = "P$TU";
+
+        /// <summary>
+        /// Title Content Cache installer type magic string
+        /// </summary>
+        public const string InstallerTypeTitleContentCache = "P$TC";
     }
 }

SabreTools.Data.Models/STFS/Enums.cs

@@ -58,4 +58,17 @@ namespace SabreTools.Data.Models.XenonExecutable
         DEVICE_ID_TRANSFER = 0x00000040,
         PROFILE_ID_TRANSFER = 0x00000080,
     }
+
+    /// <summary>
+    /// Installer cache package resume state
+    /// </summary>
+    public enum ResumeState : uint
+    {
+        FILE_HEADERS_NOT_READY = 0x46494C48,
+        NEW_FOLDER = 0x666F6C64,
+        NEW_FOLDER_RESUME_ATTEMPT_1 = 0x666F6C31,
+        NEW_FOLDER_RESUME_ATTEMPT_2 = 0x666F6C32,
+        NEW_FOLDER_RESUME_ATTEMPT_UNKNOWN = 0x666F6C3F,
+        NEW_FOLDER_RESUME_ATTEMPT_SPECIFIC = 0x666F6C40,
+    }
 }

SabreTools.Data.Models/STFS/Header.cs

@@ -34,8 +34,8 @@ namespace SabreTools.Data.Models.STFS
         public byte[] HeaderHash { get; set; } = new byte[20];
 
         /// <summary>
-        /// Size of the header, in bytes (from ??? to ???)
-        /// The actual end of header is padded and zeroed up until next multiple of 4096 bytes
+        /// Size of the header, in bytes (from start of file)
+        /// The actual end of header is padded and zeroed up until next block (multiple of 4096 bytes)
         /// </summary>
         /// <remarks>Big-endian</remarks>
         public uint HeaderSize { get; set; }
@@ -274,5 +274,10 @@ namespace SabreTools.Data.Models.STFS
         /// </summary>
         /// <remarks>If present, 768 bytes, UTF-8 string</remarks>
         public byte[]? AdditionalDisplayDescriptions { get; set; }
+
+        /// <summary>
+        /// Optional field present on installer update/cache packages
+        /// </summary>
+        public InstallerHeader? InstallerHeader { get; set; }
     }
 }

SabreTools.Data.Models/STFS/InstallerCacheHeader.cs

@@ -0,0 +1,41 @@
+using SabreTools.Numerics;
+
+namespace SabreTools.Data.Models.STFS
+{
+    /// <summary>
+    /// STFS Volume Descriptor, for System or Title Cache Installer STFS packages
+    /// </summary>
+    public class InstallerCacheHeader : InstallerHeader
+    {
+        /// <summary>
+        /// Resume state enum
+        /// See Enums.ResumeState
+        /// </summary>
+        /// <remarks>If present, 4 bytes</remarks>
+        public uint ResumeState { get; set; }
+
+        /// <summary>
+        /// Current file index
+        /// </summary>
+        /// <remarks>Big-endian</remarks>
+        public ulong CurrentFileIndex { get; set; }
+
+        /// <summary>
+        /// Number of bytes processed
+        /// </summary>
+        /// <remarks>Big-endian</remarks>
+        public ulong BytesProcessed { get; set; }
+
+        /// <summary>
+        /// Datetime for last modified
+        /// </summary>
+        /// <remarks>Microsoft FILETIME, Big-endian, 8 bytes</remarks>
+        public long LastModifiedDateTime { get; set; }
+
+        /// <summary>
+        /// Cache resume data
+        /// </summary>
+        /// <remarks>5584 bytes</remarks>
+        public byte[] ResumeData { get; set; } = new byte[5584];
+    }
+}

SabreTools.Data.Models/STFS/InstallerHeader.cs

@@ -0,0 +1,16 @@
+namespace SabreTools.Data.Models.STFS
+{
+    /// <summary>
+    /// STFS Optional header present in STFS packages for installers
+    /// Original research, field not mentioned on free60 wiki
+    /// </summary>
+    public class InstallerHeader
+    {
+        /// <summary>
+        /// String indicating type of installer
+        /// See Constants.InstallerType*
+        /// </summary>
+        /// <remarks>4 bytes, ASCII</remarks>
+        public byte[] InstallerType { get; set; } = new byte[4];
+    }
+}

SabreTools.Data.Models/STFS/InstallerUpdateHeader.cs

@@ -0,0 +1,22 @@
+using SabreTools.Numerics;
+
+namespace SabreTools.Data.Models.STFS
+{
+    /// <summary>
+    /// STFS Volume Descriptor, for System or Title Update Installer STFS packages
+    /// </summary>
+    public class InstallerUpdateHeader : InstallerHeader
+    {
+        /// <summary>
+        /// Field for base version number, major.minor.build.revision
+        /// </summary>
+        /// <remarks>4 bytes</remarks>
+        public uint InstallerBaseVersion { get; set; }
+
+        /// <summary>
+        /// Field for version number number, major.minor.build.revision
+        /// </summary>
+        /// <remarks>4 bytes</remarks>
+        public uint InstallerVersion { get; set; }
+    }
+}

SabreTools.Data.Models/STFS/STFSDescriptor.cs

@@ -26,13 +26,13 @@ namespace SabreTools.Data.Models.STFS
         /// <summary>
         /// File Table Block Count
         /// </summary>
-        /// <remarks>Big-endian</remarks>
+        /// <remarks>Little-endian</remarks>
         public short FileTableBlockCount { get; set; }
 
         /// <summary>
         /// File Table Block Number
         /// </summary>
-        /// <remarks>Big-endian, 3-byte int24</remarks>
+        /// <remarks>Little-endian, 3-byte int24</remarks>
         public Int24 FileTableBlockNumber { get; set; } = new();
 
         /// <summary>

SabreTools.Data.Models/STFS/SVODDescriptor.cs

@@ -37,13 +37,13 @@ namespace SabreTools.Data.Models.STFS
         /// <summary>
         /// Data Block Count
         /// </summary>
-        /// <remarks>Big-endian, 3-byte uint24</remarks>
+        /// <remarks>Little-endian, 3-byte uint24</remarks>
         public UInt24 DataBlockCount { get; set; } = new();
 
         /// <summary>
         /// Data Block Offset
         /// </summary>
-        /// <remarks>Big-endian, 3-byte uint24</remarks>
+        /// <remarks>Little-endian, 3-byte uint24</remarks>
         public UInt24 DataBlockOffset { get; set; } = new();
 
         /// <summary>