Muting artists automatically (#116)

Co-authored-by: Cukmekerb <cukmekerb@gmail.com>

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["hifi", "rescrobbler", "widevine"]
+}

CHANGELOG.md

@@ -4,13 +4,18 @@ 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).
 
+## 2.8.0
+
+- Added the ability to mute artists automatically
+- Added better error handling for discord rpc
+
 ## 2.7.2
 
-- Disabled sanboxing to fix a display compositor issue on Linux.
+- Disabled sandboxing to fix a display compositor issue on Linux.
 
 ## 2.7.1
 
-- Fixed bug: Triggering fullscreen from the Tidal web app would cause the menubar to be visible even if it was disabled in the settings
+- Fixed bug: Triggering full screen from the Tidal web app would cause the menubar to be visible even if it was disabled in the settings
 
 ## 2.7.0
 
@@ -19,11 +24,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## 2.6.0
 
-- Add album images to mediainfo and discord
+- Add album images to media info and discord
 
 ## 2.5.0
 
-- Notify-send now correctly shows "Tidal Hifi" as the program name
+- Notify-send now correctly shows "Tidal HiFi" as the program name
 - Updated dependencies (including electron itself)
 
 ### known issues
@@ -36,13 +41,13 @@ updated to nodejs 16 in actions
 
 ## 2.4.0
 
-- Added more mpris settings
+- Added more MPRIS settings
 - Added instruction for rescrobbler to get last.fm working without sandbox mode
 
 ## 2.3.0
 
 - Added a setting to minimize to tray on app close (off by default)
-- Added the main menu to the trayicon
+- Added the main menu to the tray icon
 
 ## 2.2.1
 
