improve address search of track id, add unregisterListener, version 1.0.4

Author: LabyStudio

README.md

@@ -14,7 +14,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.github.LabyStudio:java-spotify-api:1.0.3:all'
+    implementation 'com.github.LabyStudio:java-spotify-api:1.0.4:all'
 }
 ```
 
@@ -83,4 +83,7 @@ api.registerListener(new SpotifyListener() {
         // api.stop();
     }
 });
+
+// Initialize the API
+api.initialize();
 ```

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'de.labystudio'
-version '1.0.3'
+version '1.0.4'
 
 compileJava {
     sourceCompatibility = '1.8'
@@ -20,6 +20,19 @@ dependencies {
     implementation group: 'net.java.dev.jna', name: 'jna-platform', version: '4.5.0'
 }
 
+sourceSets {
+    main {
+        java {
+            srcDir 'src/main/java'
+            srcDir 'src/test/java'
+        }
+
+        resources {
+            srcDir 'src/main/resources'
+            srcDir 'src/test/resources'
+        }
+    }
+}
 
 java {
     withSourcesJar()

src/main/java/de/labystudio/spotifyapi/SpotifyAPI.java

@@ -85,9 +85,15 @@ default boolean hasTrack() {
      */
     void registerListener(SpotifyListener listener);
 
+    /**
+     * Unregisters a listener.
+     *
+     * @param listener the listener to unregister
+     */
+    void unregisterListener(SpotifyListener listener);
+
     /**
      * Disconnect from the Spotify application and stop all background tasks.
-     * It will also remove all listeners.
      */
     void stop();
 }

src/main/java/de/labystudio/spotifyapi/platform/AbstractSpotifyAPI.java

@@ -24,7 +24,7 @@ public void registerListener(SpotifyListener listener) {
     }
 
     @Override
-    public void stop() {
-        this.listeners.clear();
+    public void unregisterListener(SpotifyListener listener) {
+        this.listeners.remove(listener);
     }
 }

src/main/java/de/labystudio/spotifyapi/platform/osx/OSXSpotifyApi.java

@@ -44,4 +44,10 @@ public boolean isPlaying() {
     public boolean isConnected() {
         return false; // TODO Implement OSX SpotifyAPI
     }
+
+    @Override
+    public void stop() {
+
+    }
+
 }

src/main/java/de/labystudio/spotifyapi/platform/windows/WinSpotifyAPI.java

@@ -160,8 +160,6 @@ public boolean isConnected() {
 
     @Override
     public void stop() {
-        super.stop();
-
         if (this.task != null) {
             this.task.cancel(true);
             this.task = null;

src/main/java/de/labystudio/spotifyapi/platform/windows/api/WinApi.java

@@ -98,7 +98,7 @@ default String getWindowTitle(WinDef.HWND window) {
         return Native.toString(Arrays.copyOf(buffer, length));
     }
 
-    default Map<Long, Long> getModules(int pid) {
+    default Map<Long, Long> getModules(long pid) {
         Map<Long, Long> map = new HashMap<>();
 
         WinNT.HANDLE snapshot = Kernel32.INSTANCE.CreateToolhelp32Snapshot(
@@ -117,7 +117,7 @@ default Map<Long, Long> getModules(int pid) {
         return map;
     }
 
-    default long getModuleAddress(int pid, String moduleName) {
+    default long getModuleAddress(long pid, String moduleName) {
         WinNT.HANDLE snapshot = Kernel32.INSTANCE.CreateToolhelp32Snapshot(
                 Tlhelp32.TH32CS_SNAPMODULE,
                 new WinDef.DWORD(pid)

src/main/java/de/labystudio/spotifyapi/platform/windows/api/WinProcess.java

@@ -148,16 +148,63 @@ public long findInMemory(long address, long size, byte[] searchBytes) {
     public long findInMemory(long address, long size, byte[] searchBytes, SearchCondition condition) {
         long cursor = address;
         long maxAddress = size - address;
+        int index = 0;
         while (cursor < maxAddress) {
             long target = this.findInMemory(cursor, maxAddress, searchBytes);
-            if (condition.matches(target)) {
+            if (condition.matches(target, index)) {
                 return target;
             }
             cursor = target + 1;
+            index++;
         }
         return -1;
     }
 
+    /**
+     * Find the address of a text inside the memory.
+     * If there are multiple matches of the text, the given index will be used to select the correct one.
+     *
+     * @param start The address to start searching from.
+     * @param text  The text to search for.
+     * @param index The amount of matches to skip
+     * @return The address of the text at the given index
+     */
+    public long findAddressOfText(long start, String text, int index) {
+        long maxAddress = this.getMaxProcessAddress();
+        return this.findInMemory(start, maxAddress, text.getBytes(), (address, matchIndex) -> matchIndex == index);
+    }
+
+    /**
+     * Find multiple strings inside the memory.
+     * It will start searching with the first string and continue with the next at the position where the previous was found.
+     *
+     * @param path The list of strings to search for.
+     * @return The addresses of the strings.
+     */
+    public long findAddressUsingPath(String... path) {
+        long cursor = -1;
+        for (String part : path) {
+            cursor = this.findAddressOfText(cursor + 1, part, 0);
+            if (cursor == -1) {
+                return -1;
+            }
+        }
+        return cursor;
+    }
+
+    /**
+     * Find the first address of the modules.
+     *
+     * @return The address of the first module.
+     */
+    public long getFirstModuleAddress() {
+        long minAddress = Long.MAX_VALUE;
+        for (Map.Entry<Long, Long> module : this.getModules(this.processId).entrySet()) {
+            minAddress = Math.min(minAddress, module.getKey() + module.getValue());
+        }
+        return minAddress;
+    }
+
     /**
      * Find the highest process address.
      * The highest process address is determined by the highest module address + module size.
@@ -224,9 +271,10 @@ public interface SearchCondition {
          * Called for each matching address.
          *
          * @param address The address of the matching bytes.
+         * @param index   The index of the match.
          * @return True if the address matches the criteria.
          */
-        boolean matches(long address);
+        boolean matches(long address, int index);
     }
 
 }

src/main/java/de/labystudio/spotifyapi/platform/windows/api/spotify/SpotifyProcess.java

@@ -10,7 +10,6 @@
  */
 public class SpotifyProcess extends WinProcess {
 
-    private static final byte[] PREFIX_TRACK_ID = "spotify:track:".getBytes();
     private static final byte[] PREFIX_CONTEXT = new byte[]{0x63, 0x6F, 0x6E, 0x74, 0x65, 0x78, 0x74};
 
     private final long addressTrackId;
@@ -29,17 +28,17 @@ public class SpotifyProcess extends WinProcess {
     public SpotifyProcess() {
         super("Spotify.exe");
 
+        // Get the highest addresses of the modules
         long highestAddress = this.getMaxProcessAddress();
 
         // Find addresses of playback states (Located in the chrome_elf.dll module)
-        this.addressTrackId = this.findInMemory(
-                0,
-                highestAddress,
-                PREFIX_TRACK_ID,
-                address -> this.isTrackIdValid(this.readTrackId(address))
+        this.addressTrackId = this.findAddressUsingPath(
+                "This program cannot be run in DOS mode",
+                "This program cannot be run in DOS mode",
+                "chrome_elf.dll",
+                "spotify:track:"
         );
-        // Check if we have found the addresses
-        if (this.addressTrackId == -1) {
+        if (this.addressTrackId == -1 || !this.isTrackIdValid(this.getTrackId())) {
             throw new IllegalStateException("Could not find track id in memory");
         }
 
@@ -51,7 +50,7 @@ public SpotifyProcess() {
                 0,
                 highestAddress,
                 PREFIX_CONTEXT,
-                address -> {
+                (address, index) -> {
                     PlaybackAccessor accessor = new PlaybackAccessor(this, address);
                     return accessor.isValid() && accessor.isPlaying() == isPlaying; // Check if address is valid
                 }

src/main/java/de/labystudio/spotifyapi/platform/windows/api/spotify/SpotifyTitle.java

@@ -56,6 +56,6 @@ public static SpotifyTitle of(String title) {
         }
 
         String[] split = title.split(DELIMITER);
-        return new SpotifyTitle(split[0], split[1]);
+        return new SpotifyTitle(split[1], split[0]);
     }
 }