Merge pull request #265 from Mastermindzh/feature/5.6.0

Feature/5.6.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,20 @@ 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.6.0]
+
+- Added support for Wayland (on by default) fixes [#262](https://github.com/Mastermindzh/tidal-hifi/issues/262) and [#157](https://github.com/Mastermindzh/tidal-hifi/issues/157)
+- Made it clear in the readme that this tidal-hifi client supports High & Max audio settings. fixes [#261](https://github.com/Mastermindzh/tidal-hifi/issues/261)
+- Added app suspension inhibitors when music is playing. fixes [#257](https://github.com/Mastermindzh/tidal-hifi/issues/257)
+- Fixed bug with theme files from user directory trying to load: "an error occurred reading the theme file"
+- Fixed: config flags not being set correctly
+- [DEV]:
+  - Logger is now static and will automatically call either ipcRenderer or ipcMain
+
+## 5.5.0
+
+- ListenBrainz integration added (thanks @Mar0xy)
+
 ## 5.4.0
 
 - Removed Windows builds (from publishes) as they don't work anymore.
@@ -18,7 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - SPKChaosPhoenix updated the beautiful Tokyo Night theme:
 
-![](./docs/images/tokyo-night.png)
+![tidal with the tokyo night theme applied](./docs/images/tokyo-night.png)
 
 ## 5.2.0
 

README.md

@@ -2,7 +2,7 @@
 
 ![GitHub release](https://img.shields.io/github/release/Mastermindzh/tidal-hifi.svg) [![github builds](https://github.com/mastermindzh/tidal-hifi/actions/workflows/build.yml/badge.svg)](https://github.com/Mastermindzh/tidal-hifi/actions) [![Build Status](https://ci.mastermindzh.tech/api/badges/Mastermindzh/tidal-hifi/status.svg)](https://ci.mastermindzh.tech/Mastermindzh/tidal-hifi) [![Discord logo](./docs/images/discord.png)](https://discord.gg/yhNwf4v4He)
 
-The web version of [listen.tidal.com](https://listen.tidal.com) running in electron with hifi support thanks to widevine.
+The web version of [listen.tidal.com](https://listen.tidal.com) running in electron with hifi (High & Max) support thanks to widevine.
 
 ![tidal-hifi preview](./docs/images/preview.png)
 
@@ -38,16 +38,19 @@ The web version of [listen.tidal.com](https://listen.tidal.com) running in elect
 
 ## Features
 
-- HiFi playback
+- HiFi playback (High & Max settings)
 - Notifications
 - Custom [theming](./docs/theming.md)
 - Custom hotkeys ([source](https://defkey.com/tidal-desktop-shortcuts))
-- Songwhip.com integration (hotkey `ctrl + w`)
+- [Settings feature](./docs/images/settings.png) to disable certain functionality. (`ctrl+=` or `ctrl+0`)
 - API for status and playback
 - Disabled audio & visual ads, unlocked lyrics, suggested track, track info, and unlimited skips thanks to uBlockOrigin custom filters ([source](https://github.com/uBlockOrigin/uAssets/issues/17495))
-- 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))
+- Custom [integrations](#integrations)
+  - [ListenBrainz](https://listenbrainz.org/?redirect=false) integration
+  - Songwhip.com integration (hotkey `ctrl + w`)
+  - Discord RPC integration (showing "now listening", "Browsing", etc)
+  - MPRIS integration
 
 ## Contributions
 
@@ -58,8 +61,8 @@ To contribute you can use the standard GitHub features (issues, prs, etc) or joi
 ## Why did I create tidal-hifi?
 
 I moved from Spotify over to Tidal and found Linux support to be lacking.
-
 When I started this project there weren't any Linux apps that offered Tidal's "hifi" options nor any scripts to control it.
+I made this app to support the highest quality audio available on the Linux platform. It used to be "hifi" but now is ["High & Max"](https://tidal.com/sound-quality).
 
 ### Why not extend existing projects?
 
@@ -133,31 +136,27 @@ 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)
 
-It currently includes:
-
-- MPRIS - MPRIS media player controls/status
-- Discord - Shows what you're listening to on Discord.
-
-Not included:
+Integrations with other projects that are not included natively:
 
 - [i3 blocks config](https://github.com/Mastermindzh/dotfiles/commit/9714b2fa1d670108ce811d5511fd3b7a43180647) - My dotfiles where I use this app to fetch currently playing music (direct commit)
+- [neptune](https://github.com/uwu/neptune) third party plugins & theming
 
-### Known bugs
+## Known bugs
 
-#### last.fm doesn't work out of the box. Use rescrobbler as a workaround
+### last.fm doesn't work out of the box. Use rescrobbler as a workaround
 
 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
+### 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

SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+Only the very latest 😄.
+
+## Reporting a Vulnerability
+
+If you find a vulnerability just add it as an issue.
+If there's an especially bad vulnerability that you don't want to make public just send me a private message (email, discord, wherever).
+

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "ts-dist/main.js",
   "scripts": {

src/constants/flags.ts

@@ -1,4 +1,9 @@
 export const flags: { [key: string]: { flag: string; value?: string }[] } = {
   gpuRasterization: [{ flag: "enable-gpu-rasterization", value: undefined }],
   disableHardwareMediaKeys: [{ flag: "disable-features", value: "HardwareMediaKeyHandling" }],
+  enableWaylandSupport: [
+    { flag: "enable-features", value: "UseOzonePlatform" },
+    { flag: "ozone-platform-hint", value: "auto" },
+    { flag: "enable-features", value: "WaylandWindowDecorations" },
+  ],
 };

src/constants/settings.ts

@@ -20,10 +20,17 @@ 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",
     gpuRasterization: "flags.gpuRasterization",
+    enableWaylandSupport: "flags.enableWaylandSupport",
   },
   menuBar: "menuBar",
   minimizeOnClose: "minimizeOnClose",

src/constants/statuses.ts

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

src/features/flags/flags.ts

@@ -0,0 +1,41 @@
+import { App } from "electron";
+import { flags } from "../../constants/flags";
+import { settings } from "../../constants/settings";
+import { settingsStore } from "../../scripts/settings";
+import { Logger } from "../logger";
+
+/**
+ * Set default Electron flags
+ */
+export function setDefaultFlags(app: App) {
+  setFlag(app, "disable-seccomp-filter-sandbox");
+}
+
+/**
+ * Set Tidal's managed flags from the user settings
+ * @param app
+ */
+export function setManagedFlagsFromSettings(app: App) {
+  const flagsFromSettings = settingsStore.get(settings.flags.root);
+  if (flagsFromSettings) {
+    for (const [key, value] of Object.entries(flagsFromSettings)) {
+      if (value) {
+        flags[key].forEach((flag) => {
+          Logger.log(`enabling command line option ${flag.flag} with value ${flag.value}`);
+          setFlag(app, flag.flag, flag.value);
+        });
+      }
+    }
+  }
+}
+
+/**
+ * Set a single flag for Electron
+ * @param app app to set it on
+ * @param flag flag name
+ * @param value value to be set for the flag
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function setFlag(app: App, flag: string, value?: any) {
+  app.commandLine.appendSwitch(flag, value);
+}

src/features/idleInhibitor/idleInhibitor.ts

@@ -0,0 +1,65 @@
+import { PowerSaveBlocker, powerSaveBlocker } from "electron";
+import { Logger } from "../logger";
+
+/**
+ * Start blocking idle/screen timeouts
+ * @param blocker optional instance of the powerSaveBlocker to use
+ * @returns id of current block
+ */
+export const acquireInhibitor = (blocker?: PowerSaveBlocker): number => {
+  const currentBlocker = blocker ?? powerSaveBlocker;
+  const blockId = currentBlocker.start("prevent-app-suspension");
+  Logger.log(`Started preventing app suspension with id: ${blockId}`);
+  return blockId;
+};
+
+/**
+ * Check whether there is a blocker active for the current id, if not start it.
+ * @param id id of inhibitor you want to check activity against
+ * @param blocker optional instance of the powerSaveBlocker to use
+ */
+export const acquireInhibitorIfInactive = (id: number, blocker?: PowerSaveBlocker): number => {
+  const currentBlocker = blocker ?? powerSaveBlocker;
+  if (!isInhibitorActive(id, currentBlocker)) {
+    return acquireInhibitor();
+  }
+
+  return id;
+};
+
+/**
+ * stop blocking idle/screen timeouts
+ * @param id id of inhibitor you want to check activity against
+ * @param blocker optional instance of the powerSaveBlocker to use
+ */
+export const releaseInhibitor = (id: number, blocker?: PowerSaveBlocker) => {
+  try {
+    const currentBlocker = blocker ?? powerSaveBlocker;
+    currentBlocker.stop(id);
+    Logger.log(`Released inhibitor with id: ${id}`);
+  } catch (error) {
+    Logger.log("Releasing inhibitor failed");
+  }
+};
+
+/**
+ * stop blocking idle/screen timeouts if a inhibitor is active
+ * @param id id of inhibitor you want to check activity against
+ * @param blocker optional instance of the powerSaveBlocker to use
+ */
+export const releaseInhibitorIfActive = (id: number, blocker?: PowerSaveBlocker) => {
+  const currentBlocker = blocker ?? powerSaveBlocker;
+  if (isInhibitorActive(id, currentBlocker)) {
+    releaseInhibitor(id, currentBlocker);
+  }
+};
+
+/**
+ * check whether the inhibitor is active
+ * @param id id of inhibitor you want to check activity against
+ * @param blocker optional instance of the powerSaveBlocker to use
+ */
+export const isInhibitorActive = (id: number, blocker?: PowerSaveBlocker) => {
+  const currentBlocker = blocker ?? powerSaveBlocker;
+  return currentBlocker.isStarted(id);
+};

src/features/listenbrainz/listenbrainz.ts

@@ -0,0 +1,132 @@
+import axios from "axios";
+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) {
+      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

@@ -1,33 +1,52 @@
-import { IpcMain, IpcRenderer } from "electron";
+import { IpcMain, ipcMain, IpcMainEvent, ipcRenderer } from "electron";
 import { globalEvents } from "../constants/globalEvents";
 
 export class Logger {
-  /**
-   *
-   * @param ipcRenderer renderer IPC client so we can send messages to the main thread
-   */
-  constructor(private ipcRenderer: IpcRenderer) {}
-
   /**
    * Subscribe to watch for logs from the IPC client
    * @param ipcMain main thread IPC client so we can subscribe to events
    */
   public static watch(ipcMain: IpcMain) {
-    ipcMain.on(globalEvents.log, (event, content, object) => {
-      console.log(content, JSON.stringify(object, null, 2));
-    });
+    ipcMain.on(
+      globalEvents.log,
+      (event: IpcMainEvent | { content: string; message: string }, message) => {
+        const { content, object } = message ?? event;
+        this.logToSTDOut(content, object);
+      }
+    );
   }
-
   /**
    * Log content to STDOut
    * @param content
    * @param object js(on) object that will be prettyPrinted
    */
-  public log(content: string, object: object = {}) {
-    if (this.ipcRenderer) {
-      this.ipcRenderer.send(globalEvents.log, { content, object });
+  public static log(content: string, object: object = {}) {
+    if (ipcRenderer) {
+      ipcRenderer.send(globalEvents.log, { content, object });
     } else {
-      console.log(`${content} \n ${JSON.stringify(object, null, 2)}`);
+      ipcMain.emit(globalEvents.log, { content, object });
     }
   }
+
+  /**
+   * Log content to STDOut and use the provided alert function to alert
+   * @param content
+   * @param object js(on) object that will be prettyPrinted
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  public static alert(content: string, object: any = {}, alert?: (msg: string) => void) {
+    Logger.log(content, object);
+    if (alert) {
+      alert(`${content} \n\nwith details: \n${JSON.stringify(object, null, 2)}`);
+    }
+  }
+
+  /**
+   * Log to STDOut
+   * @param content
+   * @param object
+   */
+  private static logToSTDOut(content: string, object = {}) {
+    console.log(content, Object.keys(object).length > 0 ? JSON.stringify(object, null, 2) : "");
+  }
 }

src/main.ts

@@ -1,7 +1,7 @@
 import { enable, initialize } from "@electron/remote/main";
 import {
-  BrowserWindow,
   app,
+  BrowserWindow,
   components,
   globalShortcut,
   ipcMain,
@@ -9,9 +9,18 @@ import {
   session,
 } from "electron";
 import path from "path";
-import { flags } from "./constants/flags";
 import { globalEvents } from "./constants/globalEvents";
 import { mediaKeys } from "./constants/mediaKeys";
+import { settings } from "./constants/settings";
+import { setDefaultFlags, setManagedFlagsFromSettings } from "./features/flags/flags";
+import {
+  acquireInhibitorIfInactive,
+  releaseInhibitorIfActive,
+} from "./features/idleInhibitor/idleInhibitor";
+import { Logger } from "./features/logger";
+import { Songwhip } from "./features/songwhip/songwhip";
+import { MediaInfo } from "./models/mediaInfo";
+import { MediaStatus } from "./models/mediaStatus";
 import { initRPC, rpc, unRPC } from "./scripts/discord";
 import { startExpress } from "./scripts/express";
 import { updateMediaInfo } from "./scripts/mediaInfo";
@@ -20,15 +29,12 @@ import {
   closeSettingsWindow,
   createSettingsWindow,
   hideSettingsWindow,
-  showSettingsWindow,
   settingsStore,
+  showSettingsWindow,
 } from "./scripts/settings";
-import { settings } from "./constants/settings";
 import { addTray, refreshTray } from "./scripts/tray";
-import { MediaInfo } from "./models/mediaInfo";
-import { Songwhip } from "./features/songwhip/songwhip";
-import { Logger } from "./features/logger";
 const tidalUrl = "https://listen.tidal.com";
+let mainInhibitorId = -1;
 
 initialize();
 
@@ -36,29 +42,11 @@ let mainWindow: BrowserWindow;
 const icon = path.join(__dirname, "../assets/icon.png");
 const PROTOCOL_PREFIX = "tidal";
 
-setFlags();
-
-function setFlags() {
-  const flagsFromSettings = settingsStore.get(settings.flags.root);
-  if (flagsFromSettings) {
-    for (const [key, value] of Object.entries(flags)) {
-      if (value) {
-        flags[key].forEach((flag) => {
-          console.log(`enabling command line switch ${flag.flag} with value ${flag.value}`);
-          app.commandLine.appendSwitch(flag.flag, flag.value);
-        });
-      }
-    }
-  }
+setDefaultFlags(app);
+setManagedFlagsFromSettings(app);
 
 /**
-   * Fix Display Compositor issue.
-   */
-  app.commandLine.appendSwitch("disable-seccomp-filter-sandbox");
-}
-
-/**
- * Update the menuBarVisbility according to the store value
+ * Update the menuBarVisibility according to the store value
  *
  */
 function syncMenuBarWithStore() {
@@ -90,8 +78,8 @@ function createWindow(options = { x: 0, y: 0, backgroundColor: "white" }) {
   mainWindow = new BrowserWindow({
     x: options.x,
     y: options.y,
-    width: settingsStore && settingsStore.get(settings.windowBounds.width),
-    height: settingsStore && settingsStore.get(settings.windowBounds.height),
+    width: settingsStore?.get(settings.windowBounds.width),
+    height: settingsStore?.get(settings.windowBounds.height),
     icon,
     backgroundColor: options.backgroundColor,
     autoHideMenuBar: true,
@@ -124,6 +112,7 @@ function createWindow(options = { x: 0, y: 0, backgroundColor: "white" }) {
   });
   // Emitted when the window is closed.
   mainWindow.on("closed", function () {
+    releaseInhibitorIfActive(mainInhibitorId);
     closeSettingsWindow();
     app.quit();
   });
@@ -196,6 +185,12 @@ app.on("browser-window-created", (_, window) => {
 // IPC
 ipcMain.on(globalEvents.updateInfo, (_event, arg: MediaInfo) => {
   updateMediaInfo(arg);
+  if (arg.status === MediaStatus.playing) {
+    mainInhibitorId = acquireInhibitorIfInactive(mainInhibitorId);
+  } else {
+    releaseInhibitorIfActive(mainInhibitorId);
+    mainInhibitorId = -1;
+  }
 });
 
 ipcMain.on(globalEvents.hideSettings, () => {
@@ -224,7 +219,7 @@ ipcMain.on(globalEvents.error, (event) => {
 });
 
 ipcMain.handle(globalEvents.whip, async (event, url) => {
-  return await Songwhip.whip(url);
+  return Songwhip.whip(url);
 });
 
 Logger.watch(ipcMain);

src/pages/settings/preload.ts

@@ -3,6 +3,7 @@ import { ipcRenderer, shell } from "electron";
 import fs from "fs";
 import { globalEvents } from "../../constants/globalEvents";
 import { settings } from "../../constants/settings";
+import { Logger } from "../../features/logger";
 import { settingsStore } from "./../../scripts/settings";
 import { getOptions, getOptionsHeader, getThemeListFromDirectory } from "./theming";
 
@@ -25,7 +26,12 @@ let adBlock: HTMLInputElement,
   skippedArtists: HTMLInputElement,
   theme: HTMLSelectElement,
   trayIcon: HTMLInputElement,
-  updateFrequency: HTMLInputElement;
+  updateFrequency: HTMLInputElement,
+  enableListenBrainz: HTMLInputElement,
+  ListenBrainzAPI: HTMLInputElement,
+  ListenBrainzToken: HTMLInputElement,
+  enableWaylandSupport: HTMLInputElement;
+
 function getThemeFiles() {
   const selectElement = document.getElementById("themesList") as HTMLSelectElement;
   const builtInThemes = getThemeListFromDirectory(process.resourcesPath);
@@ -67,6 +73,7 @@ function handleFileUploads() {
  * Sync the UI forms with the current settings
  */
 function refreshSettings() {
+  try {
     adBlock.checked = settingsStore.get(settings.adBlock);
     api.checked = settingsStore.get(settings.api);
     customCSS.value = settingsStore.get<string, string[]>(settings.customCSS).join("\n");
@@ -74,6 +81,7 @@ function refreshSettings() {
     disableHardwareMediaKeys.checked = settingsStore.get(settings.flags.disableHardwareMediaKeys);
     enableCustomHotkeys.checked = settingsStore.get(settings.enableCustomHotkeys);
     enableDiscord.checked = settingsStore.get(settings.enableDiscord);
+    enableWaylandSupport.checked = settingsStore.get(settings.flags.enableWaylandSupport);
     gpuRasterization.checked = settingsStore.get(settings.flags.gpuRasterization);
     menuBar.checked = settingsStore.get(settings.menuBar);
     minimizeOnClose.checked = settingsStore.get(settings.minimizeOnClose);
@@ -87,6 +95,12 @@ 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);
+  } catch (error) {
+    Logger.log("Refreshing settings failed.", error);
+  }
 }
 
 /**
@@ -137,6 +151,12 @@ 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);
     });
   }
@@ -170,6 +190,7 @@ window.addEventListener("DOMContentLoaded", () => {
   disableHardwareMediaKeys = get("disableHardwareMediaKeys");
   enableCustomHotkeys = get("enableCustomHotkeys");
   enableDiscord = get("enableDiscord");
+  enableWaylandSupport = get("enableWaylandSupport");
   gpuRasterization = get("gpuRasterization");
   menuBar = get("menuBar");
   minimizeOnClose = get("minimizeOnClose");
@@ -183,8 +204,14 @@ 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);
@@ -193,6 +220,7 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(disableHardwareMediaKeys, settings.flags.disableHardwareMediaKeys);
   addInputListener(enableCustomHotkeys, settings.enableCustomHotkeys);
   addInputListener(enableDiscord, settings.enableDiscord);
+  addInputListener(enableWaylandSupport, settings.flags.enableWaylandSupport);
   addInputListener(gpuRasterization, settings.flags.gpuRasterization);
   addInputListener(menuBar, settings.menuBar);
   addInputListener(minimizeOnClose, settings.minimizeOnClose);
@@ -206,4 +234,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">
@@ -229,6 +258,7 @@
                 <input id="updateFrequency" type="number" class="text-input" name="updateFrequency" />
               </div>
             </div>
+          </div>
           <div class="group">
             <p class="group__title">Flags</p>
             <div class="group__option">
@@ -266,6 +296,18 @@
                 <span class="switch__slider"></span>
               </label>
             </div>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Wayland support</h4>
+                <p>
+                  Adds a couple of Electron flags to help Tidal-hifi run smoothly on the Wayland window system.
+                </p>
+              </div>
+              <label class="switch">
+                <input id="enableWaylandSupport" type="checkbox" />
+                <span class="switch__slider"></span>
+              </label>
+            </div>
           </div>
         </section>
 

src/pages/settings/theming.ts

@@ -1,4 +1,5 @@
 import fs from "fs";
+import { Logger } from "../../features/logger";
 
 const cssFilter = (file: string) => file.endsWith(".css");
 const sort = (a: string, b: string) => a.toLowerCase().localeCompare(b.toLowerCase());
@@ -36,7 +37,7 @@ export const getThemeListFromDirectory = (directory: string): string[] => {
     makeUserThemesDirectory(directory);
     return fs.readdirSync(directory).filter(cssFilter).sort(sort);
   } catch (err) {
-    console.error(err);
+    Logger.log(`Failed to get files from ${directory}`, err);
     return [];
   }
 };
@@ -49,6 +50,6 @@ export const makeUserThemesDirectory = (directory: string) => {
   try {
     fs.mkdirSync(directory, { recursive: true });
   } catch (err) {
-    console.error(err);
+    Logger.log(`Failed to make user theme directory: ${directory}`, err);
   }
 };

src/preload.ts

@@ -4,8 +4,15 @@ 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 {
+  ListenBrainz,
+  ListenBrainzConstants,
+  ListenBrainzStore,
+} from "./features/listenbrainz/listenbrainz";
+import { StoreData } from "./features/listenbrainz/models/storeData";
+import { Logger } from "./features/logger";
 import { Songwhip } from "./features/songwhip/songwhip";
+import { MediaStatus } from "./models/mediaStatus";
 import { Options } from "./models/options";
 import { downloadFile } from "./scripts/download";
 import { addHotkey } from "./scripts/hotkeys";
@@ -16,7 +23,7 @@ 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 +112,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);
@@ -151,12 +158,14 @@ const elements = {
 
 function addCustomCss() {
   window.addEventListener("DOMContentLoaded", () => {
-    const selectedTheme = settingsStore.get(settings.theme);
+    const selectedTheme = settingsStore.get<string, string>(settings.theme);
     if (selectedTheme !== "none") {
-      const themeFile = `${process.resourcesPath}/${selectedTheme}`;
+      const userThemePath = `${app.getPath("userData")}/themes/${selectedTheme}`;
+      const resourcesThemePath = `${process.resourcesPath}/${selectedTheme}`;
+      const themeFile = fs.existsSync(userThemePath) ? userThemePath : resourcesThemePath;
       fs.readFile(themeFile, "utf-8", (err, data) => {
         if (err) {
-          alert("An error ocurred reading the theme file.");
+          Logger.alert("An error ocurred reading the theme file.", err, alert);
           return;
         }
 
@@ -178,7 +187,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 +210,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 +288,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 +330,8 @@ function addIPCEventListeners() {
         case globalEvents.pause:
           elements.click("pause");
           break;
+        default:
+          break;
       }
     });
   });
@@ -330,9 +346,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,6 +373,12 @@ function updateMediaInfo(options: Options, notify: boolean) {
     if (settingsStore.get(settings.notifications) && notify) {
       new Notification({ title: options.title, body: options.artists, icon: options.icon }).show();
     }
+    updateMpris(options);
+    updateListenBrainz(options);
+  }
+}
+
+function updateMpris(options: Options) {
   if (player) {
     player.metadata = {
       ...player.metadata,
@@ -369,7 +391,23 @@ function updateMediaInfo(options: Options, notify: boolean) {
         "mpris:trackid": "/org/mpris/MediaPlayer2/track/" + getTrackID(),
       },
     };
-      player.playbackStatus = options.status == statuses.paused ? "Paused" : "Playing";
+    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,9 +18,15 @@ 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,
+      enableWaylandSupport: true,
+      gpuRasterization: true,
     },
     menuBar: true,
     minimizeOnClose: false,