Electron 15, single-instance-lock and setting to disable hardwareMediaKeyHandling (#134)

* Update to Electron 15 and add Flatpak to README (#131)

* Update functional

* Change to 15

* Replace window.hide, window.restart with counterparts

* Fix openexternal by doing default JS

* Change mouse to pointer for <a> elements

* turn mouse to pointer for exit button

* Fix deprecation of Audio for AudioVideo

* Made a small mistake

* Add Flatpak to readme

* 3.0.0 prep

* Added setting to disable multiple tidal-hifi windows (defaults to true)

fixes #121

* Added setting to disable HardwareMediaKeyHandling (defaults to false)

fixes #133

Co-authored-by: Marie <marie@kaifa.ch>
This commit is contained in:
Rick van Lieshout 2022-04-23 22:59:32 +02:00 committed by GitHub
parent 7b2afd2290
commit 79ff02d06c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 1433 additions and 1634 deletions

View File

@ -4,6 +4,13 @@ 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/), 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). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## 3.0.0
- Updated to Electron 15
- Fixed the develop "build-unpacked" command
- Added setting to disable multiple tidal-hifi windows (defaults to true)
- Added setting to disable HardwareMediaKeyHandling (defaults to false)
## 2.8.2 ## 2.8.2
- Updated dependencies - Updated dependencies

View File

