Refactor sample index storage (#675)

Part of #653.

TRLevelControl/Control/TR2LevelControl.cs

@@ -322,7 +322,6 @@ private void ReadSoundEffects(TRLevelReader reader)
             {
                 Volume = reader.ReadUInt16(),
                 Chance = reader.ReadUInt16(),
-                Samples = new()
             });
 
             sfx[i].SetFlags(reader.ReadUInt16());
@@ -331,14 +330,9 @@ private void ReadSoundEffects(TRLevelReader reader)
         uint numSampleIndices = reader.ReadUInt32();
         uint[] sampleIndices = reader.ReadUInt32s(numSampleIndices);
 
-        foreach (int soundID in sampleMap.Keys)
+        foreach (var (soundID, samplePointer) in sampleMap)
         {
-            TR2SoundEffect effect = sfx[soundID];
-            ushort baseIndex = sampleMap[soundID];
-            for (int i = 0; i < effect.Samples.Capacity; i++)
-            {
-                effect.Samples.Add(sampleIndices[baseIndex + i]);
-            }
+            sfx[soundID].SampleID = sampleIndices[samplePointer];
         }
 
         for (int i = 0; i < soundMap.Length; i++)
@@ -354,33 +348,38 @@ private void ReadSoundEffects(TRLevelReader reader)
 
     private void WriteSoundEffects(TRLevelWriter writer)
     {
-        short detailsIndex = 0;
-        foreach (TR2SFX id in Enum.GetValues<TR2SFX>())
+        List<TR2SoundEffect> effects = new(_level.SoundEffects.Values);
+        List<uint> sampleIndices = effects.SelectMany(s => Enumerable.Range((int)s.SampleID, s.SampleCount))
+            .Select(s => (uint)s)
+            .Distinct().ToList();
+
+        sampleIndices.Sort();
+
+        Dictionary<TR2SoundEffect, ushort> sampleMap = new();
+        foreach (TR2SoundEffect effect in effects)
         {
-            writer.Write(_level.SoundEffects.ContainsKey(id) ? detailsIndex++ : (short)-1);
+            sampleMap[effect] = (ushort)sampleIndices.IndexOf(effect.SampleID);
         }
 
-        List<uint> samplePointers = new();
-        foreach (var (_, effect) in _level.SoundEffects)
+        effects.Sort((e1, e2) => sampleMap[e1].CompareTo(sampleMap[e2]));
+
+        foreach (TR2SFX id in Enum.GetValues<TR2SFX>())
         {
-            if (!samplePointers.Contains(effect.Samples.First()))
-            {
-                samplePointers.AddRange(effect.Samples);
-            }
+            writer.Write(_level.SoundEffects.ContainsKey(id) 
+                ? (short)effects.IndexOf(_level.SoundEffects[id])
+                : (short)-1);
         }
-        samplePointers.Sort();
 
         writer.Write((uint)_level.SoundEffects.Count);
-        foreach (var (_, effect) in _level.SoundEffects)
+        foreach (TR2SoundEffect effect in effects)
         {
-            uint firstSample = effect.Samples.First();
-            writer.Write((ushort)samplePointers.IndexOf(firstSample));
+            writer.Write(sampleMap[effect]);
             writer.Write(effect.Volume);
             writer.Write(effect.Chance);
             writer.Write(effect.GetFlags());
         }
 
-        writer.Write((uint)samplePointers.Count);
-        writer.Write(samplePointers);
+        writer.Write((uint)sampleIndices.Count);
+        writer.Write(sampleIndices);
     }
 }

TRLevelControl/Control/TR3LevelControl.cs

@@ -324,7 +324,6 @@ private void ReadSoundEffects(TRLevelReader reader)
                 Range = reader.ReadByte(),
                 Chance = reader.ReadByte(),
                 Pitch = reader.ReadByte(),
-                Samples = new()
             });
 
             sfx[i].SetFlags(reader.ReadUInt16());
@@ -333,14 +332,9 @@ private void ReadSoundEffects(TRLevelReader reader)
         uint numSampleIndices = reader.ReadUInt32();
         uint[] sampleIndices = reader.ReadUInt32s(numSampleIndices);
 
-        foreach (int soundID in sampleMap.Keys)
+        foreach (var (soundID, samplePointer) in sampleMap)
         {
-            TR3SoundEffect effect = sfx[soundID];
-            ushort baseIndex = sampleMap[soundID];
-            for (int i = 0; i < effect.Samples.Capacity; i++)
-            {
-                effect.Samples.Add(sampleIndices[baseIndex + i]);
-            }
+            sfx[soundID].SampleID = sampleIndices[samplePointer];
         }
 
         for (int i = 0; i < soundMap.Length; i++)
