LostArtefacts#397 TR1-3 Pitch Variance

Adds an option to allow the game to vary the pitch on all sound effects.
lahm86 · Nov 10, 2022 · 2fce9b2 · 2fce9b2
1 parent bcd7896
commit 2fce9b2
Show file tree

Hide file tree

Showing 9 changed files with 115 additions and 3 deletions.
diff --git a/TRLevelReader/Model/Base/TRSoundDetails.cs b/TRLevelReader/Model/Base/TRSoundDetails.cs
@@ -31,6 +31,25 @@ public int NumSounds
             }
         }
 
+        public bool Wibble
+        {
+            get
+            {
+                return (Characteristics & 0x2000) > 0;
+            }
+            set
+            {
+                if (value)
+                {
+                    Characteristics |= 0x2000;
+                }
+                else
+                {
+                    Characteristics = (ushort)(Characteristics & ~0x2000);
+                }
+            }
+        }
+
         public override string ToString()
         {
             StringBuilder sb = new StringBuilder(base.ToString());

diff --git a/TRLevelReader/Model/TR3/TR3SoundDetails.cs b/TRLevelReader/Model/TR3/TR3SoundDetails.cs
@@ -25,6 +25,25 @@ public class TR3SoundDetails : ISerializableCompact
 
         public int NumSounds => (Characteristics & 0x00FC) >> 2; // get bits 2-7
 
+        public bool Wibble
+        {
+            get
+            {
+                return (Characteristics & 0x2000) > 0;
+            }
+            set
+            {
+                if (value)
+                {
+                    Characteristics |= 0x2000;
+                }
+                else
+                {
+                    Characteristics = (short)(Characteristics & ~0x2000);
+                }
+            }
+        }
+
         public byte[] Serialize()
         {
             using (MemoryStream stream = new MemoryStream())

diff --git a/TRRandomizerCore/Editors/RandomizerSettings.cs b/TRRandomizerCore/Editors/RandomizerSettings.cs
@@ -101,6 +101,7 @@ public class RandomizerSettings
         public bool LinkCreatureSFX { get; set; }
         public uint UncontrolledSFXCount { get; set; }
         public bool UncontrolledSFXAssaultCourse { get; set; }
+        public bool RandomizeWibble { get; set; }
         public bool RotateStartPositionOnly { get; set; }
         public bool RandomizeWaterLevels { get; set; }
         public bool RandomizeSlotPositions { get; set; }
@@ -241,6 +242,7 @@ public void ApplyConfig(Config config)
             LinkCreatureSFX = config.GetBool(nameof(LinkCreatureSFX));
             UncontrolledSFXCount = config.GetUInt(nameof(UncontrolledSFXCount), 0);
             UncontrolledSFXAssaultCourse = config.GetBool(nameof(UncontrolledSFXAssaultCourse));
+            RandomizeWibble = config.GetBool(nameof(RandomizeWibble));
 
             RandomizeStartPosition = config.GetBool(nameof(RandomizeStartPosition));
             StartPositionSeed = config.GetInt(nameof(StartPositionSeed), defaultSeed);
@@ -369,6 +371,7 @@ public void StoreConfig(Config config)
             config[nameof(LinkCreatureSFX)] = LinkCreatureSFX;
             config[nameof(UncontrolledSFXCount)] = UncontrolledSFXCount;
             config[nameof(UncontrolledSFXAssaultCourse)] = UncontrolledSFXAssaultCourse;
+            config[nameof(RandomizeWibble)] = RandomizeWibble;
 
             config[nameof(RandomizeStartPosition)] = RandomizeStartPosition;
             config[nameof(StartPositionSeed)] = StartPositionSeed;

diff --git a/TRRandomizerCore/Randomizers/TR1/TR1AudioRandomizer.cs b/TRRandomizerCore/Randomizers/TR1/TR1AudioRandomizer.cs
@@ -42,6 +42,8 @@ public override void Randomize(int seed)
 
                 RandomizeSoundEffects(_levelInstance);
 
+                RandomizeWibble(_levelInstance);
+
                 SaveLevelInstance();
 
                 if (!TriggerProgress())
@@ -288,5 +290,24 @@ private short ImportSoundEffect(TRLevel level, TR1SFXDefinition definition)
 
             return (short)(level.NumSoundDetails - 1);
         }
+
+        private void RandomizeWibble(TR1CombinedLevel level)
+        {
+            if (Settings.RandomizeWibble)
+            {
+                // The engine does the actual randomization, we just tell it that every
+                // sound effect should be included.
+                foreach (TRSoundDetails details in level.Data.SoundDetails)
+                {
+                    details.Wibble = true;
+                }
+
+                if (ScriptEditor.Edition.IsCommunityPatch)
+                {
+                    (ScriptEditor.Script as TR1Script).EnablePitchedSounds = true;
+                    ScriptEditor.SaveScript();
+                }
+            }
+        }
     }
 }
