Merge pull request #4 from ashkeel/feature/multiple-sounds

Multiple hit sounds

Author: wtfblub

README.md

@@ -53,8 +53,7 @@ After logging in it should look like this:
 
 - *Reaction power:* How strong your model will react
 
-- *Play hit sound:* If a sound effect should be played when items hit your model
-  * Trashy loads the hit sound effect from `VTube Studio\BepInEx\plugins\Trashy\hit.mp3` Simply replace the file with any mp3 and press `Reload hit sound` in the Trashy settings
+- *Play hit sound:* If enabled, a sound effect will be played when items hit your model
 
 ### Setting up triggers
 
@@ -107,3 +106,16 @@ Groups are made by creating folders in `VTube Studio\BepInEx\plugins\Trashy\Item
 Example: Create a folder `pokemon` in `VTube Studio\BepInEx\plugins\Trashy\Items` and drop some png files into the `pokemon` folder. Now you have the group `pokemon` available in the trigger settings and it will only throw items from the `pokemon` folder.
 
 Make sure to click on `Reload Items` in the settings after adding or changing png files.
+
+### Additional hit sounds
+
+Trashy comes with a default hit sound, but you can replace it and/or add other sounds by just adding files to the `VTube Studio\BepInEx\plugins\Trashy\Sounds` folder, provided they are in one of these supported formats:
+
+ - `.mp3` MPEG Layer 3
+ - `.ogg` Ogg Vorbis (not Opus!)
+ - `.wav` Microsoft Wave
+ - `.aiff` Audio Interchange File Format
+
+Which sound is played when hit is chosen at random.
+
+If you add/remove sounds while VTube Studio is open, remember to click `Reload hit sounds` to apply the changes.

src/Trashy/Extensions.cs

@@ -113,6 +113,9 @@ public static T Random<T>(this IReadOnlyList<T> list)
             if (list.Count == 0)
                 return default;
 
+            if (list.Count == 1)
+                return list[0];
+
             return list[UnityEngine.Random.Range(0, list.Count)];
         }
     }

src/Trashy/SoundManager.cs

@@ -13,9 +13,9 @@ public class SoundManager : MonoBehaviour
     {
         private const int MaxSounds = 6;
 
+        private static readonly List<AudioClip> s_audioClips = new List<AudioClip>();
         private static readonly Queue<AudioSource> s_queue = new Queue<AudioSource>();
         private static readonly List<AudioSource> s_active = new List<AudioSource>();
-        private static AudioClip s_audioClip;
         private static float s_lastPlay;
 
         public static void Play()
@@ -24,18 +24,44 @@ public static void Play()
             if (Time.realtimeSinceStartup - s_lastPlay < 0.05f)
                 return;
 
-            if (s_queue.Count > 0 && s_audioClip != null)
+            if (s_queue.Count > 0 && s_audioClips.Count > 0)
             {
+                // Pick audio clip at random
+                var audioClip = s_audioClips.Random();
                 var audioSource = s_queue.Dequeue();
-                audioSource.clip = s_audioClip;
+                audioSource.clip = audioClip;
                 audioSource.volume = ConfigManager.HitSoundVolume.Value / 100f;
                 audioSource.Play();
                 s_active.Add(audioSource);
                 s_lastPlay = Time.realtimeSinceStartup;
             }
         }
 
-        public static async Task LoadAudioClip()
+        private static async Task<AudioClip> LoadClip(string fileName)
+        {
+            // Get audio type from file name
+            var audioType = AudioTypeForFile(fileName);
+            if (audioType == AudioType.UNKNOWN)
+            {
+                Log.Error<SoundManager>($"Unable to detect format for audio file: {fileName}");
+                return null;
+            }
+
+            // Load file
+            using (var request = UnityWebRequestMultimedia.GetAudioClip(new Uri(fileName), audioType))
+            {
+                await request.SendWebRequest();
+                if (request.result != UnityWebRequest.Result.Success)
+                {
+                    Log.Error<SoundManager>($"Unable to load audio file: {fileName}");
+                    return null;
+                }
+
+                return DownloadHandlerAudioClip.GetContent(request);
+            }
+        }
+
+        public static async Task LoadAudioClips()
         {
             foreach (var audioSource in s_active)
             {
@@ -46,32 +72,29 @@ public static async Task LoadAudioClip()
 
             s_active.Clear();
 
-            if (s_audioClip != null)
+            // Unload all audio clips
+            if (s_audioClips.Count > 0)
             {
-                AudioClip.Destroy(s_audioClip);
-                s_audioClip = null;
-            }
+                foreach (var audioClip in s_audioClips)
+                    AudioClip.Destroy(audioClip);
 
-            var fileName = Path.Combine(Paths.PluginPath, "Trashy", "hit.mp3");
-            if (!File.Exists(fileName))
-                return;
+                s_audioClips.Clear();
+            }
 
-            using (var request = UnityWebRequestMultimedia.GetAudioClip(
-                       new Uri(fileName),
-                       AudioType.MPEG
-                   ))
+            var soundsDirectory = Path.Combine(Paths.PluginPath, "Trashy", "Sounds");
+            foreach (var file in Directory.GetFiles(soundsDirectory, "*.*"))
             {
-                await request.SendWebRequest();
-                if (request.result != UnityWebRequest.Result.Success)
-                    Log.Error<SoundManager>("Unable to load hit.mp3");
-                else
-                    s_audioClip = DownloadHandlerAudioClip.GetContent(request);
+                // Load audio clip and add it to the list
+                var clip = await LoadClip(file);
+                if (clip)
+                    s_audioClips.Add(clip);
             }
         }
 
         private async void Start()
         {
-            await LoadAudioClip();
+            Migrate1();
+            await LoadAudioClips();
             for (var i = 0; i < MaxSounds; ++i)
             {
                 var audioSource = gameObject.AddComponent<AudioSource>();
@@ -93,5 +116,48 @@ private void Update()
                 }
             }
         }
+
+        private static AudioType AudioTypeForFile(string fileName)
+        {
+            var extension = Path.GetExtension(fileName);
+            switch (extension.ToLower())
+            {
+                case ".wav":
+                    return AudioType.WAV;
+
+                case ".mp3":
+                    return AudioType.MPEG;
+
+                case ".ogg":
+                    return AudioType.OGGVORBIS;
+
+                case ".aiff":
+                case ".aif":
+                    return AudioType.AIFF;
+
+                default:
+                    return AudioType.UNKNOWN;
+            }
+        }
+
+        private static void Migrate1()
+        {
+            // Migrate from 0.3.3
+            // Sounds are now in Trashy/Sounds, move old hit.mp3 to that directory
+
+            var fileName = Path.Combine(Paths.PluginPath, "Trashy", "hit.mp3");
+            if (!File.Exists(fileName))
+                return;
+
+            var soundsDirectory = Path.Combine(Paths.PluginPath, "Trashy", "Sounds");
+            if (!Directory.Exists(soundsDirectory))
+                Directory.CreateDirectory(soundsDirectory);
+
+            var newFileName = Path.Combine(soundsDirectory, "hit.mp3");
+            if (File.Exists(newFileName))
+                File.Delete(newFileName);
+
+            File.Move(fileName, Path.Combine(soundsDirectory, "hit.mp3"));
+        }
     }
 }

src/Trashy/UI/Windows/GeneralConfigWindow.cs

@@ -100,8 +100,8 @@ private async void DrawWindow(int windowId)
                 if (GUILayout.Button("Reload Items"))
                     _spriteManager.Load();
 
-                if (GUILayout.Button("Reload hit sound"))
-                    await SoundManager.LoadAudioClip();
+                if (GUILayout.Button("Reload hit sounds"))
+                    await SoundManager.LoadAudioClips();
 
                 if (TwitchAuth.IsValidating)
                 {