VibrationActuator should limit the duration of vibration effects

cdumez · cdumez · commit cebb0928942f · 2023-01-10T17:36:18.000-08:00
https://bugs.webkit.org/show_bug.cgi?id=250415 Reviewed by Brent Fulgham. VibrationActuator should limit the duration of vibration effects: - https://w3c.github.io/gamepad/extensions.html#gamepadeffectparameters-dictionary The specification recommends a maximum of 5 seconds. * Source/WebCore/Modules/gamepad/GamepadEffectParameters.h: * Source/WebCore/Modules/gamepad/GamepadHapticActuator.cpp: (WebCore::GamepadHapticActuator::playEffect): * Source/WebCore/platform/gamepad/cocoa/GameControllerHapticEffect.mm: (WebCore::GameControllerHapticEffect::create): Canonical link: https://commits.webkit.org/258759@main
diff --git a/Source/WebCore/Modules/gamepad/GamepadEffectParameters.h b/Source/WebCore/Modules/gamepad/GamepadEffectParameters.h
@@ -34,6 +34,10 @@ struct GamepadEffectParameters {
     double startDelay = 0.0;
     double strongMagnitude = 0.0;
     double weakMagnitude = 0.0;
+
+    // A maximum duration of 5 seconds is recommended by the specification:
+    // - https://w3c.github.io/gamepad/extensions.html#gamepadeffectparameters-dictionary
+    static constexpr Seconds maximumDuration = 5_s;
 };
 
 } // namespace WebCore
diff --git a/Source/WebCore/Modules/gamepad/GamepadHapticActuator.cpp b/Source/WebCore/Modules/gamepad/GamepadHapticActuator.cpp
@@ -87,6 +87,9 @@ void GamepadHapticActuator::playEffect(Document& document, EffectType effectType
         promise->reject(Exception { NotSupportedError, "This gamepad doesn't support playing such effect"_s });
         return;
     }
+
+    effectParameters.duration = std::min(effectParameters.duration, GamepadEffectParameters::maximumDuration.milliseconds());
+
     m_playingEffectPromise = WTFMove(promise);
     GamepadProvider::singleton().playEffect(m_gamepad->index(), m_gamepad->id(), effectType, effectParameters, [this, protectedThis = Ref { *this }, document = Ref { document }, playingEffectPromise = m_playingEffectPromise](bool success) {
         if (m_playingEffectPromise != playingEffectPromise)
diff --git a/Source/WebCore/platform/gamepad/cocoa/GameControllerHapticEffect.mm b/Source/WebCore/platform/gamepad/cocoa/GameControllerHapticEffect.mm
@@ -44,7 +44,7 @@
                 @{ CHHapticPatternKeyEvent: @{
                     CHHapticPatternKeyEventType: CHHapticEventTypeHapticContinuous,
                     CHHapticPatternKeyTime: [NSNumber numberWithDouble:std::max<double>(parameters.startDelay / 1000., 0)],
-                    CHHapticPatternKeyEventDuration: [NSNumber numberWithDouble:std::max<double>(parameters.duration / 1000., 0)],
+                    CHHapticPatternKeyEventDuration: [NSNumber numberWithDouble:std::clamp<double>(parameters.duration / 1000., 0, GamepadEffectParameters::maximumDuration.seconds())],
                     CHHapticPatternKeyEventParameters: @[ @{
                         CHHapticPatternKeyParameterID: CHHapticEventParameterIDHapticIntensity,
                         CHHapticPatternKeyParameterValue: [NSNumber numberWithDouble:std::clamp<double>(intensity, 0, 1)],
