mirror of
https://github.com/servo/servo.git
synced 2025-10-04 02:29:12 +01:00
5f08e4fa76
Signed-off-by: Martin Robinson <mrobinson@igalia.com> Co-authored-by: Delan Azabani <dazabani@igalia.com> Co-authored-by: Mukilan Thiyagarajan <mukilan@igalia.com>
230 lines
9.6 KiB
Rust
230 lines
9.6 KiB
Rust
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
|
|
|
|
use std::collections::HashMap;
|
|
|
|
use gilrs::ff::{BaseEffect, BaseEffectType, Effect, EffectBuilder, Repeat, Replay, Ticks};
|
|
use gilrs::{EventType, Gilrs};
|
|
use log::{debug, warn};
|
|
use servo::ipc_channel::ipc::IpcSender;
|
|
use servo::{
|
|
GamepadEvent, GamepadHapticEffectType, GamepadIndex, GamepadInputBounds,
|
|
GamepadSupportedHapticEffects, GamepadUpdateType, WebView,
|
|
};
|
|
|
|
pub struct HapticEffect {
|
|
pub effect: Effect,
|
|
pub sender: IpcSender<bool>,
|
|
}
|
|
|
|
pub(crate) struct GamepadSupport {
|
|
handle: Gilrs,
|
|
haptic_effects: HashMap<usize, HapticEffect>,
|
|
}
|
|
|
|
impl GamepadSupport {
|
|
pub(crate) fn maybe_new() -> Option<Self> {
|
|
let handle = match Gilrs::new() {
|
|
Ok(handle) => handle,
|
|
Err(error) => {
|
|
warn!("Error creating gamepad input connection ({error})");
|
|
return None;
|
|
},
|
|
};
|
|
Some(Self {
|
|
handle,
|
|
haptic_effects: Default::default(),
|
|
})
|
|
}
|
|
|
|
/// Handle updates to connected gamepads from GilRs
|
|
pub(crate) fn handle_gamepad_events(&mut self, active_webview: WebView) {
|
|
while let Some(event) = self.handle.next_event() {
|
|
let gamepad = self.handle.gamepad(event.id);
|
|
let name = gamepad.name();
|
|
let index = GamepadIndex(event.id.into());
|
|
let mut gamepad_event: Option<GamepadEvent> = None;
|
|
match event.event {
|
|
EventType::ButtonPressed(button, _) => {
|
|
let mapped_index = Self::map_gamepad_button(button);
|
|
// We only want to send this for a valid digital button, aka on/off only
|
|
if !matches!(mapped_index, 6 | 7 | 17) {
|
|
let update_type = GamepadUpdateType::Button(mapped_index, 1.0);
|
|
gamepad_event = Some(GamepadEvent::Updated(index, update_type));
|
|
}
|
|
},
|
|
EventType::ButtonReleased(button, _) => {
|
|
let mapped_index = Self::map_gamepad_button(button);
|
|
// We only want to send this for a valid digital button, aka on/off only
|
|
if !matches!(mapped_index, 6 | 7 | 17) {
|
|
let update_type = GamepadUpdateType::Button(mapped_index, 0.0);
|
|
gamepad_event = Some(GamepadEvent::Updated(index, update_type));
|
|
}
|
|
},
|
|
EventType::ButtonChanged(button, value, _) => {
|
|
let mapped_index = Self::map_gamepad_button(button);
|
|
// We only want to send this for a valid non-digital button, aka the triggers
|
|
if matches!(mapped_index, 6 | 7) {
|
|
let update_type = GamepadUpdateType::Button(mapped_index, value as f64);
|
|
gamepad_event = Some(GamepadEvent::Updated(index, update_type));
|
|
}
|
|
},
|
|
EventType::AxisChanged(axis, value, _) => {
|
|
// Map axis index and value to represent Standard Gamepad axis
|
|
// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-axis>
|
|
let mapped_axis: usize = match axis {
|
|
gilrs::Axis::LeftStickX => 0,
|
|
gilrs::Axis::LeftStickY => 1,
|
|
gilrs::Axis::RightStickX => 2,
|
|
gilrs::Axis::RightStickY => 3,
|
|
_ => 4, // Other axes do not map to "standard" gamepad mapping and are ignored
|
|
};
|
|
if mapped_axis < 4 {
|
|
// The Gamepad spec designates down as positive and up as negative.
|
|
// GilRs does the inverse of this, so correct for it here.
|
|
let axis_value = match mapped_axis {
|
|
0 | 2 => value,
|
|
1 | 3 => -value,
|
|
_ => 0., // Should not reach here
|
|
};
|
|
let update_type = GamepadUpdateType::Axis(mapped_axis, axis_value as f64);
|
|
gamepad_event = Some(GamepadEvent::Updated(index, update_type));
|
|
}
|
|
},
|
|
EventType::Connected => {
|
|
let name = String::from(name);
|
|
let bounds = GamepadInputBounds {
|
|
axis_bounds: (-1.0, 1.0),
|
|
button_bounds: (0.0, 1.0),
|
|
};
|
|
// GilRs does not yet support trigger rumble
|
|
let supported_haptic_effects = GamepadSupportedHapticEffects {
|
|
supports_dual_rumble: true,
|
|
supports_trigger_rumble: false,
|
|
};
|
|
gamepad_event = Some(GamepadEvent::Connected(
|
|
index,
|
|
name,
|
|
bounds,
|
|
supported_haptic_effects,
|
|
));
|
|
},
|
|
EventType::Disconnected => {
|
|
gamepad_event = Some(GamepadEvent::Disconnected(index));
|
|
},
|
|
EventType::ForceFeedbackEffectCompleted => {
|
|
let Some(effect) = self.haptic_effects.get(&event.id.into()) else {
|
|
warn!("Failed to find haptic effect for id {}", event.id);
|
|
return;
|
|
};
|
|
effect
|
|
.sender
|
|
.send(true)
|
|
.expect("Failed to send haptic effect completion.");
|
|
self.haptic_effects.remove(&event.id.into());
|
|
},
|
|
_ => {},
|
|
}
|
|
|
|
if let Some(event) = gamepad_event {
|
|
active_webview.notify_gamepad_event(event);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Map button index and value to represent Standard Gamepad button
|
|
// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-button>
|
|
fn map_gamepad_button(button: gilrs::Button) -> usize {
|
|
match button {
|
|
gilrs::Button::South => 0,
|
|
gilrs::Button::East => 1,
|
|
gilrs::Button::West => 2,
|
|
gilrs::Button::North => 3,
|
|
gilrs::Button::LeftTrigger => 4,
|
|
gilrs::Button::RightTrigger => 5,
|
|
gilrs::Button::LeftTrigger2 => 6,
|
|
gilrs::Button::RightTrigger2 => 7,
|
|
gilrs::Button::Select => 8,
|
|
gilrs::Button::Start => 9,
|
|
gilrs::Button::LeftThumb => 10,
|
|
gilrs::Button::RightThumb => 11,
|
|
gilrs::Button::DPadUp => 12,
|
|
gilrs::Button::DPadDown => 13,
|
|
gilrs::Button::DPadLeft => 14,
|
|
gilrs::Button::DPadRight => 15,
|
|
gilrs::Button::Mode => 16,
|
|
_ => 17, // Other buttons do not map to "standard" gamepad mapping and are ignored
|
|
}
|
|
}
|
|
|
|
pub(crate) fn play_haptic_effect(
|
|
&mut self,
|
|
index: usize,
|
|
effect_type: GamepadHapticEffectType,
|
|
effect_complete_sender: IpcSender<bool>,
|
|
) {
|
|
let GamepadHapticEffectType::DualRumble(params) = effect_type;
|
|
if let Some(connected_gamepad) = self
|
|
.handle
|
|
.gamepads()
|
|
.find(|gamepad| usize::from(gamepad.0) == index)
|
|
{
|
|
let start_delay = Ticks::from_ms(params.start_delay as u32);
|
|
let duration = Ticks::from_ms(params.duration as u32);
|
|
let strong_magnitude = (params.strong_magnitude * u16::MAX as f64).round() as u16;
|
|
let weak_magnitude = (params.weak_magnitude * u16::MAX as f64).round() as u16;
|
|
|
|
let scheduling = Replay {
|
|
after: start_delay,
|
|
play_for: duration,
|
|
with_delay: Ticks::from_ms(0),
|
|
};
|
|
let effect = EffectBuilder::new()
|
|
.add_effect(BaseEffect {
|
|
kind: BaseEffectType::Strong { magnitude: strong_magnitude },
|
|
scheduling,
|
|
envelope: Default::default(),
|
|
})
|
|
.add_effect(BaseEffect {
|
|
kind: BaseEffectType::Weak { magnitude: weak_magnitude },
|
|
scheduling,
|
|
envelope: Default::default(),
|
|
})
|
|
.repeat(Repeat::For(start_delay + duration))
|
|
.add_gamepad(&connected_gamepad.1)
|
|
.finish(&mut self.handle)
|
|
.expect("Failed to create haptic effect, ensure connected gamepad supports force feedback.");
|
|
self.haptic_effects.insert(
|
|
index,
|
|
HapticEffect {
|
|
effect,
|
|
sender: effect_complete_sender,
|
|
},
|
|
);
|
|
self.haptic_effects[&index]
|
|
.effect
|
|
.play()
|
|
.expect("Failed to play haptic effect.");
|
|
} else {
|
|
debug!("Couldn't find connected gamepad to play haptic effect on");
|
|
}
|
|
}
|
|
|
|
pub(crate) fn stop_haptic_effect(&mut self, index: usize) -> bool {
|
|
let Some(haptic_effect) = self.haptic_effects.get(&index) else {
|
|
return false;
|
|
};
|
|
|
|
let stopped_successfully = match haptic_effect.effect.stop() {
|
|
Ok(()) => true,
|
|
Err(e) => {
|
|
debug!("Failed to stop haptic effect: {:?}", e);
|
|
false
|
|
},
|
|
};
|
|
self.haptic_effects.remove(&index);
|
|
|
|
stopped_successfully
|
|
}
|
|
}
|