Merge pull request #62 from GoXLR-on-Linux/dev-0.11.0

Dev 0.11.0

Author: FrostyCoolSlug

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
           sudo apt-get install libdbus-1-dev pkg-config libspeechd-dev
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo check
+      - run: cargo check --all-features
 
   test_linux:
     name: Test Linux Suite
@@ -25,23 +25,23 @@ jobs:
           sudo apt-get install libpulse0 libdbus-1-dev pkg-config libspeechd-dev
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test
+      - run: cargo test --all-features
 
   test_windows:
     name: Test Windows Suite
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test
+      - run: cargo test --all-features
 
   test_macos:
     name: Test MacOS Suite
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test
+      - run: cargo test --all-features
 
   fmt:
     name: Rustfmt
@@ -65,7 +65,7 @@ jobs:
       - uses: dtolnay/rust-toolchain@stable
         with:
           components: clippy
-      - run: cargo clippy --all-targets -- -D warnings
+      - run: cargo clippy --all-targets --all-features -- -D warnings
 
   clippy_macos:
     name: Clippy MacOS
@@ -75,7 +75,7 @@ jobs:
       - uses: dtolnay/rust-toolchain@stable
         with:
           components: clippy
-      - run: cargo clippy --all-targets -- -D warnings
+      - run: cargo clippy --all-targets --all-features -- -D warnings
 
   clippy_windows:
     name: Clippy Windows
@@ -85,4 +85,4 @@ jobs:
       - uses: dtolnay/rust-toolchain@stable
         with:
           components: clippy
-      - run: cargo clippy --all-targets -- -D warnings
+      - run: cargo clippy --all-targets --all-features -- -D warnings

.github/workflows/release.yml

@@ -36,7 +36,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: build
-          args: --release
+          args: --release --all-features
 
       - name: Build Packages
         run: iscc.exe goxlr-utility.iss
@@ -59,7 +59,7 @@ jobs:
           toolchain: stable
           override: true
 
-      - name: Install Pulse Client Libraries
+      - name: Install Required Libraries
         run: |
           sudo apt-get update
           sudo apt-get install libpulse0 libdbus-1-dev pkg-config libspeechd-dev

README.md

