feat: ppy/osu-framework#6628

Author: acid-chicken

osu.Game/Localisation/AudioSettingsStrings.cs

@@ -24,6 +24,11 @@ public static class AudioSettingsStrings
         /// </summary>
         public static LocalisableString VolumeHeader => new TranslatableString(getKey(@"volume_header"), @"Volume");
 
+        /// <summary>
+        /// "Audio backend"
+        /// </summary>
+        public static LocalisableString AudioBackend => new TranslatableString(getKey(@"audio_backend"), @"Audio backend");
+
         /// <summary>
         /// "Output device"
         /// </summary>
@@ -99,6 +104,21 @@ public static class AudioSettingsStrings
         /// </summary>
         public static LocalisableString AdjustBeatmapOffsetAutomaticallyTooltip => new TranslatableString(getKey(@"adjust_beatmap_offset_automatically_tooltip"), @"If enabled, the offset suggested from last play on a beatmap is automatically applied.");
 
+        /// <summary>
+        /// "In order to change the audio backend, the game will close. Please open it again."
+        /// </summary>
+        public static LocalisableString ChangeAudioBackendConfirmation => new TranslatableString(getKey("change_audio_backend_confirmation"), @"In order to change the audio backend, the game will close. Please open it again.");
+
+        /// <summary>
+        /// "Exclusive mode behaviour"
+        /// </summary>
+        public static LocalisableString ExclusiveModeBehaviour => new TranslatableString(getKey("exclusive_mode_behaviour"), @"Exclusive mode behaviour");
+
+        /// <summary>
+        /// "Changes to this setting will only apply when using BASSWASAPI backend."
+        /// </summary>
+        public static LocalisableString ExclusiveModeAvailabilityNote => new TranslatableString(getKey(@"exclusive_mode_availability_note"), @"Changes to this setting will only apply when using BASSWASAPI backend.");
+
         private static string getKey(string key) => $@"{prefix}:{key}";
     }
 }

osu.Game/Overlays/Settings/Sections/Audio/AudioDevicesSettings.cs

@@ -3,14 +3,19 @@
 
 #nullable disable
 
+using System.Collections.Generic;
+using System.Linq;
+using osu.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Audio;
+using osu.Framework.Configuration;
 using osu.Framework.Graphics;
-using System.Collections.Generic;
-using System.Linq;
 using osu.Framework.Localisation;
