Merge pull request #86 from GoXLR-on-Linux/dev-1.0.0

Dev 0.12.2

Author: FrostyCoolSlug

ROADMAP.md

@@ -1,5 +1,5 @@
 # Roadmap
-*Last Updated for 0.12.0 Release*
+*Last Updated for 0.12.2 Release*
 
 ## Completed Features
 * Initialisation of Devices under Linux
@@ -20,6 +20,7 @@
 * Full Lighting Configuration
 * Sampler Support
 * Scribbles
+* Lighting Animations
 * Full Submix Beta Support
 
 ## Utility Features
@@ -32,4 +33,4 @@
 * Logging options for troubleshooting
 
 ## Not Implemented
-* Lighting Animations (unlikely to be added)
+[ This space intentionally left blank. ]

audio/Cargo.toml

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

ci/goxlr-utility.iss

@@ -2,7 +2,7 @@
 
 [Setup]
 AppName=GoXLR Utility
-AppVersion=0.12.1
+AppVersion=0.12.2
 WizardStyle=modern
 DefaultDirName={autopf}\GoXLR Utility
 DefaultGroupName=GoXLR Utility

client/Cargo.toml

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

client/src/cli.rs

@@ -1,12 +1,13 @@
 use clap::{ArgAction, Args, Parser, Subcommand};
 
 use goxlr_types::{
-    Button, ButtonColourGroups, ButtonColourOffStyle, ChannelName, CompressorAttackTime,
-    CompressorRatio, CompressorReleaseTime, EchoStyle, EffectBankPresets, EncoderColourTargets,
-    EqFrequencies, FaderDisplayStyle, FaderName, GateTimes, GenderStyle, HardTuneSource,
-    HardTuneStyle, InputDevice, MegaphoneStyle, MiniEqFrequencies, Mix, MuteFunction, MuteState,
-    OutputDevice, PitchStyle, ReverbStyle, RobotRange, RobotStyle, SampleBank, SampleButtons,
-    SamplePlayOrder, SamplePlaybackMode, SimpleColourTargets,
+    AnimationMode, Button, ButtonColourGroups, ButtonColourOffStyle, ChannelName,
+    CompressorAttackTime, CompressorRatio, CompressorReleaseTime, EchoStyle, EffectBankPresets,
+    EncoderColourTargets, EqFrequencies, FaderDisplayStyle, FaderName, GateTimes, GenderStyle,
+    HardTuneSource, HardTuneStyle, InputDevice, MegaphoneStyle, MiniEqFrequencies, Mix,
+    MuteFunction, MuteState, OutputDevice, PitchStyle, ReverbStyle, RobotRange, RobotStyle,
+    SampleBank, SampleButtons, SamplePlayOrder, SamplePlaybackMode, SimpleColourTargets,
+    WaterfallDirection,
 };
 use std::str::FromStr;
 