diff --git a/TRRandomizerCore/Randomizers/TR2/TR2AudioRandomizer.cs b/TRRandomizerCore/Randomizers/TR2/TR2AudioRandomizer.cs
@@ -42,6 +42,8 @@ public override void Randomize(int seed)
 
                 RandomizeSoundEffects(_levelInstance);
 
+                RandomizeWibble(_levelInstance);
+
                 SaveLevelInstance();
 
                 if (!TriggerProgress())
@@ -317,5 +319,16 @@ private short ImportSoundEffect(TR2Level level, TRSFXDefinition<TRSoundDetails>
 
             return (short)(level.NumSoundDetails - 1);
         }
+
+        private void RandomizeWibble(TR2CombinedLevel level)
+        {
+            if (Settings.RandomizeWibble)
+            {
+                foreach (TRSoundDetails details in level.Data.SoundDetails)
+                {
+                    details.Wibble = true;
+                }
+            }
+        }
     }
 }
diff --git a/TRRandomizerCore/Randomizers/TR3/TR3AudioRandomizer.cs b/TRRandomizerCore/Randomizers/TR3/TR3AudioRandomizer.cs
@@ -43,6 +43,8 @@ public override void Randomize(int seed)
 
                 RandomizeSoundEffects(_levelInstance);
 
+                RandomizeWibble(_levelInstance);
+
                 SaveLevelInstance();
 
                 if (!TriggerProgress())
@@ -282,5 +284,16 @@ private short ImportSoundEffect(TR3Level level, TRSFXDefinition<TR3SoundDetails>
 
             return (short)(level.NumSoundDetails - 1);
         }
+
+        private void RandomizeWibble(TR3CombinedLevel level)
+        {
+            if (Settings.RandomizeWibble)
+            {
+                foreach (TR3SoundDetails details in level.Data.SoundDetails)
+                {
+                    details.Wibble = true;
+                }
+            }
+        }
     }
 }
diff --git a/TRRandomizerCore/TRRandomizerController.cs b/TRRandomizerCore/TRRandomizerController.cs
@@ -1612,6 +1612,12 @@ public bool UncontrolledSFXAssaultCourse
             set => LevelRandomizer.UncontrolledSFXAssaultCourse = value;
         }
 
+        public bool RandomizeWibble
+        {
+            get => LevelRandomizer.RandomizeWibble;
+            set => LevelRandomizer.RandomizeWibble = value;
+        }
+
         public bool RandomizeStartPosition
         {
             get => LevelRandomizer.RandomizeStartPosition;

diff --git a/TRRandomizerView/Model/ControllerOptions.cs b/TRRandomizerView/Model/ControllerOptions.cs
@@ -33,7 +33,7 @@ public class ControllerOptions : INotifyPropertyChanged
         private BoolItemControlClass _includeKeyItems, _includeExtraPickups, _randomizeItemTypes, _randomizeItemLocations;
         private BoolItemControlClass _crossLevelEnemies, _protectMonks, _docileWillard, _swapEnemyAppearance, _allowEmptyEggs, _hideEnemies, _removeLevelEndingLarson;
         private BoolItemControlClass _persistTextures, _randomizeWaterColour, _retainLevelTextures, _retainKeySpriteTextures, _retainSecretSpriteTextures;
-        private BoolItemControlClass _changeAmbientTracks, _includeBlankTracks, _changeTriggerTracks, _separateSecretTracks, _changeWeaponSFX, _changeCrashSFX, _changeEnemySFX, _changeDoorSFX, _linkCreatureSFX;
+        private BoolItemControlClass _changeAmbientTracks, _includeBlankTracks, _changeTriggerTracks, _separateSecretTracks, _changeWeaponSFX, _changeCrashSFX, _changeEnemySFX, _changeDoorSFX, _linkCreatureSFX, _randomizeWibble;
         private BoolItemControlClass _persistOutfits, _removeRobeDagger, _allowGymOutfit;
         private BoolItemControlClass _retainKeyItemNames, _retainLevelNames;
         private BoolItemControlClass _rotateStartPosition;
@@ -1333,6 +1333,16 @@ public BoolItemControlClass LinkCreatureSFX
             }
         }
 
