Bump version

.github/workflows/build_nupkg.yml

@@ -28,13 +28,13 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: 'Nuget Package'
-        path: 'bin/Release/*.nupkg'
+        path: 'SabreTools.Models/bin/Release/*.nupkg'
 
     - name: Upload to rolling
       uses: ncipollo/release-action@v1.14.0
       with:
         allowUpdates: True
-        artifacts: 'bin/Release/*.nupkg'
+        artifacts: 'SabreTools.Models/bin/Release/*.nupkg'
         body: 'Last built commit: ${{ github.sha }}'
         name: 'Rolling Release'
         prerelease: True

CHD/Enums.cs

@@ -1,42 +0,0 @@
-using System;
-
-namespace SabreTools.Models.CHD
-{
-    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.h"/> 
-    public enum CompressionType : uint
-    {
-        #region V1
-
-        CHDCOMPRESSION_NONE = 0,
-        CHDCOMPRESSION_ZLIB = 1,
-
-        #endregion
-
-        #region V3
-
-        CHDCOMPRESSION_ZLIB_PLUS = 2,
-
-        #endregion
-
-        #region V4
-
-        CHDCOMPRESSION_AV = 3,
-
-        #endregion
-    }
-
-    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.h"/> 
-    [Flags]
-    public enum Flags : uint
-    {
-        /// <summary>
-        /// Set if this drive has a parent
-        /// </summary>
-        DriveHasParent = 0x00000001,
-
-        /// <summary>
-        /// Set if this drive allows writes
-        /// </summary>
-        DriveAllowsWrites = 0x00000002,
-    }
-}

InstallShieldCabinet/Enums.cs

@@ -1,23 +0,0 @@
-using System;
-
-namespace SabreTools.Models.InstallShieldCabinet
-{
-    /// <see href="https://github.com/twogood/unshield/blob/main/lib/cabfile.h"/>
-    [Flags]
-    public enum FileFlags : ushort
-    {
-        FILE_SPLIT = 1,
-        FILE_OBFUSCATED = 2,
-        FILE_COMPRESSED = 4,
-        FILE_INVALID = 8,
-    }
-
-    /// <see href="https://github.com/twogood/unshield/blob/main/lib/cabfile.h"/>
-    public enum LinkFlags : byte
-    {
-        LINK_NONE = 0,
-        LINK_PREV = 1,
-        LINK_NEXT = 2,
-        LINK_BOTH = 3,
-    }
-}

SabreTools.Models.csproj

@@ -1,41 +0,0 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
-  <PropertyGroup>
-    <!-- Assembly Properties -->
-    <TargetFrameworks>net20;net35;net40;net452;net462;net472;net48;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
-    <RuntimeIdentifiers>win-x86;win-x64;win-arm64;linux-x64;linux-arm64;osx-x64;osx-arm64</RuntimeIdentifiers>
-    <LangVersion>latest</LangVersion>
-    <Nullable>enable</Nullable>
-    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>1.4.7</Version>
-    <WarningsNotAsErrors>CS0618</WarningsNotAsErrors>
-
-    <!-- Package Properties -->
-    <Authors>Matt Nadareski</Authors>
-    <Description>Common models used by other SabreTools projects</Description>
-    <Copyright>Copyright (c) Matt Nadareski 2022-2024</Copyright>
-    <PackageProjectUrl>https://github.com/SabreTools/</PackageProjectUrl>
-    <PackageReadmeFile>README.md</PackageReadmeFile>
-    <RepositoryUrl>https://github.com/SabreTools/SabreTools.Models</RepositoryUrl>
-    <RepositoryType>git</RepositoryType>
-    <PackageTags>model models executable protection archive</PackageTags>
-    <PackageLicenseExpression>MIT</PackageLicenseExpression>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <None Include="README.md" Pack="true" PackagePath="" />
-  </ItemGroup>
-
-  <!-- Support for old .NET versions -->
-  <ItemGroup Condition="$(TargetFramework.StartsWith(`net2`)) OR $(TargetFramework.StartsWith(`net3`))">
-    <PackageReference Include="MinValueTupleBridge" Version="0.2.0" />
-  </ItemGroup>
-  <ItemGroup Condition="$(TargetFramework.StartsWith(`net4`))">
-    <PackageReference Include="System.ValueTuple" Version="4.5.0" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-  </ItemGroup>
-
-</Project>

