Add global AudioManager

C7/Audio/AudioLoader.cs.uid

@@ -0,0 +1 @@
+uid://d3ppdw6qcpc4k

C7/Audio/AudioManager.cs

@@ -0,0 +1,184 @@
+
+using System;
+using C7Engine;
+using Godot;
+using Serilog;
+
+[GlobalClass]
+public partial class AudioManager : Node {
+	private ILogger log;
+
+	[Export] AudioStreamPlayer musicPlayer;
+	[Export] AudioStreamPlayer sfxPlayer;
+	[Export] AudioStreamPlayer uiPlayer;
+	[Export] AudioStreamPlayer ambiencePlayer;
+
+	public static string MusicBus = "Music";
+	public static string SfxBus = "Sfx";
+	public static string UIBus = "UI";
+	public static string AmbienceBus = "Ambience";
+
+	private bool musicEnabled = true;
+	private bool soundEnabled = true;
+	private bool uiEnabled = true;
+	private bool ambienceEnabled = true;
+
+	public override void _Ready() {
+		log = LogManager.ForContext<AudioManager>();
+		ConfigureMusic();
+		ConfigureSound();
+		ConfigureUI();
+		ConfigureAmbience();
+	}
+
+	private void ConfigureMusic() {
+		try {
+			string volume = C7Settings.GetSettingValue("audio", "musicVolume");
+			float volumeDb = LogicalVolumeAsDecibel(volume);
+
+			if (volumeDb == float.MinValue) {
+				musicEnabled = false;
+			}
+
+			if (musicEnabled) {
+				log.Debug("setting music volume to {volume}, which is {offset} decibel (offset)", volume, volumeDb);
+				int busIndex = AudioServer.GetBusIndex(MusicBus);
+				AudioServer.SetBusVolumeDb(busIndex, volumeDb);
+			}
+		} catch (ApplicationException ex) {
+			log.Error(ex, "could not configure music");
+		}
+	}
+
+	private void ConfigureSound() {
+		try {
+			string volume = C7Settings.GetSettingValue("audio", "soundVolume");
+			float volumeDb = LogicalVolumeAsDecibel(volume);
+
+			if (volumeDb == float.MinValue) {
+				soundEnabled = false;
+			}
+
+			if (soundEnabled) {
+				log.Debug("setting sound volume to {volume}, which is {offset} decibel (offset)", volume, volumeDb);
+				int busIndex = AudioServer.GetBusIndex(SfxBus);
+				AudioServer.SetBusVolumeDb(busIndex, volumeDb);
+			}
+		} catch (ApplicationException ex) {
+			log.Error(ex, "could not configure sound");
+		}
+	}
+
+	private void ConfigureUI() {
+		try {
+			string volume = C7Settings.GetSettingValue("audio", "uiVolume");
+			float volumeDb = LogicalVolumeAsDecibel(volume);
+
+			if (volumeDb == float.MinValue) {
+				uiEnabled = false;
+			}
+
+			if (uiEnabled) {
+				log.Debug("setting UI volume to {volume}, which is {offset} decibel (offset)", volume, volumeDb);
+				int busIndex = AudioServer.GetBusIndex(UIBus);
+				AudioServer.SetBusVolumeDb(busIndex, volumeDb);
+			}
+		} catch (ApplicationException ex) {
+			log.Error(ex, "could not configure UI audio");
+		}
+	}
+
+	private void ConfigureAmbience() {
+		try {
+			string volume = C7Settings.GetSettingValue("audio", "ambienceVolume");
+			float volumeDb = LogicalVolumeAsDecibel(volume);
+
+			if (volumeDb == float.MinValue) {
+				ambienceEnabled = false;
+			}
+
+			if (ambienceEnabled) {
+				log.Debug("setting ambience volume to {volume}, which is {offset} decibel (offset)", volume, volumeDb);
+				int busIndex = AudioServer.GetBusIndex(AmbienceBus);
+				AudioServer.SetBusVolumeDb(busIndex, volumeDb);
+			}
+		} catch (ApplicationException ex) {
+			log.Error(ex, "could not configure ambience audio");
+		}
+	}
+
+	/**
+	 * Godot uses a decibel offset volume system, described at https://docs.godotengine.org/en/stable/tutorials/audio/audio_buses.html
+	 * This is what audio professionals would use, but is not intuitive to end users.
+	 * In this system, a 6db difference halves or doubles the volume.
+	 * Our users are probably more used to a 0% to 100% system.
+	 * So this method converts between them.
+	 */
+	private float LogicalVolumeAsDecibel(string volume) {
+		if (volume == null) {
+			//First run.  Save the setting.
+			C7Settings.SetValue("audio", "musicVolume", "100");
+			C7Settings.SaveSettings();
+			return 0;
+		}
+		int userVolumeSetting = int.Parse(volume);
+		if (userVolumeSetting == 100) {
+			return 0;
+		} else if (userVolumeSetting == 0) {
+			return float.MinValue;
+		} else {
+			//Conversion math based on https://stackoverflow.com/a/37810295/3534605
+			return 20.0f * (float)(Math.Log10(userVolumeSetting / 100.0f));
+		}
+	}
+
+	// TODO: playlists, mixing, transitions
+	// See: https://www.youtube.com/watch?app=desktop&v=07Kyqqg31FI&t=346s
+
+	// TODO: polyphony via AudioStreamPolyphonic + AudioStreamPlaybackPolyphonic
+	// https://docs.godotengine.org/en/4.0/classes/class_audiostreampolyphonic.html
+
+	public void PlayMusic(string configKey) {
+		AudioStream stream = AudioLoader.Load(configKey);
+
+		if (stream == null)
+			return;
+
+		musicPlayer.Stream = stream;
+		musicPlayer.Play();
+	}
+
+	public void StopMusic() {
+		musicPlayer.Stop();
+	}
+
+	public void PlaySound(string configKey) {
+		AudioStream stream = AudioLoader.Load(configKey);
+
+		if (stream == null)
+			return;
+
+		sfxPlayer.Stream = stream;
+		sfxPlayer.Play();
+	}
+
+	public void PlayUI(string configKey) {
+		AudioStream stream = AudioLoader.Load(configKey);
+
+		if (stream == null)
+			return;
+
+		uiPlayer.Stream = stream;
+		uiPlayer.Play();
+	}
+
+	public void PlayAmbience(string configKey) {
+		AudioStream stream = AudioLoader.Load(configKey);
+
+		if (stream == null)
+			return;
+
+		ambiencePlayer.Stream = stream;
+		ambiencePlayer.Play();
+	}
+}

