Merge pull request #9492 from peppy/ensure-music-playing-mainmenu-lounge

Ensure music playing when returning to lounge or main menu

osu.Game.Tests/Visual/Navigation/TestSceneScreenNavigation.cs

@@ -6,6 +6,7 @@ using NUnit.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Audio.Track;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Screens;
 using osu.Game.Beatmaps;
 using osu.Game.Overlays;
 using osu.Game.Overlays.Mods;
@@ -70,6 +71,23 @@ namespace osu.Game.Tests.Visual.Navigation
             AddAssert("Ensure time wasn't reset to preview point", () => track().CurrentTime < beatmap().Metadata.PreviewTime);
         }
 
+        [Test]
+        public void TestMenuMakesMusic()
+        {
+            WorkingBeatmap beatmap() => Game.Beatmap.Value;
+            Track track() => beatmap().Track;
+
+            TestSongSelect songSelect = null;
+
+            PushAndConfirm(() => songSelect = new TestSongSelect());
+
+            AddUntilStep("wait for no track", () => track() is TrackVirtual);
+
+            AddStep("return to menu", () => songSelect.Exit());
+
+            AddUntilStep("wait for track", () => !(track() is TrackVirtual) && track().IsRunning);
+        }
+
         [Test]
         public void TestExitSongSelectWithClick()
         {

osu.Game/Beatmaps/BeatmapManager.cs

@@ -283,14 +283,16 @@ namespace osu.Game.Beatmaps
         /// Returns a list of all usable <see cref="BeatmapSetInfo"/>s.
         /// </summary>
         /// <returns>A list of available <see cref="BeatmapSetInfo"/>.</returns>
-        public List<BeatmapSetInfo> GetAllUsableBeatmapSets(IncludedDetails includes = IncludedDetails.All) => GetAllUsableBeatmapSetsEnumerable(includes).ToList();
+        public List<BeatmapSetInfo> GetAllUsableBeatmapSets(IncludedDetails includes = IncludedDetails.All, bool includeProtected = false) =>
+            GetAllUsableBeatmapSetsEnumerable(includes, includeProtected).ToList();
 
         /// <summary>
         /// Returns a list of all usable <see cref="BeatmapSetInfo"/>s. Note that files are not populated.
         /// </summary>
         /// <param name="includes">The level of detail to include in the returned objects.</param>
+        /// <param name="includeProtected">Whether to include protected (system) beatmaps. These should not be included for gameplay playable use cases.</param>
         /// <returns>A list of available <see cref="BeatmapSetInfo"/>.</returns>
-        public IEnumerable<BeatmapSetInfo> GetAllUsableBeatmapSetsEnumerable(IncludedDetails includes)
+        public IEnumerable<BeatmapSetInfo> GetAllUsableBeatmapSetsEnumerable(IncludedDetails includes, bool includeProtected = false)
         {
             IQueryable<BeatmapSetInfo> queryable;
 
@@ -312,7 +314,7 @@ namespace osu.Game.Beatmaps
             // AsEnumerable used here to avoid applying the WHERE in sql. When done so, ef core 2.x uses an incorrect ORDER BY
             // clause which causes queries to take 5-10x longer.
             // TODO: remove if upgrading to EF core 3.x.
-            return queryable.AsEnumerable().Where(s => !s.DeletePending && !s.Protected);
+            return queryable.AsEnumerable().Where(s => !s.DeletePending && (includeProtected || !s.Protected));
         }
 
         /// <summary>

osu.Game/Overlays/MusicController.cs

@@ -5,6 +5,7 @@ using System;
 using System.Collections.Generic;
 using System.Linq;
 using osu.Framework.Allocation;
+using osu.Framework.Audio.Track;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Input.Bindings;
@@ -71,7 +72,7 @@ namespace osu.Game.Overlays
             managerRemoved = beatmaps.ItemRemoved.GetBoundCopy();
             managerRemoved.BindValueChanged(beatmapRemoved);
 
-            beatmapSets.AddRange(beatmaps.GetAllUsableBeatmapSets(IncludedDetails.Minimal).OrderBy(_ => RNG.Next()));
+            beatmapSets.AddRange(beatmaps.GetAllUsableBeatmapSets(IncludedDetails.Minimal, true).OrderBy(_ => RNG.Next()));
         }
 
         protected override void LoadComplete()
@@ -133,6 +134,29 @@ namespace osu.Game.Overlays
             });
         }
 
+        /// <summary>
+        /// Ensures music is playing, no matter what, unless the user has explicitly paused.
+        /// This means that if the current beatmap has a virtual track (see <see cref="TrackVirtual"/>) a new beatmap will be selected.
+        /// </summary>
+        public void EnsurePlayingSomething()
+        {
+            if (IsUserPaused) return;
+
+            var track = current?.Track;
+
+            if (track == null || track is TrackVirtual)
+            {
+                if (beatmap.Disabled)
+                    return;
+
+                next();
+            }
+            else if (!IsPlaying)
+            {
+                Play();
+            }
+        }
+
         /// <summary>
         /// Start playing the current track (if not already playing).
         /// </summary>
@@ -144,13 +168,7 @@ namespace osu.Game.Overlays
             IsUserPaused = false;
 
             if (track == null)
-            {
-                if (beatmap.Disabled)
-                    return false;
-
-                next(true);
-                return true;
-            }
+                return false;
 
             if (restart)
                 track.Restart();
@@ -228,10 +246,9 @@ namespace osu.Game.Overlays
         /// </summary>
         public void NextTrack() => Schedule(() => next());
 
-        private bool next(bool instant = false)
+        private bool next()
         {
-            if (!instant)
-                queuedDirection = TrackChangeDirection.Next;
+            queuedDirection = TrackChangeDirection.Next;
 
             var playable = BeatmapSets.SkipWhile(i => i.ID != current.BeatmapSetInfo.ID).ElementAtOrDefault(1) ?? BeatmapSets.FirstOrDefault();
 

osu.Game/Screens/Menu/MainMenu.cs

@@ -260,8 +260,7 @@ namespace osu.Game.Screens.Menu
             // we may have consumed our preloaded instance, so let's make another.
             preloadSongSelect();
 
-            if (Beatmap.Value.Track != null && music?.IsUserPaused != true)
-                Beatmap.Value.Track.Start();
+            music.EnsurePlayingSomething();
         }
 
         public override bool OnExiting(IScreen next)

osu.Game/Screens/Multi/Lounge/LoungeSubScreen.cs

@@ -11,6 +11,7 @@ using osu.Framework.Screens;
 using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Online.Multiplayer;
+using osu.Game.Overlays;
 using osu.Game.Overlays.SearchableList;
 using osu.Game.Screens.Multi.Lounge.Components;
 using osu.Game.Screens.Multi.Match;
@@ -31,6 +32,9 @@ namespace osu.Game.Screens.Multi.Lounge
         [Resolved]
         private Bindable<Room> selectedRoom { get; set; }
 
+        [Resolved(canBeNull: true)]
+        private MusicController music { get; set; }
+
         private bool joiningRoom;
 
         [BackgroundDependencyLoader]
@@ -122,6 +126,8 @@ namespace osu.Game.Screens.Multi.Lounge
             if (selectedRoom.Value?.RoomID.Value == null)
                 selectedRoom.Value = new Room();
 
+            music.EnsurePlayingSomething();
+
             onReturning();
         }