Major player rewrite + event service implementation

core/src/main/java/xyz/gianlu/librespot/player/Player.java

@@ -35,10 +35,7 @@
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.Base64;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.concurrent.*;
 
 /**
@@ -55,7 +52,7 @@ public class Player implements Closeable, DeviceStateHandler.Listener, PlayerSes
     private StateWrapper state;
     private PlayerSession playerSession;
     private ScheduledFuture<?> releaseLineFuture = null;
-    private PlaybackMetrics metrics = null;
+    private Map<String, PlaybackMetrics> metrics = new HashMap<>(5);
 
     public Player(@NotNull Player.Configuration conf, @NotNull Session session) {
         this.conf = conf;
@@ -154,12 +151,8 @@ private void panicState(@Nullable PlaybackMetrics.Reason reason) {
 
         if (reason == null) {
             metrics = null;
-        } else if (metrics != null) {
-            metrics.endedHow(reason, null);
-            metrics.endInterval(state.getPosition());
-            metrics.update(playerSession != null ? playerSession.currentMetrics() : null);
-            session.eventService().trackPlayed(metrics);
-            metrics = null;
+        } else if (playerSession != null) {
+            endMetrics(playerSession.currentPlaybackId(), reason, playerSession.currentMetrics(), state.getPosition());
         }
     }
 
@@ -173,13 +166,7 @@ private void loadSession(@NotNull String sessionId, boolean play, boolean withSk
         TransitionInfo trans = TransitionInfo.contextChange(state, withSkip);
 
         if (playerSession != null) {
-            if (metrics != null) {
-                metrics.endedHow(trans.endedReason, state.getPlayOrigin().getFeatureIdentifier());
-                metrics.endInterval(trans.endedWhen);
-                metrics.update(playerSession.currentMetrics());
-                session.eventService().trackPlayed(metrics);
-                metrics = null;
-            }
+            endMetrics(playerSession.currentPlaybackId(), trans.endedReason, playerSession.currentMetrics(), trans.endedWhen);
 
             playerSession.close();
             playerSession = null;
@@ -200,13 +187,7 @@ private void loadSession(@NotNull String sessionId, boolean play, boolean withSk
      * @param trans A {@link TransitionInfo} object containing information about this track change
      */
     private void loadTrack(boolean play, @NotNull TransitionInfo trans) {
-        if (metrics != null) {
-            metrics.endedHow(trans.endedReason, state.getPlayOrigin().getFeatureIdentifier());
-            metrics.endInterval(trans.endedWhen);
-            metrics.update(playerSession.currentMetrics());
-            session.eventService().trackPlayed(metrics);
-            metrics = null;
-        }
+        endMetrics(playerSession.currentPlaybackId(), trans.endedReason, playerSession.currentMetrics(), trans.endedWhen);
 
         String playbackId = playerSession.play(state.getCurrentPlayableOrThrow(), state.getPosition(), trans.startedReason);
         state.setPlaybackId(playbackId);
@@ -222,9 +203,7 @@ private void loadTrack(boolean play, @NotNull TransitionInfo trans) {
         if (play) events.playbackResumed();
         else events.playbackPaused();
 
-        metrics = new PlaybackMetrics(state.getCurrentPlayableOrThrow(), playbackId, state);
-        metrics.startedHow(trans.startedReason, state.getPlayOrigin().getFeatureIdentifier());
-        metrics.startInterval(state.getPosition());
+        startMetrics(playbackId, trans.startedReason, state.getPosition());
 
         if (releaseLineFuture != null) {
             releaseLineFuture.cancel(true);
@@ -341,9 +320,10 @@ private void handleSeek(int pos) {
         state.setPosition(pos);
         events.seeked(pos);
 
-        if (metrics != null) {
-            metrics.endInterval(state.getPosition());
-            metrics.startInterval(pos);
+        PlaybackMetrics pm = metrics.get(playerSession.currentPlaybackId());
+        if (pm != null) {
+            pm.endInterval(state.getPosition());
+            pm.startInterval(pos);
         }
     }
 
@@ -497,6 +477,30 @@ private void loadAutoplay() {
     }
 
 
+    // ================================ //
+    // =========== Metrics ============ //
+    // ================================ //
+
+    private void startMetrics(String playbackId, @NotNull PlaybackMetrics.Reason reason, int pos) {
+        PlaybackMetrics pm = new PlaybackMetrics(state.getCurrentPlayableOrThrow(), playbackId, state);
+        pm.startedHow(reason, state.getPlayOrigin().getFeatureIdentifier());
+        pm.startInterval(pos);
+        metrics.put(playbackId, pm);
+    }
+
+    private void endMetrics(String playbackId, @NotNull PlaybackMetrics.Reason reason, @Nullable PlayerMetrics playerMetrics, int when) {
+        if (playbackId == null) return;
+
+        PlaybackMetrics pm = metrics.remove(playbackId);
+        if (pm == null) return;
+
+        pm.endedHow(reason, state.getPlayOrigin().getFeatureIdentifier());
+        pm.endInterval(when);
+        pm.update(playerMetrics);
+        session.eventService().trackPlayed(pm);
+    }
+
+
     // ================================ //
     // ======== Player events ========= //
     // ================================ //
@@ -554,20 +558,12 @@ public void trackChanged(@NotNull String playbackId, @Nullable TrackOrEpisode me
         events.trackChanged();
 
         session.eventService().newPlaybackId(state, playbackId);
-        metrics = new PlaybackMetrics(state.getCurrentPlayableOrThrow(), playbackId, state);
-        metrics.startedHow(startedReason, state.getPlayOrigin().getFeatureIdentifier());
-        metrics.startInterval(pos);
+        startMetrics(playbackId, startedReason, pos);
     }
 
     @Override
-    public void trackPlayed(@NotNull PlaybackMetrics.Reason endReason, @NotNull PlayerMetrics playerMetrics, int willEndAt) {
-        if (metrics != null) {
-            metrics.endedHow(endReason, state.getPlayOrigin().getFeatureIdentifier());
-            metrics.endInterval(willEndAt);
-            metrics.update(playerMetrics);
-            session.eventService().trackPlayed(metrics);
-            metrics = null;
-        }
+    public void trackPlayed(@NotNull String playbackId, @NotNull PlaybackMetrics.Reason endReason, @NotNull PlayerMetrics playerMetrics, int when) {
+        endMetrics(playbackId, endReason, playerMetrics, when);
     }
 
     @Override
@@ -716,13 +712,8 @@ public long time() {
 
     @Override
     public void close() {
-        if (metrics != null && playerSession != null) {
-            metrics.endedHow(PlaybackMetrics.Reason.LOGOUT, state.getPlayOrigin().getFeatureIdentifier());
-            metrics.endInterval(state.getPosition());
-            metrics.update(playerSession.currentMetrics());
-            session.eventService().trackPlayed(metrics);
-            metrics = null;
-        }
+        if (playerSession != null)
+            endMetrics(playerSession.currentPlaybackId(), PlaybackMetrics.Reason.LOGOUT, playerSession.currentMetrics(), state.getPosition());
 
         state.close();
         events.listeners.clear();

core/src/main/java/xyz/gianlu/librespot/player/crossfade/CrossfadeController.java

@@ -77,6 +77,8 @@ private void populateFadeOut(@NotNull Map<String, String> metadata) {
 
         if (fadeOutDuration != 0 && fadeOutCurves.size() > 0)
             fadeOutMap.put(Reason.TRACK_DONE, new FadeInterval(fadeOutStartTime, fadeOutDuration, LookupInterpolator.fromJson(getFadeCurve(fadeOutCurves))));
+        else if (defaultFadeDuration > 0)
+            fadeOutMap.put(Reason.TRACK_DONE, new FadeInterval(trackDuration - defaultFadeDuration, defaultFadeDuration, new LinearDecreasingInterpolator()));
 
 
         int backFadeOutDuration = Integer.parseInt(metadata.getOrDefault("audio.backbtn.fade_out_duration", "-1"));

core/src/main/java/xyz/gianlu/librespot/player/feeders/PlayableContentFeeder.java

@@ -33,7 +33,7 @@
 public final class PlayableContentFeeder {
     private static final Logger LOGGER = Logger.getLogger(PlayableContentFeeder.class);
     private static final String STORAGE_RESOLVE_INTERACTIVE = "/storage-resolve/files/audio/interactive/%s";
-    private static final String STORAGE_RESOLVE_INTERACTIVE_PREFETCH = "/storage-resolve/files/audio/interactive-prefetch/%s";
+    private static final String STORAGE_RESOLVE_INTERACTIVE_PREFETCH = "/storage-resolve/files/audio/interactive_prefetch/%s";
     protected final Session session;
 
     public PlayableContentFeeder(@NotNull Session session) {
@@ -58,10 +58,12 @@ private static Metadata.Track pickAlternativeIfNecessary(@NotNull Metadata.Track
 
     @NotNull
     public final LoadedStream load(@NotNull PlayableId id, @NotNull AudioQualityPreference audioQualityPreference, boolean preload, @Nullable HaltListener haltListener) throws CdnManager.CdnException, ContentRestrictedException, MercuryClient.MercuryException, IOException {
-        if (id instanceof TrackId) return loadTrack((TrackId) id, audioQualityPreference, preload, haltListener);
+        if (id instanceof TrackId)
+            return loadTrack((TrackId) id, audioQualityPreference, preload, haltListener);
         else if (id instanceof EpisodeId)
             return loadEpisode((EpisodeId) id, audioQualityPreference, preload, haltListener);
-        else throw new IllegalArgumentException("Unknown PlayableId: " + id);
+        else
+            throw new IllegalArgumentException("Unknown content: " + id);
     }
 
     @NotNull
@@ -83,7 +85,7 @@ private StorageResolveResponse resolveStorageInteractive(@NotNull ByteString fil
             String country = session.countryCode();
             if (country != null) ContentRestrictedException.checkRestrictions(country, original.getRestrictionList());
 
-            LOGGER.fatal("Couldn't find playable track: " + Utils.bytesToHex(id.getGid()));
+            LOGGER.fatal("Couldn't find playable track: " + id.toSpotifyUri());
             throw new FeederException();
         }
 
@@ -187,7 +189,7 @@ public static class Metrics {
         public final boolean preloadedAudioKey;
         public final int audioKeyTime;
 
-        public Metrics(boolean preloadedAudioKey, int audioKeyTime) { // TODO: Check values
+        public Metrics(boolean preloadedAudioKey, int audioKeyTime) {
             this.preloadedAudioKey = preloadedAudioKey;
             this.audioKeyTime = audioKeyTime;
 

core/src/main/java/xyz/gianlu/librespot/player/playback/PlayerQueueEntry.java

@@ -5,6 +5,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import xyz.gianlu.librespot.common.Utils;
+import xyz.gianlu.librespot.core.EventService.PlaybackMetrics;
 import xyz.gianlu.librespot.core.Session;
 import xyz.gianlu.librespot.mercury.MercuryClient;
 import xyz.gianlu.librespot.mercury.model.EpisodeId;
@@ -52,6 +53,7 @@ class PlayerQueueEntry extends PlayerQueue.Entry implements Closeable, Runnable,
     private final Session session;
     private final AudioFormat format;
     CrossfadeController crossfade;
+    PlaybackMetrics.Reason endReason = PlaybackMetrics.Reason.END_PLAY;
     private Codec codec;
     private TrackOrEpisode metadata;
     private volatile boolean closed = false;
@@ -150,6 +152,20 @@ int getTime() throws Codec.CannotGetTimeException {
         return codec == null ? -1 : codec.time();
     }
 
+    /**
+     * Returns the current position.
+     *
+     * @return The current position of the player or {@code -1} if not available.
+     * @see PlayerQueueEntry#getTime()
+     */
+    int getTimeNoThrow() {
+        try {
+            return getTime();
+        } catch (Codec.CannotGetTimeException e) {
+            return -1;
+        }
+    }
+
     /**
      * Seeks to the specified position.
      *
@@ -229,7 +245,7 @@ public void run() {
         } catch (IOException | ContentRestrictedException | CdnManager.CdnException | MercuryClient.MercuryException | Codec.CodecException ex) {
             close();
             listener.loadingError(this, ex, retried);
-            LOGGER.trace(String.format("%s terminated at loading.", this));
+            LOGGER.trace(String.format("%s terminated at loading.", this), ex);
             return;
         }
 
@@ -275,15 +291,24 @@ public void run() {
             }
 
             try {
-                if (codec.writeSomeTo(output.stream()) == -1)
+                if (codec.writeSomeTo(output.stream()) == -1) {
+                    try {
+                        int time = codec.time();
+                        LOGGER.debug(String.format("Player time offset is %d. {id: %s}", metadata.duration() - time, playbackId));
+                    } catch (Codec.CannotGetTimeException ignored) {
+                    }
+
+                    close();
                     break;
+                }
             } catch (IOException | Codec.CodecException ex) {
                 if (!closed) {
                     close();
                     listener.playbackError(this, ex);
+                    return;
                 }
 
-                return;
+                break;
             }
         }
 

core/src/main/java/xyz/gianlu/librespot/player/playback/PlayerSession.java

@@ -36,6 +36,7 @@ public class PlayerSession implements Closeable, PlayerQueueEntry.Listener {
     private final PlayerQueue queue;
     private int lastPlayPos = 0;
     private Reason lastPlayReason = null;
+    private volatile boolean closed = false;
 
     public PlayerSession(@NotNull Session session, @NotNull AudioSink sink, @NotNull String sessionId, @NotNull Listener listener) {
         this.session = session;
@@ -85,7 +86,7 @@ private boolean advanceTo(@NotNull PlayableId id) {
      * Gets the next content and tries to advance, notifying if successful.
      */
     private void advance(@NotNull Reason reason) {
-        // TODO: Call #trackPlayed somewhere!!
+        if (closed) return;
 
         PlayableId next = listener.nextPlayable();
         if (next == null)
@@ -114,7 +115,10 @@ public void instantReached(@NotNull PlayerQueueEntry entry, int callbackId, int
 
     @Override
     public void playbackEnded(@NotNull PlayerQueueEntry entry) {
-        if (entry == queue.head()) advance(Reason.TRACK_DONE);
+        listener.trackPlayed(entry.playbackId, entry.endReason, entry.metrics(), entry.getTimeNoThrow());
+
+        if (entry == queue.head())
+            advance(Reason.TRACK_DONE);
     }
 
     @Override
@@ -207,6 +211,7 @@ public void playbackResumed(@NotNull PlayerQueueEntry entry, int chunk, int diff
             throw new IllegalStateException();
 
         if (head.prev != null) {
+            head.prev.endReason = reason;
             CrossfadeController.FadeInterval fadeOut;
             if (head.prev.crossfade == null || (fadeOut = head.prev.crossfade.selectFadeOut(reason)) == null) {
                 head.prev.close();
@@ -300,11 +305,18 @@ public long currentTime() throws Codec.CannotGetTimeException {
         else return queue.head().getTime();
     }
 
+    @Nullable
+    public String currentPlaybackId() {
+        if (queue.head() == null) return null;
+        else return queue.head().playbackId;
+    }
+
     /**
      * Close the session by clearing the queue which will close all entries.
      */
     @Override
     public void close() {
+        closed = true;
         queue.close();
     }
 
@@ -381,10 +393,12 @@ public interface Listener {
         /**
          * The current entry has finished playing.
          *
+         * @param playbackId    The playback ID of this entry
          * @param endReason     The reason why this track ended
          * @param playerMetrics The {@link PlayerMetrics} for this entry
+         * @param endedAt       The time this entry ended
          */
-        void trackPlayed(@NotNull Reason endReason, @NotNull PlayerMetrics playerMetrics, int endedAt);
+        void trackPlayed(@NotNull String playbackId, @NotNull Reason endReason, @NotNull PlayerMetrics playerMetrics, int endedAt);
     }
 
     private static class EntryWithPos {