C7/Audio/AudioManager.cs.uid

@@ -0,0 +1 @@
+uid://eyk3k7dd7tcy

C7/Audio/AudioManager.tscn

@@ -0,0 +1,22 @@
+[gd_scene load_steps=2 format=3 uid="uid://4hh28tdyqvfg"]
+
+[ext_resource type="Script" uid="uid://eyk3k7dd7tcy" path="res://Audio/AudioManager.cs" id="1_l0aok"]
+
+[node name="AudioManager" type="Node" node_paths=PackedStringArray("musicPlayer", "sfxPlayer", "uiPlayer", "ambiencePlayer")]
+script = ExtResource("1_l0aok")
+musicPlayer = NodePath("MusicPlayer")
+sfxPlayer = NodePath("SfxPlayer")
+uiPlayer = NodePath("UIPlayer")
+ambiencePlayer = NodePath("AmbiencePlayer")
+
+[node name="MusicPlayer" type="AudioStreamPlayer" parent="."]
+bus = &"Music"
+
+[node name="SfxPlayer" type="AudioStreamPlayer" parent="."]
+bus = &"Sfx"
+
+[node name="UIPlayer" type="AudioStreamPlayer" parent="."]
+bus = &"UI"
+
+[node name="AmbiencePlayer" type="AudioStreamPlayer" parent="."]
+bus = &"Ambience"

C7/UIElements/MainMenu/MainMenu.cs

