Merge pull request #195 from Mastermindzh/feature/4.4.0

Feature/4.4.0

CHANGELOG.md

@@ -4,13 +4,31 @@ 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).
 
+## 4.4.0
+
+- Updated shortcut hint on the menubar to reflect the new `ctrl+=` shortcut.
+- Reverted icon path to `icon.png` instead of the hardcoded linux path.
+- Add support to autoHide the menubar and showing it with the `alt` key.
+- Move the quit command from the system sub-menu to the main menu
+- Added single click focus/show on the tray icon
+  - Doesn't work on all platforms. Nothing I can do about that unfortunately!
+- Added a list of artists to automatically skip.
+  - I don't like the vast majority of dutch music so I added one of them to my list to test: [./docs/no-dutch-music.mp4](./docs/no-dutch-music.mp4)
+
+## 4.3.1
+
+- fix: App always requests a default-url-handler-scheme change on start
+
+## 4.3.0
+
+- Added a setting to disable background throttling ([docs](https://www.electronjs.org/docs/latest/api/browser-window))
+
 ## 4.2.0
 
 - New settings window by BlueManCZ
 - Fixed the desktop files in electron-builder
   - icon is set to new static path based on Arch/Debian
   - Name has changed to Tidal-Hifi
-  -
 
 ## 4.1.2
 

build/electron-builder.base.yml

@@ -18,7 +18,7 @@ linux:
     Name: TIDAL Hi-Fi
     GenericName: TIDAL Hi-Fi
     Comment: The web version of listen.tidal.com running in electron with hifi support thanks to widevine.
-    Icon: /usr/share/icons/hicolor/0x0/apps/tidal-hifi.png
+    Icon: icon.png
     StartupNotify: true
     Terminal: false
     Type: Application

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "tidal-hifi",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "tidal-hifi",
-      "version": "4.2.0",
+      "version": "4.3.1",
       "license": "MIT",
       "dependencies": {
         "@electron/remote": "^2.0.8",
@@ -4041,9 +4041,9 @@
       "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus="
     },
     "node_modules/json5": {
-      "version": "2.2.1",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz",
-      "integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==",
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
+      "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
       "dev": true,
       "bin": {
         "json5": "lib/cli.js"
@@ -9566,9 +9566,9 @@
       "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus="
     },
     "json5": {
-      "version": "2.2.1",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz",
-      "integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==",
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
+      "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
       "dev": true
     },
     "jsonfile": {

package.json

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

src/constants/settings.js

@@ -15,6 +15,9 @@ const settings = {
   playBackControl: "playBackControl",
   muteArtists: "muteArtists",
   mutedArtists: "mutedArtists",
+  skipArtists: "skipArtists",
+  skippedArtists: "skippedArtists",
+  disableBackgroundThrottle: "disableBackgroundThrottle",
   apiSettings: {
     root: "apiSettings",
     port: "apiSettings.port",

src/main.js

@@ -49,7 +49,10 @@ function setFlags() {
  *
  */
 function syncMenuBarWithStore() {
-  mainWindow.setMenuBarVisibility(store.get(settings.menuBar));
+  const fixedMenuBar = store.get(settings.menuBar);
+
+  mainWindow.autoHideMenuBar = !fixedMenuBar;
+  mainWindow.setMenuBarVisibility(fixedMenuBar);
 }
 
 /**
@@ -78,6 +81,7 @@ function createWindow(options = {}) {
     height: store && store.get(settings.windowBounds.height),
     icon,
     backgroundColor: options.backgroundColor,
+    autoHideMenuBar: true,
     webPreferences: {
       preload: path.join(__dirname, "preload.js"),
       plugins: true,
@@ -91,6 +95,11 @@ function createWindow(options = {}) {
   // load the Tidal website
   mainWindow.loadURL(tidalUrl);
 
+  if (store.get(settings.disableBackgroundThrottle)) {
+    // prevent setInterval lag
+    mainWindow.webContents.setBackgroundThrottling(false);
+  }
+
   // run stuff after first load
   mainWindow.webContents.once("did-finish-load", () => {});
 
@@ -118,7 +127,9 @@ function registerHttpProtocols() {
   protocol.registerHttpProtocol(PROTOCOL_PREFIX, (request, _callback) => {
     mainWindow.loadURL(`${tidalUrl}/${request.url.substring(PROTOCOL_PREFIX.length + 3)}`);
   });
-  app.setAsDefaultProtocolClient(PROTOCOL_PREFIX);
+  if (!app.isDefaultProtocolClient(PROTOCOL_PREFIX)) {
+    app.setAsDefaultProtocolClient(PROTOCOL_PREFIX);
+  }
 }
 
 function addGlobalShortcuts() {

src/pages/settings/preload.js

@@ -4,12 +4,15 @@ let trayIcon,
   enableCustomHotkeys,
   enableDiscord,
   muteArtists,
+  skipArtists,
   notifications,
   playBackControl,
   api,
   port,
   menuBar,
   mutedArtists,
+  skippedArtists,
+  disableBackgroundThrottle,
   singleInstance,
   disableHardwareMediaKeys,
   gpuRasterization;
@@ -35,9 +38,12 @@ function refreshSettings() {
   minimizeOnClose.checked = store.get(settings.minimizeOnClose);
   muteArtists.checked = store.get(settings.muteArtists);
   mutedArtists.value = store.get(settings.mutedArtists).join("\n");
+  skipArtists.checked = store.get(settings.skipArtists);
+  skippedArtists.value = store.get(settings.skippedArtists).join("\n");
   singleInstance.checked = store.get(settings.singleInstance);
   disableHardwareMediaKeys.checked = store.get(settings.flags.disableHardwareMediaKeys);
   gpuRasterization.checked = store.get(settings.flags.gpuRasterization);
+  disableBackgroundThrottle.checked = store.get("disableBackgroundThrottle");
 }
 
 /**
@@ -117,6 +123,9 @@ window.addEventListener("DOMContentLoaded", () => {
   enableDiscord = get("enableDiscord");
   muteArtists = get("muteArtists");
   mutedArtists = get("mutedArtists");
+  skipArtists = get("skipArtists");
+  skippedArtists = get("skippedArtists");
+  disableBackgroundThrottle = get("disableBackgroundThrottle");
   singleInstance = get("singleInstance");
   disableHardwareMediaKeys = get("disableHardwareMediaKeys");
   gpuRasterization = get("gpuRasterization");
@@ -135,6 +144,9 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(minimizeOnClose, settings.minimizeOnClose);
   addInputListener(muteArtists, settings.muteArtists);
   addTextAreaListener(mutedArtists, settings.mutedArtists);
+  addInputListener(skipArtists, settings.skipArtists);
+  addTextAreaListener(skippedArtists, settings.skippedArtists);
+  addInputListener(disableBackgroundThrottle, settings.disableBackgroundThrottle);
   addInputListener(singleInstance, settings.singleInstance);
   addInputListener(disableHardwareMediaKeys, settings.flags.disableHardwareMediaKeys);
   addInputListener(gpuRasterization, settings.flags.gpuRasterization);

src/pages/settings/settings.html

@@ -63,13 +63,25 @@
               </label>
             </div>
             <textarea id="mutedArtists" class="textarea" cols="40" rows="5" spellcheck="false"></textarea>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Skip Artists automatically</h4>
+                <p>The following list of artists (1 per line) will be skipped automatically.</p>
+              </div>
+              <label class="switch">
+                <input id="skipArtists" type="checkbox">
+                <span class="switch__slider"></span>
+              </label>
+            </div>
+            <textarea id="skippedArtists" class="textarea" cols="40" rows="5" spellcheck="false"></textarea>
+
           </div>
           <div class="group">
             <p class="group__title">UI</p>
             <div class="group__option">
               <div class="group__description">
-                <h4>Menubar</h4>
-                <p>Show TIDAL Hi-Fi's menu bar.</p>
+                <h4>Fixed menubar</h4>
+                <p>Always show TIDAL Hi-Fi's menu bar.</p>
               </div>
               <label class="switch">
                 <input id="menuBar" type="checkbox">
@@ -222,6 +234,16 @@
                 <span class="switch__slider"></span>
               </label>
             </div>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Disable Background Throttling</h4>
+                <p>Makes app more responsive while in the background, at the cost of performance.</p>
+              </div>
+              <label class="switch">
+                <input id="disableBackgroundThrottle" type="checkbox">
+                <span class="switch__slider"></span>
+              </label>
+            </div>
           </div>
         </section>
 

src/preload.js

@@ -7,6 +7,7 @@ const { downloadFile } = require("./scripts/download");
 const statuses = require("./constants/statuses");
 const hotkeys = require("./scripts/hotkeys");
 const globalEvents = require("./constants/globalEvents");
+const { skipArtists } = require("./constants/settings");
 const notificationPath = `${app.getPath("userData")}/notification.jpg`;
 const appName = "Tidal Hifi";
 let currentSong = "";
@@ -327,8 +328,9 @@ function getTrackURL() {
 setInterval(function () {
   const title = elements.getText("title");
   const artists = elements.getArtists();
-  muteArtistIfFoundInMutedArtistsList(); // doing this here so that nothing can possibly fail before we call this function
-  
+  skipArtistsIfFoundInSkippedArtistsList(artists);
+  muteArtistIfFoundInMutedArtistsList(artists); // doing this here so that nothing can possibly fail before we call this function
+
   const album = elements.getAlbumName();
   const current = elements.getText("current");
   const duration = elements.getText("duration");
@@ -344,12 +346,9 @@ setInterval(function () {
     duration,
     "app-name": appName,
   };
-  
-
 
   const titleOrArtistChanged = currentSong !== songDashArtistTitle;
 
-
   // update title, url and play info with new info
   setTitle(songDashArtistTitle);
   getTrackURL();
@@ -385,7 +384,7 @@ 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() {
+  function muteArtistIfFoundInMutedArtistsList(artists) {
     if (store.get(settings.muteArtists)) {
       const mutedArtists = store.get(settings.mutedArtists);
       if (mutedArtists.find((artist) => artist === artists) !== undefined) {
@@ -399,6 +398,19 @@ setInterval(function () {
       }
     }
   }
+
+  /**
+   * automatically skip a song if the artists are found in the list of artists to skip
+   * @param {*} artists list of artists to skip
+   */
+  function skipArtistsIfFoundInSkippedArtistsList(artists) {
+    if (store.get(skipArtists)) {
+      const skippedArtists = store.get(settings.skippedArtists);
+      if (skippedArtists.find((artist) => artist === artists) !== undefined) {
+        elements.click("next");
+      }
+    }
+  }
 }, 1000);
 
 if (process.platform === "linux" && store.get(settings.mpris)) {

src/scripts/menu.js

@@ -8,7 +8,7 @@ const settingsMenuEntry = {
   click() {
     showSettingsWindow();
   },
-  accelerator: "Control+/",
+  accelerator: "Control+=",
 };
 
 const quitMenuEntry = {
@@ -110,6 +110,7 @@ menuModule.getMenu = function (mainWindow) {
       },
     },
     toggleWindow,
+    quitMenuEntry,
   ];
 
   return Menu.buildFromTemplate(mainMenu);

src/scripts/settings.js

@@ -12,6 +12,9 @@ const store = new Store({
     playBackControl: true,
     muteArtists: false,
     mutedArtists: ["TIDAL"],
+    skipArtists: false,
+    skippedArtists: [""],
+    disableBackgroundThrottle: true,
     menuBar: true,
     apiSettings: {
       port: 47836,

src/scripts/tray.js

@@ -11,6 +11,10 @@ trayModule.addTray = function (mainWindow, options = { icon: "" }) {
   const menu = getMenu(mainWindow);
 
   tray.setContextMenu(menu);
+
+  tray.on("click", function () {
+    mainWindow.isVisible() ? mainWindow.focus() : mainWindow.show();
+  });
 };
 
 trayModule.refreshTray = function (mainWindow) {