@@ -16,6 +16,7 @@ We currently provide the following via the [releases page](https://github.com/Go
 * `.deb` files, usable on Debian based systems (Ubuntu, Mint, Pop!_OS, etc)
 * `.rpm` files, usable on Redhat based systems (CentOS, Fedora, etc)
 
+
 We also provide the utility through the [Arch User Repository](https://aur.archlinux.org/packages/goxlr-utility) via the
 `goxlr-utility` package.
 
@@ -92,16 +93,29 @@ which will contain details.
 Copy `50-goxlr.rules` to `/etc/udev/rules.d/` and then reload with `sudo udevadm control --reload-rules && sudo udevadm trigger`.
 
 ## Building from source
+
 ### Prerequisites
 * Have a GoXLR :)
 * Install [Rust](https://rustup.rs/)
 * For Linux:
   * Debian: `sudo apt-get install pkg-config libdbus-1-dev libpulse0`
   * Fedora: `sudo dnf install pkgconf-pkg-config dbus-devel pulseaudio-libs`
 
+### Features
+The GoXLR Utility contains compile-time features, which can be used to enable functionality during the build process by
+adding `--features "a b c"` to the `cargo` command (with `a`, `b` and `c` being separate feature names, for example 
+`cargo build --features "tts"`). These features often require separate dependencies to be installed, and are documented
+as such below.
+
+#### Text to Speech on Button Press
+* Feature Name: `tts`
+* Dependencies:
+  * Debian: `sudo apt-get install clang libspeechd-dev`
+  * Fedora: `sudo dnf install clang speech-dispatcher-devel`
 
 ### Building
-The easiest way to build is by using the following commands to compile and install the executables:
+The easiest way to build is by using the following commands to compile and install the executables (remembering to add 
+features you may want!):
 - `cargo install --path daemon` for the daemon
 - `cargo install --path client` for the client to interact with the daemon
 - `cargo install --path defaults` for the Default Profile Handlers

audio/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "goxlr-audio"
-version = "0.10.2"
+version = "0.11.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

ci/build-and-install.sh

@@ -25,6 +25,7 @@ sudo cp target/release/goxlr-daemon /usr/bin/
 sudo cp target/release/goxlr-client /usr/bin/
 sudo cp target/release/goxlr-defaults /usr/bin/
 sudo cp target/release/goxlr-launcher /usr/bin/
+sudo cp target/release/goxlr-firmware /usr/bin/
 
 sudo chmod 755 /usr/bin/goxlr-client /usr/bin/goxlr-daemon /usr/bin/goxlr-defaults /usr/bin/goxlr-launcher
 

ci/build-packages

@@ -24,7 +24,7 @@ fi
 # Neither 'cargo deb' or 'cargo generate-rpm' seem to provide a way to specify an asset that is created at build time.
 # To work around this, we force a release build, copy out the shell completions produced from that build, put it into
 # a predictable location and then build the packages, which knows where to look.
-cargo build --release
+cargo build --release --all-features
 
 strip target/release/goxlr-client
 strip target/release/goxlr-daemon

client/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "goxlr-client"
-version = "0.10.2"
+version = "0.11.0"
 edition = "2021"
 build = "build.rs"
 authors = ["Nathan Adams <[email protected]>", "Craig McLure <[email protected]>", "Lars Mühlbauer <[email protected]>"]

daemon/Cargo.toml

@@ -1,14 +1,15 @@
 [package]
 name = "goxlr-daemon"
-version = "0.10.2"
+version = "0.11.0"
 edition = "2021"
 authors = ["Nathan Adams <[email protected]>", "Craig McLure <[email protected]>", "Lars Mühlbauer <[email protected]>"]
 description = "Allows control of a TC-Helicon GoXLR or GoXLR Mini, by maintaining an interaction with it over USB in the background."
 repository = "https://github.com/GoXLR-on-Linux/GoXLR-Utility"
 license = "MIT"
 categories = ["hardware-support", "command-line-utilities"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[features]
+tts = ["dep:tts"]
 
 [dependencies]
 goxlr-usb = { path = "../usb" }
@@ -39,7 +40,7 @@ glob = "0.3.0"
 cfg-if = "1.0.0"
 lazy_static = "1.4.0"
 
-tts = { version = "0.25.1", features=["tolk"] }
+tts = { version = "0.25.1", features = ["tolk"], optional = true }
 interprocess = { version = "1.2.1", features = ["tokio_support"] }
 
 notify = "5.0.0"
@@ -50,7 +51,7 @@ actix = "0.13.0"
 actix-web-actors = "4.1.0"
 
 # All we really need from actix-web are macros and compression, TLS and cookies aren't required
-actix-web = { version = "4.2.1", default-features = false, features = ["macros", "compress-brotli", "compress-gzip" ] }
+actix-web = { version = "4.2.1", default-features = false, features = ["macros", "compress-brotli", "compress-gzip"] }
 actix-cors = "0.6.4"
 mime_guess = "2.0.4"
 include_dir = "0.7.3"
@@ -95,6 +96,7 @@ assets = [
     ["../target/release/goxlr-client", "usr/bin/", "755"],
     ["../target/release/goxlr-defaults", "usr/bin/", "755"],
     ["../target/release/goxlr-launcher", "usr/bin/", "755"],
+    ["../target/release/goxlr-firmware", "usr/bin/", "755"],
     ["../50-goxlr.rules", "etc/udev/rules.d/", "644"],
     ["../daemon/resources/goxlr-utility.png", "usr/share/icons/hicolor/48x48/apps/", "644"],
     ["../daemon/resources/goxlr-utility-large.png", "usr/share/pixmaps/goxlr-utility.png", "644"],
@@ -123,6 +125,7 @@ assets = [
     { source = "../target/release/goxlr-client", dest = "/usr/bin/goxlr-client", mode = "0755" },
     { source = "../target/release/goxlr-defaults", dest = "/usr/bin/goxlr-defaults", mode = "0755" },
     { source = "../target/release/goxlr-launcher", dest = "/usr/bin/goxlr-launcher", mode = "0755" },
+    { source = "../target/release/goxlr-firmware", dest = "/usr/bin/goxlr-firmware", mode = "0755" },
     { source = "../50-goxlr.rules", dest = "/etc/udev/rules.d/50-goxlr.rules", mode = "0644" },
     { source = "../daemon/resources/goxlr-utility.png", dest = "/usr/share/icons/hicolor/48x48/apps/goxlr-utility.png", mode = "0644" },
     { source = "../daemon/resources/goxlr-utility-large.png", dest = "/usr/share/pixmaps/goxlr-utility.png", mode = "0644" },
@@ -151,5 +154,6 @@ auto-req = "no"
 [package.metadata.generate-rpm.requires]
 # It should be noted, that bzip2 and libusb get statically linked against the binary, so they're not actually
 # required, this leaves us with dbus and pulseaudio libs :)
-dbus-libs = "*"
-pulseaudio-libs = "*"
+dbus-libs = ">= 1.9.14"
+pulseaudio-libs = ">= 10.0"
+speech-dispatcher = ">= 0.7"

daemon/src/device.rs

@@ -1250,12 +1250,15 @@ impl<'a> Device<'a> {
                 self.profile.get_pitch_knob_position(),
                 encoders[0]
             );
-            let message = format!("Pitch {}", encoders[0]);
-            let _ = self.global_events.send(TTSMessage(message)).await;
-
             value_changed = true;
             self.profile.set_pitch_knob_position(encoders[0])?;
             self.apply_effects(LinkedHashSet::from_iter([EffectKey::PitchAmount]))?;
+
+            let user_value = self
+                .mic_profile
+                .get_effect_value(EffectKey::PitchAmount, self.profile());
+            let message = format!("Pitch {}", user_value);
+            let _ = self.global_events.send(TTSMessage(message)).await;
         }
 
         if encoders[1] != self.profile.get_gender_value() {
@@ -1264,12 +1267,23 @@ impl<'a> Device<'a> {
                 self.profile.get_gender_value(),
                 encoders[1]
             );
-            let message = format!("Gender {}", encoders[1]);
-            let _ = self.global_events.send(TTSMessage(message)).await;
 
-            value_changed = true;
+            let current_value = self
+                .mic_profile
+                .get_effect_value(EffectKey::GenderAmount, self.profile());
+
             self.profile.set_gender_value(encoders[1])?;
-            self.apply_effects(LinkedHashSet::from_iter([EffectKey::GenderAmount]))?;
+            value_changed = true;
+
+            let new_value = self
+                .mic_profile
+                .get_effect_value(EffectKey::GenderAmount, self.profile());
+
+            if new_value != current_value {
+                self.apply_effects(LinkedHashSet::from_iter([EffectKey::GenderAmount]))?;
+                let message = format!("Gender {}", new_value);
+                let _ = self.global_events.send(TTSMessage(message)).await;
+            }
         }
 
         if encoders[2] != self.profile.get_reverb_value() {
@@ -1278,12 +1292,19 @@ impl<'a> Device<'a> {
                 self.profile.get_reverb_value(),
                 encoders[2]
             );
-            let message = format!("Reverb {}", encoders[2]);
-            let _ = self.global_events.send(TTSMessage(message)).await;
 
             value_changed = true;
             self.profile.set_reverb_value(encoders[2])?;
+
+            let new_value = self
+                .mic_profile
+                .get_effect_value(EffectKey::ReverbAmount, self.profile());
+
             self.apply_effects(LinkedHashSet::from_iter([EffectKey::ReverbAmount]))?;
+
+            let percent = 100 - ((new_value as f32 / -36.) * 100.) as i32;
+            let message = format!("Reverb {} percent", percent);
+            let _ = self.global_events.send(TTSMessage(message)).await;
         }
 
         if encoders[3] != self.profile.get_echo_value() {
@@ -1292,12 +1313,16 @@ impl<'a> Device<'a> {
                 self.profile.get_echo_value(),
                 encoders[3]
             );
-            let message = format!("Echo {}", encoders[3]);
-            let _ = self.global_events.send(TTSMessage(message)).await;
-
             value_changed = true;
             self.profile.set_echo_value(encoders[3])?;
             self.apply_effects(LinkedHashSet::from_iter([EffectKey::EchoAmount]))?;
+
+            let mut user_value = self
+                .mic_profile
+                .get_effect_value(EffectKey::EchoAmount, self.profile());
+            user_value = 100 - ((user_value as f32 / -36.) * 100.) as i32;
+            let message = format!("Echo {} percent", user_value);
+            let _ = self.global_events.send(TTSMessage(message)).await;
         }
 
         Ok(value_changed)

daemon/src/platform/windows.rs

@@ -17,6 +17,7 @@ use winreg::RegKey;
 use winrt_notification::{Sound, Toast};
 
 const GOXLR_APP_NAME: &str = "GoXLR App.exe";
+const GOXLR_BETA_APP_NAME: &str = "GoXLR Beta App.exe";
 const AUTOSTART_FILENAME: &str = "GoXLR Utility.lnk";
 
 lazy_static! {
@@ -25,8 +26,10 @@ lazy_static! {
 
 pub fn perform_platform_preflight() -> Result<()> {
     let system = System::new_all();
-    let processes = system.processes_by_exact_name(GOXLR_APP_NAME);
-    if processes.count() > 0 {
+    let mut count = system.processes_by_exact_name(GOXLR_APP_NAME).count();
+    count += system.processes_by_exact_name(GOXLR_BETA_APP_NAME).count();
+
+    if count > 0 {
         throw_notification();
         error!("Detected Official GoXLR Application Running, Failing Preflight.");
         bail!("Official GoXLR App Running, Please terminate it before running the Daemon");
@@ -55,8 +58,9 @@ pub async fn spawn_platform_runtime(
         select! {
             _ = duration.tick() => {
                 system.refresh_processes();
-                let processes = system.processes_by_exact_name(GOXLR_APP_NAME);
-                if processes.count() > 0 {
+                let mut count = system.processes_by_exact_name(GOXLR_APP_NAME).count();
+                count += system.processes_by_exact_name(GOXLR_BETA_APP_NAME).count();
+                if count > 0 {
                     throw_notification();
 
                     // The processes list isn't Sendable, so this can't be triggered asynchronously.