+using osu.Framework.Platform;
+using osu.Game.Configuration;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Localisation;
+using osu.Game.Overlays.Dialog;
 
 namespace osu.Game.Overlays.Settings.Sections.Audio
 {
@@ -21,49 +26,93 @@ public partial class AudioDevicesSettings : SettingsSubsection
         [Resolved]
         private AudioManager audio { get; set; }
 
-        private SettingsDropdown<string> dropdown;
+        private SettingsDropdown<AudioBackend> backend;
+        private SettingsDropdown<string> device;
+        private SettingsDropdown<AudioExclusiveModeBehaviour> exclusiveModeBehaviour;
+
+        private bool automaticBackendInUse;
 
         [BackgroundDependencyLoader]
-        private void load()
+        private void load(FrameworkConfigManager config, OsuGame game, IDialogOverlay dialogOverlay)
         {
+            var currentBackend = config.GetBindable<AudioBackend>(FrameworkSetting.AudioBackend);
+            var currentExclusiveModeBehaviour = localConfig.GetBindable<AudioExclusiveModeBehaviour>(FrameworkSetting.AudioExclusiveModeBehaviour);
+            // Audio backend selection is currently only available on Windows for now.
+            currentBackend.Disabled = RuntimeInfo.OS != RuntimeInfo.Platform.Windows;
+            currentExclusiveModeBehaviour.Disabled = RuntimeInfo.OS != RuntimeInfo.Platform.Windows;
+            automaticBackendInUse = currentBackend.Value == AudioBackend.Automatic;
+
             Children = new Drawable[]
             {
-                dropdown = new AudioDeviceSettingsDropdown
+                backend = new SettingsEnumDropdown<AudioBackend>
+                {
+                    LabelText = AudioSettingsStrings.AudioBackend,
+                    Keywords = new[] { "backend", "bass", "wasapi" },
+                    Current = currentBackend,
+                    Items = game.GetPreferredAudioBackendsForCurrentPlatform(),
+                },
+                device = new AudioDeviceSettingsDropdown
                 {
                     LabelText = AudioSettingsStrings.OutputDevice,
-                    Keywords = new[] { "speaker", "headphone", "output" }
-                }
+                    Keywords = new[] { "speaker", "headphone", "output" },
+                },
+                exclusiveModeBehaviour = new SettingsEnumDropdown<AudioExclusiveModeBehaviour>
+                {
+                    LabelText = AudioSettingsStrings.ExclusiveModeBehaviour,
+                    Keywords = new[] { "exclusive", "latency" },
+                    Current = currentExclusiveModeBehaviour,
+                },
             };
 
+            currentBackend.BindValueChanged(r =>
+            {
+                if (r.NewValue != AudioBackend.BassWasapi)
+                    exclusiveModeBehaviour.SetNoticeText(AudioSettingsStrings.ExclusiveModeAvailabilityNote, true);
+                else
+                    exclusiveModeBehaviour.ClearNoticeText();
+
+                // Up to here is executed immediately.
+                if (r.OldValue == r.NewValue)
+                    return;
+
+                if (r.NewValue == game.ResolvedAudioBackend)
+                    return;
+
+                if (r.NewValue == AudioBackend.Automatic && automaticBackendInUse)
+                    return;
+
+                if (game?.RestartAppWhenExited() == true)
+                {
+                    game.AttemptExit();
+                }
+                else
+                {
+                    dialogOverlay?.Push(new ConfirmDialog(AudioSettingsStrings.ChangeAudioBackendConfirmation, () => game?.AttemptExit(), () =>
+                    {
+                        currentBackend.Value = automaticBackendInUse ? AudioBackend.Automatic : game?.ResolvedAudioBackend ?? AudioBackend.Automatic;
+                    }));
+                }
+            }, true);
+
             updateItems();
 
             audio.OnNewDevice += onDeviceChanged;
             audio.OnLostDevice += onDeviceChanged;
-            dropdown.Current = audio.AudioDevice;
+            device.Current = audio.AudioDevice;
         }
 
-        private void onDeviceChanged(string name) => updateItems();
+        private void onDeviceChanged(KeyValuePair<string, string> _) => updateItems();
 
         private void updateItems()
         {
             var deviceItems = new List<string> { string.Empty };
-            deviceItems.AddRange(audio.AudioDeviceNames);
+            deviceItems.AddRange(audio.AudioDevices.Keys);
 
             string preferredDeviceName = audio.AudioDevice.Value;
             if (deviceItems.All(kv => kv != preferredDeviceName))
                 deviceItems.Add(preferredDeviceName);
 
-            // The option dropdown for audio device selection lists all audio
-            // device names. Dropdowns, however, may not have multiple identical
-            // keys. Thus, we remove duplicate audio device names from
-            // the dropdown. BASS does not give us a simple mechanism to select
-            // specific audio devices in such a case anyways. Such
-            // functionality would require involved OS-specific code.
-            dropdown.Items = deviceItems
-                             // Dropdown doesn't like null items. Somehow we are seeing some arrive here (see https://github.com/ppy/osu/issues/21271)
-                             .Where(i => i != null)
-                             .Distinct()
-                             .ToList();
+            device.Items = deviceItems.ToList();
         }
 
         protected override void Dispose(bool isDisposing)
@@ -83,8 +132,15 @@ private partial class AudioDeviceSettingsDropdown : SettingsDropdown<string>
 
             private partial class AudioDeviceDropdownControl : DropdownControl
             {
+                [Resolved]
+                private AudioManager audio { get; set; }
+
                 protected override LocalisableString GenerateItemText(string item)
-                    => string.IsNullOrEmpty(item) ? CommonStrings.Default : base.GenerateItemText(item);
+                    => string.IsNullOrEmpty(item)
+                        ? CommonStrings.Default
+                        : audio is AudioManager manager && manager.AudioDevices.TryGetValue(item, out string value)
+                            ? value
+                            : item;
             }
         }
     }