Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reduce input processing overheads in PassThroughInputManager #6120

Merged
merged 6 commits into from
Jan 11, 2024
Merged

Reduce input processing overheads in PassThroughInputManager #6120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
41b7c32
Remove allocation overhead for touch input processing
peppy Jan 10, 2024
de5ad34
Optimise away all allocations during input `PassThroughInputManager` …
peppy Jan 10, 2024
91185b1
Avoid applying no-op mouse movement in `PassThroughInputManager`
peppy Jan 10, 2024
145ea2c
Remove todo
peppy Jan 10, 2024
8020cd8
Fix incorrect midi velocity source for releases
peppy Jan 10, 2024
1f881be
Fix query of potentially-nonexistent key velocity
bdach Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
71 changes: 52 additions & 19 deletions osu.Framework/Input/PassThroughInputManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
using osu.Framework.Input.States;
using osuTK;
using osuTK.Input;
using JoystickState = osu.Framework.Input.States.JoystickState;

namespace osu.Framework.Input
{
Expand Down Expand Up @@ -94,7 +95,8 @@ protected override bool Handle(UIEvent e)
switch (e)
{
case MouseMoveEvent mouseMove:
new MousePositionAbsoluteInput { Position = mouseMove.ScreenSpaceMousePosition }.Apply(CurrentState, this);
if (mouseMove.ScreenSpaceMousePosition != CurrentState.Mouse.Position)
new MousePositionAbsoluteInput { Position = mouseMove.ScreenSpaceMousePosition }.Apply(CurrentState, this);
break;

case MouseDownEvent mouseDown:
Expand Down Expand Up @@ -170,28 +172,59 @@ public void Sync(bool useCachedParentInputManager = false)
/// <param name="state">The state to synchronise current with. If this is null, it is regarded as an empty state.</param>
protected virtual void SyncInputState(InputState state)
{
// TODO: THIS IS ALL VERY HEAVY ALLOCATION AND NEEDS TO BE REMOVED.
// Using this class outside of a testing situation is not recommended...

// invariant: if mouse button is currently pressed, then it has been pressed in parent (but not the converse)
// therefore, mouse up events are always synced from parent
// mouse down events are not synced to prevent false clicks
var mouseButtonDifference = (state?.Mouse?.Buttons ?? new ButtonStates<MouseButton>()).EnumerateDifference(CurrentState.Mouse.Buttons);
new MouseButtonInput(mouseButtonDifference.Released.Select(button => new ButtonInputEntry<MouseButton>(button, false))).Apply(CurrentState, this);

new KeyboardKeyInput(state?.Keyboard?.Keys, CurrentState.Keyboard.Keys).Apply(CurrentState, this);

var touchStateDifference = (state?.Touch ?? new TouchState()).EnumerateDifference(CurrentState.Touch);
new TouchInput(touchStateDifference.deactivated, false).Apply(CurrentState, this);
new TouchInput(touchStateDifference.activated, true).Apply(CurrentState, this);

new JoystickButtonInput(state?.Joystick?.Buttons ?? new ButtonStates<JoystickButton>(), CurrentState.Joystick.Buttons).Apply(CurrentState, this);
new JoystickAxisInput(state?.Joystick?.GetAxes() ?? Array.Empty<JoystickAxis>()).Apply(CurrentState, this);

new MidiKeyInput(state?.Midi ?? new MidiState(), CurrentState.Midi).Apply(CurrentState, this);
var mouseDiff = (state?.Mouse?.Buttons ?? new ButtonStates<MouseButton>()).EnumerateDifference(CurrentState.Mouse.Buttons);
if (mouseDiff.Released.Length > 0)
new MouseButtonInput(mouseDiff.Released.Select(button => new ButtonInputEntry<MouseButton>(button, false))).Apply(CurrentState, this);

var keyDiff = (state?.Keyboard.Keys ?? new ButtonStates<Key>()).EnumerateDifference(CurrentState.Keyboard.Keys);
foreach (var key in keyDiff.Released)
new KeyboardKeyInput(key, false).Apply(CurrentState, this);
foreach (var key in keyDiff.Pressed)
new KeyboardKeyInput(key, true).Apply(CurrentState, this);

var touchDiff = (state?.Touch ?? new TouchState()).EnumerateDifference(CurrentState.Touch);
if (touchDiff.deactivated.Length > 0)
new TouchInput(touchDiff.deactivated, false).Apply(CurrentState, this);
if (touchDiff.activated.Length > 0)
new TouchInput(touchDiff.activated, true).Apply(CurrentState, this);

var joyButtonDiff = (state?.Joystick?.Buttons ?? new ButtonStates<JoystickButton>()).EnumerateDifference(CurrentState.Joystick.Buttons);
foreach (var button in joyButtonDiff.Released)
new JoystickButtonInput(button, false).Apply(CurrentState, this);
foreach (var button in joyButtonDiff.Pressed)
new JoystickButtonInput(button, true).Apply(CurrentState, this);

// Basically only perform the full state diff if we have found that any axis changed.
// This avoids unnecessary alloc overhead.
for (int i = 0; i < JoystickState.MAX_AXES; i++)
{
if (state?.Joystick?.AxesValues[i] != CurrentState.Joystick.AxesValues[i])
{
new JoystickAxisInput(state?.Joystick?.GetAxes() ?? Array.Empty<JoystickAxis>()).Apply(CurrentState, this);
break;
}
}

new TabletPenButtonInput(state?.Tablet.PenButtons ?? new ButtonStates<TabletPenButton>(), CurrentState.Tablet.PenButtons).Apply(CurrentState, this);
new TabletAuxiliaryButtonInput(state?.Tablet.AuxiliaryButtons ?? new ButtonStates<TabletAuxiliaryButton>(), CurrentState.Tablet.AuxiliaryButtons).Apply(CurrentState, this);
var midiDiff = (state?.Midi?.Keys ?? new ButtonStates<MidiKey>()).EnumerateDifference(CurrentState.Midi.Keys);
foreach (var key in midiDiff.Released)
new MidiKeyInput(key, state?.Midi?.Velocities.GetValueOrDefault(key) ?? 0, false).Apply(CurrentState, this);
foreach (var key in midiDiff.Pressed)
new MidiKeyInput(key, state?.Midi?.Velocities.GetValueOrDefault(key) ?? 0, true).Apply(CurrentState, this);

var tabletPenDiff = (state?.Tablet?.PenButtons ?? new ButtonStates<TabletPenButton>()).EnumerateDifference(CurrentState.Tablet.PenButtons);
foreach (var button in tabletPenDiff.Released)
new TabletPenButtonInput(button, false).Apply(CurrentState, this);
foreach (var button in tabletPenDiff.Pressed)
new TabletPenButtonInput(button, true).Apply(CurrentState, this);

var tabletAuxiliaryDiff = (state?.Tablet?.AuxiliaryButtons ?? new ButtonStates<TabletAuxiliaryButton>()).EnumerateDifference(CurrentState.Tablet.AuxiliaryButtons);
foreach (var button in tabletAuxiliaryDiff.Released)
new TabletAuxiliaryButtonInput(button, false).Apply(CurrentState, this);
foreach (var button in tabletAuxiliaryDiff.Pressed)
new TabletAuxiliaryButtonInput(button, true).Apply(CurrentState, this);
}
}
}
34 changes: 25 additions & 9 deletions osu.Framework/Input/States/TouchState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
// See the LICENCE file in the repository root for full licence text.

