update labels

This reverts commit b0a8815bb8.

.gitignore

@@ -1 +1,2 @@
 /build
+.vscode

CMakeLists.txt

@@ -1,11 +1,16 @@
 cmake_minimum_required(VERSION 3.0)
 project(discord-screenaudio)
 
+include(version.cmake)
+determine_version("${CMAKE_CURRENT_SOURCE_DIR}" DISCORD_SCEENAUDIO)
+add_definitions( -DDISCORD_SCEENAUDIO_VERSION_FULL="${DISCORD_SCEENAUDIO_VERSION_FULL}" )
+
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTORCC ON)
 set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DDEBUG")
+string(TIMESTAMP TIMESTAMP %s)
 # set(CMAKE_AUTOUIC ON)
 
 find_package(Qt5 CONFIG REQUIRED COMPONENTS 
@@ -13,12 +18,28 @@ find_package(Qt5 CONFIG REQUIRED COMPONENTS
   WebEngineWidgets
 )
 
+find_package(KF5Notifications)
+if(KF5Notifications_FOUND)
+  add_definitions( -DKNOTIFICATIONS )
+endif()
+
+find_package(KF5XmlGui)
+if(KF5XmlGui_FOUND)
+  add_definitions( -DKXMLGUI )
+endif()
+
+find_package(KF5GlobalAccel)
+if(KF5GlobalAccel_FOUND)
+  add_definitions( -DKGLOBALACCEL )
+endif()
+
 set(discord-screenaudio_SRC
   src/main.cpp
   src/mainwindow.cpp
   src/virtmic.cpp
   src/discordpage.cpp
   src/streamdialog.cpp
+  src/log.cpp
   resources.qrc
 )
 
@@ -47,7 +68,19 @@ add_executable(discord-screenaudio ${discord-screenaudio_SRC})
 
 target_link_libraries(discord-screenaudio Qt5::Widgets Qt5::WebEngineWidgets rohrkabel)
 
+if(KF5Notifications_FOUND)
+  target_link_libraries(discord-screenaudio KF5::Notifications)
+  install(FILES assets/discord-screenaudio.notifyrc DESTINATION ${CMAKE_INSTALL_PREFIX}/share/knotifications5)
+endif()
+if(KF5XmlGui_FOUND)
+  target_link_libraries(discord-screenaudio KF5::XmlGui)
+endif()
+if(KF5GlobalAccel_FOUND)
+  target_link_libraries(discord-screenaudio KF5::GlobalAccel)
+endif()
+
 install(TARGETS discord-screenaudio DESTINATION bin)
-install(PROGRAMS assets/discord.png DESTINATION ${CMAKE_INSTALL_PREFIX}/share/pixmaps)
-install(PROGRAMS assets/discord-screenaudio.desktop DESTINATION ${CMAKE_INSTALL_PREFIX}/share/applications)
-install(PROGRAMS assets/de.shorsh.discord-screenaudio.metainfo.xml DESTINATION ${CMAKE_INSTALL_PREFIX}/share/metainfo)
+install(FILES assets/de.shorsh.discord-screenaudio.png DESTINATION ${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/256x256/apps)
+install(PROGRAMS assets/de.shorsh.discord-screenaudio.desktop DESTINATION ${CMAKE_INSTALL_PREFIX}/share/applications)
+configure_file(assets/de.shorsh.discord-screenaudio.metainfo.xml.in de.shorsh.discord-screenaudio.metainfo.xml)
+install(FILES ${CMAKE_BINARY_DIR}/de.shorsh.discord-screenaudio.metainfo.xml DESTINATION ${CMAKE_INSTALL_PREFIX}/share/metainfo)

README.md

@@ -1,13 +1,17 @@
 # discord-screenaudio
 
-A very WIP custom discord client that supports streaming with audio on Linux,
-made possible by the
+A custom discord client that supports streaming with audio on Linux, made
+possible by the
 [great work](https://github.com/edisionnano/Screenshare-with-audio-on-Discord-with-Linux)
 of [@edisionnano](https://github.com/edisionnano) and the
 [Rohrkabel library](https://github.com/Soundux/rohrkabel) by
 [@Curve](https://github.com/Curve).
 
-![Screenshot_20220718_194357](https://user-images.githubusercontent.com/48161361/179571245-11ea05f3-fb5e-4aef-9132-2736e122ef04.png)
+Unlike a lot of other solutions, the audio here is directly fed into the
+screenshare and not passed to the user microphone
+([see explanation](#how-it-works)).
+
+![Screenshot_20220925_112945](https://user-images.githubusercontent.com/48161361/192137080-33466cf7-8c56-4373-90c6-01ea74b6fb83.png)
 
 The purpose of this project is **not** to provide an alternative to the original
 Discord client. Rather, it should be used in addition to the original client in
@@ -15,18 +19,31 @@ case you want to stream something, maybe used with a second account. For
 anything else, this client has way too many things that work less well than in
 the original client.
 
+Technically this could be against
+[Discord's TOS](https://discord.com/terms#software-in-discord%E2%80%99s-services),
+so be warned. Discord probably won't ban you for using this, but if they do I
+told you and it's not my fault.
+
 ## Known Issues
 
 - Only works with **PipeWire**
-- Only works on **X11**
-- Can only share primary screen (no other screens or specific applications) (see
+- Can only share primary screen on X11 (no other screens or specific
+  applications) (see
   [#1](https://github.com/maltejur/discord-screenaudio/issues/1))
 
 ## Installation
 
-If you are using Arch, you can build and install
-[from the AUR](https://aur.archlinux.org/packages/discord-screenaudio). If you
-aren't, you will have to [build it yourself](#building-from-source).
+You have multiple options:
+
+- Install the Flatpak (recommended):
+  `flatpak install de.shorsh.discord-screenaudio`
+- If you are on Arch, you can build and install
+  [`discord-screenaudio`](https://aur.archlinux.org/packages/discord-screenaudio)
+  from the AUR
+- If you are on openSUSE, you can use the
+  [Open Build Service package](https://software.opensuse.org//download.html?project=games%3Atools&package=discord-screenaudio)
+  by [@VortexAcherontic](https://github.com/VortexAcherontic)
+- You can [build it yourself](#building-from-source)
 
 ## Building from Source
 
@@ -37,9 +54,11 @@ aren't, you will have to [build it yourself](#building-from-source).
 - Qt5 and QtWebEngine
 - **PipeWire** (it currently doesn't work with PulseAudio)
 - Git
+- _Kf5Notifications (optional, for better notifications)_
+- _KXMLGui and KGlobalAccel (optional, for keybinds)_
 
 On Debian:
-`apt install -y build-essential cmake qtbase5-dev qtwebengine5-dev pkg-config libpipewire-0.3-dev git`
+`apt install -y build-essential cmake qtbase5-dev qtwebengine5-dev libkf5notifications-dev libkf5xmlgui-dev libkf5globalaccel-dev pkg-config libpipewire-0.3-dev git`
 
 ### Building
 

assets/de.shorsh.discord-screenaudio.desktop

@@ -0,0 +1,8 @@
+[Desktop Entry]
+Type=Application
+Name=discord-screenaudio
+Exec=discord-screenaudio
+Comment=A custom discord client that supports streaming with audio on Linux.
+Icon=de.shorsh.discord-screenaudio
+Categories=Network;InstantMessaging;
+Terminal=false

assets/de.shorsh.discord-screenaudio.metainfo.xml

@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<component type="desktop-application">
-  <id>de.shorsh.discord-screenaudio</id>
-  <metadata_license>CC0-1.0</metadata_license>
-  <project_license>GPL-3.0+</project_license>
-  <name>discord-screenaudio</name>
-  <releases>
-    <release version="v1.0.0-rc.9" />
-  </releases>
-
-  <summary>
-    A very WIP custom discord client that supports streaming with audio on
-    Linux.
-  </summary>
-
-  <description>
-    <p>A very WIP custom discord client that supports streaming with audio on Linux, made possible by the great work of @edisionnano and the Rohrkabel library by @Curve.</p>
-    <p>The purpose of this project is not to provide an alternative to the original Discord client. Rather, it should be used in addition to the original client in case you want to stream something, maybe used with a second account. For anything else, this client has way too many things that work less well than in the original client.</p>
-  </description>
-
-  <launchable type="desktop-id">
-    discord-screenaudio.desktop
-  </launchable>
-
-  <screenshots>
-    <screenshot type="default">
-      <image>
-        https://user-images.githubusercontent.com/48161361/179571245-11ea05f3-fb5e-4aef-9132-2736e122ef04.png
-      </image>
-    </screenshot>
-  </screenshots>
-
-  <url type="homepage">https://github.com/maltejur/discord-screenaudio</url>
-
-  <provides>
-    <binary>discord-screenaudio</binary>
-  </provides>
-</component>

assets/de.shorsh.discord-screenaudio.metainfo.xml.in

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component type="desktop-application">
+  <id>de.shorsh.discord-screenaudio</id>
+  <metadata_license>CC0-1.0</metadata_license>
+  <project_license>GPL-3.0+</project_license>
+  <name>discord-screenaudio</name>
+  <developer_name>Malte Jürgens</developer_name>
+  <releases>
+    <release version="${DISCORD_SCEENAUDIO_VERSION_FULL}" timestamp="${TIMESTAMP}" />
+  </releases>
+
+  <summary>A custom discord client that supports streaming with audio on Linux</summary>
+
+  <description>
+    <p>A custom discord client that supports streaming with audio on Linux, made possible by the great work of @edisionnano and the Rohrkabel library by @Curve.</p>
+    <p>Unlike a lot of other solutions, the audio here is directly fed into the screenshare and not passed to the user microphone.</p>
+    <p>The purpose of this project is not to provide an alternative to the original Discord client. Rather, it should be used in addition to the original client in case you want to stream something, maybe used with a second account. For anything else, this client has way too many things that work less well than in the original client.</p>
+    <p>Technically this could be against Discord's TOS, so be warned. Discord probably won't ban you for using this, but if they do I told you and it's not my fault.</p>
+    <p>Known issues:</p>
+    <ul>
+      <li>Only works with PipeWire</li>
+      <li>Can only share primary screen on X11</li>
+    </ul>
+  </description>
+
+  <launchable type="desktop-id">
+    de.shorsh.discord-screenaudio.desktop
+  </launchable>
+
+  <screenshots>
+    <screenshot type="default">
+      <image>
+        https://user-images.githubusercontent.com/48161361/192137080-33466cf7-8c56-4373-90c6-01ea74b6fb83.png
+      </image>
+    </screenshot>
+  </screenshots>
+
+  <url type="homepage">https://github.com/maltejur/discord-screenaudio</url>
+
+  <provides>
+    <binary>discord-screenaudio</binary>
+  </provides>
+
+  <content_rating type="oars-1.0">
+    <content_attribute id="social-chat">intense</content_attribute>
+    <content_attribute id="social-info">intense</content_attribute>
+    <content_attribute id="social-audio">intense</content_attribute>
+    <content_attribute id="social-contacts">intense</content_attribute>
+    <content_attribute id="money-purchasing">mild</content_attribute>
+  </content_rating>
+</component>

assets/discord-screenaudio.desktop

@@ -1,6 +0,0 @@
-[Desktop Entry]
-Type=Application
-Name=discord-screenaudio
-Exec=discord-screenaudio
-Icon=discord
-Terminal=false

assets/discord-screenaudio.notifyrc

@@ -0,0 +1,8 @@
+[Global]
+IconName=de.shorsh.discord-screenaudio
+Name=discord-screenaudio
+DesktopEntry=de.shorsh.discord-screenaudio.desktop
+
+[Event/discordNotification]
+Name=Discord Notification
+Action=Popup

assets/userscript.js

@@ -3,16 +3,29 @@
 navigator.mediaDevices.chromiumGetDisplayMedia =
   navigator.mediaDevices.getDisplayMedia;
 
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
 const getAudioDevice = async (nameOfAudioDevice) => {
   await navigator.mediaDevices.getUserMedia({
     audio: true,
   });
-  let devices = await navigator.mediaDevices.enumerateDevices();
-  let audioDevice = devices.find(({ label }) => label === nameOfAudioDevice);
+  let audioDevice;
+  while (audioDevice === undefined) {
+    let devices = await navigator.mediaDevices.enumerateDevices();
+    audioDevice = devices.find(({ label }) => label === nameOfAudioDevice);
+    if (!audioDevice)
+      console.log(
+        `dsa: Did not find '${nameOfAudioDevice}', trying again in 100ms`
+      );
+    await sleep(100);
+  }
+  console.log(`dsa: Found '${nameOfAudioDevice}'`);
   return audioDevice;
 };
 
-function setGetDisplayMedia(overrideArgs = undefined) {
+function setGetDisplayMedia(video = true, overrideArgs = undefined) {
   const getDisplayMedia = async (...args) => {
     var id;
     try {
@@ -50,6 +63,7 @@ function setGetDisplayMedia(overrideArgs = undefined) {
         : args || [{ video: true, audio: true }])
     );
     gdm.addTrack(track);
+    if (!video) for (const track of gdm.getVideoTracks()) track.enabled = false;
     return gdm;
   };
   navigator.mediaDevices.getDisplayMedia = getDisplayMedia;
@@ -98,8 +112,16 @@ setInterval(() => {
 
       const initialDisplay = el.style.display;
 
-      window.discordScreenaudioStartStream = (width, height, frameRate) => {
-        setGetDisplayMedia({
+      window.discordScreenaudioStartStream = (
+        video,
+        width,
+        height,
+        frameRate
+      ) => {
+        window.discordScreenaudioResolutionString = video
+          ? `${height}p ${frameRate}FPS`
+          : "Audio Only";
+        setGetDisplayMedia(video, {
           audio: true,
           video: { width, height, frameRate },
         });
@@ -121,11 +143,21 @@ setInterval(() => {
     document.getElementsByClassName("dirscordScreenaudioAboutText").length == 0
   ) {
     for (const el of document.getElementsByClassName("info-3pQQBb")) {
-      const aboutEl = document.createElement("div");
-      aboutEl.innerText = "discord-screenaudio v1.0.0-rc.9";
+      let aboutEl;
+      if (window.discordScreenaudioKXMLGUI) {
+        aboutEl = document.createElement("a");
+        aboutEl.addEventListener("click", () => {
+          console.log("!discord-screenaudio-about");
+        });
+      } else {
+        aboutEl = document.createElement("div");
+      }
+      aboutEl.innerText = `discord-screenaudio ${window.discordScreenaudioVersion}`;
       aboutEl.style.fontSize = "12px";
       aboutEl.style.color = "var(--text-muted)";
+      aboutEl.style.textTransform = "none";
       aboutEl.classList.add("dirscordScreenaudioAboutText");
+      aboutEl.style.cursor = "pointer";
       el.appendChild(aboutEl);
     }
   }
@@ -133,6 +165,62 @@ setInterval(() => {
   // Remove stream settings if stream is active
   document.getElementById("manage-streams-change-windows")?.remove();
   document.querySelector(`[aria-label="Stream Settings"]`)?.remove();
+
+  // Add event listener for keybind tab
+  if (
+    document
+      .getElementById("keybinds-tab")
+      ?.getElementsByClassName(
+        "container-3jbRo5 info-1hMolH fontSize16-3zr6Io browserNotice-1u-Y5o"
+      ).length
+  ) {
+    const el = document
+      .getElementById("keybinds-tab")
+      .getElementsByClassName("children-1xdcWE")[0];
+    const div = document.createElement("div");
+    div.style.marginBottom = "50px";
+    const button = document.createElement("button");
+    button.classList =
+      "button-f2h6uQ lookFilled-yCfaCM colorBrand-I6CyqQ sizeSmall-wU2dO- grow-2sR_-F";
+    button.innerText = "Edit Global Keybinds";
+    button.addEventListener("click", () => {
+      console.log("!discord-screenaudio-keybinds");
+    });
+    div.appendChild(button);
+    el.innerHTML = "";
+    el.appendChild(div);
+  }
+
+  const buttonContainer =
+    document.getElementsByClassName("container-YkUktl")[0];
+  if (!buttonContainer) {
+    console.log(
+      "dsa: Cannot locate Mute/Deafen/Settings button container, please report this on GitHub"
+    );
+  }
+
+  const muteBtn = buttonContainer
+    ? buttonContainer.getElementsByClassName(
+        "button-12Fmur enabled-9OeuTA button-f2h6uQ lookBlank-21BCro colorBrand-I6CyqQ grow-2sR_-F"
+      )[0]
+    : null;
+  window.discordScreenaudioToggleMute = () => muteBtn && muteBtn.click();
+
+  const deafenBtn = buttonContainer
+    ? buttonContainer.getElementsByClassName(
+        "button-12Fmur enabled-9OeuTA button-f2h6uQ lookBlank-21BCro colorBrand-I6CyqQ grow-2sR_-F"
+      )[1]
+    : null;
+
+  window.discordScreenaudioToggleDeafen = () => deafenBtn && deafenBtn.click();
+
+  if (window.discordScreenaudioResolutionString) {
+    for (const el of document.getElementsByClassName(
+      "qualityIndicator-39wQDy"
+    )) {
+      el.innerHTML = window.discordScreenaudioResolutionString;
+    }
+  }
 }, 500);
 
 // Fix for broken discord notifications after restart

resources.qrc

@@ -2,5 +2,6 @@
 <RCC>
   <qresource>
     <file>assets/userscript.js</file>
+    <file>assets/de.shorsh.discord-screenaudio.png</file>
   </qresource>
 </RCC>

src/discordpage.cpp

@@ -1,9 +1,26 @@
 #include "discordpage.h"
+#include "log.h"
+#include "mainwindow.h"
 #include "virtmic.h"
 
+#ifdef KXMLGUI
+#include <KAboutData>
+#include <KHelpMenu>
+#include <KShortcutsDialog>
+#include <KXmlGuiWindow>
+#include <QAction>
+
+#ifdef KGLOBALACCEL
+#include <KGlobalAccel>
+#endif
+
+#endif
+
 #include <QApplication>
 #include <QDesktopServices>
 #include <QFile>
+#include <QMessageBox>
+#include <QNetworkReply>
 #include <QTimer>
 #include <QWebChannel>
 #include <QWebEngineScript>
@@ -17,6 +34,11 @@ DiscordPage::DiscordPage(QWidget *parent) : QWebEnginePage(parent) {
   connect(this, &QWebEnginePage::featurePermissionRequested, this,
           &DiscordPage::featurePermissionRequested);
 
+  connect(this, &QWebEnginePage::loadStarted, [=]() {
+    runJavaScript(QString("window.discordScreenaudioVersion = '%1';")
+                      .arg(QApplication::applicationVersion()));
+  });
+
   settings()->setAttribute(QWebEngineSettings::ScreenCaptureEnabled, true);
   settings()->setAttribute(QWebEngineSettings::JavascriptCanOpenWindows, true);
   settings()->setAttribute(QWebEngineSettings::AllowRunningInsecureContent,
@@ -27,35 +49,93 @@ DiscordPage::DiscordPage(QWidget *parent) : QWebEnginePage(parent) {
   settings()->setAttribute(QWebEngineSettings::PlaybackRequiresUserGesture,
                            false);
   settings()->setAttribute(QWebEngineSettings::JavascriptCanOpenWindows, false);
+  settings()->setAttribute(QWebEngineSettings::ScrollAnimatorEnabled, true);
 
   setUrl(QUrl("https://discord.com/app"));
 
-  injectScript(":/assets/userscript.js");
+  injectScriptFile("userscript.js", ":/assets/userscript.js");
+
+  injectScriptText("version.js",
+                   QString("window.discordScreenaudioVersion = '%1';")
+                       .arg(QApplication::applicationVersion()));
+
+#ifdef KXMLGUI
+  injectScriptText("xmlgui.js", "window.discordScreenaudioKXMLGUI = true;");
+
+  KAboutData aboutData(
+      "discord-screenaudio", "discord-screenaudio",
+      QApplication::applicationVersion(),
+      "Custom Discord client with the ability to stream audio on Linux",
+      KAboutLicense::GPL_V3, "Copyright 2022 (C) Malte Jürgens");
+  aboutData.setBugAddress("https://github.com/maltejur/discord-screenaudio");
+  aboutData.addAuthor("Malte Jürgens", "Author", "maltejur@dismail.de",
+                      "https://github.com/maltejur");
+  aboutData.addCredit("edisionnano",
+                      "For creating and documenting the approach for streaming "
+                      "audio in Discord used in this project.",
+                      QString(),
+                      "https://github.com/edisionnano/"
+                      "Screenshare-with-audio-on-Discord-with-Linux");
+  aboutData.addCredit(
+      "Curve", "For creating the Rohrkabel library used in this project.",
+      QString(), "https://github.com/Curve");
+  aboutData.addComponent("Rohrkabel", "A C++ RAII Pipewire-API Wrapper", "1.3",
+                         "https://github.com/Soundux/rohrkabel");
+  m_helpMenu = new KHelpMenu(parent, aboutData);
+
+#ifdef KGLOBALACCEL
+  injectScriptText("kglobalaccel.js",
+                   "window.discordScreenaudioKGLOBALACCEL = true;");
+
+  auto toggleMuteAction = new QAction(this);
+  toggleMuteAction->setText("Toggle Mute");
+  toggleMuteAction->setIcon(QIcon::fromTheme("microphone-sensitivity-muted"));
+  connect(toggleMuteAction, &QAction::triggered, this,
+          &DiscordPage::toggleMute);
+
+  auto toggleDeafenAction = new QAction(this);
+  toggleDeafenAction->setText("Toggle Deafen");
+  toggleDeafenAction->setIcon(QIcon::fromTheme("audio-volume-muted"));
+  connect(toggleDeafenAction, &QAction::triggered, this,
+          &DiscordPage::toggleDeafen);
+
+  m_actionCollection = new KActionCollection(this);
+  m_actionCollection->addAction("toggleMute", toggleMuteAction);
+  KGlobalAccel::setGlobalShortcut(toggleMuteAction, QList<QKeySequence>{});
+  m_actionCollection->addAction("toggleDeafen", toggleDeafenAction);
+  KGlobalAccel::setGlobalShortcut(toggleDeafenAction, QList<QKeySequence>{});
+
+  m_shortcutsDialog = new KShortcutsDialog(KShortcutsEditor::GlobalAction);
+  m_shortcutsDialog->addCollection(m_actionCollection);
+#endif
+#endif
 
   connect(&m_streamDialog, &StreamDialog::requestedStreamStart, this,
           &DiscordPage::startStream);
 }
 
-void DiscordPage::injectScript(QString source) {
-  qDebug() << "[main   ] Injecting " << source;
+void DiscordPage::injectScriptText(QString name, QString content) {
+  qDebug(mainLog) << "Injecting " << name;
 
-  QFile userscript(source);
+  QWebEngineScript script;
 
-  if (!userscript.open(QIODevice::ReadOnly)) {
+  script.setSourceCode(content);
+  script.setName(name);
+  script.setWorldId(QWebEngineScript::MainWorld);
+  script.setInjectionPoint(QWebEngineScript::DocumentCreation);
+  script.setRunsOnSubFrames(false);
+
+  scripts().insert(script);
+}
+
+void DiscordPage::injectScriptFile(QString name, QString source) {
+  QFile file(source);
+
+  if (!file.open(QIODevice::ReadOnly)) {
     qFatal("Failed to load %s with error: %s", source.toLatin1().constData(),
-           userscript.errorString().toLatin1().constData());
+           file.errorString().toLatin1().constData());
   } else {
-    QByteArray userscriptJs = userscript.readAll();
-
-    QWebEngineScript script;
-
-    script.setSourceCode(userscriptJs);
-    script.setName("userscript.js");
-    script.setWorldId(QWebEngineScript::MainWorld);
-    script.setInjectionPoint(QWebEngineScript::DocumentCreation);
-    script.setRunsOnSubFrames(false);
-
-    scripts().insert(script);
+    injectScriptText(name, file.readAll());
   }
 }
 
@@ -67,8 +147,8 @@ void DiscordPage::featurePermissionRequested(const QUrl &securityOrigin,
 
   if (feature == QWebEnginePage::Feature::MediaAudioCapture) {
     if (m_virtmicProcess.state() == QProcess::NotRunning) {
-      qDebug() << "[virtmic] Starting Virtmic with no target to make sure "
-                  "Discord can find all the audio devices";
+      qDebug(virtmicLog) << "Starting Virtmic with no target to make sure "
+                            "Discord can find all the audio devices";
       m_virtmicProcess.start(QApplication::arguments()[0],
                              {"--virtmic", "None"});
     }
@@ -78,7 +158,6 @@ void DiscordPage::featurePermissionRequested(const QUrl &securityOrigin,
 bool DiscordPage::acceptNavigationRequest(const QUrl &url,
                                           QWebEnginePage::NavigationType type,
                                           bool isMainFrame) {
-  qDebug() << url;
   if (type == QWebEnginePage::NavigationTypeLinkClicked) {
     QDesktopServices::openUrl(url);
     return false;
@@ -100,17 +179,15 @@ QWebEnginePage *DiscordPage::createWindow(QWebEnginePage::WebWindowType type) {
 
 void DiscordPage::stopVirtmic() {
   if (m_virtmicProcess.state() == QProcess::Running) {
-    qDebug() << "[virtmic] Stopping Virtmic";
+    qDebug(virtmicLog) << "Stopping Virtmic";
     m_virtmicProcess.kill();
     m_virtmicProcess.waitForFinished();
   }
 }
 
 void DiscordPage::startVirtmic(QString target) {
-  if (target != "None") {
-    qDebug() << "[virtmic] Starting Virtmic with target" << target;
-    m_virtmicProcess.start(QApplication::arguments()[0], {"--virtmic", target});
-  }
+  qDebug(virtmicLog) << "Starting Virtmic with target" << target;
+  m_virtmicProcess.start(QApplication::arguments()[0], {"--virtmic", target});
 }
 
 void DiscordPage::javaScriptConsoleMessage(
@@ -124,20 +201,54 @@ void DiscordPage::javaScriptConsoleMessage(
     m_streamDialog.updateTargets();
   } else if (message == "!discord-screenaudio-stream-stopped") {
     stopVirtmic();
+  } else if (message == "!discord-screenaudio-about") {
+#ifdef KXMLGUI
+    m_helpMenu->aboutApplication();
+#endif
+  } else if (message == "!discord-screenaudio-keybinds") {
+#ifdef KXMLGUI
+#ifdef KGLOBALACCEL
+    m_shortcutsDialog->show();
+#else
+    QMessageBox::information(MainWindow::instance(), "discord-screenaudio",
+                             "Keybinds are not supported on this platform "
+                             "(KGlobalAccel is not available).",
+                             QMessageBox::Ok);
+#endif
+#else
+    QMessageBox::information(MainWindow::instance(), "discord-screenaudio",
+                             "Keybinds are not supported on this platform "
+                             "(KXmlGui and KGlobalAccel are not available).",
+                             QMessageBox::Ok);
+#endif
+  } else if (message.startsWith("dsa: ")) {
+    qDebug(userscriptLog) << message.mid(5).toUtf8().constData();
   } else {
-    qDebug() << "[discord]" << message;
+    qDebug(discordLog) << message;
   }
 }
 
-void DiscordPage::startStream(QString target, uint width, uint height,
-                              uint frameRate) {
+void DiscordPage::startStream(bool video, bool audio, uint width, uint height,
+                              uint frameRate, QString target) {
   stopVirtmic();
-  startVirtmic(target);
+  startVirtmic(audio ? target : "[None]");
   // Wait a bit for the virtmic to start
-  QTimer::singleShot(target == "None" ? 0 : 200, [=]() {
-    runJavaScript(QString("window.discordScreenaudioStartStream(%1, %2, %3);")
-                      .arg(width)
-                      .arg(height)
-                      .arg(frameRate));
+  QTimer::singleShot(200, [=]() {
+    runJavaScript(
+        QString("window.discordScreenaudioStartStream(%1, %2, %3, %4);")
+            .arg(video)
+            .arg(video ? width : 32)
+            .arg(video ? height : 16)
+            .arg(video ? frameRate : 1));
   });
 }
+
+void DiscordPage::toggleMute() {
+  qDebug(shortcutLog) << "Toggling mute";
+  runJavaScript("window.discordScreenaudioToggleMute();");
+}
+
+void DiscordPage::toggleDeafen() {
+  qDebug(shortcutLog) << "Toggling deafen";
+  runJavaScript("window.discordScreenaudioToggleDeafen();");
+}

src/discordpage.h

@@ -3,6 +3,12 @@
 #include "streamdialog.h"
 #include "virtmic.h"
 
+#ifdef KXMLGUI
+#include <KActionCollection>
+#include <KHelpMenu>
+#include <KShortcutsDialog>
+#endif
+
 #include <QProcess>
 #include <QWebEngineFullScreenRequest>
 #include <QWebEnginePage>
@@ -16,6 +22,13 @@ public:
 private:
   StreamDialog m_streamDialog;
   QProcess m_virtmicProcess;
+#ifdef KXMLGUI
+  KHelpMenu *m_helpMenu;
+#ifdef KGLOBALACCEL
+  KActionCollection *m_actionCollection;
+  KShortcutsDialog *m_shortcutsDialog;
+#endif
+#endif
   bool acceptNavigationRequest(const QUrl &url,
                                QWebEnginePage::NavigationType type,
                                bool isMainFrame) override;
@@ -24,14 +37,18 @@ private:
   javaScriptConsoleMessage(QWebEnginePage::JavaScriptConsoleMessageLevel level,
                            const QString &message, int lineNumber,
                            const QString &sourceID) override;
-  void injectScript(QString source);
+  void injectScriptText(QString name, QString content);
+  void injectScriptFile(QString name, QString source);
   void stopVirtmic();
   void startVirtmic(QString target);
+  void toggleMute();
+  void toggleDeafen();
 
 private Q_SLOTS:
   void featurePermissionRequested(const QUrl &securityOrigin,
                                   QWebEnginePage::Feature feature);
-  void startStream(QString target, uint width, uint height, uint frameRate);
+  void startStream(bool video, bool audio, uint width, uint height,
+                   uint frameRate, QString target);
 };
 
 // Will immediately get destroyed again but is needed for navigation to

src/log.cpp

@@ -0,0 +1,7 @@
+#include "log.h"
+
+Q_LOGGING_CATEGORY(mainLog, "main");
+Q_LOGGING_CATEGORY(discordLog, "discord");
+Q_LOGGING_CATEGORY(userscriptLog, "userscript");
+Q_LOGGING_CATEGORY(virtmicLog, "virtmic");
+Q_LOGGING_CATEGORY(shortcutLog, "shortcut");

src/log.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include <QLoggingCategory>
+
+Q_DECLARE_LOGGING_CATEGORY(mainLog);
+Q_DECLARE_LOGGING_CATEGORY(discordLog);
+Q_DECLARE_LOGGING_CATEGORY(userscriptLog);
+Q_DECLARE_LOGGING_CATEGORY(virtmicLog);
+Q_DECLARE_LOGGING_CATEGORY(shortcutLog);

src/main.cpp

@@ -1,13 +1,23 @@
 #include "mainwindow.h"
 #include "virtmic.h"
 
+#ifdef KXMLGUI
+#include <KAboutData>
+#endif
+
 #include <QApplication>
 #include <QCommandLineParser>
+#include <QLoggingCategory>
 
 int main(int argc, char *argv[]) {
   QApplication app(argc, argv);
   QApplication::setApplicationName("discord-screenaudio");
-  QApplication::setApplicationVersion("1.0.0-rc.9");
+  QApplication::setWindowIcon(
+      QIcon(":assets/de.shorsh.discord-screenaudio.png"));
+  QApplication::setApplicationVersion(DISCORD_SCEENAUDIO_VERSION_FULL);
+  QApplication::setDesktopFileName("de.shorsh.discord-screenaudio");
+
+  qSetMessagePattern("[%{category}] %{message}");
 
   QCommandLineParser parser;
   parser.setApplicationDescription(
@@ -17,17 +27,29 @@ int main(int argc, char *argv[]) {
   QCommandLineOption virtmicOption("virtmic", "Start the Virtual Microphone",
                                    "target");
   parser.addOption(virtmicOption);
-#ifdef DEBUG
-  parser.addOption(QCommandLineOption(
-      "remote-debugging-port", "Chromium Remote Debugging Port", "port"));
-#endif
+  QCommandLineOption degubOption("remote-debugging",
+                                 "Open Chromium Remote Debugging on port 9222");
+  parser.addOption(degubOption);
+  QCommandLineOption notifySendOption(
+      "notify-send", "Use notify-send instead of QT/KF5 notifications");
+  parser.addOption(notifySendOption);
+
   parser.process(app);
 
   if (parser.isSet(virtmicOption)) {
     Virtmic::start(parser.value(virtmicOption));
   }
 
-  MainWindow w;
+  qputenv("QTWEBENGINE_CHROMIUM_FLAGS",
+          "--enable-features=WebRTCPipeWireCapturer " +
+              qgetenv("QTWEBENGINE_CHROMIUM_FLAGS"));
+
+  if (parser.isSet(degubOption))
+    qputenv("QTWEBENGINE_CHROMIUM_FLAGS",
+            "--remote-debugging-port=9222 " +
+                qgetenv("QTWEBENGINE_CHROMIUM_FLAGS"));
+
+  MainWindow w(parser.isSet(notifySendOption));
   w.show();
 
   return app.exec();

src/mainwindow.cpp

@@ -1,6 +1,10 @@
 #include "mainwindow.h"
 #include "virtmic.h"
 
+#ifdef KNOTIFICATIONS
+#include <KNotification>
+#endif
+
 #include <QApplication>
 #include <QColor>
 #include <QComboBox>
@@ -11,12 +15,20 @@
 #include <QSpacerItem>
 #include <QThread>
 #include <QUrl>
+#include <QWebEngineNotification>
+#include <QWebEngineProfile>
 #include <QWebEngineScript>
 #include <QWebEngineScriptCollection>
 #include <QWebEngineSettings>
 #include <QWidget>
 
-MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent) {
+MainWindow *MainWindow::m_instance = nullptr;
+
+MainWindow::MainWindow(bool useNotifySend, QWidget *parent)
+    : QMainWindow(parent) {
+  assert(MainWindow::m_instance == nullptr);
+  MainWindow::m_instance = this;
+  m_useNotifySend = useNotifySend;
   setupWebView();
   resize(1000, 700);
   showMaximized();
@@ -30,6 +42,37 @@ void MainWindow::setupWebView() {
   m_webView = new QWebEngineView(this);
   m_webView->setPage(page);
 
+  if (m_useKF5Notifications || m_useNotifySend)
+    QWebEngineProfile::defaultProfile()->setNotificationPresenter(
+        [&](std::unique_ptr<QWebEngineNotification> notificationInfo) {
+          if (m_useNotifySend) {
+            auto title = notificationInfo->title();
+            auto message = notificationInfo->message();
+            auto image_path =
+                QString("/tmp/discord-screenaudio-%1.png").arg(title);
+            notificationInfo->icon().save(image_path);
+            QProcess::execute("notify-send",
+                              {"--icon", image_path, "--app-name",
+                               "discord-screenaudio", title, message});
+          } else if (m_useKF5Notifications) {
+#ifdef KNOTIFICATIONS
+            KNotification *notification =
+                new KNotification("discordNotification");
+            notification->setTitle(notificationInfo->title());
+            notification->setText(notificationInfo->message());
+            notification->setPixmap(
+                QPixmap::fromImage(notificationInfo->icon()));
+            notification->setDefaultAction("View");
+            connect(notification, &KNotification::defaultActivated,
+                    [&, notificationInfo = std::move(notificationInfo)]() {
+                      notificationInfo->click();
+                      activateWindow();
+                    });
+            notification->sendEvent();
+#endif
+          }
+        });
+
   setCentralWidget(m_webView);
 }
 
@@ -45,3 +88,5 @@ void MainWindow::fullScreenRequested(
 }
 
 void MainWindow::closeEvent(QCloseEvent *event) { QApplication::quit(); }
+
+MainWindow *MainWindow::instance() { return m_instance; }

src/mainwindow.h

@@ -14,7 +14,8 @@ class MainWindow : public QMainWindow {
   Q_OBJECT
 
 public:
-  explicit MainWindow(QWidget *parent = nullptr);
+  explicit MainWindow(bool useNotifySend = false, QWidget *parent = nullptr);
+  static MainWindow *instance();
 
 private:
   void setupWebView();
@@ -23,6 +24,13 @@ private:
   DiscordPage *m_discordPage;
   void closeEvent(QCloseEvent *event) override;
   bool m_wasMaximized;
+  static MainWindow *m_instance;
+  bool m_useNotifySend;
+#ifdef KNOTIFICATIONS
+  bool m_useKF5Notifications = true;
+#else
+  bool m_useKF5Notifications = false;
+#endif
 
 private Q_SLOTS:
   void fullScreenRequested(QWebEngineFullScreenRequest fullScreenRequest);

src/streamdialog.cpp

@@ -12,67 +12,110 @@
 StreamDialog::StreamDialog() : QWidget() {
   setAttribute(Qt::WA_QuitOnClose, false);
 
-  auto layout = new QVBoxLayout(this);
+  {
+    auto layout = new QVBoxLayout(this);
+    layout->setSizeConstraint(QLayout::SetFixedSize);
 
-  auto targetLabel = new QLabel(this);
-  targetLabel->setText("Which app do you want to stream sound from?");
-  layout->addWidget(targetLabel);
+    m_videoGroupBox = new QGroupBox(this);
+    m_videoGroupBox->setTitle("Video");
+    m_videoGroupBox->setCheckable(true);
+    layout->addWidget(m_videoGroupBox);
 
-  m_targetComboBox = new QComboBox(this);
-  updateTargets();
-  layout->addWidget(m_targetComboBox);
+    {
+      auto videoLayout = new QVBoxLayout(this);
+      m_videoGroupBox->setLayout(videoLayout);
 
-  auto qualityLabel = new QLabel(this);
-  qualityLabel->setText("Stream Quality");
-  layout->addWidget(qualityLabel);
+      auto resolutionLabel = new QLabel(this);
+      resolutionLabel->setText("Resolution");
+      videoLayout->addWidget(resolutionLabel);
 
-  auto qualityHBox = new QHBoxLayout(this);
-  layout->addLayout(qualityHBox);
+      m_resolutionComboBox = new QComboBox(this);
+      m_resolutionComboBox->addItem("2160p", "3840x2160");
+      m_resolutionComboBox->addItem("1440p", "2560x1440");
+      m_resolutionComboBox->addItem("1080p", "1920x1080");
+      m_resolutionComboBox->addItem("720p", "1280x720");
+      m_resolutionComboBox->addItem("480p", "854x480");
+      m_resolutionComboBox->addItem("360p", "640x360");
+      m_resolutionComboBox->addItem("240p", "426x240");
+      m_resolutionComboBox->setCurrentText("720p");
+      videoLayout->addWidget(m_resolutionComboBox);
 
-  m_qualityResolutionComboBox = new QComboBox(this);
-  m_qualityResolutionComboBox->addItem("2160p", "3840x2160");
-  m_qualityResolutionComboBox->addItem("1440p", "2560x1440");
-  m_qualityResolutionComboBox->addItem("1080p", "1920x1080");
-  m_qualityResolutionComboBox->addItem("720p", "1280x720");
-  m_qualityResolutionComboBox->addItem("480p", "854x480");
-  m_qualityResolutionComboBox->addItem("360p", "640x360");
-  m_qualityResolutionComboBox->addItem("240p", "426x240");
-  m_qualityResolutionComboBox->setCurrentText("720p");
-  qualityHBox->addWidget(m_qualityResolutionComboBox);
+      auto framerateLabel = new QLabel(this);
+      framerateLabel->setText("Framerate");
+      videoLayout->addWidget(framerateLabel);
 
-  m_qualityFPSComboBox = new QComboBox(this);
-  m_qualityFPSComboBox->addItem("144 FPS", 144);
-  m_qualityFPSComboBox->addItem("60 FPS", 60);
-  m_qualityFPSComboBox->addItem("30 FPS", 30);
-  m_qualityFPSComboBox->addItem("15 FPS", 15);
-  m_qualityFPSComboBox->addItem("5 FPS", 5);
-  m_qualityFPSComboBox->setCurrentText("30 FPS");
-  qualityHBox->addWidget(m_qualityFPSComboBox);
+      m_framerateComboBox = new QComboBox(this);
+      m_framerateComboBox->addItem("144 FPS", 144);
+      m_framerateComboBox->addItem("60 FPS", 60);
+      m_framerateComboBox->addItem("30 FPS", 30);
+      m_framerateComboBox->addItem("15 FPS", 15);
+      m_framerateComboBox->addItem("5 FPS", 5);
+      m_framerateComboBox->setCurrentText("30 FPS");
+      videoLayout->addWidget(m_framerateComboBox);
+    }
 
-  auto button = new QPushButton(this);
-  button->setText("Start Stream");
-  connect(button, &QPushButton::clicked, this, &StreamDialog::startStream);
-  layout->addWidget(button, Qt::AlignRight | Qt::AlignBottom);
+    m_audioGroupBox = new QGroupBox(this);
+    m_audioGroupBox->setCheckable(true);
+    m_audioGroupBox->setTitle("Audio");
+    layout->addWidget(m_audioGroupBox);
 
-  setLayout(layout);
+    {
+      auto audioLayout = new QVBoxLayout(this);
+      m_audioGroupBox->setLayout(audioLayout);
+
+      auto targetLabel = new QLabel(this);
+      targetLabel->setText("Audio Source");
+      audioLayout->addWidget(targetLabel);
+
+      {
+        auto targetLayout = new QHBoxLayout(this);
+        audioLayout->addLayout(targetLayout);
+
+        m_targetComboBox = new QComboBox(this);
+        updateTargets();
+        targetLayout->addWidget(m_targetComboBox);
+
+        auto refreshTargetsButton = new QPushButton(this);
+        refreshTargetsButton->setFixedSize(30, 30);
+        refreshTargetsButton->setIcon(QIcon::fromTheme("view-refresh"));
+        connect(refreshTargetsButton, &QPushButton::clicked, this,
+                &StreamDialog::updateTargets);
+        targetLayout->addWidget(refreshTargetsButton);
+      }
+    }
+
+    auto button = new QPushButton(this);
+    button->setText("Start Stream");
+    connect(button, &QPushButton::clicked, this, &StreamDialog::startStream);
+    layout->addWidget(button, Qt::AlignRight | Qt::AlignBottom);
+
+    setLayout(layout);
+  }
 
   setWindowTitle("discord-screenaudio Stream Dialog");
-  setFixedSize(0, 0);
 }
 
 void StreamDialog::startStream() {
-  auto resolution =
-      m_qualityResolutionComboBox->currentData().toString().split('x');
-  emit requestedStreamStart(m_targetComboBox->currentText(),
+  auto resolution = m_resolutionComboBox->currentData().toString().split('x');
+  emit requestedStreamStart(m_videoGroupBox->isChecked(),
+                            m_audioGroupBox->isChecked(),
                             resolution[0].toUInt(), resolution[1].toUInt(),
-                            m_qualityFPSComboBox->currentData().toUInt());
+                            m_framerateComboBox->currentData().toUInt(),
+                            m_targetComboBox->currentText());
   setHidden(true);
 }
 
 void StreamDialog::updateTargets() {
+  auto lastTarget = m_targetComboBox->currentText();
+
   m_targetComboBox->clear();
-  m_targetComboBox->addItem("None");
+  m_targetComboBox->addItem("[All Desktop Audio]");
   for (auto target : Virtmic::getTargets()) {
     m_targetComboBox->addItem(target);
   }
+
+  if (m_targetComboBox->findText(lastTarget) != -1)
+    m_targetComboBox->setCurrentText(lastTarget);
+  else
+    m_targetComboBox->setCurrentText("[All Desktop Audio]");
 }

src/streamdialog.h

@@ -2,6 +2,7 @@
 
 #include <QComboBox>
 #include <QDialog>
+#include <QGroupBox>
 #include <QWidget>
 
 class StreamDialog : public QWidget {
@@ -12,12 +13,14 @@ public:
 
 private:
   QComboBox *m_targetComboBox;
-  QComboBox *m_qualityResolutionComboBox;
-  QComboBox *m_qualityFPSComboBox;
+  QComboBox *m_resolutionComboBox;
+  QComboBox *m_framerateComboBox;
+  QGroupBox *m_videoGroupBox;
+  QGroupBox *m_audioGroupBox;
 
 Q_SIGNALS:
-  void requestedStreamStart(QString target, uint width, uint height,
-                            uint frameRate);
+  void requestedStreamStart(bool video, bool audio, uint width, uint height,
+                            uint frameRate, QString target);
 
 public Q_SLOTS:
   void updateTargets();

src/virtmic.cpp

@@ -1,10 +1,13 @@
 #include "virtmic.h"
+#include "log.h"
 
 #include <rohrkabel/loop/main.hpp>
 #include <rohrkabel/registry/registry.hpp>
 
 namespace Virtmic {
 
+const QStringList EXCLUDE_TARGETS{"Chromium input", "discord-screenaudio"};
+
 QVector<QString> getTargets() {
   auto main_loop = pipewire::main_loop();
   auto context = pipewire::context(main_loop);
@@ -19,11 +22,11 @@ QVector<QString> getTargets() {
         if (global.type == pipewire::node::type) {
           auto node = reg.bind<pipewire::node>(global.id);
           auto info = node.info();
+          auto name = QString::fromStdString(info.props["application.name"]);
 
-          if (info.props.count("node.name")) {
-            auto name = QString::fromStdString(info.props["node.name"]);
-            if (!targets.contains(name))
-              targets.append(name);
+          if (name != "" && !EXCLUDE_TARGETS.contains(name) &&
+              !targets.contains(name)) {
+            targets.append(name);
           }
         }
       });
@@ -64,20 +67,24 @@ void start(QString _target) {
         continue;
 
       auto &parent = nodes.at(parent_id);
+      auto name = parent.props["application.name"];
 
-      if (parent.props["node.name"].find(target) != std::string::npos) {
-        std::cout << "[virtmic] "
-                  << "Link   : " << target << ":" << port_id << " -> ";
-
-        if (port.info().props["audio.channel"] == "FL") {
-          links.emplace(port_id, core.create<pipewire::link_factory>(
-                                     {virt_fl->info().id, port_id}));
-          std::cout << "[virtmic] " << virt_fl->info().id << std::endl;
-        } else {
-          links.emplace(port_id, core.create<pipewire::link_factory>(
-                                     {virt_fr->info().id, port_id}));
-          std::cout << "[virtmic] " << virt_fr->info().id << std::endl;
-        }
+      if (name == target ||
+          (target == "[All Desktop Audio]" &&
+           !EXCLUDE_TARGETS.contains(QString::fromStdString(name)))) {
+        auto fl = port.info().props["audio.channel"] == "FL";
+        links.emplace(
+            port_id,
+            core.create<pipewire::link_factory>(
+                {fl ? virt_fl->info().id : virt_fr->info().id, port_id}));
+        qDebug(virtmicLog) << QString("Link: %1:%2 -> %3")
+                                  .arg(QString::fromStdString(
+                                      parent.props["application.name"]))
+                                  .arg(port_id)
+                                  .arg(fl ? virt_fl->info().id
+                                          : virt_fr->info().id)
+                                  .toUtf8()
+                                  .data();
       }
     }
   };
@@ -93,7 +100,7 @@ void start(QString _target) {
                                  pipewire::node::type, pipewire::node::version,
                                  pipewire::update_strategy::none);
 
-  if (target == "None") {
+  if (target == "[None]") {
     while (true) {
       main_loop.run();
     }
@@ -105,9 +112,13 @@ void start(QString _target) {
       [&](const pipewire::global &global) {
         if (global.type == pipewire::node::type) {
           auto node = reg.bind<pipewire::node>(global.id);
-          std::cout << "[virtmic] "
-                    << "Added  : " << node.info().props["node.name"]
-                    << std::endl;
+          if (!node.info().props.count("application.name"))
+            return;
+          qDebug(virtmicLog) << QString("Added: %1")
+                                    .arg(QString::fromStdString(
+                                        node.info().props["application.name"]))
+                                    .toUtf8()
+                                    .data();
 
           if (!nodes.count(global.id)) {
             nodes.emplace(global.id, node.info());
@@ -141,8 +152,11 @@ void start(QString _target) {
       [&](const std::uint32_t id) {
         if (nodes.count(id)) {
           auto info = nodes.at(id);
-          std::cout << "[virtmic] "
-                    << "Removed: " << info.props["node.name"] << std::endl;
+          qDebug(virtmicLog) << QString("Removed: %1")
+                                    .arg(QString::fromStdString(
+                                        info.props["application.name"].data()))
+                                    .toUtf8()
+                                    .data();
           nodes.erase(id);
         }
         if (ports.count(id)) {

version.cmake

@@ -0,0 +1,164 @@
+# Copyright (c) 2018-2021 Ribose Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+# desired length of commit hash
+set(GIT_REV_LEN 7)
+
+# call git, store output in var (can fail)
+macro(_git var)
+  execute_process(
+    COMMAND "${GIT_EXECUTABLE}" ${ARGN}
+    WORKING_DIRECTORY "${source_dir}"
+    RESULT_VARIABLE _git_ec
+    OUTPUT_VARIABLE ${var}
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    ERROR_QUIET
+  )
+endmacro()
+
+function(extract_version_info version var_prefix)
+  # extract the main components
+  #   v1.9.0-3-g5b92266+1546836556
+  #   v1.9.0-3-g5b92266-dirty+1546836556
+  string(REGEX MATCH "^v?([0-9]+\\.[0-9]+\\.[0-9]+)(-([0-9]+)-g([0-9a-f]+)(-dirty)?)?(\\+([0-9]+))?$" matches "${version}")
+  if (NOT matches)
+    message(FATAL_ERROR "Failed to extract version components from ${version}.")
+  endif()
+  set(${var_prefix}_VERSION "${CMAKE_MATCH_1}" PARENT_SCOPE) # 1.9.0
+  if (NOT CMAKE_MATCH_3)
+    set(CMAKE_MATCH_3 "0")
+  endif()
+  set(${var_prefix}_VERSION_NCOMMITS "${CMAKE_MATCH_3}" PARENT_SCOPE) # 3
+  if (NOT CMAKE_MATCH_4)
+    set(CMAKE_MATCH_4 "0")
+  endif()
+  set(${var_prefix}_VERSION_GIT_REV "${CMAKE_MATCH_4}" PARENT_SCOPE) # 5b92266
+  if (CMAKE_MATCH_5 STREQUAL "-dirty")
+    set(${var_prefix}_VERSION_IS_DIRTY TRUE PARENT_SCOPE)
+  else()
+    set(${var_prefix}_VERSION_IS_DIRTY FALSE PARENT_SCOPE)
+  endif()
+  # timestamp is optional, default to 0
+  if (NOT CMAKE_MATCH_7)
+    set(CMAKE_MATCH_7 "0")
+  endif()
+  set(${var_prefix}_VERSION_COMMIT_TIMESTAMP "${CMAKE_MATCH_7}" PARENT_SCOPE) # 1546836556
+endfunction()
+
+function(determine_version source_dir var_prefix)
+  set(has_release_tag NO)
+  set(has_version_txt NO)
+  set(local_prefix "_determine_ver")
+  # find out base version via version.txt
+  set(base_version "0.0.0")
+  if (EXISTS "${source_dir}/version.txt")
+    set(has_version_txt YES)
+    file(STRINGS "${source_dir}/version.txt" version_file)
+    extract_version_info("${version_file}" "${local_prefix}")
+    set(base_version "${${local_prefix}_VERSION}")
+    message(STATUS "Found version.txt with ${version_file}")
+  else()
+    message(STATUS "Found no version.txt.")
+  endif()
+  # for GIT_EXECUTABLE
+  find_package(Git)
+  # get a description of the version, something like:
+  #   v1.9.1-0-g38ffe82        (a tagged release)
+  #   v1.9.1-0-g38ffe82-dirty  (a tagged release with local modifications)
+  #   v1.9.0-3-g5b92266        (post-release snapshot)
+  #   v1.9.0-3-g5b92266-dirty  (post-release snapshot with local modifications)
+  _git(version describe --abbrev=${GIT_REV_LEN} --match "v[0-9]*" --long --dirty)
+  if (NOT _git_ec EQUAL 0)
+    # no annotated tags, fake one
+    message(STATUS "Found no annotated tags.")
+    _git(revision rev-parse --short=${GIT_REV_LEN} --verify HEAD)
+    if (_git_ec EQUAL 0)
+      set(version "v${base_version}-0-g${revision}")
+      # check if dirty (this won't detect untracked files, but should be ok)
+      _git(changes diff-index --quiet HEAD --)
+      if (NOT _git_ec EQUAL 0)
+        string(APPEND version "-dirty")
+      endif()
+      # append the commit timestamp of the most recent commit (only
+      # in non-release branches -- typically master)
+      _git(commit_timestamp show -s --format=%ct)
+      if (_git_ec EQUAL 0)
+        string(APPEND version "+${commit_timestamp}")
+      endif()
+    elseif(has_version_txt)
+      # Nothing to get from git - so use version.txt completely
+      set(version "${version_file}")
+    else()
+      # Sad case - no git, no version.txt
+      set(version "v${base_version}")
+    endif()
+  else()
+    set(has_release_tag YES)
+    message(STATUS "Found annotated tag ${version}")
+  endif()
+  extract_version_info("${version}" "${local_prefix}")
+  if ("${has_version_txt}" AND NOT ${base_version} STREQUAL ${local_prefix}_VERSION)
+    message(WARNING "Tagged version ${${local_prefix}_VERSION} doesn't match one from the version.txt: ${base_version}")
+    if (${base_version} VERSION_GREATER ${local_prefix}_VERSION)
+      set(${local_prefix}_VERSION ${base_version})
+    endif()
+  endif()
+  foreach(suffix VERSION VERSION_NCOMMITS VERSION_GIT_REV VERSION_IS_DIRTY VERSION_COMMIT_TIMESTAMP)
+    if (NOT DEFINED ${local_prefix}_${suffix})
+      message(FATAL_ERROR "Unable to determine version.")
+    endif()
+    set(${var_prefix}_${suffix} "${${local_prefix}_${suffix}}" PARENT_SCOPE)
+    message(STATUS "${var_prefix}_${suffix}: ${${local_prefix}_${suffix}}")
+  endforeach()
+  # Set VERSION_SUFFIX and VERSION_FULL. When making changes, be aware that
+  # this is used in packaging as well and will affect ordering.
+  # | state                 | version_full                |
+  # |-----------------------------------------------------|
+  # | exact tag             | 0.9.0                       |
+  # | exact tag, dirty      | 0.9.0+git20180604           |
+  # | after tag             | 0.9.0+git20180604.1.085039f |
+  # | no tag, version.txt   | 0.9.0                       |
+  # | no tag, no version.txt| 0.0.0+git20180604.2ee02af   |
+  string(TIMESTAMP date "%Y%m%d" UTC)
+  set(version_suffix "")
+  if (has_version_txt)
+  elseif (NOT ${local_prefix}_VERSION_NCOMMITS EQUAL 0)
+    # 0.9.0+git20150604.4.289818b
+    string(APPEND version_suffix "+git${date}.${${local_prefix}_VERSION_NCOMMITS}.${${local_prefix}_VERSION_GIT_REV}")
+  elseif ((NOT has_release_tag) AND ((NOT has_version_txt) OR ("${base_version}" STREQUAL "0.0.0") OR (NOT "${revision}" STREQUAL "")))
+    # 0.9.0+git20150604.289818b
+    string(APPEND version_suffix "+git${date}.${${local_prefix}_VERSION_GIT_REV}")
+  elseif(${local_prefix}_VERSION_IS_DIRTY)
+    # 0.9.0+git20150604
+    string(APPEND version_suffix "+git${date}")
+  endif()
+  set(version_full "${${local_prefix}_VERSION}${version_suffix}")
+  # set the results
+  set(${var_prefix}_VERSION_SUFFIX "${version_suffix}" PARENT_SCOPE)
+  set(${var_prefix}_VERSION_FULL "${version_full}" PARENT_SCOPE)
+  # for informational purposes
+  message(STATUS "${var_prefix}_VERSION_SUFFIX: ${version_suffix}")
+  message(STATUS "${var_prefix}_VERSION_FULL: ${version_full}")
+endfunction()
+