1 /* 2 * Copyright (C) 2018 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 17 #ifndef _UI_INPUT_READER_BASE_H 18 #define _UI_INPUT_READER_BASE_H 19 20 #include <input/DisplayViewport.h> 21 #include <input/Input.h> 22 #include <input/InputDevice.h> 23 #include <input/VelocityControl.h> 24 #include <input/VelocityTracker.h> 25 #include <stddef.h> 26 #include <unistd.h> 27 #include <utils/Errors.h> 28 #include <utils/RefBase.h> 29 30 #include <optional> 31 #include <set> 32 #include <unordered_map> 33 #include <vector> 34 35 #include "PointerControllerInterface.h" 36 #include "VibrationElement.h" 37 38 // Maximum supported size of a vibration pattern. 39 // Must be at least 2. 40 #define MAX_VIBRATE_PATTERN_SIZE 100 41 42 namespace android { 43 44 // --- InputReaderInterface --- 45 46 /* The interface for the InputReader shared library. 47 * 48 * Manages one or more threads that process raw input events and sends cooked event data to an 49 * input listener. 50 * 51 * The implementation must guarantee thread safety for this interface. However, since the input 52 * listener is NOT thread safe, all calls to the listener must happen from the same thread. 53 */ 54 class InputReaderInterface : public virtual RefBase { 55 protected: InputReaderInterface()56 InputReaderInterface() { } ~InputReaderInterface()57 virtual ~InputReaderInterface() { } 58 59 public: 60 /* Dumps the state of the input reader. 61 * 62 * This method may be called on any thread (usually by the input manager). */ 63 virtual void dump(std::string& dump) = 0; 64 65 /* Called by the heartbeat to ensures that the reader has not deadlocked. */ 66 virtual void monitor() = 0; 67 68 /* Returns true if the input device is enabled. */ 69 virtual bool isInputDeviceEnabled(int32_t deviceId) = 0; 70 71 /* Makes the reader start processing events from the kernel. */ 72 virtual status_t start() = 0; 73 74 /* Makes the reader stop processing any more events. */ 75 virtual status_t stop() = 0; 76 77 /* Gets information about all input devices. 78 * 79 * This method may be called on any thread (usually by the input manager). 80 */ 81 virtual std::vector<InputDeviceInfo> getInputDevices() const = 0; 82 83 /* Query current input state. */ 84 virtual int32_t getScanCodeState(int32_t deviceId, uint32_t sourceMask, 85 int32_t scanCode) = 0; 86 virtual int32_t getKeyCodeState(int32_t deviceId, uint32_t sourceMask, 87 int32_t keyCode) = 0; 88 virtual int32_t getSwitchState(int32_t deviceId, uint32_t sourceMask, 89 int32_t sw) = 0; 90 91 /* Toggle Caps Lock */ 92 virtual void toggleCapsLockState(int32_t deviceId) = 0; 93 94 /* Determine whether physical keys exist for the given framework-domain key codes. */ 95 virtual bool hasKeys(int32_t deviceId, uint32_t sourceMask, 96 size_t numCodes, const int32_t* keyCodes, uint8_t* outFlags) = 0; 97 98 /* Requests that a reconfiguration of all input devices. 99 * The changes flag is a bitfield that indicates what has changed and whether 100 * the input devices must all be reopened. */ 101 virtual void requestRefreshConfiguration(uint32_t changes) = 0; 102 103 /* Controls the vibrator of a particular input device. */ 104 virtual void vibrate(int32_t deviceId, const VibrationSequence& sequence, ssize_t repeat, 105 int32_t token) = 0; 106 virtual void cancelVibrate(int32_t deviceId, int32_t token) = 0; 107 108 virtual bool isVibrating(int32_t deviceId) = 0; 109 110 virtual std::vector<int32_t> getVibratorIds(int32_t deviceId) = 0; 111 /* Get battery level of a particular input device. */ 112 virtual std::optional<int32_t> getBatteryCapacity(int32_t deviceId) = 0; 113 /* Get battery status of a particular input device. */ 114 virtual std::optional<int32_t> getBatteryStatus(int32_t deviceId) = 0; 115 116 virtual std::vector<InputDeviceLightInfo> getLights(int32_t deviceId) = 0; 117 118 virtual std::vector<InputDeviceSensorInfo> getSensors(int32_t deviceId) = 0; 119 120 /* Return true if the device can send input events to the specified display. */ 121 virtual bool canDispatchToDisplay(int32_t deviceId, int32_t displayId) = 0; 122 123 /* Enable sensor in input reader mapper. */ 124 virtual bool enableSensor(int32_t deviceId, InputDeviceSensorType sensorType, 125 std::chrono::microseconds samplingPeriod, 126 std::chrono::microseconds maxBatchReportLatency) = 0; 127 128 /* Disable sensor in input reader mapper. */ 129 virtual void disableSensor(int32_t deviceId, InputDeviceSensorType sensorType) = 0; 130 131 /* Flush sensor data in input reader mapper. */ 132 virtual void flushSensor(int32_t deviceId, InputDeviceSensorType sensorType) = 0; 133 134 /* Set color for the light */ 135 virtual bool setLightColor(int32_t deviceId, int32_t lightId, int32_t color) = 0; 136 /* Set player ID for the light */ 137 virtual bool setLightPlayerId(int32_t deviceId, int32_t lightId, int32_t playerId) = 0; 138 /* Get light color */ 139 virtual std::optional<int32_t> getLightColor(int32_t deviceId, int32_t lightId) = 0; 140 /* Get light player ID */ 141 virtual std::optional<int32_t> getLightPlayerId(int32_t deviceId, int32_t lightId) = 0; 142 }; 143 144 // --- InputReaderConfiguration --- 145 146 /* 147 * Input reader configuration. 148 * 149 * Specifies various options that modify the behavior of the input reader. 150 */ 151 struct InputReaderConfiguration { 152 // Describes changes that have occurred. 153 enum { 154 // The pointer speed changed. 155 CHANGE_POINTER_SPEED = 1 << 0, 156 157 // The pointer gesture control changed. 158 CHANGE_POINTER_GESTURE_ENABLEMENT = 1 << 1, 159 160 // The display size or orientation changed. 161 CHANGE_DISPLAY_INFO = 1 << 2, 162 163 // The visible touches option changed. 164 CHANGE_SHOW_TOUCHES = 1 << 3, 165 166 // The keyboard layouts must be reloaded. 167 CHANGE_KEYBOARD_LAYOUTS = 1 << 4, 168 169 // The device name alias supplied by the may have changed for some devices. 170 CHANGE_DEVICE_ALIAS = 1 << 5, 171 172 // The location calibration matrix changed. 173 CHANGE_TOUCH_AFFINE_TRANSFORMATION = 1 << 6, 174 175 // The presence of an external stylus has changed. 176 CHANGE_EXTERNAL_STYLUS_PRESENCE = 1 << 7, 177 178 // The pointer capture mode has changed. 179 CHANGE_POINTER_CAPTURE = 1 << 8, 180 181 // The set of disabled input devices (disabledDevices) has changed. 182 CHANGE_ENABLED_STATE = 1 << 9, 183 184 // All devices must be reopened. 185 CHANGE_MUST_REOPEN = 1 << 31, 186 }; 187 188 // Gets the amount of time to disable virtual keys after the screen is touched 189 // in order to filter out accidental virtual key presses due to swiping gestures 190 // or taps near the edge of the display. May be 0 to disable the feature. 191 nsecs_t virtualKeyQuietTime; 192 193 // The excluded device names for the platform. 194 // Devices with these names will be ignored. 195 std::vector<std::string> excludedDeviceNames; 196 197 // The associations between input ports and display ports. 198 // Used to determine which DisplayViewport should be tied to which InputDevice. 199 std::unordered_map<std::string, uint8_t> portAssociations; 200 201 // The associations between input device names and display unique ids. 202 // Used to determine which DisplayViewport should be tied to which InputDevice. 203 std::unordered_map<std::string, std::string> uniqueIdAssociations; 204 205 // The suggested display ID to show the cursor. 206 int32_t defaultPointerDisplayId; 207 208 // Velocity control parameters for mouse pointer movements. 209 VelocityControlParameters pointerVelocityControlParameters; 210 211 // Velocity control parameters for mouse wheel movements. 212 VelocityControlParameters wheelVelocityControlParameters; 213 214 // True if pointer gestures are enabled. 215 bool pointerGesturesEnabled; 216 217 // Quiet time between certain pointer gesture transitions. 218 // Time to allow for all fingers or buttons to settle into a stable state before 219 // starting a new gesture. 220 nsecs_t pointerGestureQuietInterval; 221 222 // The minimum speed that a pointer must travel for us to consider switching the active 223 // touch pointer to it during a drag. This threshold is set to avoid switching due 224 // to noise from a finger resting on the touch pad (perhaps just pressing it down). 225 float pointerGestureDragMinSwitchSpeed; // in pixels per second 226 227 // Tap gesture delay time. 228 // The time between down and up must be less than this to be considered a tap. 229 nsecs_t pointerGestureTapInterval; 230 231 // Tap drag gesture delay time. 232 // The time between the previous tap's up and the next down must be less than 233 // this to be considered a drag. Otherwise, the previous tap is finished and a 234 // new tap begins. 235 // 236 // Note that the previous tap will be held down for this entire duration so this 237 // interval must be shorter than the long press timeout. 238 nsecs_t pointerGestureTapDragInterval; 239 240 // The distance in pixels that the pointer is allowed to move from initial down 241 // to up and still be called a tap. 242 float pointerGestureTapSlop; // in pixels 243 244 // Time after the first touch points go down to settle on an initial centroid. 245 // This is intended to be enough time to handle cases where the user puts down two 246 // fingers at almost but not quite exactly the same time. 247 nsecs_t pointerGestureMultitouchSettleInterval; 248 249 // The transition from PRESS to SWIPE or FREEFORM gesture mode is made when 250 // at least two pointers have moved at least this far from their starting place. 251 float pointerGestureMultitouchMinDistance; // in pixels 252 253 // The transition from PRESS to SWIPE gesture mode can only occur when the 254 // cosine of the angle between the two vectors is greater than or equal to than this value 255 // which indicates that the vectors are oriented in the same direction. 256 // When the vectors are oriented in the exactly same direction, the cosine is 1.0. 257 // (In exactly opposite directions, the cosine is -1.0.) 258 float pointerGestureSwipeTransitionAngleCosine; 259 260 // The transition from PRESS to SWIPE gesture mode can only occur when the 261 // fingers are no more than this far apart relative to the diagonal size of 262 // the touch pad. For example, a ratio of 0.5 means that the fingers must be 263 // no more than half the diagonal size of the touch pad apart. 264 float pointerGestureSwipeMaxWidthRatio; 265 266 // The gesture movement speed factor relative to the size of the display. 267 // Movement speed applies when the fingers are moving in the same direction. 268 // Without acceleration, a full swipe of the touch pad diagonal in movement mode 269 // will cover this portion of the display diagonal. 270 float pointerGestureMovementSpeedRatio; 271 272 // The gesture zoom speed factor relative to the size of the display. 273 // Zoom speed applies when the fingers are mostly moving relative to each other 274 // to execute a scale gesture or similar. 275 // Without acceleration, a full swipe of the touch pad diagonal in zoom mode 276 // will cover this portion of the display diagonal. 277 float pointerGestureZoomSpeedRatio; 278 279 // True to show the location of touches on the touch screen as spots. 280 bool showTouches; 281 282 // True if pointer capture is enabled. 283 bool pointerCapture; 284 285 // The set of currently disabled input devices. 286 std::set<int32_t> disabledDevices; 287 InputReaderConfigurationInputReaderConfiguration288 InputReaderConfiguration() : 289 virtualKeyQuietTime(0), 290 pointerVelocityControlParameters(1.0f, 500.0f, 3000.0f, 3.0f), 291 wheelVelocityControlParameters(1.0f, 15.0f, 50.0f, 4.0f), 292 pointerGesturesEnabled(true), 293 pointerGestureQuietInterval(100 * 1000000LL), // 100 ms 294 pointerGestureDragMinSwitchSpeed(50), // 50 pixels per second 295 pointerGestureTapInterval(150 * 1000000LL), // 150 ms 296 pointerGestureTapDragInterval(150 * 1000000LL), // 150 ms 297 pointerGestureTapSlop(10.0f), // 10 pixels 298 pointerGestureMultitouchSettleInterval(100 * 1000000LL), // 100 ms 299 pointerGestureMultitouchMinDistance(15), // 15 pixels 300 pointerGestureSwipeTransitionAngleCosine(0.2588f), // cosine of 75 degrees 301 pointerGestureSwipeMaxWidthRatio(0.25f), 302 pointerGestureMovementSpeedRatio(0.8f), 303 pointerGestureZoomSpeedRatio(0.3f), 304 showTouches(false), pointerCapture(false) { } 305 306 static std::string changesToString(uint32_t changes); 307 308 std::optional<DisplayViewport> getDisplayViewportByType(ViewportType type) const; 309 std::optional<DisplayViewport> getDisplayViewportByUniqueId(const std::string& uniqueDisplayId) 310 const; 311 std::optional<DisplayViewport> getDisplayViewportByPort(uint8_t physicalPort) const; 312 std::optional<DisplayViewport> getDisplayViewportById(int32_t displayId) const; 313 void setDisplayViewports(const std::vector<DisplayViewport>& viewports); 314 315 316 void dump(std::string& dump) const; 317 void dumpViewport(std::string& dump, const DisplayViewport& viewport) const; 318 319 private: 320 std::vector<DisplayViewport> mDisplays; 321 }; 322 323 // --- TouchAffineTransformation --- 324 325 struct TouchAffineTransformation { 326 float x_scale; 327 float x_ymix; 328 float x_offset; 329 float y_xmix; 330 float y_scale; 331 float y_offset; 332 TouchAffineTransformationTouchAffineTransformation333 TouchAffineTransformation() : 334 x_scale(1.0f), x_ymix(0.0f), x_offset(0.0f), 335 y_xmix(0.0f), y_scale(1.0f), y_offset(0.0f) { 336 } 337 TouchAffineTransformationTouchAffineTransformation338 TouchAffineTransformation(float xscale, float xymix, float xoffset, 339 float yxmix, float yscale, float yoffset) : 340 x_scale(xscale), x_ymix(xymix), x_offset(xoffset), 341 y_xmix(yxmix), y_scale(yscale), y_offset(yoffset) { 342 } 343 344 void applyTo(float& x, float& y) const; 345 }; 346 347 // --- InputReaderPolicyInterface --- 348 349 /* 350 * Input reader policy interface. 351 * 352 * The input reader policy is used by the input reader to interact with the Window Manager 353 * and other system components. 354 * 355 * The actual implementation is partially supported by callbacks into the DVM 356 * via JNI. This interface is also mocked in the unit tests. 357 * 358 * These methods will NOT re-enter the input reader interface, so they may be called from 359 * any method in the input reader interface. 360 */ 361 class InputReaderPolicyInterface : public virtual RefBase { 362 protected: InputReaderPolicyInterface()363 InputReaderPolicyInterface() { } ~InputReaderPolicyInterface()364 virtual ~InputReaderPolicyInterface() { } 365 366 public: 367 /* Gets the input reader configuration. */ 368 virtual void getReaderConfiguration(InputReaderConfiguration* outConfig) = 0; 369 370 /* Gets a pointer controller associated with the specified cursor device (ie. a mouse). */ 371 virtual std::shared_ptr<PointerControllerInterface> obtainPointerController( 372 int32_t deviceId) = 0; 373 374 /* Notifies the input reader policy that some input devices have changed 375 * and provides information about all current input devices. 376 */ 377 virtual void notifyInputDevicesChanged(const std::vector<InputDeviceInfo>& inputDevices) = 0; 378 379 /* Gets the keyboard layout for a particular input device. */ 380 virtual std::shared_ptr<KeyCharacterMap> getKeyboardLayoutOverlay( 381 const InputDeviceIdentifier& identifier) = 0; 382 383 /* Gets a user-supplied alias for a particular input device, or an empty string if none. */ 384 virtual std::string getDeviceAlias(const InputDeviceIdentifier& identifier) = 0; 385 386 /* Gets the affine calibration associated with the specified device. */ 387 virtual TouchAffineTransformation getTouchAffineTransformation( 388 const std::string& inputDeviceDescriptor, int32_t surfaceRotation) = 0; 389 }; 390 391 } // namespace android 392 393 #endif // _UI_INPUT_READER_COMMON_H 394