using System;
using System.Collections.Generic;
using System.Linq;
using osuTK;

namespace osu.Framework.Input.States
Expand Down Expand Up @@ -46,15 +44,33 @@ public class TouchState
/// Enumerates the difference between this state and a <param ref="previous"/> state.
/// </summary>
/// <param name="previous">The previous state.</param>
public (IEnumerable<Touch> deactivated, IEnumerable<Touch> activated) EnumerateDifference(TouchState previous)
public (Touch[] deactivated, Touch[] activated) EnumerateDifference(TouchState previous)
{
var activityDifference = ActiveSources.EnumerateDifference(previous.ActiveSources);
var diff = ActiveSources.EnumerateDifference(previous.ActiveSources);

return
(
activityDifference.Released.Select(s => new Touch(s, previous.TouchPositions[(int)s])),
activityDifference.Pressed.Select(s => new Touch(s, TouchPositions[(int)s]))
);
int pressedCount = diff.Pressed.Length;
int releasedCount = diff.Released.Length;

if (pressedCount == 0 && releasedCount == 0)
return (Array.Empty<Touch>(), Array.Empty<Touch>());

Touch[] pressedTouches = new Touch[pressedCount];

for (int i = 0; i < pressedCount; i++)
{
var s = diff.Pressed[i];
pressedTouches[i] = new Touch(s, TouchPositions[(int)s]);
}

Touch[] releasedTouches = new Touch[releasedCount];

for (int i = 0; i < releasedCount; i++)
{
var s = diff.Released[i];
releasedTouches[i] = new Touch(s, previous.TouchPositions[(int)s]);
}

return (releasedTouches, pressedTouches);
}
}
}