SabreTools/SabreTools.Serialization
1
0
Fork 0
mirror of https://github.com/SabreTools/SabreTools.Serialization.git synced 2026-07-08 18:06:41 +00:00
Code Issues 56 Packages Projects Releases 20 Wiki Activity

Editorconfig cleanup of STFS

Browse Source
This commit is contained in:
Matt Nadareski
2026-04-07 22:20:14 -04:00
parent 7485a43364
commit 574b993985
15 changed files with 233 additions and 256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
SabreTools.Data.Models/STFS/ConsoleSignature.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>

2
SabreTools.Data.Models/STFS/Constants.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <see href="https://free60.org/System-Software/Formats/STFS/"/>

4
SabreTools.Data.Models/STFS/HashTable.cs
View File

@@ -1,9 +1,7 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>
/// STFS Hash Table in a Hash Table Block
/// STFS Hash Table in a Hash Table Block
/// </summary>
/// <see href="https://free60.org/System-Software/Formats/STFS/"/>
public class HashTable

1
SabreTools.Data.Models/STFS/HashTableEntry.cs
View File

@@ -1,4 +1,3 @@
using System.Collections.Generic;
using SabreTools.Numerics;
namespace SabreTools.Data.Models.STFS

4
SabreTools.Data.Models/STFS/Header.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>
@@ -30,7 +28,7 @@ namespace SabreTools.Data.Models.STFS
public LicenseEntry[] LicensingData { get; set; } = new LicenseEntry[16];
/// <summary>
/// SHA-1 Integrity Hash of the header (from ContentType/0x344 to first hash table)
/// SHA-1 Integrity Hash of the header (from ContentType/0x344 to first hash table)
/// </summary>
/// <remarks>20 bytes</remarks>
public byte[] HeaderHash { get; set; } = new byte[20];

2
SabreTools.Data.Models/STFS/LicenseEntry.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>

2
SabreTools.Data.Models/STFS/MicrosoftSignature.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>

1
SabreTools.Data.Models/STFS/STFSDescriptor.cs
View File

@@ -1,4 +1,3 @@
using System.Collections.Generic;
using SabreTools.Numerics;
namespace SabreTools.Data.Models.STFS

1
SabreTools.Data.Models/STFS/SVODDescriptor.cs
View File

@@ -1,4 +1,3 @@
using System.Collections.Generic;
using SabreTools.Numerics;
namespace SabreTools.Data.Models.STFS

2
SabreTools.Data.Models/STFS/Signature.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>

2
SabreTools.Data.Models/STFS/Volume.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>

2
SabreTools.Data.Models/STFS/VolumeDescriptor.cs
View File

