blob: 6485ab2159a4591dd0d57a742e5221711fcf0f8d [file] [log] [blame]
Prabir Pradhanbaa5c822019-08-30 15:27:05 -07001/*
2 * Copyright (C) 2019 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Prabir Pradhan48108662022-09-09 21:22:04 +000017#pragma once
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070018
Harry Cutts3f570c72024-04-05 16:44:28 +000019#include <array>
20#include <climits>
21#include <limits>
22#include <list>
23#include <memory>
Harry Cuttsf13161a2023-03-08 14:15:49 +000024#include <optional>
25#include <string>
Harry Cutts3f570c72024-04-05 16:44:28 +000026#include <utility>
27#include <vector>
Harry Cuttsf13161a2023-03-08 14:15:49 +000028
Michael Wright227c5542020-07-02 18:30:52 +010029#include <stdint.h>
Harry Cutts3f570c72024-04-05 16:44:28 +000030#include <gui/constants.h>
31#include <input/DisplayViewport.h>
32#include <input/Input.h>
33#include <input/InputDevice.h>
34#include <input/VelocityControl.h>
35#include <input/VelocityTracker.h>
36#include <ui/Rect.h>
Michael Wrighta9cf4192022-12-01 23:46:39 +000037#include <ui/Rotation.h>
Harry Cutts3f570c72024-04-05 16:44:28 +000038#include <ui/Size.h>
39#include <ui/Transform.h>
40#include <utils/BitSet.h>
41#include <utils/Timers.h>
Michael Wright227c5542020-07-02 18:30:52 +010042
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070043#include "CursorButtonAccumulator.h"
44#include "CursorScrollAccumulator.h"
45#include "EventHub.h"
46#include "InputMapper.h"
47#include "InputReaderBase.h"
Harry Cutts3f570c72024-04-05 16:44:28 +000048#include "NotifyArgs.h"
Harry Cutts3f570c72024-04-05 16:44:28 +000049#include "StylusState.h"
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070050#include "TouchButtonAccumulator.h"
51
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070052namespace android {
53
Prabir Pradhan7d04c4b2022-10-28 19:23:26 +000054// Maximum amount of latency to add to touch events while waiting for data from an
55// external stylus.
56static constexpr nsecs_t EXTERNAL_STYLUS_DATA_TIMEOUT = ms2ns(72);
57
58// Maximum amount of time to wait on touch data before pushing out new pressure data.
59static constexpr nsecs_t TOUCH_DATA_TIMEOUT = ms2ns(20);
60
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070061/* Raw axis information from the driver. */
62struct RawPointerAxes {
Prabir Pradhand6ccedb2022-09-27 21:04:06 +000063 RawAbsoluteAxisInfo x{};
64 RawAbsoluteAxisInfo y{};
65 RawAbsoluteAxisInfo pressure{};
66 RawAbsoluteAxisInfo touchMajor{};
67 RawAbsoluteAxisInfo touchMinor{};
68 RawAbsoluteAxisInfo toolMajor{};
69 RawAbsoluteAxisInfo toolMinor{};
70 RawAbsoluteAxisInfo orientation{};
71 RawAbsoluteAxisInfo distance{};
72 RawAbsoluteAxisInfo tiltX{};
73 RawAbsoluteAxisInfo tiltY{};
74 RawAbsoluteAxisInfo trackingId{};
75 RawAbsoluteAxisInfo slot{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070076
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070077 inline int32_t getRawWidth() const { return x.maxValue - x.minValue + 1; }
78 inline int32_t getRawHeight() const { return y.maxValue - y.minValue + 1; }
Prabir Pradhand6ccedb2022-09-27 21:04:06 +000079 inline void clear() { *this = RawPointerAxes(); }
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070080};
81
Prabir Pradhand6ccedb2022-09-27 21:04:06 +000082using PropertiesArray = std::array<PointerProperties, MAX_POINTERS>;
83using CoordsArray = std::array<PointerCoords, MAX_POINTERS>;
84using IdToIndexArray = std::array<uint32_t, MAX_POINTER_ID + 1>;
85
Prabir Pradhanbaa5c822019-08-30 15:27:05 -070086/* Raw data for a collection of pointers including a pointer id mapping table. */
87struct RawPointerData {
88 struct Pointer {
Prabir Pradhand6ccedb2022-09-27 21:04:06 +000089 uint32_t id{0xFFFFFFFF};
90 int32_t x{};
91 int32_t y{};
92 int32_t pressure{};
93 int32_t touchMajor{};
94 int32_t touchMinor{};
95 int32_t toolMajor{};
96 int32_t toolMinor{};
97 int32_t orientation{};
98 int32_t distance{};
99 int32_t tiltX{};
100 int32_t tiltY{};
Siarhei Vishniakou6d73f832022-07-21 17:27:03 -0700101 // A fully decoded ToolType constant.
102 ToolType toolType{ToolType::UNKNOWN};
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000103 bool isHovering{false};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700104 };
105
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000106 uint32_t pointerCount{};
107 std::array<Pointer, MAX_POINTERS> pointers{};
108 BitSet32 hoveringIdBits{}, touchingIdBits{}, canceledIdBits{};
109 IdToIndexArray idToIndex{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700110
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000111 inline void clear() { *this = RawPointerData(); }
112
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700113 void getCentroidOfTouchingPointers(float* outX, float* outY) const;
114
115 inline void markIdBit(uint32_t id, bool isHovering) {
116 if (isHovering) {
117 hoveringIdBits.markBit(id);
118 } else {
119 touchingIdBits.markBit(id);
120 }
121 }
122
123 inline void clearIdBits() {
124 hoveringIdBits.clear();
125 touchingIdBits.clear();
arthurhungcc7f9802020-04-30 17:55:40 +0800126 canceledIdBits.clear();
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700127 }
128
129 inline const Pointer& pointerForId(uint32_t id) const { return pointers[idToIndex[id]]; }
130
131 inline bool isHovering(uint32_t pointerIndex) { return pointers[pointerIndex].isHovering; }
132};
133
134/* Cooked data for a collection of pointers including a pointer id mapping table. */
135struct CookedPointerData {
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000136 uint32_t pointerCount{};
137 PropertiesArray pointerProperties{};
138 CoordsArray pointerCoords{};
139 BitSet32 hoveringIdBits{}, touchingIdBits{}, canceledIdBits{}, validIdBits{};
140 IdToIndexArray idToIndex{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700141
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000142 inline void clear() { *this = CookedPointerData(); }
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700143
144 inline const PointerCoords& pointerCoordsForId(uint32_t id) const {
145 return pointerCoords[idToIndex[id]];
146 }
147
148 inline PointerCoords& editPointerCoordsWithId(uint32_t id) {
149 return pointerCoords[idToIndex[id]];
150 }
151
152 inline PointerProperties& editPointerPropertiesWithId(uint32_t id) {
153 return pointerProperties[idToIndex[id]];
154 }
155
156 inline bool isHovering(uint32_t pointerIndex) const {
157 return hoveringIdBits.hasBit(pointerProperties[pointerIndex].id);
158 }
159
160 inline bool isTouching(uint32_t pointerIndex) const {
161 return touchingIdBits.hasBit(pointerProperties[pointerIndex].id);
162 }
Nathaniel R. Lewisadb58ea2019-08-21 04:46:29 +0000163
164 inline bool hasPointerCoordsForId(uint32_t id) const { return validIdBits.hasBit(id); }
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700165};
166
167class TouchInputMapper : public InputMapper {
168public:
Michael Wright227c5542020-07-02 18:30:52 +0100169 ~TouchInputMapper() override;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700170
Philip Junker4af3b3d2021-12-14 10:36:55 +0100171 uint32_t getSources() const override;
Harry Cuttsd02ea102023-03-17 18:21:30 +0000172 void populateDeviceInfo(InputDeviceInfo& deviceInfo) override;
Michael Wright227c5542020-07-02 18:30:52 +0100173 void dump(std::string& dump) override;
Arpit Singh4be4eef2023-03-28 14:26:01 +0000174 [[nodiscard]] std::list<NotifyArgs> reconfigure(nsecs_t when,
Arpit Singhed6c3de2023-04-05 19:24:37 +0000175 const InputReaderConfiguration& config,
Prabir Pradhan4bf6d452023-04-18 21:26:56 +0000176 ConfigurationChanges changes) override;
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700177 [[nodiscard]] std::list<NotifyArgs> reset(nsecs_t when) override;
178 [[nodiscard]] std::list<NotifyArgs> process(const RawEvent* rawEvent) override;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700179
Michael Wright227c5542020-07-02 18:30:52 +0100180 int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode) override;
181 int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode) override;
Siarhei Vishniakou74007942022-06-13 13:57:47 -0700182 bool markSupportedKeyCodes(uint32_t sourceMask, const std::vector<int32_t>& keyCodes,
Michael Wright227c5542020-07-02 18:30:52 +0100183 uint8_t* outFlags) override;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700184
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700185 [[nodiscard]] std::list<NotifyArgs> cancelTouch(nsecs_t when, nsecs_t readTime) override;
186 [[nodiscard]] std::list<NotifyArgs> timeoutExpired(nsecs_t when) override;
187 [[nodiscard]] std::list<NotifyArgs> updateExternalStylusState(
188 const StylusState& state) override;
Michael Wright227c5542020-07-02 18:30:52 +0100189 std::optional<int32_t> getAssociatedDisplayId() override;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700190
191protected:
192 CursorButtonAccumulator mCursorButtonAccumulator;
193 CursorScrollAccumulator mCursorScrollAccumulator;
194 TouchButtonAccumulator mTouchButtonAccumulator;
195
196 struct VirtualKey {
197 int32_t keyCode;
198 int32_t scanCode;
199 uint32_t flags;
200
201 // computed hit box, specified in touch screen coords based on known display size
202 int32_t hitLeft;
203 int32_t hitTop;
204 int32_t hitRight;
205 int32_t hitBottom;
206
207 inline bool isHit(int32_t x, int32_t y) const {
208 return x >= hitLeft && x <= hitRight && y >= hitTop && y <= hitBottom;
209 }
210 };
211
212 // Input sources and device mode.
Arpit Singh403e53c2023-04-18 11:46:56 +0000213 uint32_t mSource{0};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700214
Michael Wright227c5542020-07-02 18:30:52 +0100215 enum class DeviceMode {
216 DISABLED, // input is disabled
217 DIRECT, // direct mapping (touchscreen)
Michael Wright227c5542020-07-02 18:30:52 +0100218 NAVIGATION, // unscaled mapping with assist gesture (touch navigation)
Harry Cuttse3aaf392023-06-19 17:13:43 +0000219 POINTER, // pointer mapping (e.g. uncaptured touchpad, drawing tablet)
Dominik Laskowski75788452021-02-09 18:51:25 -0800220
221 ftl_last = POINTER
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700222 };
Arpit Singh403e53c2023-04-18 11:46:56 +0000223 DeviceMode mDeviceMode{DeviceMode::DISABLED};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700224
225 // The reader's configuration.
226 InputReaderConfiguration mConfig;
227
228 // Immutable configuration parameters.
229 struct Parameters {
Michael Wright227c5542020-07-02 18:30:52 +0100230 enum class DeviceType {
231 TOUCH_SCREEN,
Michael Wright227c5542020-07-02 18:30:52 +0100232 TOUCH_NAVIGATION,
233 POINTER,
Dominik Laskowski75788452021-02-09 18:51:25 -0800234
235 ftl_last = POINTER
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700236 };
237
238 DeviceType deviceType;
239 bool hasAssociatedDisplay;
240 bool associatedDisplayIsExternal;
241 bool orientationAware;
Prabir Pradhanac1c74f2021-08-20 16:09:32 -0700242
Michael Wrighta9cf4192022-12-01 23:46:39 +0000243 ui::Rotation orientation;
Prabir Pradhanac1c74f2021-08-20 16:09:32 -0700244
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700245 bool hasButtonUnderPad;
246 std::string uniqueDisplayId;
247
Michael Wright227c5542020-07-02 18:30:52 +0100248 enum class GestureMode {
249 SINGLE_TOUCH,
250 MULTI_TOUCH,
Dominik Laskowski75788452021-02-09 18:51:25 -0800251
252 ftl_last = MULTI_TOUCH
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700253 };
254 GestureMode gestureMode;
255
256 bool wake;
Prabir Pradhan167c2702022-09-14 00:37:24 +0000257
Prabir Pradhane04ffaa2022-12-13 23:04:04 +0000258 // The Universal Stylus Initiative (USI) protocol version supported by this device.
259 std::optional<InputDeviceUsiVersion> usiVersion;
Yuncheol Heo50c19b12022-11-02 20:33:08 -0700260
261 // Allows touches while the display is off.
262 bool enableForInactiveViewport;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700263 } mParameters;
264
265 // Immutable calibration parameters in parsed form.
266 struct Calibration {
267 // Size
Michael Wright227c5542020-07-02 18:30:52 +0100268 enum class SizeCalibration {
269 DEFAULT,
270 NONE,
271 GEOMETRIC,
272 DIAMETER,
273 BOX,
274 AREA,
Siarhei Vishniakou4e837cc2021-12-20 23:24:33 -0800275 ftl_last = AREA
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700276 };
277
278 SizeCalibration sizeCalibration;
279
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700280 std::optional<float> sizeScale;
281 std::optional<float> sizeBias;
282 std::optional<bool> sizeIsSummed;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700283
284 // Pressure
Michael Wright227c5542020-07-02 18:30:52 +0100285 enum class PressureCalibration {
286 DEFAULT,
287 NONE,
288 PHYSICAL,
289 AMPLITUDE,
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700290 };
291
292 PressureCalibration pressureCalibration;
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700293 std::optional<float> pressureScale;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700294
295 // Orientation
Michael Wright227c5542020-07-02 18:30:52 +0100296 enum class OrientationCalibration {
297 DEFAULT,
298 NONE,
299 INTERPOLATED,
300 VECTOR,
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700301 };
302
303 OrientationCalibration orientationCalibration;
304
305 // Distance
Michael Wright227c5542020-07-02 18:30:52 +0100306 enum class DistanceCalibration {
307 DEFAULT,
308 NONE,
309 SCALED,
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700310 };
311
312 DistanceCalibration distanceCalibration;
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700313 std::optional<float> distanceScale;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700314
Siarhei Vishniakou07247342022-07-15 14:27:37 -0700315 inline void applySizeScaleAndBias(float& outSize) const {
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700316 if (sizeScale) {
Siarhei Vishniakou07247342022-07-15 14:27:37 -0700317 outSize *= *sizeScale;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700318 }
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700319 if (sizeBias) {
Siarhei Vishniakou07247342022-07-15 14:27:37 -0700320 outSize += *sizeBias;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700321 }
Siarhei Vishniakou07247342022-07-15 14:27:37 -0700322 if (outSize < 0) {
323 outSize = 0;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700324 }
325 }
326 } mCalibration;
327
328 // Affine location transformation/calibration
329 struct TouchAffineTransformation mAffineTransform;
330
331 RawPointerAxes mRawPointerAxes;
332
333 struct RawState {
Prabir Pradhan2f37bcb2022-11-08 20:41:28 +0000334 nsecs_t when{std::numeric_limits<nsecs_t>::min()};
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000335 nsecs_t readTime{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700336
337 // Raw pointer sample data.
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000338 RawPointerData rawPointerData{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700339
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000340 int32_t buttonState{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700341
342 // Scroll state.
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000343 int32_t rawVScroll{};
344 int32_t rawHScroll{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700345
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000346 inline void clear() { *this = RawState(); }
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700347 };
348
349 struct CookedState {
350 // Cooked pointer sample data.
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000351 CookedPointerData cookedPointerData{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700352
353 // Id bits used to differentiate fingers, stylus and mouse tools.
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000354 BitSet32 fingerIdBits{};
355 BitSet32 stylusIdBits{};
356 BitSet32 mouseIdBits{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700357
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000358 int32_t buttonState{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700359
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000360 inline void clear() { *this = CookedState(); }
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700361 };
362
363 std::vector<RawState> mRawStatesPending;
364 RawState mCurrentRawState;
365 CookedState mCurrentCookedState;
366 RawState mLastRawState;
367 CookedState mLastCookedState;
368
369 // State provided by an external stylus
370 StylusState mExternalStylusState;
Prabir Pradhan8d9ba912022-11-11 22:26:33 +0000371 // If an external stylus is capable of reporting pointer-specific data like pressure, we will
372 // attempt to fuse the pointer data reported by the stylus to the first touch pointer. This is
373 // the id of the pointer to which the external stylus data is fused.
374 std::optional<uint32_t> mFusedStylusPointerId;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700375 nsecs_t mExternalStylusFusionTimeout;
376 bool mExternalStylusDataPending;
Prabir Pradhan124ea442022-10-28 20:27:44 +0000377 // A subset of the buttons in mCurrentRawState that came from an external stylus.
Arpit Singha8c236b2023-04-25 13:56:05 +0000378 int32_t mExternalStylusButtonsApplied{0};
Prabir Pradhanb08a0e82023-09-14 22:28:32 +0000379 // True if the current cooked pointer data was modified due to the state of an external stylus.
380 bool mCurrentStreamModifiedByExternalStylus{false};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700381
382 // True if we sent a HOVER_ENTER event.
Arpit Singha8c236b2023-04-25 13:56:05 +0000383 bool mSentHoverEnter{false};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700384
385 // Have we assigned pointer IDs for this stream
Arpit Singha8c236b2023-04-25 13:56:05 +0000386 bool mHavePointerIds{false};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700387
388 // Is the current stream of direct touch events aborted
Arpit Singha8c236b2023-04-25 13:56:05 +0000389 bool mCurrentMotionAborted{false};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700390
391 // The time the primary pointer last went down.
Arpit Singha8c236b2023-04-25 13:56:05 +0000392 nsecs_t mDownTime{0};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700393
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700394 std::vector<VirtualKey> mVirtualKeys;
395
Arpit Singha8c236b2023-04-25 13:56:05 +0000396 explicit TouchInputMapper(InputDeviceContext& deviceContext,
397 const InputReaderConfiguration& readerConfig);
398
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700399 virtual void dumpParameters(std::string& dump);
400 virtual void configureRawPointerAxes();
401 virtual void dumpRawPointerAxes(std::string& dump);
Prabir Pradhan1728b212021-10-19 16:00:03 -0700402 virtual void configureInputDevice(nsecs_t when, bool* outResetNeeded);
403 virtual void dumpDisplay(std::string& dump);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700404 virtual void configureVirtualKeys();
405 virtual void dumpVirtualKeys(std::string& dump);
406 virtual void parseCalibration();
407 virtual void resolveCalibration();
408 virtual void dumpCalibration(std::string& dump);
409 virtual void updateAffineTransformation();
410 virtual void dumpAffineTransformation(std::string& dump);
411 virtual void resolveExternalStylusPresence();
412 virtual bool hasStylus() const = 0;
413 virtual bool hasExternalStylus() const;
414
415 virtual void syncTouch(nsecs_t when, RawState* outState) = 0;
416
417private:
418 // The current viewport.
419 // The components of the viewport are specified in the display's rotated orientation.
420 DisplayViewport mViewport;
421
Prabir Pradhan2d613f42022-11-10 20:22:06 +0000422 // We refer to the display as being in the "natural orientation" when there is no rotation
423 // applied. The display size obtained from the viewport in the natural orientation.
Prabir Pradhan7ddbc952022-11-09 22:03:40 +0000424 // Always starts at (0, 0).
425 ui::Size mDisplayBounds{ui::kInvalidSize};
Arthur Hung4197f6b2020-03-16 15:39:59 +0800426
Prabir Pradhan675f25a2022-11-10 22:04:07 +0000427 // The physical frame is the rectangle in the rotated display's coordinate space that maps to
Prabir Pradhan1728b212021-10-19 16:00:03 -0700428 // the logical display frame.
Prabir Pradhan675f25a2022-11-10 22:04:07 +0000429 Rect mPhysicalFrameInRotatedDisplay{Rect::INVALID_RECT};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700430
Prabir Pradhan1728b212021-10-19 16:00:03 -0700431 // The orientation of the input device relative to that of the display panel. It specifies
432 // the rotation of the input device coordinates required to produce the display panel
433 // orientation, so it will depend on whether the device is orientation aware.
Arpit Singh403e53c2023-04-18 11:46:56 +0000434 ui::Rotation mInputDeviceOrientation{ui::ROTATION_0};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700435
Prabir Pradhanea31d4f2022-11-10 20:48:01 +0000436 // The transform that maps the input device's raw coordinate space to the un-rotated display's
437 // coordinate space. InputReader generates events in the un-rotated display's coordinate space.
438 ui::Transform mRawToDisplay;
439
Prabir Pradhan675f25a2022-11-10 22:04:07 +0000440 // The transform that maps the input device's raw coordinate space to the rotated display's
441 // coordinate space. This used to perform hit-testing of raw events with the physical frame in
442 // the rotated coordinate space. See mPhysicalFrameInRotatedDisplay.
443 ui::Transform mRawToRotatedDisplay;
444
Prabir Pradhane2e10b42022-11-17 20:59:36 +0000445 // The transform used for non-planar raw axes, such as orientation and tilt.
446 ui::Transform mRawRotation;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700447
448 float mGeometricScale;
449
450 float mPressureScale;
451
452 float mSizeScale;
453
454 float mOrientationScale;
455
456 float mDistanceScale;
457
458 bool mHaveTilt;
459 float mTiltXCenter;
460 float mTiltXScale;
461 float mTiltYCenter;
462 float mTiltYScale;
463
464 bool mExternalStylusConnected;
465
466 // Oriented motion ranges for input device info.
467 struct OrientedRanges {
468 InputDeviceInfo::MotionRange x;
469 InputDeviceInfo::MotionRange y;
470 InputDeviceInfo::MotionRange pressure;
471
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700472 std::optional<InputDeviceInfo::MotionRange> size;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700473
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700474 std::optional<InputDeviceInfo::MotionRange> touchMajor;
475 std::optional<InputDeviceInfo::MotionRange> touchMinor;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700476
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700477 std::optional<InputDeviceInfo::MotionRange> toolMajor;
478 std::optional<InputDeviceInfo::MotionRange> toolMinor;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700479
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700480 std::optional<InputDeviceInfo::MotionRange> orientation;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700481
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700482 std::optional<InputDeviceInfo::MotionRange> distance;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700483
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700484 std::optional<InputDeviceInfo::MotionRange> tilt;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700485
486 void clear() {
Siarhei Vishniakou24210882022-07-15 09:42:04 -0700487 size = std::nullopt;
488 touchMajor = std::nullopt;
489 touchMinor = std::nullopt;
490 toolMajor = std::nullopt;
491 toolMinor = std::nullopt;
492 orientation = std::nullopt;
493 distance = std::nullopt;
494 tilt = std::nullopt;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700495 }
496 } mOrientedRanges;
497
498 // Oriented dimensions and precision.
499 float mOrientedXPrecision;
500 float mOrientedYPrecision;
501
502 struct CurrentVirtualKeyState {
503 bool down;
504 bool ignored;
505 nsecs_t downTime;
506 int32_t keyCode;
507 int32_t scanCode;
508 } mCurrentVirtualKey;
509
510 // Scale factor for gesture or mouse based pointer movements.
511 float mPointerXMovementScale;
512 float mPointerYMovementScale;
513
514 // Scale factor for gesture based zooming and other freeform motions.
515 float mPointerXZoomScale;
516 float mPointerYZoomScale;
517
HQ Liue6983c72022-04-19 22:14:56 +0000518 // The maximum swipe width between pointers to detect a swipe gesture
519 // in the number of pixels.Touches that are wider than this are translated
520 // into freeform gestures.
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700521 float mPointerGestureMaxSwipeWidth;
522
523 struct PointerDistanceHeapElement {
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000524 uint32_t currentPointerIndex : 8 {};
525 uint32_t lastPointerIndex : 8 {};
526 uint64_t distance : 48 {}; // squared distance
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700527 };
528
Michael Wright227c5542020-07-02 18:30:52 +0100529 enum class PointerUsage {
530 NONE,
531 GESTURES,
532 STYLUS,
533 MOUSE,
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700534 };
Arpit Singha8c236b2023-04-25 13:56:05 +0000535 PointerUsage mPointerUsage{PointerUsage::NONE};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700536
537 struct PointerGesture {
Michael Wright227c5542020-07-02 18:30:52 +0100538 enum class Mode {
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700539 // No fingers, button is not pressed.
540 // Nothing happening.
541 NEUTRAL,
542
543 // No fingers, button is not pressed.
544 // Tap detected.
545 // Emits DOWN and UP events at the pointer location.
546 TAP,
547
548 // Exactly one finger dragging following a tap.
549 // Pointer follows the active finger.
550 // Emits DOWN, MOVE and UP events at the pointer location.
551 //
552 // Detect double-taps when the finger goes up while in TAP_DRAG mode.
553 TAP_DRAG,
554
555 // Button is pressed.
556 // Pointer follows the active finger if there is one. Other fingers are ignored.
557 // Emits DOWN, MOVE and UP events at the pointer location.
558 BUTTON_CLICK_OR_DRAG,
559
560 // Exactly one finger, button is not pressed.
561 // Pointer follows the active finger.
562 // Emits HOVER_MOVE events at the pointer location.
563 //
564 // Detect taps when the finger goes up while in HOVER mode.
565 HOVER,
566
567 // Exactly two fingers but neither have moved enough to clearly indicate
568 // whether a swipe or freeform gesture was intended. We consider the
569 // pointer to be pressed so this enables clicking or long-pressing on buttons.
570 // Pointer does not move.
571 // Emits DOWN, MOVE and UP events with a single stationary pointer coordinate.
572 PRESS,
573
574 // Exactly two fingers moving in the same direction, button is not pressed.
575 // Pointer does not move.
576 // Emits DOWN, MOVE and UP events with a single pointer coordinate that
577 // follows the midpoint between both fingers.
578 SWIPE,
579
580 // Two or more fingers moving in arbitrary directions, button is not pressed.
581 // Pointer does not move.
582 // Emits DOWN, POINTER_DOWN, MOVE, POINTER_UP and UP events that follow
583 // each finger individually relative to the initial centroid of the finger.
584 FREEFORM,
585
586 // Waiting for quiet time to end before starting the next gesture.
587 QUIET,
Harry Cuttsc57cd3c2024-04-24 13:52:55 +0000588
589 ftl_last = QUIET,
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700590 };
591
Prabir Pradhan47cf0a02021-03-11 20:30:57 -0800592 // When a gesture is sent to an unfocused window, return true if it can bring that window
593 // into focus, false otherwise.
594 static bool canGestureAffectWindowFocus(Mode mode) {
595 switch (mode) {
596 case Mode::TAP:
597 case Mode::TAP_DRAG:
598 case Mode::BUTTON_CLICK_OR_DRAG:
599 // Taps can affect window focus.
600 return true;
601 case Mode::FREEFORM:
602 case Mode::HOVER:
603 case Mode::NEUTRAL:
604 case Mode::PRESS:
605 case Mode::QUIET:
606 case Mode::SWIPE:
607 // Most gestures can be performed on an unfocused window, so they should not
608 // not affect window focus.
609 return false;
610 }
611 }
612
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700613 // Time the first finger went down.
614 nsecs_t firstTouchTime;
615
616 // The active pointer id from the raw touch data.
617 int32_t activeTouchId; // -1 if none
618
619 // The active pointer id from the gesture last delivered to the application.
620 int32_t activeGestureId; // -1 if none
621
622 // Pointer coords and ids for the current and previous pointer gesture.
623 Mode currentGestureMode;
624 BitSet32 currentGestureIdBits;
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000625 IdToIndexArray currentGestureIdToIndex{};
626 PropertiesArray currentGestureProperties{};
627 CoordsArray currentGestureCoords{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700628
629 Mode lastGestureMode;
630 BitSet32 lastGestureIdBits;
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000631 IdToIndexArray lastGestureIdToIndex{};
632 PropertiesArray lastGestureProperties{};
633 CoordsArray lastGestureCoords{};
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700634
635 // Time the pointer gesture last went down.
636 nsecs_t downTime;
637
638 // Time when the pointer went down for a TAP.
639 nsecs_t tapDownTime;
640
641 // Time when the pointer went up for a TAP.
642 nsecs_t tapUpTime;
643
644 // Location of initial tap.
645 float tapX, tapY;
646
647 // Time we started waiting for quiescence.
648 nsecs_t quietTime;
649
650 // Reference points for multitouch gestures.
651 float referenceTouchX; // reference touch X/Y coordinates in surface units
652 float referenceTouchY;
653 float referenceGestureX; // reference gesture X/Y coordinates in pixels
654 float referenceGestureY;
655
656 // Distance that each pointer has traveled which has not yet been
657 // subsumed into the reference gesture position.
658 BitSet32 referenceIdBits;
659 struct Delta {
660 float dx, dy;
661 };
662 Delta referenceDeltas[MAX_POINTER_ID + 1];
663
664 // Describes how touch ids are mapped to gesture ids for freeform gestures.
665 uint32_t freeformTouchToGestureIdMap[MAX_POINTER_ID + 1];
666
667 // A velocity tracker for determining whether to switch active pointers during drags.
668 VelocityTracker velocityTracker;
669
670 void reset() {
671 firstTouchTime = LLONG_MIN;
672 activeTouchId = -1;
673 activeGestureId = -1;
Michael Wright227c5542020-07-02 18:30:52 +0100674 currentGestureMode = Mode::NEUTRAL;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700675 currentGestureIdBits.clear();
Michael Wright227c5542020-07-02 18:30:52 +0100676 lastGestureMode = Mode::NEUTRAL;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700677 lastGestureIdBits.clear();
678 downTime = 0;
679 velocityTracker.clear();
680 resetTap();
681 resetQuietTime();
682 }
683
684 void resetTap() {
685 tapDownTime = LLONG_MIN;
686 tapUpTime = LLONG_MIN;
687 }
688
689 void resetQuietTime() { quietTime = LLONG_MIN; }
690 } mPointerGesture;
691
692 struct PointerSimple {
693 PointerCoords currentCoords;
694 PointerProperties currentProperties;
695 PointerCoords lastCoords;
696 PointerProperties lastProperties;
697
698 // True if the pointer is down.
699 bool down;
700
701 // True if the pointer is hovering.
702 bool hovering;
703
704 // Time the pointer last went down.
705 nsecs_t downTime;
706
Prabir Pradhanb80b6c02022-11-02 20:05:13 +0000707 // Values reported for the last pointer event.
708 uint32_t source;
709 int32_t displayId;
710 float lastCursorX;
711 float lastCursorY;
712
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700713 void reset() {
714 currentCoords.clear();
715 currentProperties.clear();
716 lastCoords.clear();
717 lastProperties.clear();
718 down = false;
719 hovering = false;
720 downTime = 0;
Prabir Pradhanb80b6c02022-11-02 20:05:13 +0000721 source = 0;
722 displayId = ADISPLAY_ID_NONE;
723 lastCursorX = 0.f;
724 lastCursorY = 0.f;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700725 }
726 } mPointerSimple;
727
728 // The pointer and scroll velocity controls.
Harry Cuttse78184b2024-01-08 15:54:58 +0000729 SimpleVelocityControl mPointerVelocityControl;
730 SimpleVelocityControl mWheelXVelocityControl;
731 SimpleVelocityControl mWheelYVelocityControl;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700732
733 std::optional<DisplayViewport> findViewport();
734
735 void resetExternalStylus();
736 void clearStylusDataPendingFlags();
737
Siarhei Vishniakou12c0fcb2021-12-17 13:40:44 -0800738 int32_t clampResolution(const char* axisName, int32_t resolution) const;
Siarhei Vishniakou4e837cc2021-12-20 23:24:33 -0800739 void initializeOrientedRanges();
740 void initializeSizeRanges();
741
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700742 [[nodiscard]] std::list<NotifyArgs> sync(nsecs_t when, nsecs_t readTime);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700743
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700744 [[nodiscard]] std::list<NotifyArgs> consumeRawTouches(nsecs_t when, nsecs_t readTime,
745 uint32_t policyFlags, bool& outConsumed);
746 [[nodiscard]] std::list<NotifyArgs> processRawTouches(bool timeout);
747 [[nodiscard]] std::list<NotifyArgs> cookAndDispatch(nsecs_t when, nsecs_t readTime);
748 [[nodiscard]] NotifyKeyArgs dispatchVirtualKey(nsecs_t when, nsecs_t readTime,
749 uint32_t policyFlags, int32_t keyEventAction,
750 int32_t keyEventFlags);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700751
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700752 [[nodiscard]] std::list<NotifyArgs> dispatchTouches(nsecs_t when, nsecs_t readTime,
753 uint32_t policyFlags);
754 [[nodiscard]] std::list<NotifyArgs> dispatchHoverExit(nsecs_t when, nsecs_t readTime,
755 uint32_t policyFlags);
756 [[nodiscard]] std::list<NotifyArgs> dispatchHoverEnterAndMove(nsecs_t when, nsecs_t readTime,
757 uint32_t policyFlags);
758 [[nodiscard]] std::list<NotifyArgs> dispatchButtonRelease(nsecs_t when, nsecs_t readTime,
759 uint32_t policyFlags);
760 [[nodiscard]] std::list<NotifyArgs> dispatchButtonPress(nsecs_t when, nsecs_t readTime,
761 uint32_t policyFlags);
LiZhihong758eb562022-11-03 15:28:29 +0800762 [[nodiscard]] std::list<NotifyArgs> dispatchGestureButtonPress(nsecs_t when,
763 uint32_t policyFlags,
764 BitSet32 idBits,
765 nsecs_t readTime);
766 [[nodiscard]] std::list<NotifyArgs> dispatchGestureButtonRelease(nsecs_t when,
767 uint32_t policyFlags,
768 BitSet32 idBits,
769 nsecs_t readTime);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700770 const BitSet32& findActiveIdBits(const CookedPointerData& cookedPointerData);
771 void cookPointerData();
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700772 [[nodiscard]] std::list<NotifyArgs> abortTouches(nsecs_t when, nsecs_t readTime,
773 uint32_t policyFlags);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700774
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700775 [[nodiscard]] std::list<NotifyArgs> dispatchPointerUsage(nsecs_t when, nsecs_t readTime,
776 uint32_t policyFlags,
777 PointerUsage pointerUsage);
778 [[nodiscard]] std::list<NotifyArgs> abortPointerUsage(nsecs_t when, nsecs_t readTime,
779 uint32_t policyFlags);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700780
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700781 [[nodiscard]] std::list<NotifyArgs> dispatchPointerGestures(nsecs_t when, nsecs_t readTime,
782 uint32_t policyFlags,
783 bool isTimeout);
784 [[nodiscard]] std::list<NotifyArgs> abortPointerGestures(nsecs_t when, nsecs_t readTime,
785 uint32_t policyFlags);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700786 bool preparePointerGestures(nsecs_t when, bool* outCancelPreviousGesture,
787 bool* outFinishPreviousGesture, bool isTimeout);
788
Harry Cuttsbea6ce52022-10-14 15:17:30 +0000789 // Returns true if we're in a period of "quiet time" when touchpad gestures should be ignored.
790 bool checkForTouchpadQuietTime(nsecs_t when);
791
792 std::pair<int32_t, float> getFastestFinger();
793
794 void prepareMultiFingerPointerGestures(nsecs_t when, bool* outCancelPreviousGesture,
795 bool* outFinishPreviousGesture);
796
Harry Cutts714d1ad2022-08-24 16:36:43 +0000797 // Moves the on-screen mouse pointer based on the movement of the pointer of the given ID
798 // between the last and current events. Uses a relative motion.
799 void moveMousePointerFromPointerDelta(nsecs_t when, uint32_t pointerId);
800
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700801 [[nodiscard]] std::list<NotifyArgs> dispatchPointerStylus(nsecs_t when, nsecs_t readTime,
802 uint32_t policyFlags);
803 [[nodiscard]] std::list<NotifyArgs> abortPointerStylus(nsecs_t when, nsecs_t readTime,
804 uint32_t policyFlags);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700805
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700806 [[nodiscard]] std::list<NotifyArgs> dispatchPointerMouse(nsecs_t when, nsecs_t readTime,
807 uint32_t policyFlags);
808 [[nodiscard]] std::list<NotifyArgs> abortPointerMouse(nsecs_t when, nsecs_t readTime,
809 uint32_t policyFlags);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700810
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700811 [[nodiscard]] std::list<NotifyArgs> dispatchPointerSimple(nsecs_t when, nsecs_t readTime,
812 uint32_t policyFlags, bool down,
Prabir Pradhane71e5702023-03-29 14:51:38 +0000813 bool hovering, int32_t displayId);
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700814 [[nodiscard]] std::list<NotifyArgs> abortPointerSimple(nsecs_t when, nsecs_t readTime,
815 uint32_t policyFlags);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700816
Prabir Pradhan3f7545f2022-10-19 16:56:39 +0000817 // Attempts to assign a pointer id to the external stylus. Returns true if the state should be
818 // withheld from further processing while waiting for data from the stylus.
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700819 bool assignExternalStylusId(const RawState& state, bool timeout);
820 void applyExternalStylusButtonState(nsecs_t when);
821 void applyExternalStylusTouchState(nsecs_t when);
822
823 // Dispatches a motion event.
824 // If the changedId is >= 0 and the action is POINTER_DOWN or POINTER_UP, the
825 // method will take care of setting the index and transmuting the action to DOWN or UP
826 // it is the first / last pointer to go down / up.
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700827 [[nodiscard]] NotifyMotionArgs dispatchMotion(
828 nsecs_t when, nsecs_t readTime, uint32_t policyFlags, uint32_t source, int32_t action,
829 int32_t actionButton, int32_t flags, int32_t metaState, int32_t buttonState,
Prabir Pradhand6ccedb2022-09-27 21:04:06 +0000830 int32_t edgeFlags, const PropertiesArray& properties, const CoordsArray& coords,
831 const IdToIndexArray& idToIndex, BitSet32 idBits, int32_t changedId, float xPrecision,
Siarhei Vishniakou2935db72022-09-22 13:35:22 -0700832 float yPrecision, nsecs_t downTime, MotionClassification classification);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700833
Garfield Tanc734e4f2021-01-15 20:01:39 -0800834 // Returns if this touch device is a touch screen with an associated display.
835 bool isTouchScreen();
Garfield Tanc734e4f2021-01-15 20:01:39 -0800836
Prabir Pradhan1728b212021-10-19 16:00:03 -0700837 bool isPointInsidePhysicalFrame(int32_t x, int32_t y) const;
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700838 const VirtualKey* findVirtualKeyHit(int32_t x, int32_t y);
839
Siarhei Vishniakou57479982021-03-03 01:32:21 +0000840 static void assignPointerIds(const RawState& last, RawState& current);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700841
Prabir Pradhan7d9cb5a2023-03-14 21:18:07 +0000842 // Compute input transforms for DIRECT and POINTER modes.
Prabir Pradhan675f25a2022-11-10 22:04:07 +0000843 void computeInputTransforms();
Arpit Singh403e53c2023-04-18 11:46:56 +0000844 static Parameters::DeviceType computeDeviceType(const InputDeviceContext& deviceContext);
845 static Parameters computeParameters(const InputDeviceContext& deviceContext);
Prabir Pradhanbaa5c822019-08-30 15:27:05 -0700846};
847
848} // namespace android