fetch cover art image locally on Linux

Author: LabyStudio

README.md

@@ -58,13 +58,10 @@ localApi.registerListener(new SpotifyListener() {
     public void onTrackChanged(Track track) {
         System.out.printf("Track changed: %s (%s)\n", track, formatDuration(track.getLength()));
 
-        // You could use the OpenSpotifyAPI to request the track cover image
-        // try {
-        //     BufferedImage imageTrackCover = openApi.requestImage(track);
-        //     System.out.println("Loaded track cover: " + imageTrackCover.getWidth() + "x" + imageTrackCover.getHeight());
-        // } catch (Exception e) {
-        //     System.out.println("Could not load track cover: " + e.getMessage());
-        // }
+        if (track.getCoverArt() != null) {
+            BufferedImage coverArt = track.getCoverArt();
+            System.out.println("Track cover: " + coverArt.getWidth() + "x" + coverArt.getHeight());
+        }
     }
 
     @Override
@@ -106,20 +103,23 @@ localApi.registerListener(new SpotifyListener() {
 localApi.initialize();
 ```
 
-Fetch an image of the current playing track:
+Request information of any track id using open.spotify.com:
 ```java
 // Create a secret provider
 SecretProvider secretProvider = new DefaultSecretProvider(
         // Note: You have to update the secret with the latest TOTP secret from open.spotify.com
         // or find a way to retrieve it automatically from their website
-        Secret.fromString("meZcB\\tlUFV1D6W2Hy4@9+$QaH5)N8", 9)
+        Secret.fromString("=n:b#OuEfH\fE])e*K", 10)
 );
 
 // Create an instance of the Open Spotify API
 OpenSpotifyAPI openSpotifyAPI = new OpenSpotifyAPI(secretProvider);
 
-// Download the cover art of the current song
-BufferedImage imageTrackCover = openSpotifyAPI.requestImage(track);
+// Fetch cover art image by track id
+BufferedImage coverArt = openSpotifyAPI.requestImage(trackId);
+
+// Fetch track information by track id
+OpenTrack openTrack = openSpotifyAPI.requestOpenTrack(trackId);
 ```
 
 You can also skip the current song using the Media Key API:

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'de.labystudio'
-version '1.4.3'
+version '1.4.4'
 
 compileJava {
     sourceCompatibility = '1.8'

src/main/java/de/labystudio/spotifyapi/model/Track.java

@@ -1,5 +1,7 @@
 package de.labystudio.spotifyapi.model;
 
+import java.awt.image.BufferedImage;
+
 /**
  * A Spotify track containing the track id, name, artist and length of a song.
  *
@@ -13,11 +15,20 @@ public class Track {
 
     private final int length;
 
-    public Track(String id, String name, String artist, int length) {
+    private final BufferedImage coverArt;
+
+    public Track(
+            String id,
+            String name,
+            String artist,
+            int length,
+            BufferedImage coverArt
+    ) {
         this.id = id;
         this.name = name;
         this.artist = artist;
         this.length = length;
+        this.coverArt = coverArt;
     }
 
     public String getId() {
@@ -36,6 +47,10 @@ public int getLength() {
         return this.length;
     }
 
+    public BufferedImage getCoverArt() {
+        return this.coverArt;
+    }
+
     @Override
     public boolean equals(Object obj) {
         return obj instanceof Track && this.id.equals(((Track) obj).id);

src/main/java/de/labystudio/spotifyapi/open/model/track/OpenTrack.java

@@ -1,7 +1,6 @@
 package de.labystudio.spotifyapi.open.model.track;
 
 import com.google.gson.annotations.SerializedName;
-import de.labystudio.spotifyapi.model.Track;
 
 import java.util.List;
 
@@ -83,13 +82,4 @@ public String getArtists(String delimiter) {
 
         return builder.substring(delimiter.length());
     }
-
-    /**
-     * Create a new {@link Track} based on the current object.
-     *
-     * @return The new {@link Track} object
-     */
-    public Track toTrack() {
-        return new Track(this.id, this.name, this.getArtists(), this.durationMs);
-    }
 }

src/main/java/de/labystudio/spotifyapi/platform/linux/LinuxSpotifyApi.java

@@ -5,7 +5,11 @@
 import de.labystudio.spotifyapi.model.Track;
 import de.labystudio.spotifyapi.platform.AbstractTickSpotifyAPI;
 import de.labystudio.spotifyapi.platform.linux.api.MPRISCommunicator;
+import de.labystudio.spotifyapi.platform.linux.api.model.Metadata;
 
+import javax.imageio.ImageIO;
+import java.awt.image.BufferedImage;
+import java.net.URL;
 import java.util.Objects;
 
 /**
@@ -29,23 +33,26 @@ public class LinuxSpotifyApi extends AbstractTickSpotifyAPI {
 
     @Override
     protected void onTick() throws Exception {
-        String trackId = this.mediaPlayer.getTrackId();
+        Metadata metadata = this.mediaPlayer.readMetadata();
+        String trackId = metadata.getTrackId();
 
         // Handle on connect
-        if (!this.connected && !trackId.isEmpty()) {
+        if (!this.connected) {
             this.connected = true;
             this.listeners.forEach(SpotifyListener::onConnect);
         }
 
         // Handle track changes
-        if (!Objects.equals(trackId, this.currentTrack == null ? null : this.currentTrack.getId())) {
-            String trackName = this.mediaPlayer.getTrackName();
-            String trackArtist = this.mediaPlayer.getArtist();
-            int trackLength = this.mediaPlayer.getTrackLength();
+        String currentTrackId = this.currentTrack == null ? null : this.currentTrack.getId();
+        if (!Objects.equals(trackId, currentTrackId)) {
+            String trackName = metadata.getTrackName();
+            String trackArtist = metadata.getArtistsJoined();
+            int trackLength = metadata.getTrackLength();
+            BufferedImage coverArt = this.toBufferedImage(metadata.getArtUrl());
 
             boolean isFirstTrack = !this.hasTrack();
 
-            Track track = new Track(trackId, trackName, trackArtist, trackLength);
+            Track track = new Track(trackId, trackName, trackArtist, trackLength, coverArt);
             this.currentTrack = track;
 
             // Fire on track changed
@@ -58,7 +65,7 @@ protected void onTick() throws Exception {
         }
 
         // Handle is playing changes
-        boolean isPlaying = this.mediaPlayer.isPlaying();
+        boolean isPlaying = this.mediaPlayer.readIsPlaying();
         if (isPlaying != this.isPlaying) {
             this.isPlaying = isPlaying;
 
@@ -67,7 +74,7 @@ protected void onTick() throws Exception {
         }
 
         // Handle position changes
-        int position = this.mediaPlayer.getPosition();
+        int position = this.mediaPlayer.readPosition();
         if (!this.hasPosition() || Math.abs(position - this.getPosition()) >= 1000) {
             this.updatePosition(position);
         }
@@ -150,4 +157,16 @@ public boolean hasPosition() {
         return this.currentPosition != -1;
     }
 
+    private BufferedImage toBufferedImage(String artUrl) {
+        if (artUrl == null || artUrl.isEmpty()) {
+            return null; // No cover art available
+        }
+        try {
+            return ImageIO.read(new URL(artUrl));
+        } catch (Throwable e) {
+            e.printStackTrace();
+            return null; // Failed to load cover art
+        }
+    }
+
 }

src/main/java/de/labystudio/spotifyapi/platform/linux/api/DBusSend.java

@@ -1,5 +1,9 @@
 package de.labystudio.spotifyapi.platform.linux.api;
 
+import de.labystudio.spotifyapi.platform.linux.api.model.InterfaceMember;
+import de.labystudio.spotifyapi.platform.linux.api.model.Parameter;
+import de.labystudio.spotifyapi.platform.linux.api.model.Variant;
+
 import java.io.BufferedReader;
 import java.io.InputStreamReader;
 

src/main/java/de/labystudio/spotifyapi/platform/linux/api/MPRISCommunicator.java

@@ -1,5 +1,10 @@
 package de.labystudio.spotifyapi.platform.linux.api;
 
+import de.labystudio.spotifyapi.platform.linux.api.model.InterfaceMember;
+import de.labystudio.spotifyapi.platform.linux.api.model.Metadata;
+import de.labystudio.spotifyapi.platform.linux.api.model.Parameter;
+import de.labystudio.spotifyapi.platform.linux.api.model.Variant;
+
 import java.util.HashMap;
 import java.util.Map;
 
@@ -26,42 +31,20 @@ public class MPRISCommunicator {
             "/org/mpris/MediaPlayer2"
     );
 
-    private final Map<String, Object> metadata = new HashMap<>();
-
-    private void updateMetadata() throws Exception {
-        this.metadata.clear();
-
+    public Metadata readMetadata() throws Exception {
+        Map<String, Object> metadata = new HashMap<>();
         Variant array = this.dbus.get("org.mpris.MediaPlayer2.Player", "Metadata");
         for (Variant entry : array.<Variant[]>getValue()) {
-            this.metadata.put(entry.getSig(), entry.getValue());
+            metadata.put(entry.getSig(), entry.getValue());
         }
+        return new Metadata(metadata);
     }
 
-    public String getTrackId() throws Exception {
-        this.updateMetadata();
-        return ((String) this.metadata.get("mpris:trackid")).split("/")[4];
-    }
-
-    public String getTrackName() throws Exception {
-        this.updateMetadata();
-        return this.metadata.get("xesam:title").toString();
-    }
-
-    public String getArtist() throws Exception {
-        this.updateMetadata();
-        return String.join(", ", (String[]) this.metadata.get("xesam:artist"));
-    }
-
-    public Integer getTrackLength() throws Exception {
-        this.updateMetadata();
-        return (int) ((Long) this.metadata.get("mpris:length") / 1000L) + 1;
-    }
-
-    public boolean isPlaying() throws Exception {
+    public boolean readIsPlaying() throws Exception {
         return this.dbus.get("org.mpris.MediaPlayer2.Player", "PlaybackStatus").getValue().equals("Playing");
     }
 
-    public Integer getPosition() throws Exception {
+    public Integer readPosition() throws Exception {
         return (int) ((Long) this.dbus.get("org.mpris.MediaPlayer2.Player", "Position").getValue() / 1000L);
     }
 

…/platform/linux/api/InterfaceMember.java …orm/linux/api/model/InterfaceMember.javasrc/main/java/de/labystudio/spotifyapi/platform/linux/api/InterfaceMember.java renamed to src/main/java/de/labystudio/spotifyapi/platform/linux/api/model/InterfaceMember.java src/main/java/de/labystudio/spotifyapi/platform/linux/api/InterfaceMember.java renamed to src/main/java/de/labystudio/spotifyapi/platform/linux/api/model/InterfaceMember.java

@@ -1,4 +1,4 @@
-package de.labystudio.spotifyapi.platform.linux.api;
+package de.labystudio.spotifyapi.platform.linux.api.model;
 
 /**
  * Interface member wrapper for the DBusSend class.

src/main/java/de/labystudio/spotifyapi/platform/linux/api/model/Metadata.java

@@ -0,0 +1,44 @@
+package de.labystudio.spotifyapi.platform.linux.api.model;
+
+import java.util.Map;
+
+public class Metadata {
+
+    private final String trackId;
+    private final String trackName;
+    private final String[] artists;
+    private final int trackLength;
+    private final String artUrl;
+
+    public Metadata(Map<String, Object> metadata) {
+        this.trackId = ((String) metadata.get("mpris:trackid")).split("/")[4];
+        this.trackName = metadata.get("xesam:title").toString();
+        this.artists = (String[]) metadata.get("xesam:artist");
+        this.trackLength = (int) ((Long) metadata.get("mpris:length") / 1000L) + 1;
+        this.artUrl = (String) metadata.get("mpris:artUrl");
+    }
+
+    public String getTrackId() {
+        return this.trackId;
+    }
+
+    public String getTrackName() {
+        return this.trackName;
+    }
+
+    public String[] getArtists() {
+        return this.artists;
+    }
+
+    public String getArtistsJoined() {
+        return String.join(", ", this.artists);
+    }
+
+    public int getTrackLength() {
+        return this.trackLength;
+    }
+
+    public String getArtUrl() {
+        return this.artUrl;
+    }
+}

…ifyapi/platform/linux/api/Parameter.java …/platform/linux/api/model/Parameter.javasrc/main/java/de/labystudio/spotifyapi/platform/linux/api/Parameter.java renamed to src/main/java/de/labystudio/spotifyapi/platform/linux/api/model/Parameter.java src/main/java/de/labystudio/spotifyapi/platform/linux/api/Parameter.java renamed to src/main/java/de/labystudio/spotifyapi/platform/linux/api/model/Parameter.java

@@ -1,4 +1,4 @@
-package de.labystudio.spotifyapi.platform.linux.api;
+package de.labystudio.spotifyapi.platform.linux.api.model;
 
 /**
  * Parameter wrapper for the DBusSend class.