@@ -356,35 +350,40 @@ private void ReadSoundEffects(TRLevelReader reader)
 
     private void WriteSoundEffects(TRLevelWriter writer)
     {
-        short detailsIndex = 0;
-        foreach (TR3SFX id in Enum.GetValues<TR3SFX>())
+        List<TR3SoundEffect> effects = new(_level.SoundEffects.Values);
+        List<uint> sampleIndices = effects.SelectMany(s => Enumerable.Range((int)s.SampleID, s.SampleCount))
+            .Select(s => (uint)s)
+            .Distinct().ToList();
+
+        sampleIndices.Sort();
+
+        Dictionary<TR3SoundEffect, ushort> sampleMap = new();
+        foreach (TR3SoundEffect effect in effects)
         {
-            writer.Write(_level.SoundEffects.ContainsKey(id) ? detailsIndex++ : (short)-1);
+            sampleMap[effect] = (ushort)sampleIndices.IndexOf(effect.SampleID);
         }
 
-        List<uint> samplePointers = new();
-        foreach (var (_, effect) in _level.SoundEffects)
+        effects.Sort((e1, e2) => sampleMap[e1].CompareTo(sampleMap[e2]));
+
+        foreach (TR3SFX id in Enum.GetValues<TR3SFX>())
         {
-            if (!samplePointers.Contains(effect.Samples.First()))
-            {
-                samplePointers.AddRange(effect.Samples);
-            }
+            writer.Write(_level.SoundEffects.ContainsKey(id)
+                ? (short)effects.IndexOf(_level.SoundEffects[id])
+                : (short)-1);
         }
-        samplePointers.Sort();
 
         writer.Write((uint)_level.SoundEffects.Count);
-        foreach (var (_, effect) in _level.SoundEffects)
+        foreach (TR3SoundEffect effect in effects)
         {
-            uint firstSample = effect.Samples.First();
-            writer.Write((ushort)samplePointers.IndexOf(firstSample));
+            writer.Write(sampleMap[effect]);
             writer.Write(effect.Volume);
             writer.Write(effect.Range);
             writer.Write(effect.Chance);
             writer.Write(effect.Pitch);
             writer.Write(effect.GetFlags());
         }
 
-        writer.Write((uint)samplePointers.Count);
-        writer.Write(samplePointers);
+        writer.Write((uint)sampleIndices.Count);
+        writer.Write(sampleIndices);
     }
 }

TRLevelControl/Model/TR2/TR2SoundEffect.cs

@@ -4,11 +4,12 @@ public class TR2SoundEffect : TRSoundEffect<TR2SFXMode>
 {
     public ushort Volume { get; set; }
     public ushort Chance { get; set; }
-    public List<uint> Samples { get; set; }
+    public uint SampleID { get; set; }
+    public int SampleCount { get; set; }
 
     protected override void SetSampleCount(int count)
-        => Samples.Capacity = count;
+        => SampleCount = count;
 
     protected override int GetSampleCount()
-        => Samples.Count;
+        => SampleCount;
 }

TRLevelControl/Model/TR3/TR3SoundEffect.cs

@@ -6,11 +6,12 @@ public class TR3SoundEffect : TRSoundEffect<TR3SFXMode>
     public byte Chance { get; set; }
     public byte Range { get; set; }
     public byte Pitch { get; set; }
-    public List<uint> Samples { get; set; }
+    public uint SampleID { get; set; }
+    public int SampleCount { get; set; }
 
     protected override void SetSampleCount(int count)
-        => Samples.Capacity = count;
+        => SampleCount = count;
 
     protected override int GetSampleCount()
-        => Samples.Count;
+        => SampleCount;
 }

TRRandomizerCore/Randomizers/TR2/TR2AudioRandomizer.cs