+        public BoolItemControlClass RandomizeWibble
+        {
+            get => _randomizeWibble;
+            set
+            {
+                _randomizeWibble = value;
+                FirePropertyChanged();
+            }
+        }
+
         public uint UncontrolledSFXCount
         {
             get => _uncontrolledSFXCount;
@@ -2443,6 +2453,12 @@ public ControllerOptions()
                 Description = "Enforce the use of human sounds for human enemies and animal sounds for animal enemies."
             };
             BindingOperations.SetBinding(LinkCreatureSFX, BoolItemControlClass.IsActiveProperty, randomizeAudioBinding);
+            RandomizeWibble = new BoolItemControlClass
+            {
+                Title = "Apply maximum pitch variance",
+                Description = "Allow the engine to randomize the pitch of all sound effects and not just the defaults."
+            };
+            BindingOperations.SetBinding(RandomizeWibble, BoolItemControlClass.IsActiveProperty, randomizeAudioBinding);
 
             // Outfits
             Binding randomizeOutfitsBinding = new Binding(nameof(RandomizeOutfits)) { Source = this };
@@ -2544,7 +2560,7 @@ public ControllerOptions()
             AudioBoolItemControls = new List<BoolItemControlClass>()
             {
                 _changeAmbientTracks, _includeBlankTracks, _changeTriggerTracks, _separateSecretTracks, _changeWeaponSFX,
-                _changeCrashSFX, _changeEnemySFX, _changeDoorSFX, _linkCreatureSFX
+                _changeCrashSFX, _changeEnemySFX, _changeDoorSFX, _linkCreatureSFX, _randomizeWibble
             };
             OutfitBoolItemControls = new List<BoolItemControlClass>()
             {
@@ -2669,6 +2685,7 @@ public void Load(TRRandomizerController controller)
             ChangeEnemySFX.Value = _controller.ChangeEnemySFX;
             ChangeDoorSFX.Value = _controller.ChangeDoorSFX;
             LinkCreatureSFX.Value = _controller.LinkCreatureSFX;
+            RandomizeWibble.Value = _controller.RandomizeWibble;
             UncontrolledSFXCount = _controller.UncontrolledSFXCount;
             UncontrolledSFXAssaultCourse = _controller.UncontrolledSFXAssaultCourse;
 
@@ -2924,6 +2941,7 @@ public void Save()
             _controller.ChangeEnemySFX = ChangeEnemySFX.Value;
             _controller.ChangeDoorSFX = ChangeDoorSFX.Value;
             _controller.LinkCreatureSFX = LinkCreatureSFX.Value;
+            _controller.RandomizeWibble = RandomizeWibble.Value;
             _controller.UncontrolledSFXCount = UncontrolledSFXCount;
             _controller.UncontrolledSFXAssaultCourse = UncontrolledSFXAssaultCourse;
 

diff --git a/TRRandomizerView/Windows/Tomb1MainWindow.xaml b/TRRandomizerView/Windows/Tomb1MainWindow.xaml
@@ -1115,7 +1115,7 @@
                             <CheckBox IsChecked="{Binding ControllerProxy.EnablePitchedSounds, Mode=TwoWay}"
                                       VerticalAlignment="Center">
                                 <Label Padding="0"
-                                       Content="Enable pitched sounds" />
+                                       Content="Enable pitched sounds *" />
                             </CheckBox>
                         </Border>
                         <Border Grid.Row="2"