fix: select screen music reset

Fixes https://discord.com/channels/233345562261323776/233363722934943744/1497285469761962024
Related to #3537 fix attempt.

Author: K4thos

src/script.go

@@ -2884,6 +2884,7 @@ func systemScriptInit(l *lua.LState) {
 					sys.statsLog.finalizeMatch()
 				}
 				// Cleanup
+				sys.restorePauseVolume()
 				sys.timerStart = 0
 				sys.timerRounds = []int32{}
 				sys.scoreStart = [2]float32{}

src/sound.go

@@ -303,6 +303,7 @@ type Bgm struct {
 	filename   string
 	bgmVolume  int
 	volRestore int
+	pauseVolumeApplied bool
 	loop       int
 	streamer   beep.StreamSeeker
 	ctrl       *beep.Ctrl
@@ -326,6 +327,8 @@ func (bgm *Bgm) Stop() {
 		})
 	}
 	bgm.filename = ""
+	bgm.volRestore = 0
+	bgm.pauseVolumeApplied = false
 }
 
 func (bgm *Bgm) Open(filename string, loop, bgmVolume, bgmLoopStart, bgmLoopEnd, startPosition int, freqmul float32, loopcount int) {
@@ -342,6 +345,8 @@ func (bgm *Bgm) Open(filename string, loop, bgmVolume, bgmLoopStart, bgmLoopEnd,
 	bgm.loop = loop
 	bgm.bgmVolume = bgmVolume
 	bgm.freqmul = freqmul
+	bgm.volRestore = 0
+	bgm.pauseVolumeApplied = false
 	// Starve the current music streamer
 	if bgm.ctrl != nil {
 		WithSpeakerLock(func() {
@@ -422,11 +427,11 @@ func (bgm *Bgm) Open(filename string, loop, bgmVolume, bgmLoopStart, bgmLoopEnd,
 	dstFreq := beep.SampleRate(float32(sys.cfg.Sound.SampleRate) / bgm.freqmul)
 	resampler := beep.Resample(Clamp(sys.cfg.Sound.AudioResampleQuality, 1, 16), bgm.sampleRate, dstFreq, bgm.volctrl)
 	bgm.ctrl = &beep.Ctrl{Streamer: resampler}
-	bgm.volRestore = 0 // need this to prevent paused BGM volume from overwriting the new BGM volume
 	if sys.paused && sys.pauseVolumeApplied {
 		// A new BGM can start while the game is already paused.
 		bgm.volRestore = bgm.bgmVolume
 		bgm.bgmVolume = int(sys.cfg.Sound.PauseMasterVolume * bgm.bgmVolume / 100.0)
+		bgm.pauseVolumeApplied = true
 	}
 	bgm.UpdateVolume()
 	bgm.streamer.Seek(startPosition)
@@ -619,6 +624,8 @@ func (bgm *Bgm) OpenFromStreamer(stream beep.Streamer, srcSampleRate beep.Sample
 	bgm.loop = 0
 	bgm.bgmVolume = bgmVolume
 	bgm.freqmul = 1
+	bgm.volRestore = 0
+	bgm.pauseVolumeApplied = false
 
 	// Starve the current music streamer
 	if bgm.ctrl != nil {
@@ -640,11 +647,11 @@ func (bgm *Bgm) OpenFromStreamer(stream beep.Streamer, srcSampleRate beep.Sample
 	dstFreq := beep.SampleRate(float32(sys.cfg.Sound.SampleRate) / bgm.freqmul)
 	resampler := beep.Resample(Clamp(sys.cfg.Sound.AudioResampleQuality, 1, 16), bgm.sampleRate, dstFreq, bgm.volctrl)
 	bgm.ctrl = &beep.Ctrl{Streamer: resampler}
-	bgm.volRestore = 0
 	if sys.paused && sys.pauseVolumeApplied {
 		// A video-backed BGM can also be attached while pause is active.
 		bgm.volRestore = bgm.bgmVolume
 		bgm.bgmVolume = int(sys.cfg.Sound.PauseMasterVolume * bgm.bgmVolume / 100.0)
+		bgm.pauseVolumeApplied = true
 	}
 	bgm.UpdateVolume()
 	speaker.Play(bgm.ctrl)

src/system.go

@@ -926,22 +926,30 @@ func (s *System) tickSound() {
 
 	if s.paused {
 		// Apply BGM pause volume once per pause, even when the original BGM volume is 0.
-		// volRestore cannot be used as the latch because 0 is a valid volume and also
-		// the default value when no BGM is playing.
-		if !s.pauseVolumeApplied {
+		// volRestore cannot be used as the latch because 0 is a valid volume.
+		if !s.bgm.pauseVolumeApplied {
 			s.bgm.volRestore = s.bgm.bgmVolume
 			s.bgm.bgmVolume = int(s.cfg.Sound.PauseMasterVolume * s.bgm.bgmVolume / 100.0)
 			s.bgm.UpdateVolume()
-			s.pauseVolumeApplied = true
+			s.bgm.pauseVolumeApplied = true
 		}
 
 		// Run every paused tick so sounds started while paused are also softened.
+		s.pauseVolumeApplied = true
 		s.softenAllSound()
-	} else if s.pauseVolumeApplied {
-		// Restore all volume
+	} else if s.pauseVolumeApplied || s.bgm.pauseVolumeApplied {
+		s.restorePauseVolume()
+	}
+}
+
+func (s *System) restorePauseVolume() {
+	if s.bgm.pauseVolumeApplied {
 		s.bgm.bgmVolume = s.bgm.volRestore
 		s.bgm.volRestore = 0
+		s.bgm.pauseVolumeApplied = false
 		s.bgm.UpdateVolume()
+	}
+	if s.pauseVolumeApplied {
 		s.restoreAllVolume()
 		s.pauseVolumeApplied = false
 	}
@@ -2148,6 +2156,7 @@ func (s *System) resetRoundState() {
 
 	s.resetFrameTime()
 
+	s.restorePauseVolume()
 	s.paused = false
 	s.introSkipCall = false
 	s.roundResetFlg = false