Audio Device Switching Option

Author: Raltyro

source/funkin/Preferences.hx

@@ -415,6 +415,38 @@ class Preferences
     return value;
   }
 
+  /**
+   * What audio device should it playback sounds to.
+   * @default Default
+   */
+  public static var audioDevice(get, set):String;
+
+  static function get_audioDevice():String
+  {
+    return Save?.instance?.options?.audioDevice ?? "Default";
+  }
+
+  static function set_audioDevice(value:String):String
+  {
+    if (value == Save.instance.options.audioDevice) return value;
+
+    var save:Save = Save.instance;
+    if (value != "Default" && lime.media.AudioManager.refresh(value))
+    {
+      lime.media.AudioManager.automaticDefaultPlaybackDevice = false;
+    }
+    else
+    {
+      lime.media.AudioManager.refresh();
+      lime.media.AudioManager.automaticDefaultPlaybackDevice = true;
+    }
+
+    save.options.audioDevice = value;
+    Save.system.flush();
+
+    return value;
+  }
+
   /**
    * If enabled, the game will hide the mouse when taking a screenshot.
    * @default `true`
@@ -484,6 +516,17 @@ class Preferences
     setDebugDisplayMode(Preferences.debugDisplay);
     setDebugDisplayBGOpacity(Preferences.debugDisplayBGOpacity / 100);
 
+    // Apply audio device preference, if failed, fallback to Default.
+    if (lime.media.AudioManager.refresh(Preferences.audioDevice))
+    {
+      lime.media.AudioManager.automaticDefaultPlaybackDevice = false;
+    }
+    else
+    {
+      Preferences.audioDevice = "Default";
+      lime.media.AudioManager.automaticDefaultPlaybackDevice = true;
+    }
+
     #if web
     toggleFramerateCap(Preferences.unlockedFramerate);
     #end

source/funkin/save/Save.hx

@@ -120,6 +120,7 @@ class Save implements ConsoleClass
           globalOffset: 0,
           audioVisualOffset: 0,
           unlockedFramerate: false,
+          audioDevice: 'Default',
           screenshot:
             {
               shouldHideMouse: true,
@@ -1232,6 +1233,12 @@ typedef SaveDataOptions =
    */
   var unlockedFramerate:Bool;
 
+  /**
+   * What audio device should it playback sounds to.
+   * @default 'Default'
+   */
+  var audioDevice:String;
+
   /**
    * Screenshot options
    * @param shouldHideMouse Should the mouse be hidden when taking a screenshot? Default: `true`

source/funkin/ui/options/PreferencesMenu.hx

@@ -25,6 +25,7 @@ import funkin.util.TouchUtil;
 import funkin.util.SwipeUtil;
 #end
 import funkin.util.HapticUtil;
+import lime.media.AudioManager;
 import lime.ui.WindowVSyncMode;
 
 class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
@@ -39,6 +40,10 @@ class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
   var hudCamera:FlxCamera;
   var camFollow:FlxObject;
 
+  #if desktop
+  var audioDeviceItem:EnumPreferenceItem<String>;
+  #end
+
   public function new()
   {
     super();
@@ -170,6 +175,17 @@ class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
     }, Preferences.autoFullscreen);
     #end
 
+    #if desktop
+    audioDeviceItem = createPrefItemEnum('Audio Device', 'What audio device should the game playbacks sounds to.', generateAudioDeviceEnums(),
+      (key:String, value:String) ->
+    {
+      Preferences.audioDevice = value;
+    }, Preferences.audioDevice);
+    AudioManager.onDefaultPlaybackDeviceChanged.add(refreshAudioDeviceItem);
+    AudioManager.onPlaybackDeviceAdded.add(refreshAudioDeviceItem);
+    AudioManager.onPlaybackDeviceRemoved.add(refreshAudioDeviceItem);
+    #end
+
     #if web
     createPrefItemCheckbox('Unlocked Framerate', 'When enabled, the framerate is unlocked.', function(value:Bool):Void {
       Preferences.unlockedFramerate = value;
@@ -260,7 +276,7 @@ class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
    * @param onChange Gets called every time the player changes the value; use this to apply the value
    * @param defaultValue The value that is loaded in when the pref item is created (usually your Preferences.settingVariable)
    */
