Logging + simplifying PlaylistProvider

devgianlu · devgianlu · commit aee0b76f7f0a · 2019-05-26T21:49:37.000+02:00
diff --git a/conf.properties b/conf.properties
@@ -33,8 +33,6 @@ player.preferredAudioQuality=VORBIS_160
 player.normalisationPregain=0
 # Initial volume (0-65536)
 player.initialVolume=65536
-# Default unshuffle behaviour (can't unshuffle if client is loaded with shuffled playlist)
-player.defaultUnshuffleBehaviour=false
 # Log available mixers
 player.logAvailableMixers=true
 # Mixer/backend search keywords
diff --git a/core/src/main/java/xyz/gianlu/librespot/DefaultConfiguration.java b/core/src/main/java/xyz/gianlu/librespot/DefaultConfiguration.java
@@ -28,11 +28,6 @@ public float normalisationPregain() {
         return 0;
     }
 
-    @Override
-    public boolean defaultUnshuffleBehaviour() {
-        return false;
-    }
-
     @Override
     public @NotNull String[] mixerSearchKeywords() {
         return new String[0];
diff --git a/core/src/main/java/xyz/gianlu/librespot/FileConfiguration.java b/core/src/main/java/xyz/gianlu/librespot/FileConfiguration.java
@@ -121,11 +121,6 @@ public float normalisationPregain() {
         return getFloat("player.normalisationPregain", defaults.normalisationPregain());
     }
 
-    @Override
-    public boolean defaultUnshuffleBehaviour() {
-        return getBoolean("player.defaultUnshuffleBehaviour", defaults.defaultUnshuffleBehaviour());
-    }
-
     @NotNull
     @Override
     public String[] mixerSearchKeywords() {
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/Player.java b/core/src/main/java/xyz/gianlu/librespot/player/Player.java
@@ -294,7 +294,7 @@ private void handleSeek(int pos) {
 
     private void loadTracksProvider(@NotNull String uri) throws SpotifyContext.UnsupportedContextException {
         SpotifyContext context = SpotifyContext.from(uri);
-        tracksProvider = context.initProvider(session, state.state, conf);
+        tracksProvider = context.initProvider(session, state.state);
     }
 
     @Override
@@ -618,8 +618,6 @@ public interface Configuration {
 
         float normalisationPregain();
 
-        boolean defaultUnshuffleBehaviour();
-
         @Nullable
         String[] mixerSearchKeywords();
 
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/AlbumContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/AlbumContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.PlaylistProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class AlbumContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
-        return new PlaylistProvider(session, state, conf);
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
+        return new PlaylistProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/ArtistContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/ArtistContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.PlaylistProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class ArtistContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
-        return new PlaylistProvider(session, state, conf);
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
+        return new PlaylistProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/CollectionContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/CollectionContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.PlaylistProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class CollectionContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
-        return new PlaylistProvider(session, state, conf);
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
+        return new PlaylistProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/DailyMixContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/DailyMixContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.StationProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class DailyMixContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
         return new StationProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/EpisodeContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/EpisodeContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.ShowProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class EpisodeContext extends AbsEpisodeContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
         return new ShowProvider(state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/GenreContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/GenreContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.PlaylistProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class GenreContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
-        return new PlaylistProvider(session, state, conf);
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
+        return new PlaylistProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/PlaylistContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/PlaylistContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.PlaylistProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class PlaylistContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
-        return new PlaylistProvider(session, state, conf);
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
+        return new PlaylistProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/SearchContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/SearchContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.PlaylistProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -18,7 +17,7 @@ public SearchContext(@NotNull String searchTerm) {
     }
 
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
-        return new PlaylistProvider(session, state, conf);
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
+        return new PlaylistProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/ShowContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/ShowContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.ShowProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class ShowContext extends AbsEpisodeContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
         return new ShowProvider(state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/SpotifyContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/SpotifyContext.java
@@ -4,7 +4,6 @@
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
 import xyz.gianlu.librespot.mercury.model.PlayableId;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
 import java.io.UnsupportedEncodingException;
@@ -96,7 +95,7 @@ static SpotifyContext<?> parseType(String[] split, int i) {
     P createId(@NotNull Spirc.TrackRef ref);
 
     @NotNull
-    TracksProvider initProvider(@NotNull Session session, @NotNull Spirc.State.Builder state, @NotNull Player.Configuration conf);
+    TracksProvider initProvider(@NotNull Session session, @NotNull Spirc.State.Builder state);
 
     class UnsupportedContextException extends Exception {
         UnsupportedContextException(@NotNull String message) {
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/StationContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/StationContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.StationProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class StationContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
         return new StationProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/contexts/TrackContext.java b/core/src/main/java/xyz/gianlu/librespot/player/contexts/TrackContext.java
@@ -3,7 +3,6 @@
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.common.proto.Spirc;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.tracks.PlaylistProvider;
 import xyz.gianlu.librespot.player.tracks.TracksProvider;
 
@@ -12,7 +11,7 @@
  */
 public final class TrackContext extends AbsTrackContext {
     @Override
-    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state, Player.@NotNull Configuration conf) {
-        return new PlaylistProvider(session, state, conf);
+    public @NotNull TracksProvider initProvider(@NotNull Session session, Spirc.State.@NotNull Builder state) {
+        return new PlaylistProvider(session, state);
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/player/tracks/PlaylistProvider.java b/core/src/main/java/xyz/gianlu/librespot/player/tracks/PlaylistProvider.java
@@ -8,7 +8,6 @@
 import xyz.gianlu.librespot.mercury.MercuryRequests;
 import xyz.gianlu.librespot.mercury.model.PlayableId;
 import xyz.gianlu.librespot.mercury.model.TrackId;
-import xyz.gianlu.librespot.player.Player;
 import xyz.gianlu.librespot.player.remote.Remote3Track;
 
 import java.io.IOException;
@@ -23,13 +22,11 @@
 public class PlaylistProvider implements TracksProvider {
     private static final Logger LOGGER = Logger.getLogger(PlaylistProvider.class);
     private final Spirc.State.Builder state;
-    private final Player.Configuration conf;
     private final MercuryClient mercury;
     private long shuffleSeed = 0;
 
-    public PlaylistProvider(@NotNull Session session, @NotNull Spirc.State.Builder state, @NotNull Player.Configuration conf) {
+    public PlaylistProvider(@NotNull Session session, @NotNull Spirc.State.Builder state) {
         this.state = state;
-        this.conf = conf;
         this.mercury = session.mercury();
     }
 
@@ -68,29 +65,50 @@ public void shuffleTracks(@NotNull Random random, boolean fully) {
 
         state.clearTrack();
         state.addAllTrack(tracks);
+        LOGGER.trace("Shuffled, seed: " + shuffleSeed);
     }
 
     public void unshuffleTracks() {
         if (state.getTrackCount() <= 1)
             return;
 
-        if (shuffleSeed == 0 && !conf.defaultUnshuffleBehaviour() && state.hasContextUri()) {
+        if (shuffleSeed != 0) {
+            List<Spirc.TrackRef> tracks = new ArrayList<>(state.getTrackList());
+            if (state.getPlayingTrackIndex() != 0) {
+                Collections.swap(tracks, 0, state.getPlayingTrackIndex());
+                state.setPlayingTrackIndex(0);
+            }
+
+            int size = tracks.size() - 1;
+            int[] exchanges = getShuffleExchanges(size, shuffleSeed);
+            for (int i = 2; i < size; i++) {
+                int n = exchanges[size - i - 1];
+                Collections.swap(tracks, i, n + 1);
+            }
+
+            state.clearTrack();
+            state.addAllTrack(tracks);
+
+            LOGGER.trace("Unshuffled using seed: " + shuffleSeed);
+            return;
+        }
+
+        if (state.hasContextUri()) {
             List<Remote3Track> tracks;
             try {
                 MercuryRequests.ResolvedContextWrapper context = mercury.sendSync(MercuryRequests.resolveContext(state.getContextUri()));
                 tracks = context.pages().get(0).tracks;
             } catch (IOException | MercuryClient.MercuryException ex) {
-                LOGGER.fatal("Failed requesting context!", ex);
+                LOGGER.fatal("Cannot unshuffle context!", ex);
                 return;
             }
 
             PlayableId.removeUnsupported(tracks, -1);
 
             Spirc.TrackRef current = state.getTrack(state.getPlayingTrackIndex());
+            String currentTrackUri = TrackId.fromTrackRef(current).toSpotifyUri();
 
             List<Spirc.TrackRef> rebuildState = new ArrayList<>(80);
-            TrackId currentTrackId = TrackId.fromTrackRef(current);
-            String currentTrackUri = currentTrackId.toSpotifyUri();
             boolean add = false;
             int count = 80;
             for (Remote3Track track : tracks) {
@@ -106,22 +124,10 @@ public void unshuffleTracks() {
             state.clearTrack();
             state.addAllTrack(rebuildState);
             state.setPlayingTrackIndex(0);
-        } else {
-            List<Spirc.TrackRef> tracks = new ArrayList<>(state.getTrackList());
-            if (state.getPlayingTrackIndex() != 0) {
-                Collections.swap(tracks, 0, state.getPlayingTrackIndex());
-                state.setPlayingTrackIndex(0);
-            }
 
-            int size = tracks.size() - 1;
-            int[] exchanges = getShuffleExchanges(size, shuffleSeed);
-            for (int i = 2; i < size; i++) {
-                int n = exchanges[size - i - 1];
-                Collections.swap(tracks, i, n + 1);
-            }
-
-            state.clearTrack();
-            state.addAllTrack(tracks);
+            LOGGER.trace("Unshuffled using context-resolve.");
+        } else {
+            LOGGER.fatal("Cannot unshuffle context! Did not know seed and context is missing.");
         }
     }
 
