Merge branch 'dev'

Author: devgianlu

CHANGELOG.md

@@ -4,6 +4,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 14-06-2020
+### Added
+- Report to server that we played a track (#155, still buggy)
+- Retrieve tracks in state from API (#222)
+- Add/remove tracks from queue from API (#222)
+- Seek from API (6104db1a66b9defabc43ec21e6668899cf8c2683)
+- Added logout feature (5839d5b48133cd69cf59a028ee423b44caec8627)
+
+### Changed
+- Rewritten player and related bug fixing (#155, 08282b94d6adc7e5e5a07fe20c150829fc912943, #216, #217, 13423cdcfd39b8a5722e3a14bb19e53ab426b4ea, e549f08356696ef46add79f60ad8e28891738bd7)
+- Using Log4j2 (5bb16797b78a76618821d28f547e92c217bdb8c8, 73a668c47db36932567777216330479d8147d80b, 52a60cbf0c059d4582dfe278a65bf786a4df43a3, 548163e4d3b2267d3030f7597ed5b4e8eeeab29c)
+- Improved error message for mixers (#220)
+- Refactored audio quality selection (#223)
+- Close readers properly (6ad0f3cddc89e6d172eb16c5635ed46128eb65db)
+- Better truncation of sensitive values (661c171fcd353471924a4ae0544dc27ff0ca83d0)
+
+### Fixed
+- Fixed time bar in wrong position after resuming (#213)
+- Do not get Cipher instance every time (#215)
+- Fixed loading of some podcasts (#223)
+- Fixed crash when pressing next after adding song to queue (#226)
+- Prevent deadlock when closing after network issue (#227)
+- Fixed old issue with Zeroconf active session (#225, #229, #231)
+- Avoid establishing two connections (afc7dc366379391f7e59ce8a37a0b007b2c69303)
+- Start line before writing for the first time (#232)
+- Do not close `System.out` for any reason (#234)
+- Shutdown OkHttp threads when closing (#235)
+
+
 ## [1.3.1] - 26-04-2020
 ### Added
 - Added explicit content filter (#200)

README.md

@@ -51,6 +51,8 @@ On some systems, many mixers could be installed making librespot-java playback o
 4) Pick the right mixer and copy its name inside the `mixerSearchKeywords` option. If you need to specify more search keywords, you can separate them with a semicolon
 5) Restart and enjoy
 
+> **Linux note:** librespot-java will not be able to detect the mixers available on the system if you are running headless OpenJDK. You'll need to install a headful version of OpenJDK (usually doesn't end with `-headless`).
+
 ## Build it
 This project uses [Maven](https://maven.apache.org/), after installing it you can compile with `mvn clean package` in the project root, if the compilation succeeds you'll be pleased with a JAR executable in `core/target`.
 To run the newly build jar run `java -jar ./core/target/librespot-core-jar-with-dependencies.jar`.

api/README.md

@@ -5,20 +5,24 @@ This module depends on `librespot-core` and provides an API to interact with the
 
 ## Available endpoints
 All the endpoints will respond with `200` if successful or:
-- `204`, if there isn't any active session (Zeroconf only)
-- `500`, if the session is invalid
-- `503`, if the session is reconnecting (`Retry-After` is always 10 seconds)
+- `204` If there isn't any active session (Zeroconf only)
+- `500` If the session is invalid
+- `503` If the session is reconnecting (`Retry-After` is always 10 seconds)
 
 ### Player
 - `POST /player/load` Load a track from a given URI. The request body should contain two parameters: `uri` and `play`.
 - `POST /player/pause` Pause playback.
 - `POST /player/resume` Resume playback.
 - `POST /player/next` Skip to next track.
 - `POST /player/prev` Skip to previous track.
+- `POST /player/seek` Seek to a given position in ms specified by `pos`.
 - `POST /player/set-volume` Set volume to a given `volume` value from 0 to 65536.
 - `POST /player/volume-up` Up the volume a little bit.
 - `POST /player/volume-down` Lower the volume a little bit.
 - `POST /player/current` Retrieve information about the current track (metadata and time).
+- `POST /player/tracks` Retrieve all the tracks in the player state with metadata, you can specify `withQueue`.
+- `POST /player/addToQueue` Add a track to the queue, specified by `uri`.
+- `POST /player/removeFromQueue` Remove a track from the queue, specified by `uri`.
 
 ### Metadata
 - `POST /metadata/{type}/{uri}` Retrieve metadata. `type` can be one of `episode`, `track`, `album`, `show`, `artist` or `playlist`, `uri` is the standard Spotify uri.
@@ -33,19 +37,20 @@ All the endpoints will respond with `200` if successful or:
 ### Events
 You can subscribe for players events by creating a WebSocket connection to `/events`.
 The currently available events are:
-- `contextChanged`, the Spotify context URI changed
-- `trackChanged`, the Spotify track URI changed
-- `playbackPaused`, playback has been paused
-- `playbackResumed`, playback has been resumed
-- `volumeChanged`, playback volume changed
-- `trackSeeked`, track has been seeked
-- `metadataAvailable`, metadata for the current track is available
-- `playbackHaltStateChanged`, playback halted or resumed from halt
-- `sessionCleared`, (Zeroconf only) current session went away
-- `sessionChanged`, (Zeroconf only) current session changed
-- `inactiveSession`, current session is now inactive (no audio)
-- `connectionDropped`, a network error occurred and we're trying to reconnect
-- `connectionEstablished`, successfully reconnected
+- `contextChanged` The Spotify context URI changed
+- `trackChanged` The Spotify track URI changed
+- `playbackPaused` Playback has been paused
+- `playbackResumed` Playback has been resumed
+- `volumeChanged` Playback volume changed
+- `trackSeeked` Track has been seeked
+- `metadataAvailable` Metadata for the current track is available
+- `playbackHaltStateChanged` Playback halted or resumed from halt
+- `sessionCleared` Current session went away (Zeroconf only)
+- `sessionChanged` Current session changed (Zeroconf only)
+- `inactiveSession` Current session is now inactive (no audio)
+- `connectionDropped` A network error occurred and we're trying to reconnect
+- `connectionEstablished` Successfully reconnected
+- `panic` Entered the panic state, playback is stopped. This is usually recoverable.
 
 ## Examples
 `curl -X POST -d "uri=spotify:track:xxxxxxxxxxxxxxxxxxxxxx&play=true" http://localhost:24879/player/load`

api/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>xyz.gianlu.librespot</groupId>
         <artifactId>librespot-java</artifactId>
-        <version>1.3.1</version>
+        <version>1.4.0</version>
         <relativePath>../</relativePath>
     </parent>
 
@@ -19,7 +19,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-assembly-plugin</artifactId>
-                <version>3.2.0</version>
+                <version>3.3.0</version>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -33,6 +33,9 @@
                                     <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
                                     <mainClass>xyz.gianlu.librespot.api.Main</mainClass>
                                 </manifest>
+                                <manifestEntries>
+                                    <Multi-Release>true</Multi-Release>
+                                </manifestEntries>
                             </archive>
                             <descriptorRefs>
                                 <descriptorRef>jar-with-dependencies</descriptorRef>
@@ -54,7 +57,7 @@
         <dependency>
             <groupId>io.undertow</groupId>
             <artifactId>undertow-core</artifactId>
-            <version>2.0.29.Final</version>
+            <version>2.1.0.Final</version>
         </dependency>
     </dependencies>
 </project>

api/src/main/java/xyz/gianlu/librespot/api/ApiServer.java

@@ -3,12 +3,13 @@
 import io.undertow.Undertow;
 import io.undertow.server.HttpHandler;
 import io.undertow.server.RoutingHandler;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.jetbrains.annotations.NotNull;
 import xyz.gianlu.librespot.api.handlers.*;
 
 public class ApiServer {
-    private static final Logger LOGGER = Logger.getLogger(ApiServer.class);
+    private static final Logger LOGGER = LogManager.getLogger(ApiServer.class);
     private final int port;
     private final String host;
     private final HttpHandler handler;
@@ -35,7 +36,7 @@ public void start() {
 
         undertow = Undertow.builder().addHttpListener(port, host, handler).build();
         undertow.start();
-        LOGGER.info(String.format("Server started on port %d!", port));
+        LOGGER.info("Server started on port {}!", port);
     }
 
     public void stop() {

api/src/main/java/xyz/gianlu/librespot/api/CorsHandler.java

@@ -2,7 +2,6 @@
 
 import io.undertow.server.HttpHandler;
 import io.undertow.server.HttpServerExchange;
-import io.undertow.server.RoutingHandler;
 import io.undertow.util.HeaderMap;
 import io.undertow.util.HttpString;
 

api/src/main/java/xyz/gianlu/librespot/api/Main.java

@@ -1,8 +1,10 @@
 package xyz.gianlu.librespot.api;
 
-import org.apache.log4j.LogManager;
+
+import org.apache.logging.log4j.core.config.Configurator;
 import xyz.gianlu.librespot.AbsConfiguration;
 import xyz.gianlu.librespot.FileConfiguration;
+import xyz.gianlu.librespot.common.Log4JUncaughtExceptionHandler;
 import xyz.gianlu.librespot.core.AuthConfiguration;
 import xyz.gianlu.librespot.core.Session;
 import xyz.gianlu.librespot.core.ZeroconfServer;
@@ -18,7 +20,8 @@ public class Main {
 
     public static void main(String[] args) throws IOException, MercuryClient.MercuryException, GeneralSecurityException, Session.SpotifyAuthenticationException {
         AbsConfiguration conf = new FileConfiguration(args);
-        LogManager.getRootLogger().setLevel(conf.loggingLevel());
+        Configurator.setRootLevel(conf.loggingLevel());
+        Thread.setDefaultUncaughtExceptionHandler(new Log4JUncaughtExceptionHandler());
 
         SessionWrapper wrapper;
         if (conf.authStrategy() == AuthConfiguration.Strategy.ZEROCONF && !conf.hasStoredCredentials())

api/src/main/java/xyz/gianlu/librespot/api/SessionWrapper.java

@@ -57,8 +57,9 @@ private void set(@NotNull Session session) {
     }
 
     private void clear() {
+        Session old = ref.get();
         ref.set(null);
-        if (listener != null) listener.onSessionCleared();
+        if (listener != null && old != null) listener.onSessionCleared(old);
     }
 
     @Nullable
@@ -73,7 +74,7 @@ public Session get() {
     }
 
     public interface Listener {
-        void onSessionCleared();
+        void onSessionCleared(@NotNull Session old);
 
         void onNewSession(@NotNull Session session);
     }

api/src/main/java/xyz/gianlu/librespot/api/handlers/EventsHandler.java

@@ -1,12 +1,12 @@
 package xyz.gianlu.librespot.api.handlers;
 
 import com.google.gson.JsonObject;
-import com.spotify.metadata.Metadata;
 import io.undertow.websockets.WebSocketConnectionCallback;
 import io.undertow.websockets.WebSocketProtocolHandshakeHandler;
 import io.undertow.websockets.core.WebSocketChannel;
 import io.undertow.websockets.core.WebSockets;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Range;
@@ -15,12 +15,13 @@
 import xyz.gianlu.librespot.core.Session;
 import xyz.gianlu.librespot.mercury.model.PlayableId;
 import xyz.gianlu.librespot.player.Player;
+import xyz.gianlu.librespot.player.TrackOrEpisode;
 
 public final class EventsHandler extends WebSocketProtocolHandshakeHandler implements Player.EventsListener, SessionWrapper.Listener, Session.ReconnectionListener {
-    private static final Logger LOGGER = Logger.getLogger(EventsHandler.class);
+    private static final Logger LOGGER = LogManager.getLogger(EventsHandler.class);
 
     public EventsHandler() {
-        super((WebSocketConnectionCallback) (exchange, channel) -> LOGGER.info(String.format("Accepted new websocket connection from %s.", channel.getSourceAddress().getAddress())));
+        super((WebSocketConnectionCallback) (exchange, channel) -> LOGGER.info("Accepted new websocket connection from {}.", channel.getSourceAddress().getAddress()));
     }
 
     private void dispatch(@NotNull JsonObject obj) {
@@ -37,12 +38,15 @@ public void onContextChanged(@NotNull String newUri) {
     }
 
     @Override
-    public void onTrackChanged(@NotNull PlayableId id, Metadata.@Nullable Track track, Metadata.@Nullable Episode episode) {
+    public void onTrackChanged(@NotNull PlayableId id, @Nullable TrackOrEpisode metadata) {
         JsonObject obj = new JsonObject();
         obj.addProperty("event", "trackChanged");
         obj.addProperty("uri", id.toSpotifyUri());
-        if (track != null) obj.add("track", ProtobufToJson.convert(track));
-        if (episode != null) obj.add("episode", ProtobufToJson.convert(episode));
+        if (metadata != null) {
+            if (metadata.track != null) obj.add("track", ProtobufToJson.convert(metadata.track));
+            else if (metadata.episode != null) obj.add("episode", ProtobufToJson.convert(metadata.episode));
+        }
+
         dispatch(obj);
     }
 
@@ -71,11 +75,11 @@ public void onTrackSeeked(long trackTime) {
     }
 
     @Override
-    public void onMetadataAvailable(Metadata.@Nullable Track track, Metadata.@Nullable Episode episode) {
+    public void onMetadataAvailable(@NotNull TrackOrEpisode metadata) {
         JsonObject obj = new JsonObject();
         obj.addProperty("event", "metadataAvailable");
-        if (track != null) obj.add("track", ProtobufToJson.convert(track));
-        if (episode != null) obj.add("episode", ProtobufToJson.convert(episode));
+        if (metadata.track != null) obj.add("track", ProtobufToJson.convert(metadata.track));
+        else if (metadata.episode != null) obj.add("episode", ProtobufToJson.convert(metadata.episode));
         dispatch(obj);
     }
 
@@ -105,7 +109,17 @@ public void onVolumeChanged(@Range(from = 0, to = 1) float volume) {
     }
 
     @Override
-    public void onSessionCleared() {
+    public void onPanicState() {
+        JsonObject obj = new JsonObject();
+        obj.addProperty("event", "panic");
+        dispatch(obj);
+    }
+
+    @Override
+    public void onSessionCleared(@NotNull Session old) {
+        old.player().removeEventsListener(this);
+        old.removeReconnectionListener(this);
+
         JsonObject obj = new JsonObject();
         obj.addProperty("event", "sessionCleared");
         dispatch(obj);

api/src/main/java/xyz/gianlu/librespot/api/handlers/MetadataHandler.java

@@ -2,7 +2,8 @@
 
 import com.google.gson.JsonObject;
 import io.undertow.server.HttpServerExchange;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import xyz.gianlu.librespot.api.SessionWrapper;
@@ -23,7 +24,7 @@
  * @author Gianlu
  */
 public final class MetadataHandler extends AbsSessionHandler {
-    private static final Logger LOGGER = Logger.getLogger(MetadataHandler.class);
+    private static final Logger LOGGER = LogManager.getLogger(MetadataHandler.class);
     private final boolean needsType;
 
     public MetadataHandler(@NotNull SessionWrapper wrapper, boolean needsType) {
@@ -74,10 +75,10 @@ public void handleRequest(@NotNull HttpServerExchange exchange, @NotNull Session
             }
 
             Utils.internalError(exchange, ex);
-            LOGGER.error(String.format("Failed handling api request. {type: %s, uri: %s, code: %d}", type, uri, ex.code), ex);
+            LOGGER.error("Failed handling api request. {type: {}, uri: {}, code: {}}", type, uri, ex.code, ex);
         } catch (IOException | MercuryClient.MercuryException ex) {
             Utils.internalError(exchange, ex);
-            LOGGER.error(String.format("Failed handling api request. {type: %s, uri: %s}", type, uri), ex);
+            LOGGER.error("Failed handling api request. {type: {}, uri: {}}", type, uri, ex);
         } catch (IllegalArgumentException ex) {
             Utils.invalidParameter(exchange, "uri", "Invalid uri for type: " + type);
         }