@ -15,6 +15,7 @@ The web version of [listen.tidal.com](https://listen.tidal.com) running in elect
- [Using releases](#using-releases) - [Using releases](#using-releases)
- [Snap install](#snap-install) - [Snap install](#snap-install)
- [Arch Linux](#arch-linux) - [Arch Linux](#arch-linux)
- [Flatpak](#flatpak)
- [Using source](#using-source) - [Using source](#using-source)
- [features](#features) - [features](#features)
- [Integrations](#integrations) - [Integrations](#integrations)
@ -61,6 +62,14 @@ Arch Linux users can use the AUR to install tidal-hifi:
trizen tidal-hifi-bin trizen tidal-hifi-bin
``` ```
### Flatpak
To install via Flatpak run the following command:
```sh
flatpak install flathub com.mastermindzh.tidal-hifi
```
### Using source ### Using source
To install and work with the code on this project follow these steps: To install and work with the code on this project follow these steps:

View File

@ -1,3 +1,4 @@
extends: ./build/electron-builder.yml extends: ./build/electron-builder.yml
linux: linux:
target: target:
- dir

View File

@ -1,7 +1,7 @@
appId: com.rickvanlieshout.tidal-hifi appId: com.rickvanlieshout.tidal-hifi
electronVersion: 8.5.2 electronVersion: 15.5.2
electronDownload: electronDownload:
version: 8.5.2-wvvmp version: 15.5.2-wvvmp
mirror: https://github.com/castlabs/electron-releases/releases/download/v mirror: https://github.com/castlabs/electron-releases/releases/download/v
snap: snap:
plugs: plugs:
@ -27,7 +27,7 @@ linux:
StartupNotify: true StartupNotify: true
Terminal: false Terminal: false
Type: Application Type: Application
Categories: Network;Application;Audio;Video Categories: Network;Application;AudioVideo;Audio;Video
StartupWMClass: tidal-hifi StartupWMClass: tidal-hifi
X-PulseAudio-Properties: media.role=music X-PulseAudio-Properties: media.role=music
mac: mac:

2859
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "tidal-hifi", "name": "tidal-hifi",
"version": "2.8.2", "version": "3.0.0",
"description": "Tidal on Electron with widevine(hifi) support", "description": "Tidal on Electron with widevine(hifi) support",
"main": "src/main.js", "main": "src/main.js",
"scripts": { "scripts": {
@ -24,6 +24,7 @@
"homepage": "https://github.com/Mastermindzh/tidal-hifi", "homepage": "https://github.com/Mastermindzh/tidal-hifi",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@electron/remote": "^2.0.8",
"discord-rpc": "^4.0.1", "discord-rpc": "^4.0.1",
"electron-store": "^8.0.1", "electron-store": "^8.0.1",
"express": "^4.17.1", "express": "^4.17.1",
@ -33,9 +34,8 @@
}, },
"devDependencies": { "devDependencies": {
"@mastermindzh/prettier-config": "^1.0.0", "@mastermindzh/prettier-config": "^1.0.0",
"electron": "git+https://github.com/castlabs/electron-releases.git#15.5.2-wvvmp", "electron": "git+https://github.com/castlabs/electron-releases.git#v15.5.2-wvvmp",
"electron-builder": "^22.14.5", "electron-builder": "^22.14.5",
"electron-reload": "^1.5.0",
"prettier": "^2.5.0" "prettier": "^2.5.0"
}, },
"prettier": "@mastermindzh/prettier-config" "prettier": "@mastermindzh/prettier-config"

View File

@ -19,6 +19,8 @@ const settings = {
root: "apiSettings", root: "apiSettings",
port: "apiSettings.port", port: "apiSettings.port",
}, },
singleInstance: "singleInstance",
disableHardwareMediaKeys: "disableHardwareMediaKeys",
mpris: "mpris", mpris: "mpris",
enableCustomHotkeys: "enableCustomHotkeys", enableCustomHotkeys: "enableCustomHotkeys",
trayIcon: "trayIcon", trayIcon: "trayIcon",

View File

@ -1,3 +1,4 @@
require("@electron/remote/main").initialize();
const { app, BrowserWindow, globalShortcut, ipcMain } = require("electron"); const { app, BrowserWindow, globalShortcut, ipcMain } = require("electron");
const { const {
settings, settings,
@ -20,19 +21,17 @@ const globalEvents = require("./constants/globalEvents");
let mainWindow; let mainWindow;
let icon = path.join(__dirname, "../assets/icon.png"); let icon = path.join(__dirname, "../assets/icon.png");
/**
* Enable live reload in development builds
*/
if (!app.isPackaged) {
require("electron-reload")(`${__dirname}`, {
electron: require(`${__dirname}/../node_modules/electron`),
});
}
/** /**
* Fix Display Compositor issue. * Fix Display Compositor issue.
*/ */
app.commandLine.appendSwitch('disable-seccomp-filter-sandbox'); app.commandLine.appendSwitch("disable-seccomp-filter-sandbox");
/**
* Disable media keys when requested
*/
if (store.get(settings.disableHardwareMediaKeys)) {
app.commandLine.appendSwitch("disable-features", "HardwareMediaKeyHandling");
}
/** /**
* Update the menuBarVisbility according to the store value * Update the menuBarVisbility according to the store value
@ -42,6 +41,23 @@ function syncMenuBarWithStore() {
mainWindow.setMenuBarVisibility(store.get(settings.menuBar)); mainWindow.setMenuBarVisibility(store.get(settings.menuBar));
} }
/**
* Determine whether the current window is the main window
* if singleInstance is requested.
* If singleInstance isn't requested simply return true
* @returns true if singInstance is not requested, otherwise true/false based on whether the current window is the main window
*/
function isMainInstanceOrMultipleInstancesAllowed() {
if (store.get(settings.singleInstance)) {
const gotTheLock = app.requestSingleInstanceLock();
if (!gotTheLock) {
return false;
}
}
return true;
}
function createWindow(options = {}) { function createWindow(options = {}) {
// Create the browser window. // Create the browser window.
mainWindow = new BrowserWindow({ mainWindow = new BrowserWindow({
@ -50,16 +66,14 @@ function createWindow(options = {}) {
width: store && store.get(settings.windowBounds.width), width: store && store.get(settings.windowBounds.width),
height: store && store.get(settings.windowBounds.height), height: store && store.get(settings.windowBounds.height),
icon, icon,
tray: true,
backgroundColor: options.backgroundColor, backgroundColor: options.backgroundColor,
webPreferences: { webPreferences: {
affinity: "window",
preload: path.join(__dirname, "preload.js"), preload: path.join(__dirname, "preload.js"),
plugins: true, plugins: true,
devTools: true, // I like tinkering, others might too devTools: true, // I like tinkering, others might too
enableRemoteModule: true,
}, },
}); });
require("@electron/remote/main").enable(mainWindow.webContents);
syncMenuBarWithStore(); syncMenuBarWithStore();
@ -101,7 +115,7 @@ function addGlobalShortcuts() {
// initialization and is ready to create browser windows. // initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs. // Some APIs can only be used after this event occurs.
app.on("ready", () => { app.on("ready", () => {
app.allowRendererProcessReuse = true; if (isMainInstanceOrMultipleInstancesAllowed()) {
createWindow(); createWindow();
addMenu(); addMenu();
createSettingsWindow(); createSettingsWindow();
@ -110,6 +124,9 @@ app.on("ready", () => {
store.get(settings.api) && expressModule.run(mainWindow); store.get(settings.api) && expressModule.run(mainWindow);
store.get(settings.enableDiscord) && discordModule.initRPC(); store.get(settings.enableDiscord) && discordModule.initRPC();
// mainWindow.webContents.openDevTools(); // mainWindow.webContents.openDevTools();
} else {
app.quit();
}
}); });
app.on("activate", function () { app.on("activate", function () {
@ -120,23 +137,27 @@ app.on("activate", function () {
} }
}); });
app.on("browser-window-created", (_, window) => {
require("@electron/remote/main").enable(window.webContents);
});
// IPC // IPC
ipcMain.on(globalEvents.updateInfo, (event, arg) => { ipcMain.on(globalEvents.updateInfo, (_event, arg) => {
mediaInfoModule.update(arg); mediaInfoModule.update(arg);
}); });
ipcMain.on(globalEvents.hideSettings, (event, arg) => { ipcMain.on(globalEvents.hideSettings, (_event, _arg) => {
hideSettingsWindow(); hideSettingsWindow();
}); });
ipcMain.on(globalEvents.showSettings, (event, arg) => { ipcMain.on(globalEvents.showSettings, (_event, _arg) => {
showSettingsWindow(); showSettingsWindow();
}); });
ipcMain.on(globalEvents.refreshMenuBar, (event, arg) => { ipcMain.on(globalEvents.refreshMenuBar, (_event, _arg) => {
syncMenuBarWithStore(); syncMenuBarWithStore();
}); });
ipcMain.on(globalEvents.storeChanged, (event, arg) => { ipcMain.on(globalEvents.storeChanged, (_event, _arg) => {
syncMenuBarWithStore(); syncMenuBarWithStore();
if (store.get(settings.enableDiscord) && !discordModule.rpc) { if (store.get(settings.enableDiscord) && !discordModule.rpc) {
@ -146,6 +167,6 @@ ipcMain.on(globalEvents.storeChanged, (event, arg) => {
} }
}); });
ipcMain.on(globalEvents.error, (event, arg) => { ipcMain.on(globalEvents.error, (event, _arg) => {
console.log(event); console.log(event);
}); });

View File

@ -9,12 +9,15 @@ let trayIcon,
api, api,
port, port,
menuBar, menuBar,
mutedArtists; mutedArtists,
singleInstance,
disableHardwareMediaKeys;
const { store, settings } = require("./../../scripts/settings"); const { store, settings } = require("./../../scripts/settings");
const { ipcRenderer } = require("electron"); const { ipcRenderer } = require("electron");
const globalEvents = require("./../../constants/globalEvents"); const globalEvents = require("./../../constants/globalEvents");
const remote = require("@electron/remote");
const { app } = remote;
/** /**
* Sync the UI forms with the current settings * Sync the UI forms with the current settings
*/ */
@ -31,31 +34,32 @@ function refreshSettings() {
minimizeOnClose.checked = store.get(settings.minimizeOnClose); minimizeOnClose.checked = store.get(settings.minimizeOnClose);
muteArtists.checked = store.get(settings.muteArtists); muteArtists.checked = store.get(settings.muteArtists);
mutedArtists.value = store.get(settings.mutedArtists).join("\n"); mutedArtists.value = store.get(settings.mutedArtists).join("\n");
singleInstance.checked = store.get(settings.singleInstance);
disableHardwareMediaKeys.checked = store.get(settings.disableHardwareMediaKeys);
} }
/** /**
* Open an url in the default browsers * Open an url in the default browsers
*/ */
window.openExternal = function (url) { function openExternal(url) {
const { shell } = require("electron"); const { shell } = require("electron");
shell.openExternal(url); shell.openExternal(url);
}; }
/** /**
* hide the settings window * hide the settings window
*/ */
window.hide = function () { function hide() {
ipcRenderer.send(globalEvents.hideSettings); ipcRenderer.send(globalEvents.hideSettings);
}; }
/** /**
* Restart tidal-hifi after changes * Restart tidal-hifi after changes
*/ */
window.restart = function () { function restart() {
const remote = require("electron").remote; app.relaunch();
remote.app.relaunch(); app.quit();
remote.app.exit(0); }
};
/** /**
* Bind UI components to functions after DOMContentLoaded * Bind UI components to functions after DOMContentLoaded
@ -65,8 +69,16 @@ window.addEventListener("DOMContentLoaded", () => {
return document.getElementById(id); return document.getElementById(id);
} }
document.getElementById("close").addEventListener("click", hide);
document.getElementById("restart").addEventListener("click", restart);
document.querySelectorAll("#openExternal").forEach((elem) =>
elem.addEventListener("click", function (event) {
openExternal(event.target.getAttribute("data-url"));
})
);
function addInputListener(source, key) { function addInputListener(source, key) {
source.addEventListener("input", function (event, data) { source.addEventListener("input", function (_event, _data) {
if (this.value === "on") { if (this.value === "on") {
store.set(key, source.checked); store.set(key, source.checked);
} else { } else {
@ -77,7 +89,7 @@ window.addEventListener("DOMContentLoaded", () => {
} }
function addTextAreaListener(source, key) { function addTextAreaListener(source, key) {
source.addEventListener("input", function (event, data) { source.addEventListener("input", function (_event, _data) {
store.set(key, source.value.split("\n")); store.set(key, source.value.split("\n"));
ipcRenderer.send(globalEvents.storeChanged); ipcRenderer.send(globalEvents.storeChanged);
}); });
@ -103,6 +115,8 @@ window.addEventListener("DOMContentLoaded", () => {
enableDiscord = get("enableDiscord"); enableDiscord = get("enableDiscord");
muteArtists = get("muteArtists"); muteArtists = get("muteArtists");
mutedArtists = get("mutedArtists"); mutedArtists = get("mutedArtists");
singleInstance = get("singleInstance");
disableHardwareMediaKeys = get("disableHardwareMediaKeys");
refreshSettings(); refreshSettings();
@ -118,4 +132,6 @@ window.addEventListener("DOMContentLoaded", () => {
addInputListener(minimizeOnClose, settings.minimizeOnClose); addInputListener(minimizeOnClose, settings.minimizeOnClose);
addInputListener(muteArtists, settings.muteArtists); addInputListener(muteArtists, settings.muteArtists);
addTextAreaListener(mutedArtists, settings.mutedArtists); addTextAreaListener(mutedArtists, settings.mutedArtists);
addInputListener(singleInstance, settings.singleInstance);
addInputListener(disableHardwareMediaKeys, settings.disableHardwareMediaKeys);
}); });

View File

@ -11,7 +11,7 @@
<body> <body>
<div class="header"> <div class="header">
<h1 class="title">Settings</h1> <h1 class="title">Settings</h1>
<a href="javascript:hide();" class="exitWindow"> <a id="close" style="cursor: pointer;" class="exitWindow">
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="18px" height="18px" viewBox="0 0 348.333 348.334"> <svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="18px" height="18px" viewBox="0 0 348.333 348.334">
<g> <g>
@ -105,13 +105,34 @@
<div class="option"> <div class="option">
<h4>Hotkeys</h4> <h4>Hotkeys</h4>
<p> <p>
Enables extra hotkeys to achieve feature parity with the <a href = "javascript:openExternal('https://defkey.com/tidal-desktop-shortcuts')">desktop apps</a><br /> Enables extra hotkeys to achieve feature parity with the <a id="openExternal" style="text-decoration: underline; cursor: pointer;" data-url= "https://defkey.com/tidal-desktop-shortcuts">desktop apps</a><br />
</p> </p>
<label class="switch"> <label class="switch">
<input id="enableCustomHotkeys" type="checkbox"> <input id="enableCustomHotkeys" type="checkbox">
<span class="slider round"></span> <span class="slider round"></span>
</label> </label>
</div> </div>
<div class="option">
<h4>Single instance</h4>
<p>
Prevent opening multiple tidal-hifi instances
</p>
<label class="switch">
<input id="singleInstance" type="checkbox">
<span class="slider round"></span>
</label>
</div>
<div class="option">
<h4>Disable hardware media keys</h4>
<p>
Disable built-in media keys. <br />
Also prevents certain desktop environments from recognizing the chrome MPRIS client separetely from the custom MPRIS client.
</p>
<label class="switch">
<input id="disableHardwareMediaKeys" type="checkbox">
<span class="slider round"></span>
</label>
</div>
</div> </div>
</section> </section>
<section id="api" class="tab-panel"> <section id="api" class="tab-panel">
@ -179,15 +200,15 @@
<div class="section"> <div class="section">
<img alt="tidal icon" 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;"> <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 /> <a id="openExternal" style="text-decoration: underline; cursor: pointer;" data-url="https://github.com/Mastermindzh/tidal-hifi">Tidal-hifi</a> is made by <a id="openExternal" data-url="https://www.rickvanlieshout.com" style="text-decoration: underline; cursor: pointer;">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 style="text-decoration: underline; cursor: pointer;" id="openExternal" data-url="https://castlabs.com/">Castlabs'</a> versions of Electron for widevine support.
</p> </p>
</div> </div>
</section> </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> <button id="restart" style ="width: 100%">Restart Tidal-hifi</button>
</div> </div>
</div> </div>
</div> </div>

View File

@ -1,8 +1,8 @@
const { setTitle } = require("./scripts/window-functions"); const { setTitle } = require("./scripts/window-functions");
const { dialog, process, Notification } = require("electron").remote; const { dialog, process, Notification } = require('@electron/remote');
const { store, settings } = require("./scripts/settings"); const { store, settings } = require("./scripts/settings");
const { ipcRenderer } = require("electron"); const { ipcRenderer } = require("electron");
const { app } = require("electron").remote; const { app } = require('@electron/remote');
const { downloadFile } = require("./scripts/download"); const { downloadFile } = require("./scripts/download");
const statuses = require("./constants/statuses"); const statuses = require("./constants/statuses");
const hotkeys = require("./scripts/hotkeys"); const hotkeys = require("./scripts/hotkeys");

View File

@ -16,6 +16,8 @@ const store = new Store({
apiSettings: { apiSettings: {
port: 47836, port: 47836,
}, },
singleInstance: true,
disableHardwareMediaKeys: false,
trayIcon: true, trayIcon: true,
minimizeOnClose: false, minimizeOnClose: false,
mpris: false, mpris: false,
@ -39,7 +41,6 @@ settingsModule.createSettingsWindow = function () {
frame: false, frame: false,
title: "Tidal-hifi - settings", title: "Tidal-hifi - settings",
webPreferences: { webPreferences: {
affinity: "window",
preload: path.join(__dirname, "../pages/settings/preload.js"), preload: path.join(__dirname, "../pages/settings/preload.js"),
plugins: true, plugins: true,
nodeIntegration: true, nodeIntegration: true,