Merge pull request #260 from Mastermindzh/5.5.0

5.5.0

.vscode/settings.json

@@ -1,10 +1,16 @@
 {
   "cSpell.words": [
+    "Brainz",
+    "Castlabs",
     "flac",
+    "Flatpak",
     "geqnfr",
     "hifi",
+    "listenbrainz",
     "playpause",
     "rescrobbler",
+    "scrobble",
+    "scrobbling",
     "Songwhip",
     "trackid",
     "tracklist",

CHANGELOG.md

@@ -4,6 +4,10 @@ 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).
 
+## 5.5.0
+
+- ListenBrainz integration added (thanks @Mar0xy)
+
 ## 5.4.0
 
 - Removed Windows builds (from publishes) as they don't work anymore.

README.md

@@ -48,6 +48,7 @@ The web version of [listen.tidal.com](https://listen.tidal.com) running in elect
 - Custom [integrations](#integrations)
 - [Settings feature](./docs/images/settings.png) to disable certain functionality. (`ctrl+=` or `ctrl+0`)
 - AlbumArt in integrations ([best-effort](https://github.com/Mastermindzh/tidal-hifi/pull/88#pullrequestreview-840814847))
+- [ListenBrainz](https://listenbrainz.org/?redirect=false) integration
 
 ## Contributions
 
@@ -133,7 +134,7 @@ To install and work with the code on this project follow these steps:
 
 ## Integrations
 
-Tidal-hifi comes with several integrations out of the box.
+tidal-hifi comes with several integrations out of the box.
 You can find these in the settings menu (`ctrl + =` by default) under the "integrations" tab.
 
 ![integrations menu, showing a list of integrations](./docs/images/integrations.png)
@@ -153,11 +154,11 @@ Not included:
 
 The last.fm login doesn't work, as is evident from the following issue: [Last.fm login doesn't work](https://github.com/Mastermindzh/tidal-hifi/issues/4).
 However, in that same issue you can read about a workaround using [rescrobbler](https://github.com/InputUsername/rescrobbled).
-For now that will be the default workaround.
+For now, that will be the default workaround.
 
 #### DRM not working on Windows
 
-Most Windows users run into DRM issues when trying to use Tidal-hifi.
+Most Windows users run into DRM issues when trying to use tidal-hifi.
 Nothing I can do about that I'm afraid... Tidal is working on removing/changing DRM so when they finish with that we can give it another shot.
 
 ## Special thanks to

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "tidal-hifi",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "tidal-hifi",
-      "version": "5.4.0",
+      "version": "5.5.0",
       "license": "MIT",
       "dependencies": {
         "@electron/remote": "^2.0.10",
@@ -9340,4 +9340,4 @@
       }
     }
   }
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "ts-dist/main.js",
   "scripts": {
@@ -72,4 +72,4 @@
     "typescript": "^5.1.6"
   },
   "prettier": "@mastermindzh/prettier-config"
-}
+}

src/constants/settings.ts

@@ -20,6 +20,12 @@ export const settings = {
   disableHardwareMediaKeys: "disableHardwareMediaKeys",
   enableCustomHotkeys: "enableCustomHotkeys",
   enableDiscord: "enableDiscord",
+  ListenBrainz: {
+    root: "ListenBrainz",
+    enabled: "ListenBrainz.enabled",
+    api: "ListenBrainz.api",
+    token: "ListenBrainz.token",
+  },
   flags: {
     root: "flags",
     disableHardwareMediaKeys: "flags.disableHardwareMediaKeys",

src/constants/statuses.ts

@@ -1,4 +0,0 @@
-export const statuses = {
-  playing: "playing",
-  paused: "paused",
-};

src/features/listenbrainz/listenbrainz.ts

@@ -0,0 +1,134 @@
+import axios from "axios";
+import { ipcRenderer } from "electron";
+import Store from "electron-store";
+import { settings } from "../../constants/settings";
+import { MediaStatus } from "../../models/mediaStatus";
+import { settingsStore } from "../../scripts/settings";
+import { Logger } from "../logger";
+import { StoreData } from "./models/storeData";
+
+const ListenBrainzStore = new Store({ name: "listenbrainz" });
+
+export const ListenBrainzConstants = {
+  oldData: "oldData",
+};
+
+export class ListenBrainz {
+  /**
+   * Create the object to store old information in the Store :)
+   * @param title
+   * @param artists
+   * @param duration
+   * @returns data passed along in an object + a "listenedAt" key with the current time
+   */
+  private static constructStoreData(title: string, artists: string, duration: number): StoreData {
+    return {
+      listenedAt: Math.floor(new Date().getTime() / 1000),
+      title,
+      artists,
+      duration,
+    };
+  }
+
+  /**
+   * Call the ListenBrainz API and create playing now payload and scrobble old song
+   * @param title
+   * @param artists
+   * @param status
+   * @param duration
+   */
+  public static async scrobble(
+    title: string,
+    artists: string,
+    status: string,
+    duration: number
+  ): Promise<void> {
+    try {
+      if (status === MediaStatus.paused) {
+        return;
+      } else {
+        // Fetches the oldData required for scrobbling and proceeds to construct a playing_now data payload for the Playing Now area
+        const oldData = ListenBrainzStore.get(ListenBrainzConstants.oldData) as StoreData;
+        const playing_data = {
+          listen_type: "playing_now",
+          payload: [
+            {
+              track_metadata: {
+                additional_info: {
+                  media_player: "Tidal Hi-Fi",
+                  submission_client: "Tidal Hi-Fi",
+                  music_service: "tidal.com",
+                  duration: duration,
+                },
+                artist_name: artists,
+                track_name: title,
+              },
+            },
+          ],
+        };
+
+        await axios.post(
+          `${settingsStore.get<string, string>(settings.ListenBrainz.api)}/1/submit-listens`,
+          playing_data,
+          {
+            headers: {
+              "Content-Type": "application/json",
+              Authorization: `Token ${settingsStore.get<string, string>(
+                settings.ListenBrainz.token
+              )}`,
+            },
+          }
+        );
+        if (!oldData) {
+          ListenBrainzStore.set(
+            ListenBrainzConstants.oldData,
+            this.constructStoreData(title, artists, duration)
+          );
+        } else {
+          if (oldData.title !== title) {
+            // This constructs the data required to scrobble the data after the song finishes
+            const scrobble_data = {
+              listen_type: "single",
+              payload: [
+                {
+                  listened_at: oldData.listenedAt,
+                  track_metadata: {
+                    additional_info: {
+                      media_player: "Tidal Hi-Fi",
+                      submission_client: "Tidal Hi-Fi",
+                      music_service: "listen.tidal.com",
+                      duration: oldData.duration,
+                    },
+                    artist_name: oldData.artists,
+                    track_name: oldData.title,
+                  },
+                },
+              ],
+            };
+            await axios.post(
+              `${settingsStore.get<string, string>(settings.ListenBrainz.api)}/1/submit-listens`,
+              scrobble_data,
+              {
+                headers: {
+                  "Content-Type": "application/json",
+                  Authorization: `Token ${settingsStore.get<string, string>(
+                    settings.ListenBrainz.token
+                  )}`,
+                },
+              }
+            );
+            ListenBrainzStore.set(
+              ListenBrainzConstants.oldData,
+              this.constructStoreData(title, artists, duration)
+            );
+          }
+        }
+      }
+    } catch (error) {
+      const logger = new Logger(ipcRenderer);
+      logger.log(JSON.stringify(error));
+    }
+  }
+}
+
+export { ListenBrainzStore };

src/features/listenbrainz/models/storeData.ts

@@ -0,0 +1,9 @@
+/**
+ * Data saved for ListenBrainz
+ */
+export interface StoreData {
+  listenedAt: number;
+  title: string;
+  artists: string;
+  duration: number;
+}

src/features/logger.ts

@@ -26,8 +26,7 @@ export class Logger {
   public log(content: string, object: object = {}) {
     if (this.ipcRenderer) {
       this.ipcRenderer.send(globalEvents.log, { content, object });
-    } else {
-      console.log(`${content} \n ${JSON.stringify(object, null, 2)}`);
     }
+    console.log(`${content} \n ${JSON.stringify(object, null, 2)}`);
   }
 }

src/main.ts

@@ -58,7 +58,7 @@ function setFlags() {
 }
 
 /**
- * Update the menuBarVisbility according to the store value
+ * Update the menuBarVisibility according to the store value
  *
  */
 function syncMenuBarWithStore() {

src/pages/settings/preload.ts

@@ -25,7 +25,11 @@ let adBlock: HTMLInputElement,
   skippedArtists: HTMLInputElement,
   theme: HTMLSelectElement,
   trayIcon: HTMLInputElement,
-  updateFrequency: HTMLInputElement;
+  updateFrequency: HTMLInputElement,
+  enableListenBrainz: HTMLInputElement,
+  ListenBrainzAPI: HTMLInputElement,
+  ListenBrainzToken: HTMLInputElement;
+
 function getThemeFiles() {
   const selectElement = document.getElementById("themesList") as HTMLSelectElement;
   const builtInThemes = getThemeListFromDirectory(process.resourcesPath);
@@ -87,6 +91,9 @@ function refreshSettings() {
   skippedArtists.value = settingsStore.get<string, string[]>(settings.skippedArtists).join("\n");
   trayIcon.checked = settingsStore.get(settings.trayIcon);
   updateFrequency.value = settingsStore.get(settings.updateFrequency);
+  enableListenBrainz.checked = settingsStore.get(settings.ListenBrainz.enabled);
+  ListenBrainzAPI.value = settingsStore.get(settings.ListenBrainz.api);
+  ListenBrainzToken.value = settingsStore.get(settings.ListenBrainz.token);
 }
 
 /**
@@ -137,6 +144,10 @@ window.addEventListener("DOMContentLoaded", () => {
       } else {
         settingsStore.set(key, source.value);
       }
+      // Live update the view for ListenBrainz input, hide if disabled/show if enabled
+      if (source.value === "on" && source.id === "enableListenBrainz") {
+        source.checked ? document.getElementById("listenbrainz__options").removeAttribute("hidden") : document.getElementById("listenbrainz__options").setAttribute("hidden", "true");
+      }
       ipcRenderer.send(globalEvents.storeChanged);
     });
   }
@@ -183,8 +194,12 @@ window.addEventListener("DOMContentLoaded", () => {
   skippedArtists = get("skippedArtists");
   singleInstance = get("singleInstance");
   updateFrequency = get("updateFrequency");
+  enableListenBrainz = get("enableListenBrainz");
+  ListenBrainzAPI = get("ListenBrainzAPI");
+  ListenBrainzToken = get("ListenBrainzToken");
 
   refreshSettings();
+  enableListenBrainz.checked ? document.getElementById("listenbrainz__options").removeAttribute("hidden") : document.getElementById("listenbrainz__options").setAttribute("hidden", "true");
 
   addInputListener(adBlock, settings.adBlock);
   addInputListener(api, settings.api);
@@ -206,4 +221,7 @@ window.addEventListener("DOMContentLoaded", () => {
   addSelectListener(theme, settings.theme);
   addInputListener(trayIcon, settings.trayIcon);
   addInputListener(updateFrequency, settings.updateFrequency);
+  addInputListener(enableListenBrainz, settings.ListenBrainz.enabled);
+  addTextAreaListener(ListenBrainzAPI, settings.ListenBrainz.api);
+  addTextAreaListener(ListenBrainzToken, settings.ListenBrainz.token);
 });

src/pages/settings/settings.html

@@ -212,6 +212,35 @@
               </label>
             </div>
           </div>
+          <div class="group">
+            <p class="group__title">ListenBrainz</p>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Enable ListenBrainz</h4>
+                <p>Scrobble your listens directly to ListenBrainz.</p>
+              </div>
+              <label class="switch">
+                <input id="enableListenBrainz" type="checkbox" />
+                <span class="switch__slider"></span>
+              </label>
+            </div>
+            <div id="listenbrainz__options" hidden="true">
+              <div class="group__option">
+                <div class="group__description">
+                  <h4>ListenBrainz API Url</h4>
+                  <p>There are multiple instances for ListenBrainz you can set the corresponding API url below.</p>
+                </div>
+              </div>
+              <textarea id="ListenBrainzAPI" class="textarea" cols="1" rows="1" spellcheck="false"></textarea>
+              <div class="group__option">
+                <div class="group__description">
+                  <h4>ListenBrainz User Token</h4>
+                  <p>Provide the user token you can get from the settings page.</p>
+                </div>
+              </div>
+              <textarea id="ListenBrainzToken" class="textarea" cols="1" rows="1" spellcheck="false"></textarea>
+            </div>
+          </div>
         </section>
 
         <section id="advanced-section" class="tabs__section">

src/preload.ts

@@ -4,19 +4,25 @@ import fs from "fs";
 import Player from "mpris-service";
 import { globalEvents } from "./constants/globalEvents";
 import { settings } from "./constants/settings";
-import { statuses } from "./constants/statuses";
 import { Songwhip } from "./features/songwhip/songwhip";
+import {
+  ListenBrainz,
+  ListenBrainzConstants,
+  ListenBrainzStore,
+} from "./features/listenbrainz/listenbrainz";
 import { Options } from "./models/options";
 import { downloadFile } from "./scripts/download";
 import { addHotkey } from "./scripts/hotkeys";
 import { settingsStore } from "./scripts/settings";
 import { setTitle } from "./scripts/window-functions";
+import { StoreData } from "./features/listenbrainz/models/storeData";
+import { MediaStatus } from "./models/mediaStatus";
 
 const notificationPath = `${app.getPath("userData")}/notification.jpg`;
 const appName = "Tidal Hifi";
 let currentSong = "";
 let player: Player;
-let currentPlayStatus = statuses.paused;
+let currentPlayStatus = MediaStatus.paused;
 
 const elements = {
   play: '*[data-test="play"]',
@@ -105,7 +111,7 @@ const elements = {
       window.location.href.includes("/playlist/") ||
       window.location.href.includes("/mix/")
     ) {
-      if (currentPlayStatus === statuses.playing) {
+      if (currentPlayStatus === MediaStatus.playing) {
         // find the currently playing element from the list (which might be in an album icon), traverse back up to the mediaItem (row) and select the album cell.
         // document.querySelector("[class^='isPlayingIcon'], [data-test-is-playing='true']").closest('[data-type="mediaItem"]').querySelector('[class^="album"]').textContent
         const row = window.document.querySelector(this.currentlyPlaying).closest(this.mediaItem);
@@ -178,7 +184,7 @@ function addCustomCss() {
  * make sure it returns a number, if not use the default
  */
 function getUpdateFrequency() {
-  const storeValue = settingsStore.get(settings.updateFrequency) as number;
+  const storeValue = settingsStore.get<string, number>(settings.updateFrequency);
   const defaultValue = 500;
 
   if (!isNaN(storeValue)) {
@@ -201,6 +207,11 @@ function playPause() {
   }
 }
 
+/**
+ * Clears the old listenbrainz data on launch
+ */
+ListenBrainzStore.clear();
+
 /**
  * Add hotkeys for when tidal is focused
  * Reflects the desktop hotkeys found on:
@@ -274,7 +285,7 @@ function handleLogout() {
       defaultId: 2,
     })
     .then((result: { response: number }) => {
-      if (logoutOptions.indexOf("Yes, please") == result.response) {
+      if (logoutOptions.indexOf("Yes, please") === result.response) {
         for (let i = 0; i < window.localStorage.length; i++) {
           const key = window.localStorage.key(i);
           if (key.startsWith("_TIDAL_activeSession")) {
@@ -316,6 +327,8 @@ function addIPCEventListeners() {
         case globalEvents.pause:
           elements.click("pause");
           break;
+        default:
+          break;
       }
     });
   });
@@ -330,9 +343,9 @@ function getCurrentlyPlayingStatus() {
 
   // if pause button is visible tidal is playing
   if (pause) {
-    status = statuses.playing;
+    status = MediaStatus.playing;
   } else {
-    status = statuses.paused;
+    status = MediaStatus.paused;
   }
   return status;
 }
@@ -357,19 +370,41 @@ function updateMediaInfo(options: Options, notify: boolean) {
     if (settingsStore.get(settings.notifications) && notify) {
       new Notification({ title: options.title, body: options.artists, icon: options.icon }).show();
     }
-    if (player) {
-      player.metadata = {
-        ...player.metadata,
-        ...{
-          "xesam:title": options.title,
-          "xesam:artist": [options.artists],
-          "xesam:album": options.album,
-          "mpris:artUrl": options.image,
-          "mpris:length": convertDuration(options.duration) * 1000 * 1000,
-          "mpris:trackid": "/org/mpris/MediaPlayer2/track/" + getTrackID(),
-        },
-      };
-      player.playbackStatus = options.status == statuses.paused ? "Paused" : "Playing";
+    updateMpris(options);
+    updateListenBrainz(options);
+  }
+}
+
+function updateMpris(options: Options) {
+  if (player) {
+    player.metadata = {
+      ...player.metadata,
+      ...{
+        "xesam:title": options.title,
+        "xesam:artist": [options.artists],
+        "xesam:album": options.album,
+        "mpris:artUrl": options.image,
+        "mpris:length": convertDuration(options.duration) * 1000 * 1000,
+        "mpris:trackid": "/org/mpris/MediaPlayer2/track/" + getTrackID(),
+      },
+    };
+    player.playbackStatus = options.status === MediaStatus.paused ? "Paused" : "Playing";
+  }
+}
+
+function updateListenBrainz(options: Options) {
+  if (settingsStore.get(settings.ListenBrainz.enabled)) {
+    const oldData = ListenBrainzStore.get(ListenBrainzConstants.oldData) as StoreData;
+    if (
+      (!oldData && options.status === MediaStatus.playing) ||
+      (oldData && oldData.title !== options.title)
+    ) {
+      ListenBrainz.scrobble(
+        options.title,
+        options.artists,
+        options.status,
+        convertDuration(options.duration)
+      );
     }
   }
 }

src/scripts/express.ts

@@ -1,11 +1,11 @@
 import { BrowserWindow, dialog } from "electron";
 import express, { Response } from "express";
 import fs from "fs";
+import { settings } from "../constants/settings";
+import { MediaStatus } from "../models/mediaStatus";
 import { globalEvents } from "./../constants/globalEvents";
-import { statuses } from "./../constants/statuses";
 import { mediaInfo } from "./mediaInfo";
 import { settingsStore } from "./settings";
-import { settings } from "../constants/settings";
 
 /**
  * Function to enable tidal-hifi's express api
@@ -44,7 +44,7 @@ export const startExpress = (mainWindow: BrowserWindow) => {
     expressApp.get("/next", (req, res) => handleGlobalEvent(res, globalEvents.next));
     expressApp.get("/previous", (req, res) => handleGlobalEvent(res, globalEvents.previous));
     expressApp.get("/playpause", (req, res) => {
-      if (mediaInfo.status == statuses.playing) {
+      if (mediaInfo.status === MediaStatus.playing) {
         handleGlobalEvent(res, globalEvents.pause);
       } else {
         handleGlobalEvent(res, globalEvents.play);

src/scripts/mediaInfo.ts

@@ -1,12 +1,12 @@
 import { MediaInfo } from "../models/mediaInfo";
-import { statuses } from "./../constants/statuses";
+import { MediaStatus } from "../models/mediaStatus";
 
 export const mediaInfo = {
   title: "",
   artists: "",
   album: "",
   icon: "",
-  status: statuses.paused,
+  status: MediaStatus.paused as string,
   url: "",
   current: "",
   duration: "",

src/scripts/settings.ts

@@ -18,6 +18,11 @@ export const settingsStore = new Store({
     disableHardwareMediaKeys: false,
     enableCustomHotkeys: false,
     enableDiscord: false,
+    ListenBrainz: {
+      enabled: false,
+      api: "https://api.listenbrainz.org",
+      token: "",
+    },
     flags: {
       gpuRasterization: true,
       disableHardwareMediaKeys: false,