@@ -492,6 +493,11 @@ pub enum CoughCommands {
 #[derive(Subcommand, Debug)]
 #[command(arg_required_else_help = true)]
 pub enum LightingCommands {
+    Animation {
+        #[command(subcommand)]
+        command: AnimationCommands,
+    },
+
     /// Sets the Global GoXLR Colour
     Global { colour: String },
 
@@ -541,6 +547,15 @@ pub enum LightingCommands {
     },
 }
 
+#[derive(Subcommand, Debug)]
+#[command(arg_required_else_help = true)]
+pub enum AnimationCommands {
+    Mode { mode: AnimationMode },
+    Mod1 { mod1: u8 },
+    Mod2 { mod2: u8 },
+    WaterFall { waterfall: WaterfallDirection },
+}
+
 #[derive(Subcommand, Debug)]
 #[command(arg_required_else_help = true)]
 pub enum FaderLightingCommands {

client/src/main.rs

@@ -2,11 +2,11 @@ mod cli;
 mod microphone;
 
 use crate::cli::{
-    ButtonGroupLightingCommands, ButtonLightingCommands, CompressorCommands, CoughButtonBehaviours,
-    Echo, EffectsCommands, EqualiserCommands, EqualiserMiniCommands, FaderCommands,
-    FaderLightingCommands, FadersAllLightingCommands, Gender, HardTune, LightingCommands,
-    Megaphone, MicrophoneCommands, NoiseGateCommands, Pitch, ProfileAction, ProfileType, Reverb,
-    Robot, SamplerCommands, Scribbles, SubCommands, SubmixCommands,
+    AnimationCommands, ButtonGroupLightingCommands, ButtonLightingCommands, CompressorCommands,
+    CoughButtonBehaviours, Echo, EffectsCommands, EqualiserCommands, EqualiserMiniCommands,
+    FaderCommands, FaderLightingCommands, FadersAllLightingCommands, Gender, HardTune,
+    LightingCommands, Megaphone, MicrophoneCommands, NoiseGateCommands, Pitch, ProfileAction,
+    ProfileType, Reverb, Robot, SamplerCommands, Scribbles, SubCommands, SubmixCommands,
 };
 use crate::microphone::apply_microphone_controls;
 use anyhow::{anyhow, Context, Result};
@@ -272,6 +272,29 @@ async fn main() -> Result<()> {
                 }
 
                 SubCommands::Lighting { command } => match command {
+                    LightingCommands::Animation { command } => match command {
+                        AnimationCommands::Mode { mode } => {
+                            client
+                                .command(&serial, GoXLRCommand::SetAnimationMode(*mode))
+                                .await?;
+                        }
+                        AnimationCommands::Mod1 { mod1 } => {
+                            client
+                                .command(&serial, GoXLRCommand::SetAnimationMod1(*mod1))
+                                .await?;
+                        }
+                        AnimationCommands::Mod2 { mod2 } => {
+                            client
+                                .command(&serial, GoXLRCommand::SetAnimationMod2(*mod2))
+                                .await?;
+                        }
+                        AnimationCommands::WaterFall { waterfall } => {
+                            client
+                                .command(&serial, GoXLRCommand::SetAnimationWaterfall(*waterfall))
+                                .await?;
+                        }
+                    },
+
                     LightingCommands::Global { colour } => {
                         client
                             .command(&serial, GoXLRCommand::SetGlobalColour(colour.to_string()))

daemon/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "goxlr-daemon"
-version = "0.12.1"
+version = "0.12.2"
 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."

daemon/src/device.rs

@@ -20,8 +20,9 @@ use goxlr_types::{
     Button, ChannelName, DisplayModeComponents, EffectBankPresets, EffectKey, EncoderName,
     FaderName, HardTuneSource, InputDevice as BasicInputDevice, MicrophoneParamKey, Mix, MuteState,
     OutputDevice as BasicOutputDevice, RobotRange, SampleBank, SampleButtons, SamplePlaybackMode,
-    VersionNumber,
+    VersionNumber, WaterfallDirection,
 };
+use goxlr_usb::animation::{AnimationMode, WaterFallDir};
 use goxlr_usb::buttonstate::{ButtonStates, Buttons};
 use goxlr_usb::channelstate::ChannelState;
 use goxlr_usb::channelstate::ChannelState::{Muted, Unmuted};
@@ -209,6 +210,8 @@ impl<'a> Device<'a> {
             sample_error.replace(error.clone());
         }
 
+        let is_mini = self.hardware.device_type == DeviceType::Mini;
+
         MixerStatus {
             hardware: self.hardware.clone(),
             shutdown_commands,
@@ -233,12 +236,10 @@ impl<'a> Device<'a> {
             },
             lighting: self
                 .profile
-                .get_lighting_ipc(self.hardware.device_type == DeviceType::Mini),
-            effects: self
-                .profile
-                .get_effects_ipc(self.hardware.device_type == DeviceType::Mini),
+                .get_lighting_ipc(is_mini, self.device_supports_animations()),
+            effects: self.profile.get_effects_ipc(is_mini),
             sampler: self.profile.get_sampler_ipc(
-                self.hardware.device_type == DeviceType::Mini,
+                is_mini,
                 &self.audio_handler,
                 sampler_prerecord,
                 SampleProcessState {
@@ -1631,6 +1632,39 @@ impl<'a> Device<'a> {
             }
 
             // Colouring..
+            GoXLRCommand::SetAnimationMode(mode) => {
+                if !self.device_supports_animations() {
+                    bail!("Animations not supported on this firmware.");
+                }
+
+                self.profile.set_animation_mode(mode)?;
+                self.load_animation(false)?;
+            }
+            GoXLRCommand::SetAnimationMod1(value) => {
+                if !self.device_supports_animations() {
+                    bail!("Animations not supported on this firmware.");
+                }
+
+                self.profile.set_animation_mod1(value)?;
+                self.load_animation(false)?;
+            }
+            GoXLRCommand::SetAnimationMod2(value) => {
+                if !self.device_supports_animations() {
+                    bail!("Animations not supported on this firmware.");
+                }
+
+                self.profile.set_animation_mod2(value)?;
+                self.load_animation(false)?;
+            }
+            GoXLRCommand::SetAnimationWaterfall(direction) => {
+                if !self.device_supports_animations() {
+                    bail!("Animations not supported on this firmware.");
+                }
+
+                self.profile.set_animation_waterfall(direction)?;
+                self.load_animation(false)?;
+            }
+
             GoXLRCommand::SetGlobalColour(colour) => {
                 self.profile.set_global_colour(colour)?;
                 self.load_colour_map()?;
@@ -2812,18 +2846,7 @@ impl<'a> Device<'a> {
         // The new colour format occurred on different firmware versions depending on device,
         // so do the check here.
 
-        let use_1_3_40_format: bool = match self.hardware.device_type {
-            DeviceType::Unknown => true,
-            DeviceType::Full => version_newer_or_equal_to(
-                &self.hardware.versions.firmware,
-                VersionNumber(1, 3, 40, 0),
-            ),
-            DeviceType::Mini => version_newer_or_equal_to(
-                &self.hardware.versions.firmware,
-                VersionNumber(1, 1, 8, 0),
-            ),
-        };
-
+        let use_1_3_40_format = self.device_supports_animations();
         let colour_map = self.profile.get_colour_map(use_1_3_40_format);
 
         if use_1_3_40_format {
@@ -2837,6 +2860,41 @@ impl<'a> Device<'a> {
         Ok(())
     }
 
+    fn load_animation(&mut self, map_set: bool) -> Result<()> {
+        let enabled = self.profile.get_animation_mode() != goxlr_types::AnimationMode::None;
+
+        // This one is kinda weird, we go from profile -> types -> usb..
+        let mode = match self.profile.get_animation_mode() {
+            goxlr_types::AnimationMode::RetroRainbow => AnimationMode::RetroRainbow,
+            goxlr_types::AnimationMode::RainbowDark => AnimationMode::RainbowDark,
+            goxlr_types::AnimationMode::RainbowBright => AnimationMode::RainbowBright,
+            goxlr_types::AnimationMode::Simple => AnimationMode::Simple,
+            goxlr_types::AnimationMode::Ripple => AnimationMode::Ripple,
+            goxlr_types::AnimationMode::None => AnimationMode::None,
+        };
+
+        let mod1 = self.profile.get_animation_mod1();
+        let mod2 = self.profile.get_animation_mod2();
+        let waterfall = match self.profile.get_animation_waterfall() {
+            WaterfallDirection::Down => WaterFallDir::Down,
+            WaterfallDirection::Up => WaterFallDir::Up,
+            WaterfallDirection::Off => WaterFallDir::Off,
+        };
+
+        self.goxlr
+            .set_animation_mode(enabled, mode, mod1, mod2, waterfall)?;
+
+        if !map_set
+            && (mode == AnimationMode::None
+                || mode == AnimationMode::Ripple
+                || mode == AnimationMode::Simple)
+        {
+            self.load_colour_map()?;
+        }
+
+        Ok(())
+    }
+
     async fn apply_profile(&mut self, current: Option<CurrentState>) -> Result<()> {
         // Set volumes first, applying mute may modify stuff..
         debug!("Applying Profile..");
@@ -2913,6 +2971,11 @@ impl<'a> Device<'a> {
         debug!("Loading Colour Map..");
         self.load_colour_map()?;
 
+        if self.device_supports_animations() {
+            // Load any animation settings..
+            self.load_animation(true)?;
+        }
+
         debug!("Setting Fader display modes..");
         for fader in FaderName::iter() {
             debug!("Setting display for {}", fader);
@@ -3251,6 +3314,20 @@ impl<'a> Device<'a> {
         }
     }
 
+    fn device_supports_animations(&self) -> bool {
+        match self.hardware.device_type {
+            DeviceType::Unknown => true,
+            DeviceType::Full => version_newer_or_equal_to(
+                &self.hardware.versions.firmware,
+                VersionNumber(1, 3, 40, 0),
+            ),
+            DeviceType::Mini => version_newer_or_equal_to(
+                &self.hardware.versions.firmware,
+                VersionNumber(1, 1, 8, 0),
+            ),
+        }
+    }
+
     // Get the current time in millis..
     fn get_epoch_ms(&self) -> u128 {
         SystemTime::now()