@@ -59,7 +64,7 @@ moved to: [https://github.com/Mastermindzh/tidal-hifi-aur](https://github.com/Ma
 - All fields (current, remaining, and url are also available in the API\*)
 - the artist field is now correctly identified
 
-* current time only updates on play/pause.
+\* current time only updates on play/pause.
 
 ## 2.1.1
 
@@ -84,7 +89,7 @@ moved to: [https://github.com/Mastermindzh/tidal-hifi-aur](https://github.com/Ma
 
 ## 1.3.0
 
--- re-enabled mpris-service wit the electron downloader fixes
+-- re-enabled MPRIS-service wit the electron downloader fixes
 
 ## 1.2.0
 
@@ -99,7 +104,7 @@ Bugfixes:
 ## 1.1.0
 
 - updated to electron 8.0.0
-- Added a beta-version of the mpris service
+- Added a beta-version of the MPRIS service
 
 - Bugfixes:
   - icon on gnome not showing in launcher

README.md

@@ -76,6 +76,7 @@ To install and work with the code on this project follow these steps:
 - Notifications
 - Custom hotkeys ([source](https://defkey.com/tidal-desktop-shortcuts))
 - API for status and playback
+- [Mute artists automatically (defaults to "Tidal")]("./docs/muting-artists.md")
 - Custom [integrations](#integrations)
 - [Settings feature](./docs/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))
@@ -89,7 +90,7 @@ You can find these in the settings menu (`ctrl + =` by default) under the "integ
 
 It currently includes:
 
-- mpris - mpris media player controls/status
+- MPRIS - MPRIS media player controls/status
 - Discord - Shows what you're listening to on Discord.
 
 ### not included

docs/muting-artists.md

@@ -0,0 +1,11 @@
+# Muting artists
+
+If you feel that some of your music is embarrassing for others you can mute specific artists in the settings window.
+This functionality is inspired by the [adblock ticket](https://github.com/Mastermindzh/tidal-hifi/issues/112), and whilst I personally feel you should simply buy Tidal, I also believe in muting sound that you don't want to hear.
+
+Anyway, to block an artist, open the settings window (see image below) and enter a list of artists in the textarea as seen below.
+Don't forget to turn the feature on and Tidal-hifi will automatically mute the player whenever that artist is playing.
+
+This will allow you to skip the song without anyone noticing. (you can always say "no idea, it seems to have no audio").
+
+![muted artists settings window](./settings-muted-artists.png)

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "tidal-hifi",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "tidal-hifi",
-      "version": "2.7.2",
+      "version": "2.8.0",
       "license": "MIT",
       "dependencies": {
         "discord-rpc": "^4.0.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "src/main.js",
   "scripts": {

src/constants/settings.js

@@ -13,6 +13,8 @@ const settings = {
   api: "api",
   menuBar: "menuBar",
   playBackControl: "playBackControl",
+  muteArtists: "muteArtists",
+  mutedArtists: "mutedArtists",
   apiSettings: {
     root: "apiSettings",
     port: "apiSettings.port",

src/pages/settings/preload.js

@@ -1,8 +1,15 @@
-let notifications;
-let playBackControl;
-let api;
-let port;
-let menuBar;
+let trayIcon,
+  minimizeOnClose,
+  mpris,
+  enableCustomHotkeys,
+  enableDiscord,
+  muteArtists,
+  notifications,
+  playBackControl,
+  api,
+  port,
+  menuBar,
+  mutedArtists;
 
 const { store, settings } = require("./../../scripts/settings");
 const { ipcRenderer } = require("electron");
@@ -22,6 +29,8 @@ function refreshSettings() {
   enableCustomHotkeys.checked = store.get(settings.enableCustomHotkeys);
   enableDiscord.checked = store.get(settings.enableDiscord);
   minimizeOnClose.checked = store.get(settings.minimizeOnClose);
+  muteArtists.checked = store.get(settings.muteArtists);
+  mutedArtists.value = store.get(settings.mutedArtists).join("\n");
 }
 
 /**
@@ -67,6 +76,13 @@ window.addEventListener("DOMContentLoaded", () => {
     });
   }
 
+  function addTextAreaListener(source, key) {
+    source.addEventListener("input", function (event, data) {
+      store.set(key, source.value.split("\n"));
+      ipcRenderer.send(globalEvents.storeChanged);
+    });
+  }
+
   ipcRenderer.on("refreshData", () => {
     refreshSettings();
   });
@@ -85,6 +101,8 @@ window.addEventListener("DOMContentLoaded", () => {
   mpris = get("mprisCheckbox");
   enableCustomHotkeys = get("enableCustomHotkeys");
   enableDiscord = get("enableDiscord");
+  muteArtists = get("muteArtists");
+  mutedArtists = get("mutedArtists");
 
   refreshSettings();
 
@@ -98,4 +116,6 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(enableCustomHotkeys, settings.enableCustomHotkeys);
   addInputListener(enableDiscord, settings.enableDiscord);
   addInputListener(minimizeOnClose, settings.minimizeOnClose);
+  addInputListener(muteArtists, settings.muteArtists);
+  addTextAreaListener(mutedArtists, settings.mutedArtists);
 });

src/pages/settings/settings.html

@@ -2,6 +2,7 @@
 <html lang="en">
 
 <head>
+    <title>Tidal-hifi settings</title>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta http-equiv="X-UA-Compatible" content="ie=edge" />
@@ -54,6 +55,17 @@
                                 <span class="slider round"></span>
                             </label>
                         </div>
+                        <div class="option">
+                            <h4>Mute Artists automatically</h4>
+                            <p>
+                                The following list of artists (1 per line) will be muted automatically.
+                            </p>
+                            <label class="switch" style="margin-bottom:10px">
+                              <input id="muteArtists" type="checkbox">
+                              <span class="slider round" ></span>
+                          </label>
+                          <textarea id="mutedArtists" cols="40" rows="5"></textarea>
+                        </div>
                     </div>
                     <div class="section">
                         <h3>UI</h3>
@@ -139,12 +151,12 @@
                   <div class="section">
                       <h3>integrations</h3>
                       <p style="margin-bottom: 15px;">
-                          Tidal-hifi is extensible trough the use of integrations. You can enable or disable integrations here
+                          Tidal-hifi is extensible through the use of integrations. You can enable or disable integrations here
                       </p>
                       <div class="option">
-                          <h4>mpris-player</h4>
+                          <h4>MPRIS-player</h4>
                           <p>
-                              Whether to enable the mpris media player controls for Linux systems
+                              Whether to enable the MPRIS media player controls for Linux systems
                           </p>
                           <label class="switch">
                               <input id="mprisCheckbox" type="checkbox">
@@ -165,16 +177,16 @@
               </section>
                 <section id="about" class="tab-panel">
                   <div class="section">
-                    <img style="width: 100px; height: auto; display: block; margin: 0 auto; margin-bottom: 20px; margin-top: 20px;" src = "./icon.png">
+                    <img alt="tidal icon" style="width: 100px; height: auto; display: block; margin: 0 auto; margin-bottom: 20px; margin-top: 20px;" src = "./icon.png">
                     <p style="max-width: 350px; display:block; margin: 0 auto; text-align: center;">
                       <a href ="javascript:openExternal('https://github.com/Mastermindzh/tidal-hifi');">Tidal-hifi</a> is made by <a href ="javascript:openExternal('https://www.rickvanlieshout.com')">Rick van Lieshout</a>.<br />
-                      It uses <a href="javascript:openExternal('https://castlabs.com/');">castlabs</a> versions of Electron for widevine support.
+                      It uses <a href="javascript:openExternal('https://castlabs.com/');">Castlabs'</a> versions of Electron for widevine support.
                     </p>
 
                   </div>
                 </section>
 
-              <small>Some settings require a restart of Tidal-hifi. To do so click the button below:</small>
+              <small>Some settings require a restart of Tidal-hifi. To do so, click the button below:</small>
               <button onClick="restart()" style ="width: 100%">Restart Tidal-hifi</button>
             </div>
         </div>
@@ -469,5 +481,19 @@
     button:hover{
       background-color: rgba(229,238,255,.3);
     }
+    textarea {
+      color: #72777f;
+      background: #242528;
+      border: 0;
+      width: 100%;
+      color: rgba(229, 238, 255, .6);
+      padding: 0 0 12px;
+      display:block;
+    }
+    textarea:focus {
+      outline: none;
+      border: 0;
+      border-bottom: 1px solid #0ff;
+    }
 </style>
 </html>

src/preload.js

@@ -15,6 +15,7 @@ let progressBarTime;
 let currentTimeChanged = false;
 let currentTime;
 let currentURL = undefined;
+let isMutedArtist = false;
 
 const elements = {
   play: '*[data-test="play"]',
@@ -42,7 +43,7 @@ const elements = {
   playing_title: 'span[data-test="table-cell-title"].css-geqnfr',
   album_name_cell: '[data-test="table-cell-album"]',
   tracklist_row: '[data-test="tracklist-row"]',
-
+  volume: '*[data-test="volume"]',
   /**
    * Get an element from the dom
    * @param {*} key key in elements object to fetch
@@ -103,6 +104,10 @@ const elements = {
     return "";
   },
 
+  isMuted: function () {
+    return this.get("volume").getAttribute("aria-checked") === "false"; // it's muted if aria-checked is false
+  },
+
   /**
    * Shorthand function to get the text of a dom element
    * @param {*} key key in elements object to fetch
@@ -350,6 +355,8 @@ setInterval(function () {
   const progressBarTimeChanged = progressBarcurrentTime !== progressBarTime;
   const titleOrArtistChanged = currentSong !== songDashArtistTitle;
 
+  muteArtistIfFoundInMutedArtistsList();
+
   if (titleOrArtistChanged || playStatusChanged || progressBarTimeChanged || currentTimeChanged) {
     // update title, url and play info with new info
     setTitle(songDashArtistTitle);
@@ -404,6 +411,24 @@ setInterval(function () {
       () => {}
     );
   }
+
+  /**
+   * Checks whether the current artist is included in the "muted artists" list and if so it will automatically mute the player
+   */
+  function muteArtistIfFoundInMutedArtistsList() {
+    if (store.get(settings.muteArtists)) {
+      const mutedArtists = store.get(settings.mutedArtists);
+      if (mutedArtists.find((artist) => artist === artists) !== undefined) {
+        if (!elements.isMuted()) {
+          isMutedArtist = true;
+          elements.click("volume");
+        }
+      } else if (currentStatus === statuses.playing && isMutedArtist && elements.isMuted()) {
+        elements.click("volume");
+        isMutedArtist = false;
+      }
+    }
+  }
 }, 200);
 
 if (process.platform === "linux" && store.get(settings.mpris)) {

src/scripts/discord.js

@@ -32,7 +32,9 @@ const observer = (event, arg) => {
           startTimestamp: parseInt(now),
           endTimestamp: parseInt(remaining),
           largeImageKey: mediaInfoModule.mediaInfo.image,
-          largeImageText: (mediaInfoModule.mediaInfo.album) ? mediaInfoModule.mediaInfo.album : `${idleStatus.largeImageText}`,
+          largeImageText: mediaInfoModule.mediaInfo.album
+            ? mediaInfoModule.mediaInfo.album
+            : `${idleStatus.largeImageText}`,
           buttons: [{ label: "Play on Tidal", url: mediaInfoModule.mediaInfo.url }],
         },
       });
@@ -62,24 +64,32 @@ const idleStatus = {
  */
 discordModule.initRPC = function () {
   rpc = new discordrpc.Client({ transport: "ipc" });
-  rpc.login({ clientId }).catch(console.error);
-  discordModule.rpc = rpc;
+  rpc.login({ clientId }).then(
+    () => {
+      discordModule.rpc = rpc;
 
-  rpc.on("ready", () => {
-    rpc.setActivity(idleStatus);
-  });
-  ipcMain.on(globalEvents.updateInfo, observer);
+      rpc.on("ready", () => {
+        rpc.setActivity(idleStatus);
+      });
+      ipcMain.on(globalEvents.updateInfo, observer);
+    },
+    () => {
+      console.error("Can't connect to Discord, is it running?");
+    }
+  );
 };
 
 /**
  * Remove any RPC connection with discord and remove the event listener on globalEvents.updateInfo
  */
 discordModule.unRPC = function () {
-  rpc.clearActivity();
-  rpc.destroy();
-  rpc = false;
-  discordModule.rpc = rpc;
-  ipcMain.removeListener(globalEvents.updateInfo, observer);
+  if (rpc) {
+    rpc.clearActivity();
+    rpc.destroy();
+    rpc = false;
+    discordModule.rpc = undefined;
+    ipcMain.removeListener(globalEvents.updateInfo, observer);
+  }
 };
 
 module.exports = discordModule;

src/scripts/settings.js

@@ -10,12 +10,14 @@ const store = new Store({
     notifications: true,
     api: true,
     playBackControl: true,
+    muteArtists: false,
+    mutedArtists: ["Tidal"],
     menuBar: true,
     apiSettings: {
       port: 47836,
     },
     trayIcon: true,
-    minimizeOnClose : false,
+    minimizeOnClose: false,
     mpris: false,
     enableCustomHotkeys: false,
     enableDiscord: false,