feat: add volume control with the right stick and keys

Right stick up and down change the volume in steps of 5 and clicking it
mutes; + (or =), - and m do the same on a keyboard, on every screen. The
stick's dominant axis wins, so a diagonal push does not seek and change
the volume at once. Any step unmutes.

The level goes to playbin's volume on a cubic scale, so steps sound
even, and to its mute. A pill shows the level for a moment after each
change, the now-playing screen shows it under the times, and it is
saved in settings.toml once the changes stop and on quit.

Hint icons for the right stick and the keys are from Kenney's Input
Prompts 1.5, like the others.
This commit is contained in:
Ansho Rei
2026-11-04 15:18:17 +01:00
parent 5e1e120457
commit 0e7c63c09a
22 changed files with 349 additions and 6 deletions
+89
View File
@@ -65,6 +65,12 @@ pub fn shutdown() {
let app = APP.with(|cell| cell.borrow_mut().take());
if let Some(mut app) = app {
app.save_queue();
// A volume change made just before quitting is still waiting to save.
if app.volume_save_timer.running()
&& let Err(e) = config::save_settings(&app.settings)
{
log::warn!("saving settings: {e:#}");
}
if let Some(i) = app.inhibitor.take() {
i.shutdown();
}
@@ -247,6 +253,10 @@ pub struct App {
last_save: Instant,
login_focus: i32,
toast_timer: Timer,
/// Hides the volume overlay a moment after the last change.
volume_timer: Timer,
/// Saves the volume once a run of changes is over.
volume_save_timer: Timer,
/// Keyboard keys or the buttons of the controller used last.
prompts: Prompts,
/// Decoded hint icons, so a selection move does not parse SVG again.
@@ -323,6 +333,8 @@ impl App {
last_save: Instant::now(),
login_focus: 0,
toast_timer: Timer::default(),
volume_timer: Timer::default(),
volume_save_timer: Timer::default(),
art_shown: None,
flip_timer: Timer::default(),
prompts: Prompts::Keyboard,
@@ -352,6 +364,7 @@ impl App {
self.toast(format!("Playback unavailable: {e:#}"));
}
}
self.apply_volume();
match config::load() {
Ok(Some(cfg)) => {
@@ -509,6 +522,16 @@ impl App {
w.set_fullscreen(!w.is_fullscreen());
return;
}
// Everywhere, the login screen included.
Action::VolumeUp | Action::VolumeDown => {
self.change_volume(a == Action::VolumeUp);
return;
}
Action::ToggleMute => {
self.settings.muted = !self.settings.muted;
self.volume_changed();
return;
}
_ => {}
}
match self.screen {
@@ -935,6 +958,53 @@ impl App {
self.ui.set_np_backdrop_right(right);
}
// ---------------------------------------------------------------- volume
fn change_volume(&mut self, up: bool) {
let v = step_volume(self.settings.volume, up);
// Any change unmutes, as on a phone: turning it up while muted should
// be heard.
let unmute = self.settings.muted;
if v == self.settings.volume && !unmute {
self.show_volume();
return;
}
self.settings.volume = v;
self.settings.muted = false;
self.volume_changed();
}
fn volume_changed(&mut self) {
self.apply_volume();
self.show_volume();
// Saved once the changes stop, not for every step of a held stick.
self.volume_save_timer
.start(slint::TimerMode::SingleShot, Duration::from_millis(800), || {
with_app(|app| {
if let Err(e) = config::save_settings(&app.settings) {
app.toast(format!("Could not save settings: {e:#}"));
}
})
});
}
fn apply_volume(&self) {
if let Some(p) = &self.player {
p.set_volume(self.settings.volume);
p.set_muted(self.settings.muted);
}
self.ui.set_volume(self.settings.volume as i32);
self.ui.set_muted(self.settings.muted);
}
fn show_volume(&mut self) {
self.ui.set_volume_shown(true);
self.volume_timer
.start(slint::TimerMode::SingleShot, Duration::from_millis(1500), || {
with_app(|app| app.ui.set_volume_shown(false))
});
}
// ---------------------------------------------------------------- theme
/// The palette the UI should show: from the playing track's cover when
@@ -1428,6 +1498,8 @@ impl App {
h(Control::PlayPause, "Play / Pause");
h(Control::Skip, "Skip");
h(Control::Seek, "Seek");
h(Control::Volume, "Volume");
h(Control::Mute, "Mute");
}
}
self.ui.set_hints(ModelRc::new(VecModel::from(hints)));
@@ -2181,6 +2253,12 @@ fn settings_data(s: &Settings) -> PageData {
}
}
/// One step of the volume, kept within 0 to 100.
fn step_volume(v: u8, up: bool) -> u8 {
let v = v.min(100);
if up { (v + 5).min(100) } else { v.saturating_sub(5) }
}
/// One step of the cover backdrop setting, kept within 0 to 100.
fn step_backdrop(v: u8, up: bool) -> u8 {
let v = v.min(100);
@@ -2396,6 +2474,17 @@ mod tests {
assert_ne!(a, c);
}
#[test]
fn volume_steps_stay_in_range() {
assert_eq!(step_volume(50, true), 55);
assert_eq!(step_volume(50, false), 45);
assert_eq!(step_volume(100, true), 100);
assert_eq!(step_volume(98, true), 100);
assert_eq!(step_volume(0, false), 0);
assert_eq!(step_volume(3, false), 0);
assert_eq!(step_volume(200, false), 95);
}
#[test]
fn default_backdrop_looks_like_before_it_was_a_setting() {
assert_eq!(backdrop_look(config::COVER_BACKDROP_DEFAULT), (0.16, 0.67, 0.95));
+10
View File
@@ -95,6 +95,10 @@ pub struct Settings {
pub album_art_colours: bool,
/// How strongly the cover shows behind the now-playing screen, 0 to 100.
pub cover_backdrop: u8,
/// Playback volume, 0 to 100. Only remus's own stream, not the system's.
pub volume: u8,
/// Muted, keeping `volume` for when it is unmuted.
pub muted: bool,
}
/// The cover backdrop strength that looks like it did before it was a setting.
@@ -105,6 +109,8 @@ impl Default for Settings {
Settings {
album_art_colours: false,
cover_backdrop: COVER_BACKDROP_DEFAULT,
volume: 100,
muted: false,
}
}
}
@@ -208,6 +214,8 @@ mod tests {
assert_eq!(s, Settings::default());
assert!(!s.album_art_colours);
assert_eq!(s.cover_backdrop, COVER_BACKDROP_DEFAULT);
assert_eq!(s.volume, 100);
assert!(!s.muted);
}
#[test]
@@ -222,6 +230,8 @@ mod tests {
let s = Settings {
album_art_colours: true,
cover_backdrop: 70,
volume: 35,
muted: true,
};
let back: Settings = toml::from_str(&toml::to_string(&s).unwrap()).unwrap();
assert_eq!(back, s);
+3
View File
@@ -91,6 +91,9 @@ fn step(ui: slint::Weak<AppWindow>, steps: Vec<String>, i: usize) {
"now-playing" => Action::NowPlaying,
"search" => Action::Search,
"quit" => Action::Quit,
"volume-up" => Action::VolumeUp,
"volume-down" => Action::VolumeDown,
"mute" => Action::ToggleMute,
other => {
log::warn!("unknown dev script step {other}");
Action::None
+9 -3
View File
@@ -93,7 +93,7 @@ pub fn spawn_gamepad(emit: impl Fn(PadEvent) + Send + 'static) {
EventType::AxisChanged(axis, value, _) => {
let source = match axis {
Axis::LeftStickX | Axis::LeftStickY => Source::LeftStick,
Axis::RightStickX => Source::RightStick,
Axis::RightStickX | Axis::RightStickY => Source::RightStick,
_ => continue,
};
let pad = gilrs.gamepad(ev.id);
@@ -226,6 +226,7 @@ fn button_action(b: Button) -> Option<Action> {
Button::RightTrigger2 => Action::SectionNext,
Button::Start => Action::NowPlaying,
Button::Select => Action::Search,
Button::RightThumb => Action::ToggleMute,
_ => return None,
})
}
@@ -247,12 +248,17 @@ fn stick_direction(source: Source, pad: &gilrs::Gamepad<'_>, _changed: f32, held
Some(if y > 0.0 { Action::Up } else { Action::Down })
}
}
// Across seeks, up and down set the volume. The dominant axis wins, so
// a diagonal push does only one of them.
Source::RightStick => {
let x = pad.value(Axis::RightStickX);
if x.abs() < threshold {
let y = pad.value(Axis::RightStickY);
if x.abs() < threshold && y.abs() < threshold {
None
} else {
} else if x.abs() > y.abs() {
Some(if x > 0.0 { Action::SeekForward } else { Action::SeekBack })
} else {
Some(if y > 0.0 { Action::VolumeUp } else { Action::VolumeDown })
}
}
Source::DPad => None,
+11
View File
@@ -177,6 +177,17 @@ impl Player {
}
}
/// Sets remus's own playback volume, 0 to 100. Cubic, so equal steps
/// sound equally loud apart.
pub fn set_volume(&self, level: u8) {
let v = level.min(100) as f64 / 100.0;
self.playbin.set_property("volume", v * v * v);
}
pub fn set_muted(&self, muted: bool) {
self.playbin.set_property("mute", muted);
}
pub fn seek(&self, seconds: f64) {
let Some(pos) = self.playbin.query_position::<gst::ClockTime>() else {
return;
+15 -1
View File
@@ -33,6 +33,8 @@ pub enum Control {
Search,
NowPlaying,
Seek,
Volume,
Mute,
/// Steam + X brings up Steam's on-screen keyboard. Nothing to show for a
/// real keyboard.
OnScreenKeyboard,
@@ -40,7 +42,7 @@ pub enum Control {
#[cfg(test)]
impl Control {
pub const ALL: [Control; 10] = [
pub const ALL: [Control; 12] = [
Control::Activate,
Control::Back,
Control::PlayPause,
@@ -50,6 +52,8 @@ impl Control {
Control::Search,
Control::NowPlaying,
Control::Seek,
Control::Volume,
Control::Mute,
Control::OnScreenKeyboard,
];
}
@@ -75,6 +79,8 @@ pub fn icons(prompts: Prompts, control: Control) -> &'static [&'static [u8]] {
Search => &[icon!("keyboard", "keyboard_slash_forward")],
NowPlaying => &[icon!("keyboard", "keyboard_f")],
Seek => &[icon!("keyboard", "keyboard_arrows_horizontal")],
Volume => &[icon!("keyboard", "keyboard_minus"), icon!("keyboard", "keyboard_plus")],
Mute => &[icon!("keyboard", "keyboard_m")],
OnScreenKeyboard => &[],
},
Prompts::Pad(Family::Xbox) => match control {
@@ -87,6 +93,8 @@ pub fn icons(prompts: Prompts, control: Control) -> &'static [&'static [u8]] {
Search => &[icon!("xbox", "xbox_button_view")],
NowPlaying => &[icon!("xbox", "xbox_button_menu")],
Seek => &[icon!("xbox", "xbox_dpad_horizontal")],
Volume => &[icon!("xbox", "xbox_stick_r_vertical")],
Mute => &[icon!("xbox", "xbox_stick_r_press")],
OnScreenKeyboard => &[icon!("xbox", "xbox_guide"), icon!("xbox", "xbox_button_color_x")],
},
Prompts::Pad(Family::PlayStation) => match control {
@@ -105,6 +113,8 @@ pub fn icons(prompts: Prompts, control: Control) -> &'static [&'static [u8]] {
Search => &[icon!("playstation", "playstation5_button_create")],
NowPlaying => &[icon!("playstation", "playstation5_button_options")],
Seek => &[icon!("playstation", "playstation_dpad_horizontal")],
Volume => &[icon!("playstation", "playstation_stick_r_vertical")],
Mute => &[icon!("playstation", "playstation_stick_r_press")],
// The pack has no PS button; Steam's own label says the same thing.
OnScreenKeyboard => &[
icon!("steamdeck", "steamdeck_button_guide"),
@@ -122,6 +132,8 @@ pub fn icons(prompts: Prompts, control: Control) -> &'static [&'static [u8]] {
Search => &[icon!("switch", "switch_button_minus")],
NowPlaying => &[icon!("switch", "switch_button_plus")],
Seek => &[icon!("switch", "switch_dpad_horizontal")],
Volume => &[icon!("switch", "switch_stick_r_vertical")],
Mute => &[icon!("switch", "switch_stick_r_press")],
OnScreenKeyboard => &[
icon!("switch", "switch_button_home"),
icon!("switch", "switch_button_y"),
@@ -143,6 +155,8 @@ pub fn icons(prompts: Prompts, control: Control) -> &'static [&'static [u8]] {
Search => &[icon!("steamdeck", "steamdeck_button_view")],
NowPlaying => &[icon!("steamdeck", "steamdeck_button_options")],
Seek => &[icon!("steamdeck", "steamdeck_dpad_horizontal")],
Volume => &[icon!("steamdeck", "steamdeck_stick_r_vertical")],
Mute => &[icon!("steamdeck", "steamdeck_stick_r_press")],
OnScreenKeyboard => &[
icon!("steamdeck", "steamdeck_button_guide"),
icon!("steamdeck", "steamdeck_button_x"),