@@ -1,5 +1,3 @@
using System.Collections.Generic;
namespace SabreTools.Data.Models.STFS
{
/// <summary>

454
SabreTools.Serialization.Readers/STFS.cs
View File

@@ -1,228 +1,226 @@
using System.Collections.Generic;
using System.IO;
using SabreTools.Data.Models.STFS;
using SabreTools.IO.Extensions;
using SabreTools.Numerics;
using SabreTools.Numerics.Extensions;
namespace SabreTools.Serialization.Readers
{
public class STFS : BaseBinaryReader<Volume>
{
/// <inheritdoc/>
public override Volume? Deserialize(Stream? data)
{
// If the data is invalid
if (data is null || !data.CanRead)
return null;
// Simple check for a valid stream length
if (Constants.StandardHeaderSize > data.Length - data.Position)
return null;
try
{
// Cache the current offset
long initialOffset = data.Position;
// Create a new Volume to fill
var volume = new Volume();
// Read and validate the header
var header = ParseHeader(data);
if (header is null)
return null;
volume.Header = header;
// TODO: Parse the hash table blocks
// Don't parse the data blocks into memory
return volume;
}
catch
{
// Ignore the actual error
return null;
}
}
/// <summary>
/// Parse a Stream into a Header
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled Header on success, null on error</returns>
public static Header? ParseHeader(Stream data)
{
var obj = new Header();
obj.MagicBytes = data.ReadBytes(4);
var signature = System.Text.Encoding.ASCII.GetString(obj.MagicBytes);
bool remoteSigned = signature.Equals(Constants.MagicStringLIVE) | signature.Equals(Constants.MagicStringPIRS);
if (!remoteSigned && !signature.Equals(Constants.MagicStringCON))
return null;
obj.Signature = ParseSignature(data, remoteSigned);
obj.LicensingData = ParseLicensingData(data);
obj.HeaderHash = data.ReadBytes(20);
obj.HeaderSize = data.ReadUInt32BigEndian();
obj.ContentType = data.ReadInt32BigEndian();
obj.MetadataVersion = data.ReadInt32BigEndian();
obj.ContentSize = data.ReadInt64BigEndian();
obj.MediaID = data.ReadUInt32BigEndian();
obj.Version = data.ReadInt32BigEndian();
obj.BaseVersion = data.ReadInt32BigEndian();
obj.TitleID = data.ReadUInt32BigEndian();
obj.Platform = data.ReadByteValue();
obj.ExecutableType = data.ReadByteValue();
obj.DiscNumber = data.ReadByteValue();
obj.DiscInSet = data.ReadByteValue();
obj.SaveGameID = data.ReadUInt32BigEndian();
obj.ConsoleID = data.ReadBytes(5);
obj.ProfileID = data.ReadBytes(8);
// Peek forward to read whether VolumeDescriptor is SVOD or STFS
byte[] peeked = data.PeekBytes(52);
bool svod = peeked[51] == 0x01;
obj.VolumeDescriptor = ParseVolumeDescriptor(data, svod);
obj.DataFileCount = data.ReadInt32BigEndian();
obj.DataFileCombinedSize = data.ReadInt64BigEndian();
obj.DescriptorType = data.ReadUInt32BigEndian();
obj.Reserved = data.ReadUInt32BigEndian();
if (obj.MetadataVersion == 2)
{
obj.SeriesID = data.ReadBytes(16);
obj.SeasonID = data.ReadBytes(16);
obj.SeasonNumber = data.ReadInt16BigEndian();
obj.EpisodeNumber = data.ReadInt16BigEndian();
obj.Padding = data.ReadBytes(40);
}
else
{
obj.Padding = data.ReadBytes(76);
}
obj.DeviceID = data.ReadBytes(20);
obj.DisplayName = data.ReadBytes(2304);
obj.DisplayDescription = data.ReadBytes(2304);
obj.PublisherName = data.ReadBytes(128);
obj.TitleName = data.ReadBytes(128);
obj.TransferFlags = data.ReadByteValue();
obj.ThumbnailImageSize = data.ReadInt32BigEndian();
obj.TitleThumbnailImageSize = data.ReadInt32BigEndian();
if (obj.MetadataVersion == 2)
{
obj.ThumbnailImage = data.ReadBytes(0x3D00);
obj.AdditionalDisplayNames = data.ReadBytes(768);
obj.TitleThumbnailImage = data.ReadBytes(0x3D00);
obj.AdditionalDisplayDescriptions = data.ReadBytes(768);
}
else
{
obj.ThumbnailImage = data.ReadBytes(0x4000);
obj.TitleThumbnailImage = data.ReadBytes(0x4000);
}
return obj;
}
/// <summary>
/// Parse a Stream into a Signature
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled Signature</returns>
public static Signature ParseSignature(Stream data, bool remoteSigned)
{
if (remoteSigned)
{
var obj = new MicrosoftSignature();
obj.PackageSignature = data.ReadBytes(256);
obj.Padding = data.ReadBytes(296);
return obj;
}
else
{
var obj = new ConsoleSignature();
obj.CertificateSize = data.ReadUInt16BigEndian();
obj.ConsoleID = data.ReadBytes(5);
obj.PartNumber = data.ReadBytes(20);
obj.ConsoleType = data.ReadByteValue();
obj.CertificateDate = data.ReadBytes(8);
obj.PublicExponent = data.ReadBytes(4);
obj.PublicModulus = data.ReadBytes(128);
obj.CertificateSignature = data.ReadBytes(256);
obj.Signature = data.ReadBytes(128);
return obj;
}
}
/// <summary>
/// Parse a Stream into an array of LicenseEntry
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled array of LicenseEntry</returns>
public static LicenseEntry[] ParseLicensingData(Stream data)
{
var obj = new LicenseEntry[16];
for (int i = 0; i < 16; i++)
{
obj[i] = new LicenseEntry();
obj[i].LicenseID = data.ReadInt64BigEndian();
obj[i].LicenseBits = data.ReadInt32BigEndian();
obj[i].LicenseFlags = data.ReadInt32BigEndian();
}
return obj;
}
/// <summary>
/// Parse a Stream into a VolumeDescriptor
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled VolumeDescriptor</returns>
public static VolumeDescriptor ParseVolumeDescriptor(Stream data, bool svod)
{
if (svod)
{
var obj = new SVODDescriptor();
obj.VolumeDescriptorSize = data.ReadByteValue();
obj.BlockCacheElementCount = data.ReadByteValue();
obj.WorkerThreadProcessor = data.ReadByteValue();
obj.WorkerThreadPriority = data.ReadByteValue();
obj.Hash = data.ReadBytes(20);
obj.DataBlockCount = data.ReadUInt24BigEndian();
obj.DataBlockOffset = data.ReadUInt24BigEndian();
obj.Hash = data.ReadBytes(5);
return obj;
}
else
{
var obj = new STFSDescriptor();
obj.VolumeDescriptorSize = data.ReadByteValue();
obj.Reserved = data.ReadByteValue();
obj.BlockSeparation = data.ReadByteValue();
obj.FileTableBlockCount = data.ReadInt16BigEndian();
obj.FileTableBlockNumber = data.ReadInt24BigEndian();
obj.TopHashTableHash = data.ReadBytes(20);
obj.TotalAllocatedBlockCount = data.ReadInt32BigEndian();
obj.TotalUnallocatedBlockCount = data.ReadInt32BigEndian();
return obj;
}
}
}
}
using System.IO;
using SabreTools.Data.Models.STFS;
using SabreTools.IO.Extensions;
using SabreTools.Numerics.Extensions;
namespace SabreTools.Serialization.Readers
{
public class STFS : BaseBinaryReader<Volume>
{
/// <inheritdoc/>
public override Volume? Deserialize(Stream? data)
{
// If the data is invalid
if (data is null || !data.CanRead)
return null;
// Simple check for a valid stream length
if (Constants.StandardHeaderSize > data.Length - data.Position)
return null;
try
{
// Cache the current offset
long initialOffset = data.Position;
// Create a new Volume to fill
var volume = new Volume();
// Read and validate the header
var header = ParseHeader(data);
if (header is null)
return null;
volume.Header = header;
// TODO: Parse the hash table blocks
// Don't parse the data blocks into memory
return volume;
}
catch
{
// Ignore the actual error
return null;
}
}
/// <summary>
/// Parse a Stream into a Header
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled Header on success, null on error</returns>
public static Header? ParseHeader(Stream data)
{
var obj = new Header();
obj.MagicBytes = data.ReadBytes(4);
var signature = System.Text.Encoding.ASCII.GetString(obj.MagicBytes);
bool remoteSigned = signature.Equals(Constants.MagicStringLIVE) | signature.Equals(Constants.MagicStringPIRS);
if (!remoteSigned && !signature.Equals(Constants.MagicStringCON))
return null;
obj.Signature = ParseSignature(data, remoteSigned);
obj.LicensingData = ParseLicensingData(data);
obj.HeaderHash = data.ReadBytes(20);
obj.HeaderSize = data.ReadUInt32BigEndian();
obj.ContentType = data.ReadInt32BigEndian();
obj.MetadataVersion = data.ReadInt32BigEndian();
obj.ContentSize = data.ReadInt64BigEndian();
obj.MediaID = data.ReadUInt32BigEndian();
obj.Version = data.ReadInt32BigEndian();
obj.BaseVersion = data.ReadInt32BigEndian();
obj.TitleID = data.ReadUInt32BigEndian();
obj.Platform = data.ReadByteValue();
obj.ExecutableType = data.ReadByteValue();
obj.DiscNumber = data.ReadByteValue();
obj.DiscInSet = data.ReadByteValue();
obj.SaveGameID = data.ReadUInt32BigEndian();
obj.ConsoleID = data.ReadBytes(5);
obj.ProfileID = data.ReadBytes(8);
// Peek forward to read whether VolumeDescriptor is SVOD or STFS
byte[] peeked = data.PeekBytes(52);
bool svod = peeked[51] == 0x01;
obj.VolumeDescriptor = ParseVolumeDescriptor(data, svod);
obj.DataFileCount = data.ReadInt32BigEndian();
obj.DataFileCombinedSize = data.ReadInt64BigEndian();
obj.DescriptorType = data.ReadUInt32BigEndian();
obj.Reserved = data.ReadUInt32BigEndian();
if (obj.MetadataVersion == 2)
{
obj.SeriesID = data.ReadBytes(16);
obj.SeasonID = data.ReadBytes(16);
obj.SeasonNumber = data.ReadInt16BigEndian();
obj.EpisodeNumber = data.ReadInt16BigEndian();
obj.Padding = data.ReadBytes(40);
}
else
{
obj.Padding = data.ReadBytes(76);
}
obj.DeviceID = data.ReadBytes(20);
obj.DisplayName = data.ReadBytes(2304);
obj.DisplayDescription = data.ReadBytes(2304);
obj.PublisherName = data.ReadBytes(128);
obj.TitleName = data.ReadBytes(128);
obj.TransferFlags = data.ReadByteValue();
obj.ThumbnailImageSize = data.ReadInt32BigEndian();
obj.TitleThumbnailImageSize = data.ReadInt32BigEndian();
if (obj.MetadataVersion == 2)
{
obj.ThumbnailImage = data.ReadBytes(0x3D00);
obj.AdditionalDisplayNames = data.ReadBytes(768);
obj.TitleThumbnailImage = data.ReadBytes(0x3D00);
obj.AdditionalDisplayDescriptions = data.ReadBytes(768);
}
else
{
obj.ThumbnailImage = data.ReadBytes(0x4000);
obj.TitleThumbnailImage = data.ReadBytes(0x4000);
}
return obj;
}
/// <summary>
/// Parse a Stream into a Signature
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled Signature</returns>
public static Signature ParseSignature(Stream data, bool remoteSigned)
{
if (remoteSigned)
{
var obj = new MicrosoftSignature();
obj.PackageSignature = data.ReadBytes(256);
obj.Padding = data.ReadBytes(296);
return obj;
}
else
{
var obj = new ConsoleSignature();
obj.CertificateSize = data.ReadUInt16BigEndian();
obj.ConsoleID = data.ReadBytes(5);
obj.PartNumber = data.ReadBytes(20);
obj.ConsoleType = data.ReadByteValue();
obj.CertificateDate = data.ReadBytes(8);
obj.PublicExponent = data.ReadBytes(4);
obj.PublicModulus = data.ReadBytes(128);
obj.CertificateSignature = data.ReadBytes(256);
obj.Signature = data.ReadBytes(128);
return obj;
}
}
/// <summary>
/// Parse a Stream into an array of LicenseEntry
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled array of LicenseEntry</returns>
public static LicenseEntry[] ParseLicensingData(Stream data)
{
var obj = new LicenseEntry[16];
for (int i = 0; i < 16; i++)
{
obj[i] = new LicenseEntry();
obj[i].LicenseID = data.ReadInt64BigEndian();
obj[i].LicenseBits = data.ReadInt32BigEndian();
obj[i].LicenseFlags = data.ReadInt32BigEndian();
}
return obj;
}
/// <summary>
/// Parse a Stream into a VolumeDescriptor
/// </summary>
/// <param name="data">Stream to parse</param>
/// <returns>Filled VolumeDescriptor</returns>
public static VolumeDescriptor ParseVolumeDescriptor(Stream data, bool svod)
{
if (svod)
{
var obj = new SVODDescriptor();
obj.VolumeDescriptorSize = data.ReadByteValue();
obj.BlockCacheElementCount = data.ReadByteValue();
obj.WorkerThreadProcessor = data.ReadByteValue();
obj.WorkerThreadPriority = data.ReadByteValue();
obj.Hash = data.ReadBytes(20);
obj.DataBlockCount = data.ReadUInt24BigEndian();
obj.DataBlockOffset = data.ReadUInt24BigEndian();
obj.Hash = data.ReadBytes(5);
return obj;
}
else
{
var obj = new STFSDescriptor();
obj.VolumeDescriptorSize = data.ReadByteValue();
obj.Reserved = data.ReadByteValue();
obj.BlockSeparation = data.ReadByteValue();
obj.FileTableBlockCount = data.ReadInt16BigEndian();
obj.FileTableBlockNumber = data.ReadInt24BigEndian();
obj.TopHashTableHash = data.ReadBytes(20);
obj.TotalAllocatedBlockCount = data.ReadInt32BigEndian();
obj.TotalUnallocatedBlockCount = data.ReadInt32BigEndian();
return obj;
}
}
}
}

9
SabreTools.Wrappers/STFS.Printing.cs
View File

@@ -1,7 +1,6 @@
using System;
using System.Text;
using SabreTools.Data.Models.STFS;
using SabreTools.Numerics;
using SabreTools.Text.Extensions;
namespace SabreTools.Wrappers
@@ -60,7 +59,7 @@ namespace SabreTools.Wrappers
builder.AppendLine(header.DataFileCombinedSize, " Data File Combined Size");
builder.AppendLine(header.DescriptorType, " Descriptor Type");
builder.AppendLine(header.Reserved, " Reserved");
if (header.MetadataVersion == 2)
{
builder.AppendLine(header.SeriesID, " Series ID");
@@ -135,7 +134,7 @@ namespace SabreTools.Wrappers
builder.AppendLine(header.TransferFlags, " Transfer Flags"); // See Enums.TransferFlags
builder.AppendLine(header.ThumbnailImageSize, " Thumbnail Image Size");
builder.AppendLine(header.TitleThumbnailImageSize, " Title Thumbnail Image Size");
if (header.AdditionalDisplayNames is not null)
{
for (int i = 0; i < 18; i++)
@@ -149,6 +148,7 @@ namespace SabreTools.Wrappers
}
}
}
if (header.AdditionalDisplayDescriptions is not null)
{
for (int i = 0; i < 18; i++)
@@ -160,7 +160,7 @@ namespace SabreTools.Wrappers
builder.AppendLine(localeString, $" Additional Display Description {i}");
builder.AppendLine(Encoding.BigEndianUnicode.GetString(localeString), $" Additional Display Description {i} (Parsed)");
}
}
}
}
builder.AppendLine();
@@ -212,6 +212,7 @@ namespace SabreTools.Wrappers
lastLicenseData = i + 1;
break;
}
if (i == 0)
builder.AppendLine("Zeroed", " Licensing Data");
}

1
SabreTools.Wrappers/STFS.cs
View File

@@ -1,4 +1,3 @@
using System.Collections.Generic;
using System.IO;
using SabreTools.Data.Models.STFS;