@@ -12,6 +12,8 @@ namespace TRRandomizerCore.Randomizers;
 
 public class TR2AudioRandomizer : BaseTR2Randomizer
 {
+    private const int _numSamples = 408; // Number of entries in MAIN.SFX
+
     private AudioRandomizer _audioRandomizer;
 
     private List<TR2SFXDefinition> _soundEffects;
@@ -142,12 +144,10 @@ private void RandomizeSecretTracks(TR2Level level)
             {
                 entries.Add(new FDTriggerEntry
                 {
-                    Actions = new List<FDActionItem>
+                    TrigType = FDTrigType.Pickup,
+                    Actions = new()
                     {
-                        new()
-                        {
-                            Parameter = (short)entityIndex
-                        },
+                        new() { Parameter = (short)entityIndex },
                         musicAction
                     }
                 });
@@ -208,20 +208,14 @@ private void RandomizeSoundEffects(TR2CombinedLevel level)
         if (IsUncontrolledLevel(level.Script))
         {
             // Choose a random but unique pointer into MAIN.SFX for each sample.
-            int maxSample = Enum.GetValues<TR2SFX>().Length;
             HashSet<uint> indices = new();
-            foreach (var (_, effect) in level.Data.SoundEffects)
+            foreach (TR2SoundEffect effect in level.Data.SoundEffects.Values)
             {
-                for (int i = 0; i < effect.Samples.Count; i++)
+                do
                 {
-                    uint sample;
-                    do
-                    {
-                        sample = (uint)_generator.Next(0, maxSample + 1);
-                    }
-                    while (!indices.Add(sample));
-                    effect.Samples[i] = sample;
+                    effect.SampleID = (uint)_generator.Next(0, _numSamples + 1 - Math.Max(effect.SampleCount, 1));
                 }
+                while (!indices.Add(effect.SampleID));
             }
         }
         else

TRRandomizerCore/Randomizers/TR2R/TR2RAudioRandomizer.cs

@@ -12,6 +12,8 @@ namespace TRRandomizerCore.Randomizers;
 
 public class TR2RAudioRandomizer : BaseTR2RRandomizer
 {
+    private const int _numSamples = 412;
+
     private AudioRandomizer _audioRandomizer;
 
     private List<TR2SFXDefinition> _soundEffects;
@@ -129,12 +131,10 @@ private void RandomizeSecretTracks(TR2Level level)
             {
                 entries.Add(new FDTriggerEntry
                 {
+                    TrigType = FDTrigType.Pickup,
                     Actions = new()
                     {
-                        new()
-                        {
-                            Parameter = (short)entityIndex
-                        },
+                        new() { Parameter = (short)entityIndex },
                         musicAction
                     }
                 });
@@ -188,20 +188,14 @@ private void RandomizeSoundEffects(TR2RCombinedLevel level)
 
         if (IsUncontrolledLevel(level.Script))
         {
-            int maxSample = Enum.GetValues<TR2SFX>().Length;            
             HashSet<uint> indices = new();
-            foreach (var (_, effect) in level.Data.SoundEffects)
+            foreach (TR2SoundEffect effect in level.Data.SoundEffects.Values)
             {
-                for (int i = 0; i < effect.Samples.Count; i++)
+                do
                 {
-                    uint sample;
-                    do
-                    {
-                        sample = (uint)_generator.Next(0, maxSample + 1);
-                    }
-                    while (!indices.Add(sample));
-                    effect.Samples[i] = sample;
+                    effect.SampleID = (uint)_generator.Next(0, _numSamples + 1 - Math.Max(effect.SampleCount, 1));
                 }
+                while (!indices.Add(effect.SampleID));
             }
         }
         else

TRRandomizerCore/Randomizers/TR3/TR3AudioRandomizer.cs

@@ -13,6 +13,7 @@ namespace TRRandomizerCore.Randomizers;
 public class TR3AudioRandomizer : BaseTR3Randomizer
 {
     private const int _defaultSecretTrack = 122;
+    private const int _numSamples = 414;
 
     private AudioRandomizer _audioRandomizer;
     private TRAudioTrack _fixedSecretTrack;
@@ -176,21 +177,15 @@ private void RandomizeSoundEffects(TR3CombinedLevel level)
 
         if (IsUncontrolledLevel(level.Script))
         {
-            // Choose a random sample for each current entry and replace the entire index list.
-            int maxSample = Enum.GetValues<TR3SFX>().Length;
+            // Choose a random but unique pointer into MAIN.SFX for each sample.
             HashSet<uint> indices = new();
-            foreach (var (_, effect) in level.Data.SoundEffects)
+            foreach (TR3SoundEffect effect in level.Data.SoundEffects.Values)
             {
-                for (int i = 0; i < effect.Samples.Count; i++)
+                do
                 {
-                    uint sample;
-                    do
-                    {
-                        sample = (uint)_generator.Next(0, maxSample + 1);
-                    }
-                    while (!indices.Add(sample));
-                    effect.Samples[i] = sample;
+                    effect.SampleID = (uint)_generator.Next(0, _numSamples + 1 - Math.Max(effect.SampleCount, 1));
                 }
+                while (!indices.Add(effect.SampleID));
             }
         }
         else

TRRandomizerCore/Randomizers/TR3R/TR3RAudioRandomizer.cs

@@ -13,6 +13,7 @@ namespace TRRandomizerCore.Randomizers;
 public class TR3RAudioRandomizer : BaseTR3RRandomizer
 {
     private const int _defaultSecretTrack = 122;
+    private const int _numSamples = 414;
 
     private AudioRandomizer _audioRandomizer;
 
@@ -151,20 +152,16 @@ private void RandomizeSoundEffects(TR3RCombinedLevel level)
 
         if (IsUncontrolledLevel(level.Script))
         {
-            int maxSample = Enum.GetValues<TR3SFX>().Length;
             HashSet<uint> indices = new();
-            foreach (var (_, effect) in level.Data.SoundEffects)
+            foreach (TR3SoundEffect effect in level.Data.SoundEffects.Values)
             {
-                for (int i = 0; i < effect.Samples.Count; i++)
+                uint sampleIndex;
+                do
                 {
-                    uint sample;
-                    do
-                    {
-                        sample = (uint)_generator.Next(0, maxSample + 1);
-                    }
-                    while (!indices.Add(sample));
-                    effect.Samples[i] = sample;
+                    sampleIndex = (uint)_generator.Next(0, _numSamples + 1 - Math.Max(effect.SampleCount, 1));
                 }
+                while (!indices.Add(sampleIndex));
+                effect.SampleID = sampleIndex;
             }
         }
         else