@@ -16,10 +16,9 @@ public partial class MainMenu : Node {
 	Civ3FileDialog LoadScenarioDialog;
 	[Export]
 	MenuButtonContainer ButtonContainer;
-	[Export]
-	AudioStreamPlayer player;
 
 	GlobalSingleton Global;
+	AudioManager AudioManager;
 
 	public override void _Ready() {
 		log = LogManager.ForContext<MainMenu>();
@@ -29,6 +28,8 @@ public override void _Ready() {
 
 		try {
 			DisplayTitleScreen();
+			AudioManager = GetNode<AudioManager>("/root/GlobalAudioManager");
+			PlayMusic();
 		} catch (Exception ex) {
 			log.Error(ex, "Could not set up the main menu");
 		}
@@ -148,16 +149,6 @@ public void _on_Exit_pressed() {
 		GetTree().Quit(); // no need to notify the scene tree
 	}
 
-	private void PlayButtonPressedSound() {
-		AudioStream stream = AudioLoader.Load("buttons.button_1");
-
-		if (stream == null)
-			return;
-
-		player.Stream = stream;
-		player.Play();
-	}
-
 	private void _on_SetCiv3Home_pressed() {
 		SetCiv3HomeDialog.Popup();
 	}
@@ -174,4 +165,12 @@ private void UseStandaloneModePressed() {
 		Global.ActivateGameMode(GamePaths.standalone);
 		DisplayTitleScreen();
 	}
+
+	private void PlayMusic() {
+		AudioManager.PlayMusic("menu.main_menu_1");
+	}
+
+	private void PlayButtonPressedSound() {
+		AudioManager.PlaySound("buttons.button_1");
+	}
 }

C7/UIElements/MainMenu/main_menu.tscn

@@ -1,11 +1,10 @@
-[gd_scene load_steps=11 format=3 uid="uid://gnt0y3og7nk6"]
+[gd_scene load_steps=10 format=3 uid="uid://gnt0y3og7nk6"]
 
 [ext_resource type="Script" uid="uid://dgpuse88jc2hc" path="res://UIElements/MainMenu/MainMenu.cs" id="1_akneh"]
 [ext_resource type="Texture2D" uid="uid://s55xvcaini8h" path="res://title-screen.png" id="2_erxyj"]
 [ext_resource type="Script" uid="uid://ca14gkdccjfcg" path="res://UIElements/MainMenu/MenuButtonContainer.cs" id="3_t1nuq"]
 [ext_resource type="FontFile" uid="uid://b1xkj8g82jbx5" path="res://Fonts/NotoSans-BoldItalic.ttf" id="3_x68dx"]
 [ext_resource type="Texture2D" uid="uid://ovwv08a53d7k" path="res://title.png" id="4_brea7"]
-[ext_resource type="Script" uid="uid://dauceqein40wj" path="res://UIElements/MainMenu/MainMenuMusicPlayer.cs" id="4_tqr50"]
 [ext_resource type="PackedScene" uid="uid://bvncm1bgcii5e" path="res://UIElements/civ3_file_dialog.tscn" id="5_rw2g7"]
 
 [sub_resource type="StyleBoxFlat" id="StyleBoxFlat_vbij8"]
@@ -127,9 +126,6 @@ theme_override_font_sizes/font_size = 11
 text = "Notice: standalone mode makes use of AI placeholder art"
 horizontal_alignment = 1
 
-[node name="MainMenuMusicPlayer" type="AudioStreamPlayer" parent="."]
-script = ExtResource("4_tqr50")
-
 [node name="SoundEffectPlayer" type="AudioStreamPlayer" parent="."]
 
 [node name="SetCiv3HomeDialog" type="FileDialog" parent="."]

C7/UIElements/NewGame/PlayerSetup.cs

@@ -256,6 +256,10 @@ private void PersistGameSettings(GameSetup gameSetup) {
 	}
 
 	private void StartGame() {
+		AudioManager audio = GetNode<AudioManager>("/root/GlobalAudioManager");
+		audio.StopMusic();
+		// TODO: switch to in-game playlist / music logic
+
 		GetTree().ChangeSceneToFile("res://C7Game.tscn");
 	}
 }

C7/default_bus_layout.tres

@@ -0,0 +1,27 @@
+[gd_resource type="AudioBusLayout" format=3 uid="uid://cw11tyqth76rn"]
+
+[resource]
+bus/1/name = &"Music"
+bus/1/solo = false
+bus/1/mute = false
+bus/1/bypass_fx = false
+bus/1/volume_db = 0.0
+bus/1/send = &"Master"
+bus/2/name = &"Sfx"
+bus/2/solo = false
+bus/2/mute = false
+bus/2/bypass_fx = false
+bus/2/volume_db = 0.0
+bus/2/send = &"Master"
+bus/3/name = &"UI"
+bus/3/solo = false
+bus/3/mute = false
+bus/3/bypass_fx = false
+bus/3/volume_db = 0.0
+bus/3/send = &"Master"
+bus/4/name = &"Ambience"
+bus/4/solo = false
+bus/4/mute = false
+bus/4/bypass_fx = false
+bus/4/volume_db = 0.0
+bus/4/send = &"Master"

C7/project.godot

@@ -21,6 +21,7 @@ config/icon="res://icon.png"
 
 GlobalSingleton="*res://GlobalSingleton.cs"
 LogManager="*res://LogManager.cs"
+GlobalAudioManager="*res://Audio/AudioManager.tscn"
 
 [display]