SabreTools.Models.sln

@@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.0.31903.59
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SabreTools.Models", "SabreTools.Models.csproj", "{51F0D5D9-7C2B-445A-8ECD-4A47B33609C4}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SabreTools.Models", "SabreTools.Models\SabreTools.Models.csproj", "{51F0D5D9-7C2B-445A-8ECD-4A47B33609C4}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

SabreTools.Models/CHD/Constants.cs

@@ -0,0 +1,23 @@
+namespace SabreTools.Models.CHD
+{
+    public static class Constants
+    {
+        public const string SignatureString = "MComprHD";
+
+        #region Header Sizes
+
+        public const int HeaderV1Size = 76;
+        public const int HeaderV2Size = 80;
+        public const int HeaderV3Size = 120;
+        public const int HeaderV4Size = 108;
+        public const int HeaderV5Size = 124;
+
+        #endregion
+
+        #region Metadata Parameters
+
+        public const uint CHDMETAINDEX_APPEND = uint.MaxValue;
+
+        #endregion
+    }
+}

SabreTools.Models/CHD/Enums.cs

@@ -0,0 +1,358 @@
+using System;
+
+namespace SabreTools.Models.CHD
+{
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chdcodec.h"/> 
+    public enum AVHuffCodec
+    {
+        DECOMPRESS_CONFIG = 1,
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chdcodec.h"/> 
+    public enum CodecType : uint
+    {
+        CHD_CODEC_NONE = 0,
+
+        #region General Codecs
+
+        /// <remarks>"zlib"</remarks>
+        ZLIB = 0x7a6c6962,
+
+        /// <remarks>"zstd"</remarks>
+        ZSTD = 0x7a737464,
+
+        /// <remarks>"lzma"</remarks>
+        LZMA = 0x6c7a6d61,
+
+        /// <remarks>"huff"</remarks>
+        HUFFMAN = 0x68756666,
+
+        /// <remarks>"flac"</remarks>
+        FLAC = 0x666c6163,
+
+        #endregion
+
+        #region General Codecs with CD Frontend
+
+        /// <remarks>"cdzl"</remarks>
+        CD_ZLIB = 0x63647a6c,
+
+        /// <remarks>"cdzs"</remarks>
+        CD_ZSTD = 0x63647a73,
+
+        /// <remarks>"cdlz"</remarks>
+        CD_LZMA = 0x63646c7a,
+
+        /// <remarks>"cdfl"</remarks>
+        CD_FLAC = 0x6364666c,
+
+        #endregion
+
+        #region A/V Codecs
+
+        /// <remarks>"avhu"</remarks>
+        AVHUFF = 0x61766875,
+
+        #endregion
+
+        #region Pseudo-Codecs Returned by hunk_info
+
+        /// <summary>
+        /// Copy of another hunk
+        /// </summary>
+        CHD_CODEC_SELF = 1,
+
+        /// <summary>
+        /// Copy of a parent's hunk
+        /// </summary>
+        CHD_CODEC_PARENT = 2,
+
+        /// <summary>
+        /// Legacy "mini" 8-byte repeat
+        /// </summary>
+        CHD_CODEC_MINI = 3,
+
+        #endregion
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.h"/> 
+    public enum CompressionType : uint
+    {
+        #region V1
+
+        CHDCOMPRESSION_NONE = 0,
+        CHDCOMPRESSION_ZLIB = 1,
+
+        #endregion
+
+        #region V3
+
+        CHDCOMPRESSION_ZLIB_PLUS = 2,
+
+        #endregion
+
+        #region V4
+
+        CHDCOMPRESSION_AV = 3,
+
+        #endregion
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.h"/> 
+    public enum Error : uint
+    {
+        NO_INTERFACE = 1,
+        NOT_OPEN,
+        ALREADY_OPEN,
+        INVALID_FILE,
+        INVALID_DATA,
+        REQUIRES_PARENT,
+        FILE_NOT_WRITEABLE,
+        CODEC_ERROR,
+        INVALID_PARENT,
+        HUNK_OUT_OF_RANGE,
+        DECOMPRESSION_ERROR,
+        COMPRESSION_ERROR,
+        CANT_VERIFY,
+        METADATA_NOT_FOUND,
+        INVALID_METADATA_SIZE,
+        UNSUPPORTED_VERSION,
+        VERIFY_INCOMPLETE,
+        INVALID_METADATA,
+        INVALID_STATE,
+        OPERATION_PENDING,
+        UNSUPPORTED_FORMAT,
+        UNKNOWN_COMPRESSION,
+        WALKING_PARENT,
+        COMPRESSING
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.h"/> 
+    [Flags]
+    public enum Flags : uint
+    {
+        /// <summary>
+        /// Set if this drive has a parent
+        /// </summary>
+        DriveHasParent = 0x00000001,
+
+        /// <summary>
+        /// Set if this drive allows writes
+        /// </summary>
+        DriveAllowsWrites = 0x00000002,
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.h"/> 
+    [Flags]
+    public enum MetadataFlags : byte
+    {
+        /// <summary>
+        /// Indicates data is checksummed
+        /// </summary>
+        CHD_MDFLAGS_CHECKSUM = 0x01,
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.h"/> 
+    public enum MetadataTag : uint
+    {
+        CHDMETATAG_WILDCARD = 0,
+
+        #region Hard Disk
+
+        /// <summary>
+        /// Standard hard disk metadata
+        /// </summary>
+        /// <remarks>"GDDD"</remarks>
+        HARD_DISK_METADATA_TAG = 0x47444444,
+
+        /// <summary>
+        /// Hard disk identify information
+        /// </summary>
+        /// <remarks>"IDNT"</remarks>
+        HARD_DISK_IDENT_METADATA_TAG = 0x49444e54,
+
+        /// <summary>
+        /// Hard disk key information
+        /// </summary>
+        /// <remarks>"KEY "</remarks>
+        HARD_DISK_KEY_METADATA_TAG = 0x4b455920,
+
+        #endregion
+
+        #region PCMCIA
+
+        /// <summary>
+        /// PCMCIA CIS information
+        /// </summary>
+        /// <remarks>"CIS "</remarks>
+        PCMCIA_CIS_METADATA_TAG = 0x43495320,
+
+        #endregion
+
+        #region CD-ROM
+
+        /// <remarks>"CHCD"</remarks>
+        CDROM_OLD_METADATA_TAG = 0x43484344,
+
+        /// <remarks>"CHTR"</remarks>
+        CDROM_TRACK_METADATA_TAG = 0x43485452,
+
+        /// <remarks>"CHT2"</remarks>
+        CDROM_TRACK_METADATA2_TAG = 0x43485432,
+
+        #endregion
+
+        #region GD-ROM
+
+        /// <remarks>"CHGT"</remarks>
+        GDROM_OLD_METADATA_TAG = 0x43484754,
+
+        /// <remarks>"CHGD"</remarks>
+        GDROM_TRACK_METADATA_TAG = 0x43484744,
+
+        #endregion
+
+        #region DVD
+
+        /// <summary>
+        /// Standard DVD metadata
+        /// </summary>
+        /// <remarks>"DVD "</remarks>
+        DVD_METADATA_TAG = 0x44564420,
+
+        #endregion
+
+        #region A/V
+
+        /// <summary>
+        /// Standard A/V metadata
+        /// </summary>
+        /// <remarks>"AVAV"</remarks>
+        AV_METADATA_TAG = 0x41564156,
+
+        /// <summary>
+        /// A/V laserdisc frame metadata
+        /// </summary>
+        /// <remarks>"AVLD"</remarks>
+        AV_LD_METADATA_TAG = 0x41564c44,
+
+        #endregion
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.cpp"/> 
+    public enum V34EntryType : uint
+    {
+        /// <summary>
+        /// Invalid type
+        /// </summary>
+        V34_MAP_ENTRY_TYPE_INVALID = 0,
+
+        /// <summary>
+        /// Standard compression
+        /// </summary>
+        V34_MAP_ENTRY_TYPE_COMPRESSED = 1,
+
+        /// <summary>
+        /// Uncompressed data
+        /// </summary>
+        V34_MAP_ENTRY_TYPE_UNCOMPRESSED = 2,
+
+        /// <summary>
+        /// Mini: use offset as raw data
+        /// </summary>
+        V34_MAP_ENTRY_TYPE_MINI = 3,
+
+        /// <summary>
+        /// Same as another hunk in this file
+        /// </summary>
+        V34_MAP_ENTRY_TYPE_SELF_HUNK = 4,
+
+        /// <summary>
+        /// Same as a hunk in the parent file
+        /// </summary>
+        V34_MAP_ENTRY_TYPE_PARENT_HUNK = 5,
+
+        /// <summary>
+        /// Compressed with secondary algorithm (usually FLAC CDDA)
+        /// </summary>
+        V34_MAP_ENTRY_TYPE_2ND_COMPRESSED = 6,
+    }
+
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.cpp"/> 
+    public enum V5CompressionType : uint
+    {
+        // These types are live when running
+
+        /// <summary>
+        /// Codec #0
+        /// </summary>
+        COMPRESSION_TYPE_0 = 0,
+
+        /// <summary>
+        /// Codec #1
+        /// </summary>
+        COMPRESSION_TYPE_1 = 1,
+
+        /// <summary>
+        /// Codec #2
+        /// </summary>
+        COMPRESSION_TYPE_2 = 2,
+
+        /// <summary>
+        /// Codec #3
+        /// </summary>
+        COMPRESSION_TYPE_3 = 3,
+
+        /// <summary>
+        /// No compression; implicit length = hunkbytes
+        /// </summary>
+        COMPRESSION_NONE = 4,
+
+        /// <summary>
+        /// Same as another block in this CHD
+        /// </summary>
+        COMPRESSION_SELF = 5,
+
+        /// <summary>
+        /// Same as a hunk's worth of units in the parent CHD
+        /// </summary>
+        COMPRESSION_PARENT = 6,
+
+        // These additional pseudo-types are used for compressed encodings
+
+        /// <summary>
+        /// Start of small RLE run (4-bit length)
+        /// </summary>
+        COMPRESSION_RLE_SMALL,
+
+        /// <summary>
+        /// Start of large RLE run (8-bit length)
+        /// </summary>
+        COMPRESSION_RLE_LARGE,
+
+        /// <summary>
+        /// Same as the last COMPRESSION_SELF block
+        /// </summary>
+        COMPRESSION_SELF_0,
+
+        /// <summary>
+        /// Same as the last COMPRESSION_SELF block + 1
+        /// </summary>
+        COMPRESSION_SELF_1,
+
+        /// <summary>
+        /// Same block in the parent
+        /// </summary>
+        COMPRESSION_PARENT_SELF,
+
+        /// <summary>
+        /// Same as the last COMPRESSION_PARENT block
+        /// </summary>
+        COMPRESSION_PARENT_0,
+
+        /// <summary>
+        /// Same as the last COMPRESSION_PARENT block + 1
+        /// </summary>
+        COMPRESSION_PARENT_1
+    }
+}

SabreTools.Models/CHD/MetadataEntry.cs

@@ -0,0 +1,39 @@
+using System.Runtime.InteropServices;
+
+namespace SabreTools.Models.CHD
+{
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.cpp"/> 
+    [StructLayout(LayoutKind.Sequential)]
+    public sealed class MetadataEntry
+    {
+        /// <summary>
+        /// Offset within the file of the header
+        /// </summary>
+        public ulong Offset;
+
+        /// <summary>
+        /// Offset within the file of the next header
+        /// </summary>
+        public ulong Next;
+
+        /// <summary>
+        /// Offset within the file of the previous header
+        /// </summary>
+        public ulong Prev;
+
+        /// <summary>
+        /// Length of the metadata
+        /// </summary>
+        public uint Length;
+
+        /// <summary>
+        /// Metadata tag
+        /// </summary>
+        public MetadataTag Metatag;
+
+        /// <summary>
+        /// Flag bits
+        /// </summary>
+        public MetadataFlags Flags;
+    }
+}

SabreTools.Models/CHD/MetadataHash.cs

@@ -0,0 +1,20 @@
+using System.Runtime.InteropServices;
+
+namespace SabreTools.Models.CHD
+{
+    /// <see href="https://github.com/mamedev/mame/blob/master/src/lib/util/chd.cpp"/> 
+    [StructLayout(LayoutKind.Sequential)]
+    public sealed class MetadataHash
+    {
+        /// <summary>
+        /// Tag of the metadata in big-endian
+        /// </summary>
+        public MetadataTag Tag;
+
+        /// <summary>
+        /// Hash data
+        /// </summary>
+        [MarshalAs(UnmanagedType.ByValArray, SizeConst = 20)]
+        public byte[]? SHA1;
+    }
+}

SabreTools.Models/Charts/SongIni.cs

@@ -4,7 +4,7 @@ namespace SabreTools.Models.Charts
 {
     /// <see href="https://github.com/TheNathannator/GuitarGame_ChartFormats/tree/main/doc/FileFormats/song.ini"/> 
     /// <remarks>[song]/[Song]</remarks>
-    internal class SongIni
+    public class SongIni
     {
         #region Song/Chart Metadata
 

SabreTools.Models/Charts/Tier.cs

@@ -0,0 +1,16 @@
+namespace SabreTools.Models.Charts
+{
+    /// <see href="https://github.com/TheNathannator/GuitarGame_ChartFormats/blob/main/doc/FileFormats/Other/Frets%20on%20Fire%20X/Careers.md"/> 
+    public class Tier
+    {
+        /// <summary>
+        /// Display name of the tier.
+        /// </summary>
+        public string? Name { get; set; }
+
+        /// <summary>
+        /// Name used for associating a song with this tier, and for checking unlock requirements.
+        /// </summary>
+        public string? UnlockId { get; set; }
+    }
+}

SabreTools.Models/Charts/TitlesIni.cs

@@ -1,10 +1,8 @@
-using System.Collections.Generic;
-
 namespace SabreTools.Models.Charts
 {
     /// <see href="https://github.com/TheNathannator/GuitarGame_ChartFormats/blob/main/doc/FileFormats/Other/Frets%20on%20Fire%20X/Careers.md"/> 
     /// <remarks>[titles]</remarks>
-    internal class TitlesIni
+    public class TitlesIni
     {
         /// <summary>
         /// A space-separated list of .ini sections to include in the career.
@@ -13,9 +11,8 @@ namespace SabreTools.Models.Charts
         public string[]? SectionList { get; set; }
 
         /// <summary>
-        /// `name` - Display name of the tier.
-        /// `unlock_id` - Name used for associating a song with this tier, and for checking unlock requirements.
+        /// This entry points to other sections that should be used as part of the career.
         /// </summary>
-        public Dictionary<string, (string? Name, string? UnlockId)>? Sections { get; set; }
+        public Tier[]? Sections { get; set; }
     }
 }