-  function createPrefItemCheckbox(prefName:String, prefDesc:String, onChange:Bool->Void, defaultValue:Bool, available:Bool = true):Void
+  function createPrefItemCheckbox(prefName:String, prefDesc:String, onChange:Bool->Void, defaultValue:Bool, available:Bool = true):CheckboxPreferenceItem
   {
     var checkbox:CheckboxPreferenceItem = new CheckboxPreferenceItem(funkin.ui.FullScreenScaleMode.gameNotchSize.x, 120 * (items.length - 1 + 1),
       defaultValue, available);
@@ -273,6 +289,8 @@ class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
 
     preferenceItems.add(checkbox);
     preferenceDesc.push(prefDesc);
+
+    return checkbox;
   }
 
   /**
@@ -286,13 +304,16 @@ class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
    * @param precision Rounds decimals up to a `precision` amount of digits (ex: 4 -> 0.1234, 2 -> 0.12)
    */
   function createPrefItemNumber(prefName:String, prefDesc:String, onChange:Float->Void, ?valueFormatter:Float->String, defaultValue:Float, min:Float,
-      max:Float, step:Float = 0.1, precision:Int):Void
+      max:Float, step:Float = 0.1, precision:Int):NumberPreferenceItem
   {
     var item = new NumberPreferenceItem(funkin.ui.FullScreenScaleMode.gameNotchSize.x, (120 * items.length) + 30, prefName, defaultValue, min, max, step,
       precision, onChange, valueFormatter);
+
     items.addItem(prefName, item);
     preferenceItems.add(item.lefthandText);
     preferenceDesc.push(prefDesc);
+
+    return item;
   }
 
   /**
@@ -302,19 +323,23 @@ class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
    * @param min Minimum value (default = 0)
    * @param max Maximum value (default = 100)
    */
-  function createPrefItemPercentage(prefName:String, prefDesc:String, onChange:Int->Void, defaultValue:Int, min:Int = 0, max:Int = 100):Void
+  function createPrefItemPercentage(prefName:String, prefDesc:String, onChange:Int->Void, defaultValue:Int, min:Int = 0, max:Int = 100):NumberPreferenceItem
   {
     var newCallback = function(value:Float) {
       onChange(Std.int(value));
     };
     var formatter = function(value:Float) {
       return '${value}%';
     };
+
     var item = new NumberPreferenceItem(funkin.ui.FullScreenScaleMode.gameNotchSize.x, (120 * items.length) + 30, prefName, defaultValue, min, max, 10, 0,
       newCallback, formatter);
+
     items.addItem(prefName, item);
     preferenceItems.add(item.lefthandText);
     preferenceDesc.push(prefDesc);
+
+    return item;
   }
 
   /**
@@ -323,18 +348,44 @@ class PreferencesMenu extends Page<OptionsState.OptionsMenuPageName>
    * @param onChange Gets called every time the player changes the value; use this to apply the value
    * @param defaultValue The value that is loaded in when the pref item is created (usually your Preferences.settingVariable)
    */
-  function createPrefItemEnum<T>(prefName:String, prefDesc:String, values:Map<String, T>, onChange:String->T->Void, defaultKey:String):Void
+  function createPrefItemEnum<T>(prefName:String, prefDesc:String, values:Map<String, T>, onChange:String->T->Void, defaultKey:String):EnumPreferenceItem<T>
   {
     var item = new EnumPreferenceItem<T>(funkin.ui.FullScreenScaleMode.gameNotchSize.x, (120 * items.length) + 30, prefName, values, defaultKey, onChange);
+
     items.addItem(prefName, item);
     preferenceItems.add(item.lefthandText);
     preferenceDesc.push(prefDesc);
+
+    return item;
+  }
+
+  #if desktop
+  function generateAudioDeviceEnums():Map<String, String>
+  {
+    var enums = ['Default' => 'Default'];
+    var devices = AudioManager.getPlaybackDeviceNames();
+
+    for (device in devices)
+    {
+      enums.set(device, device);
+    }
+
+    return enums;
+  }
+
+  function refreshAudioDeviceItem(deviceName:String):Void
+  {
+    audioDeviceItem.changeEnums(generateAudioDeviceEnums(), Preferences.audioDevice);
   }
+  #end
 
   override function exit():Void
   {
     camFollow.setPosition(640, 30);
     menuCamera.snapToTarget();
+    AudioManager.onDefaultPlaybackDeviceChanged.remove(refreshAudioDeviceItem);
+    AudioManager.onPlaybackDeviceAdded.remove(refreshAudioDeviceItem);
+    AudioManager.onPlaybackDeviceRemoved.remove(refreshAudioDeviceItem);
     super.exit();
   }
 }

source/funkin/ui/options/items/EnumPreferenceItem.hx

@@ -30,14 +30,23 @@ class EnumPreferenceItem<T> extends TextMenuItem
   {
     super(x, y, name, function() {
       var value = map.get(this.currentKey);
-      callback(this.currentKey, value);
+      this.onChangeCallback(this.currentKey, value);
     });
 
     updateHitbox();
 
-    this.map = map;
-    this.currentKey = defaultKey;
     this.onChangeCallback = callback;
+    changeEnums(map, defaultKey);
+
+    lefthandText = new AtlasText(x + 15, y, formatted(defaultKey), AtlasFont.DEFAULT);
+
+    this.fireInstantly = true;
+  }
+
+  public function changeEnums(map:Map<String, T>, ?defaultKey:String):Void
+  {
+    this.map = map;
+    if (defaultKey != null) this.currentKey = defaultKey;
 
     var i:Int = 0;
     for (key in map.keys())
@@ -48,10 +57,6 @@ class EnumPreferenceItem<T> extends TextMenuItem
       if (this.currentKey == key) index = i;
       i += 1;
     }
-
-    lefthandText = new AtlasText(x + 15, y, formatted(defaultKey), AtlasFont.DEFAULT);
-
-    this.fireInstantly = true;
   }
 
   override function update(elapsed:Float):Void