Merge tag 'v1.5.3'

Author: devgianlu

CHANGELOG.md

@@ -1,8 +1,45 @@
 # Changelog
+
 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).
+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.5.3] - 28-12-2020
+
+### Added
+
+- Dispatch session closing when using Zeroconf (5b53af7aa5c23a5ed5153e68c5b022aee63ca3e6)
+- Allow set volume with relative steps count (#273)
+
+### Changed
+
+- Improved thread usage (#249, #280)
+- Catch and log exceptions happening in command/message handling (352d6e3c0cc0a36ea676505e0f761f678f4b11b8,
+  3229d2cc72ad2c4d364f7c197b0aec38083d577a)
+
+### Fixed
+
+- Fixed parsing some payloads (f6191ff6636dd538b5ebf1090df4eaa9bd062110)
+- Fixed double reading of first chunk (e5a8ae712114c344aca43e5ec5f557f7ce9657b9)
+- Fixed proxy auth (#274)
+- Fixed playback not starting (#277, 26818c619e2fa6f0d4da9f4e96a8e913ccc0468d, abde6b64d68d49e637343560514efc2dca895815,
+  a79e78a716df74e582504b5d69df455404cef356)
+
+## [1.5.2] - 17-11-2020
+
+### Added
+
+- Added `Player#waitReady()` method (d3149d3843e066986524e14369c5871c22629810)
+- Added pass through endpoints for official Spotify API (#255)
+- Store and check hash of first chunk of cache data (9ab9f43a91ebbce0e9a3a3c6f3c55a714c756525)
+
+### Fixed
+
+- Fixed `UnsupportedOperationException` when starting playback (#251)
+- Close cache files correctly (e953129ed5f0dc4e9931660bd216267557d6010a, #253)
+- Fixed starting playback from API (#254)
+
 
 ## [1.5.2] - 17-11-2020
 ### Added

api/README.md

@@ -1,7 +1,7 @@
 # API
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/xyz.gianlu.librespot/librespot-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/xyz.gianlu.librespot/librespot-api)
 
-This module depends on `librespot-core` and provides an API to interact with the Spotify client.
+This module depends on `librespot-player` and, in addition, provides an API to interact with the Spotify client.
 
 ## Available endpoints
 All the endpoints will respond with `200` if successful or:
@@ -17,7 +17,7 @@ All the endpoints will respond with `200` if successful or:
 - `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/set-volume` Either set volume to a given `volume` value (from 0 to 65536), or change it by a `step` count (positive or negative).
 - `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).

api/pom.xml

@@ -5,8 +5,8 @@
     <parent>
         <groupId>xyz.gianlu.librespot</groupId>
         <artifactId>librespot-java</artifactId>
-        <version>1.5.2</version>
-        <relativePath>../</relativePath>
+        <version>1.5.3</version>
+        <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>librespot-api</artifactId>
@@ -59,7 +59,7 @@
         <dependency>
             <groupId>io.undertow</groupId>
             <artifactId>undertow-core</artifactId>
-            <version>2.1.3.Final</version>
+            <version>2.2.3.Final</version>
         </dependency>
     </dependencies>
 </project>

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

@@ -31,7 +31,18 @@ private PlayerWrapper(@NotNull PlayerConfiguration conf) {
     @NotNull
     public static PlayerWrapper fromZeroconf(@NotNull ZeroconfServer server, @NotNull PlayerConfiguration conf) {
         PlayerWrapper wrapper = new PlayerWrapper(conf);
-        server.addSessionListener(wrapper::set);
+        server.addSessionListener(new ZeroconfServer.SessionListener() {
+            @Override
+            public void sessionClosing(@NotNull Session session) {
+                if (wrapper.getSession() == session)
+                    wrapper.clear();
+            }
+
+            @Override
+            public void sessionChanged(@NotNull Session session) {
+                wrapper.set(session);
+            }
+        });
         return wrapper;
     }
 

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

@@ -26,7 +26,18 @@ protected SessionWrapper() {
     @NotNull
     public static SessionWrapper fromZeroconf(@NotNull ZeroconfServer server) {
         SessionWrapper wrapper = new SessionWrapper();
-        server.addSessionListener(wrapper::set);
+        server.addSessionListener(new ZeroconfServer.SessionListener() {
+            @Override
+            public void sessionClosing(@NotNull Session session) {
+                if (wrapper.getSession() == session)
+                    wrapper.clear();
+            }
+
+            @Override
+            public void sessionChanged(@NotNull Session session) {
+                wrapper.set(session);
+            }
+        });
         return wrapper;
     }
 

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

@@ -30,7 +30,7 @@ public static Map<String, Deque<String>> readParameters(@NotNull HttpServerExcha
                 byte[] buffer = new byte[1024];
                 int count;
                 while ((count = in.read(buffer)) > 0) out.write(buffer, 0, count);
-                body = new String(out.toByteArray());
+                body = out.toString();
             }
 
             return QueryParameterUtils.mergeQueryParametersWithNewQueryString(map, body, "UTF-8");

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

@@ -24,26 +24,42 @@ public PlayerHandler(@NotNull PlayerWrapper wrapper) {
         super(wrapper);
     }
 
-    private static void setVolume(HttpServerExchange exchange, @NotNull Player player, @Nullable String valStr) {
-        if (valStr == null) {
-            Utils.invalidParameter(exchange, "volume");
-            return;
-        }
+    private static void setVolume(HttpServerExchange exchange, @NotNull Player player, @Nullable String valStr, @Nullable String stepStr) {
+        if (valStr != null && stepStr != null) {
+            // Reject requests with both parameters
+            Utils.invalidParameter(exchange, "step", "Cannot be passed alongside volume");
+        } else if (valStr != null) {
+            // Absolute volume change
+            int val;
+            try {
+                val = Integer.parseInt(valStr);
+            } catch (Exception ex) {
+                Utils.invalidParameter(exchange, "volume", "Not an integer");
+                return;
+            }
 
-        int val;
-        try {
-            val = Integer.parseInt(valStr);
-        } catch (Exception ex) {
-            Utils.invalidParameter(exchange, "volume", "Not an integer");
-            return;
-        }
+            if (val < 0 || val > Player.VOLUME_MAX) {
+                Utils.invalidParameter(exchange, "volume", "Must be >= 0 and <= " + Player.VOLUME_MAX);
+                return;
+            }
 
-        if (val < 0 || val > Player.VOLUME_MAX) {
-            Utils.invalidParameter(exchange, "volume", "Must be >= 0 and <= " + Player.VOLUME_MAX);
-            return;
-        }
+            player.setVolume(val);
+        } else if (stepStr != null) {
+            // Relative volume change in number of steps
+            int val;
+            try {
+                val = Integer.parseInt(stepStr);
+            } catch (Exception ex) {
+                Utils.invalidParameter(exchange, "step", "Not an integer");
+                return;
+            }
 
-        player.setVolume(val);
+            if (val > 0) player.volumeUp(val);
+            else if (val < 0) player.volumeDown(Math.abs(val));
+            else Utils.invalidParameter(exchange, "step", "Must be non zero");
+        } else {
+            Utils.invalidParameter(exchange, "volume");
+        }
     }
 
     private static void load(HttpServerExchange exchange, @NotNull Player player, @Nullable String uri, boolean play) {
@@ -168,7 +184,7 @@ protected void handleRequest(@NotNull HttpServerExchange exchange, @NotNull Sess
                 current(exchange, player);
                 return;
             case SET_VOLUME:
-                setVolume(exchange, player, Utils.getFirstString(params, "volume"));
+                setVolume(exchange, player, Utils.getFirstString(params, "volume"), Utils.getFirstString(params, "step"));
                 return;
             case VOLUME_UP:
                 player.volumeUp();

lib/README.md

@@ -1,7 +1,6 @@
 # Library
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/xyz.gianlu.librespot/librespot-lib/badge.svg)](https://maven-badges.herokuapp.com/maven-central/xyz.gianlu.librespot/librespot-lib)
 
-
 This module contains all the necessary components to interact with the Spotify infrastructure, but doesn't require configuration files or additional system resources.
 
 ## Getting started

lib/pom.xml

@@ -5,8 +5,8 @@
     <parent>
         <groupId>xyz.gianlu.librespot</groupId>
         <artifactId>librespot-java</artifactId>
-        <version>1.5.2</version>
-        <relativePath>../</relativePath>
+        <version>1.5.3</version>
+        <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>librespot-lib</artifactId>
@@ -90,7 +90,7 @@
         <dependency>
             <groupId>com.squareup.okhttp3</groupId>
             <artifactId>okhttp</artifactId>
-            <version>4.8.0</version>
+            <version>4.9.0</version>
         </dependency>
 
         <!-- Commons Net (NTP) -->

lib/src/main/java/xyz/gianlu/librespot/ZeroconfServer.java

@@ -201,6 +201,8 @@ public void close() throws IOException {
     }
 
     public void closeSession() throws IOException {
+        sessionListeners.forEach(l -> l.sessionClosing(session));
+
         if (session != null) session.close();
         session = null;
     }
@@ -377,6 +379,18 @@ public void removeSessionListener(@NotNull SessionListener listener) {
     }
 
     public interface SessionListener {
+        /**
+         * The session instance is going to be closed after this call.
+         *
+         * @param session The old {@link Session}
+         */
+        void sessionClosing(@NotNull Session session);
+
+        /**
+         * The session instance changed. {@link #sessionClosing(Session)} has been already called.
+         *
+         * @param session The new {@link Session}
+         */
         void sessionChanged(@NotNull Session session);
     }