Merge branch 'streamer-music-mode' into 'master'

Add streamer safe music mode

Closes #1334

See merge request KartKrew/Kart!2327

src/cvars.cpp

@@ -318,6 +318,7 @@ void Captioning_OnChange(void);
 consvar_t cv_closedcaptioning = Player("closedcaptioning", "Off").on_off().onchange(Captioning_OnChange);
 
 consvar_t cv_continuousmusic = Player("continuousmusic", "On").on_off();
+consvar_t cv_streamersafemusic = Player("streamersafemusic", "Off").on_off();
 consvar_t cv_controlperkey = Player("controlperkey", "One").values({{1, "One"}, {2, "Several"}});
 
 // actual general (maximum) sound & music volume, saved into the config

src/menus/options-sound.cpp

@@ -292,6 +292,9 @@ menuitem_t OPTIONS_Sound[] =
 	{IT_STRING | IT_CVAR, "Continuous Attack Music", "Keep music playing seamlessly when retrying in Attack modes.",
 		NULL, {.cvar = &cv_continuousmusic}, 0, 0},
 
+	{IT_STRING | IT_CVAR, "Streamer-Safe Music", "Only play music safe for video platforms.",
+		NULL, {.cvar = &cv_streamersafemusic}, 0, 0},
+
 	{IT_SPACE | IT_DYBIGSPACE, NULL,  NULL,
 		NULL, {NULL}, 0, 0},
 

src/music_manager.cpp

@@ -81,7 +81,12 @@ void TuneManager::tick()
 	{
 		if (load())
 		{
-			I_PlaySong(tune->loop);
+			musicdef_t* def = find_musicdef();
+			if (!cv_streamersafemusic.value || (def != nullptr && !def->contentidunsafe))
+			{
+				I_PlaySong(tune->loop);
+			}
+
 			I_FadeSongFromVolume(
 				tune->use_level_volume ? level_volume_ : 100,
 				0,
@@ -151,7 +156,11 @@ void TuneManager::pause_unpause() const
 		}
 		else
 		{
-			I_ResumeSong();
+			musicdef_t* def = find_musicdef();
+			if (!cv_streamersafemusic.value || (def != nullptr && !def->contentidunsafe))
+			{
+				I_ResumeSong();
+			}
 		}
 	}
 }
@@ -168,6 +177,12 @@ bool TuneManager::load() const
 	return I_LoadSong(static_cast<char*>(W_CacheLumpNum(lumpnum, PU_MUSIC)), W_LumpLength(lumpnum));
 }
 
+musicdef_t* TuneManager::find_musicdef() const
+{
+	uint8_t index = 0;
+	return S_FindMusicDef(current_song_.c_str(), &index);
+}
+
 void TuneManager::adjust_volume() const
 {
 	UINT8 i;

src/music_manager.hpp

@@ -121,6 +121,7 @@ private:
 	}
 
 	bool load() const;
+	musicdef_t* find_musicdef() const;
 	void adjust_volume() const;
 
 	bool resync();

src/s_sound.c

@@ -2041,6 +2041,11 @@ ReadMusicDefFields
 				textline[0] = toupper(textline[0]);
 				def->important = (textline[0] == 'Y' || textline[0] == 'T' || textline[0] == '1');
 			}
+			else if (!stricmp(stoken, "contentidunsafe"))
+			{
+				textline[0] = toupper(textline[0]);
+				def->contentidunsafe = (textline[0] == 'Y' || textline[0] == 'T' || textline[0] == '1');
+			}
 			else
 			{
 				MusicDefError(CONS_WARNING,

src/s_sound.h

@@ -43,6 +43,7 @@ extern consvar_t cv_gamedigimusic;
 
 extern consvar_t cv_gamesounds;
 extern consvar_t cv_bgaudio;
+extern consvar_t cv_streamersafemusic;
 
 typedef enum
 {
@@ -171,6 +172,7 @@ struct musicdef_t
 	int volume;
 	int debug_volume;
 	boolean important;
+	boolean contentidunsafe;
 	musicdef_t *next;
 	soundtestsequence_t sequence;
 };