Adds the Volume Mixer to adjust individual channel volumes (#15507)

* Adds the Volume Mixer

* Address AA

* LF -> CRLF

* Puts thunderdome.ogg on CHANNEL_ADMIN

* Update interface name

code/modules/client/preference/preferences.dm

@@ -184,8 +184,18 @@ GLOBAL_LIST_INIT(special_role_times, list( //minimum age (in days) for accounts
 	var/slot_name = ""
 	var/saved = FALSE // Indicates whether the character comes from the database or not
 
-	// jukebox volume
-	var/volume = 100
+	/// Volume mixer, indexed by channel as TEXT (numerical indexes will not work). Volume goes from 0 to 100.
+	var/list/volume_mixer = list(
+		"1024" = 100, // CHANNEL_LOBBYMUSIC
+		"1023" = 100, // CHANNEL_ADMIN
+		"1022" = 100, // CHANNEL_VOX
+		"1021" = 100, // CHANNEL_JUKEBOX
+		"1020" = 100, // CHANNEL_HEARTBEAT
+		"1019" = 100, // CHANNEL_BUZZ
+		"1018" = 100, // CHANNEL_AMBIENCE
+	)
+	/// The volume mixer save timer handle. Used to debounce the DB call to save, to avoid spamming.
+	var/volume_mixer_saving = null
 
 	// BYOND membership
 	var/unlock_content = 0

code/modules/client/preference/preferences_mysql.dm

@@ -10,7 +10,7 @@
 					toggles,
 					toggles_2,
 					sound,
-					volume,
+					volume_mixer,
 					lastchangelog,
 					exp,
 					clientfps,
@@ -38,7 +38,7 @@
 		toggles = text2num(query.item[7])
 		toggles2 = text2num(query.item[8])
 		sound = text2num(query.item[9])
-		volume = text2num(query.item[10])
+		volume_mixer = deserialize_volume_mixer(query.item[10])
 		lastchangelog = query.item[11]
 		exp = query.item[12]
 		clientfps = text2num(query.item[13])
@@ -57,7 +57,6 @@
 	sound			= sanitize_integer(sound, 0, 65535, initial(sound))
 	UI_style_color	= sanitize_hexcolor(UI_style_color, initial(UI_style_color))
 	UI_style_alpha	= sanitize_integer(UI_style_alpha, 0, 255, initial(UI_style_alpha))
-	volume			= sanitize_integer(volume, 0, 100, initial(volume))
 	lastchangelog	= sanitize_text(lastchangelog, initial(lastchangelog))
 	exp	= sanitize_text(exp, initial(exp))
 	clientfps = sanitize_integer(clientfps, 0, 1000, initial(clientfps))
@@ -74,6 +73,11 @@
 			log_runtime(EXCEPTION("[C.key] had a malformed role entry: '[role]'. Removing!"), src)
 			be_special -= role
 
+	// We're saving volume_mixer here as well, so no point in keeping the timer running
+	if(volume_mixer_saving)
+		deltimer(volume_mixer_saving)
+		volume_mixer_saving = null
+
 	var/datum/db_query/query = SSdbcore.NewQuery({"UPDATE [format_table_name("player")]
 				SET
 					ooccolor=:ooccolour,
@@ -86,7 +90,7 @@
 					toggles_2=:toggles2,
 					atklog=:atklog,
 					sound=:sound,
-					volume=:volume,
+					volume_mixer=:volume_mixer,
 					lastchangelog=:lastchangelog,
 					clientfps=:clientfps,
 					parallax=:parallax
@@ -103,7 +107,7 @@
 						"toggles2" = num2text(toggles2, CEILING(log(10, (TOGGLES_2_TOTAL)), 1)),
 						"atklog" = atklog,
 						"sound" = sound,
-						"volume" = volume,
+						"volume_mixer" = serialize_volume_mixer(volume_mixer),
 						"lastchangelog" = lastchangelog,
 						"clientfps" = clientfps,
 						"parallax" = parallax,
@@ -657,3 +661,24 @@
 
 	saved = FALSE
 	return TRUE
+
+/**
+  * Saves [/datum/preferences/proc/volume_mixer] for the current client.
+  */
+/datum/preferences/proc/save_volume_mixer()
+	volume_mixer_saving = null
+
+	var/datum/db_query/update_query = SSdbcore.NewQuery(
+		"UPDATE [format_table_name("player")] SET volume_mixer=:volume_mixer WHERE ckey=:ckey",
+		list(
+			"volume_mixer" = serialize_volume_mixer(volume_mixer),
+			"ckey" = parent.ckey
+		)
+	)
+
+	if(!update_query.warn_execute())
+		qdel(update_query)
+		return FALSE
+
+	qdel(update_query)
+	return TRUE

code/modules/client/preference/preferences_volume_mixer.dm

@@ -0,0 +1,84 @@
+/**
+  * Returns a DB-friendly version of a volume mixer list.
+  *
+  * Arguments
+  * * vm - The volume mixer list to serialize.
+  */
+/datum/preferences/proc/serialize_volume_mixer(list/vm)
+	var/list/temp = list()
+	for(var/channel in vm)
+		if(!get_channel_name(text2num(channel)))
+			continue
+		temp["[channel]"] = vm[channel]
+	return json_encode(temp)
+
+/**
+  * Returns a volume mixer list from text, usually from the DB.
+  *
+  * Failure to deserialize will return the current value.
+  *
+  * Arguments
+  * * vmt - The volume mixer list to deserialize.
+  */
+/datum/preferences/proc/deserialize_volume_mixer(vmt)
+	if(!istext(vmt))
+		return volume_mixer
+	var/list/vm = json_decode(vmt)
+	if(!islist(vm))
+		return volume_mixer
+	var/list/temp = list()
+	// Ensure the default values are present
+	for(var/channel in volume_mixer)
+		temp[channel] = volume_mixer[channel]
+	for(var/channel in vm)
+		if(!get_channel_name(text2num(channel)))
+			continue
+		temp[channel] = vm[channel]
+	return temp
+
+/**
+  * Changes a channel's volume then queues it for DB save.
+  *
+  * Arguments:
+  * * channel - The channel whose volume to change.
+  * * volume - The new volume, clamped between 0 and 100.
+  * * debounce_save - Whether to debounce the save call to prevent spamming of DB calls.
+  */
+/datum/preferences/proc/set_channel_volume(channel, volume, debounce_save = TRUE)
+	if(!get_channel_name(channel))
+		return
+	// Set the volume
+	volume = clamp(volume, 0, 100)
+	volume_mixer["[channel]"] = volume
+	// Update the sound channel
+	var/sound/S = sound(null, channel = channel, volume = volume)
+	S.status = SOUND_UPDATE
+	SEND_SOUND(parent, S)
+	// Save it
+	if(debounce_save)
+		volume_mixer_saving = addtimer(CALLBACK(src, .proc/save_volume_mixer), 3 SECONDS, TIMER_UNIQUE | TIMER_OVERRIDE | TIMER_STOPPABLE)
+	else
+		if(volume_mixer_saving)
+			deltimer(volume_mixer_saving)
+		save_volume_mixer()
+
+/**
+  * Returns a volume multiplier for the given channel, from 0 to 1 (default).
+  *
+  * Arguments:
+  * * channel - The channel whose volume to get.
+  */
+/datum/preferences/proc/get_channel_volume(channel)
+	if(!istext(channel))
+		channel = "[channel]"
+	if(isnull(volume_mixer[channel]))
+		return 1
+	return clamp(volume_mixer[channel] / 100, 0, 1)
+
+/client/verb/volume_mixer()
+	set name = "Open Volume Mixer"
+	set category = "Preferences"
+	set hidden = TRUE
+
+	var/datum/ui_module/volume_mixer/VM = new()
+	VM.ui_interact(usr)