include/input/Input.h

   1 /*
   2  * Copyright (C) 2010 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 _LIBINPUT_INPUT_H
  18 #define _LIBINPUT_INPUT_H
  19
  20 /**
  21  * Native input event structures.
  22  */
  23
  24 #include <android/input.h>
  25 #include <utils/Vector.h>
  26 #include <utils/KeyedVector.h>
  27 #include <utils/Timers.h>
  28 #include <utils/RefBase.h>
  29 #include <utils/String8.h>
  30
  31 /*
  32  * Additional private constants not defined in ndk/ui/input.h.
  33  */
  34 enum {
  35     /* Signifies that the key is being predispatched */
  36     AKEY_EVENT_FLAG_PREDISPATCH = 0x20000000,
  37
  38     /* Private control to determine when an app is tracking a key sequence. */
  39     AKEY_EVENT_FLAG_START_TRACKING = 0x40000000,
  40
  41     /* Key event is inconsistent with previously sent key events. */
  42     AKEY_EVENT_FLAG_TAINTED = 0x80000000,
  43 };
  44
  45 enum {
  46     /* Motion event is inconsistent with previously sent motion events. */
  47     AMOTION_EVENT_FLAG_TAINTED = 0x80000000,
  48 };
  49
  50 enum {
  51     /* Used when a motion event is not associated with any display.
  52      * Typically used for non-pointer events. */
  53     ADISPLAY_ID_NONE = -1,
  54
  55     /* The default display id. */
  56     ADISPLAY_ID_DEFAULT = 0,
  57 };
  58
  59 enum {
  60     /*
  61      * Indicates that an input device has switches.
  62      * This input source flag is hidden from the API because switches are only used by the system
  63      * and applications have no way to interact with them.
  64      */
  65     AINPUT_SOURCE_SWITCH = 0x80000000,
  66 };
  67
  68 /*
  69  * SystemUiVisibility constants from View.
  70  */
  71 enum {
  72     ASYSTEM_UI_VISIBILITY_STATUS_BAR_VISIBLE = 0,
  73     ASYSTEM_UI_VISIBILITY_STATUS_BAR_HIDDEN = 0x00000001,
  74 };
  75
  76 /*
  77  * Maximum number of pointers supported per motion event.
  78  * Smallest number of pointers is 1.
  79  * (We want at least 10 but some touch controllers obstensibly configured for 10 pointers
  80  * will occasionally emit 11.  There is not much harm making this constant bigger.)
  81  */
  82 #define MAX_POINTERS 16
  83
  84 /*
  85  * Maximum pointer id value supported in a motion event.
  86  * Smallest pointer id is 0.
  87  * (This is limited by our use of BitSet32 to track pointer assignments.)
  88  */
  89 #define MAX_POINTER_ID 31
  90
  91 /*
  92  * Declare a concrete type for the NDK's input event forward declaration.
  93  */
  94 struct AInputEvent {
  95     virtual ~AInputEvent() { }
  96 };
  97
  98 /*
  99  * Declare a concrete type for the NDK's input device forward declaration.
 100  */
 101 struct AInputDevice {
 102     virtual ~AInputDevice() { }
 103 };
 104
 105
 106 namespace android {
 107
 108 #ifdef HAVE_ANDROID_OS
 109 class Parcel;
 110 #endif
 111
 112 /*
 113  * Flags that flow alongside events in the input dispatch system to help with certain
 114  * policy decisions such as waking from device sleep.
 115  *
 116  * These flags are also defined in frameworks/base/core/java/android/view/WindowManagerPolicy.java.
 117  */
 118 enum {
 119     /* These flags originate in RawEvents and are generally set in the key map.
 120      * NOTE: If you edit these flags, also edit labels in KeycodeLabels.h. */
 121
 122     POLICY_FLAG_WAKE = 0x00000001,
 123     POLICY_FLAG_WAKE_DROPPED = 0x00000002,
 124     POLICY_FLAG_SHIFT = 0x00000004,
 125     POLICY_FLAG_CAPS_LOCK = 0x00000008,
 126     POLICY_FLAG_ALT = 0x00000010,
 127     POLICY_FLAG_ALT_GR = 0x00000020,
 128     POLICY_FLAG_MENU = 0x00000040,
 129     POLICY_FLAG_LAUNCHER = 0x00000080,
 130     POLICY_FLAG_VIRTUAL = 0x00000100,
 131     POLICY_FLAG_FUNCTION = 0x00000200,
 132
 133     POLICY_FLAG_RAW_MASK = 0x0000ffff,
 134
 135     /* These flags are set by the input dispatcher. */
 136
 137     // Indicates that the input event was injected.
 138     POLICY_FLAG_INJECTED = 0x01000000,
 139
 140     // Indicates that the input event is from a trusted source such as a directly attached
 141     // input device or an application with system-wide event injection permission.
 142     POLICY_FLAG_TRUSTED = 0x02000000,
 143
 144     // Indicates that the input event has passed through an input filter.
 145     POLICY_FLAG_FILTERED = 0x04000000,
 146
 147     // Disables automatic key repeating behavior.
 148     POLICY_FLAG_DISABLE_KEY_REPEAT = 0x08000000,
 149
 150     /* These flags are set by the input reader policy as it intercepts each event. */
 151
 152     // Indicates that the screen was off when the event was received and the event
 153     // should wake the device.
 154     POLICY_FLAG_WOKE_HERE = 0x10000000,
 155
 156     // Indicates that the screen was dim when the event was received and the event
 157     // should brighten the device.
 158     POLICY_FLAG_BRIGHT_HERE = 0x20000000,
 159
 160     // Indicates that the event should be dispatched to applications.
 161     // The input event should still be sent to the InputDispatcher so that it can see all
 162     // input events received include those that it will not deliver.
 163     POLICY_FLAG_PASS_TO_USER = 0x40000000,
 164 };
 165
 166 /*
 167  * Pointer coordinate data.
 168  */
 169 struct PointerCoords {
 170     enum { MAX_AXES = 14 }; // 14 so that sizeof(PointerCoords) == 64
 171
 172     // Bitfield of axes that are present in this structure.
 173     uint64_t bits;
 174
 175     // Values of axes that are stored in this structure packed in order by axis id
 176     // for each axis that is present in the structure according to 'bits'.
 177     float values[MAX_AXES];
 178
 179     inline void clear() {
 180         bits = 0;
 181     }
 182
 183     float getAxisValue(int32_t axis) const;
 184     status_t setAxisValue(int32_t axis, float value);
 185
 186     void scale(float scale);
 187     void applyOffset(float xOffset, float yOffset);
 188
 189     inline float getX() const {
 190         return getAxisValue(AMOTION_EVENT_AXIS_X);
 191     }
 192
 193     inline float getY() const {
 194         return getAxisValue(AMOTION_EVENT_AXIS_Y);
 195     }
 196
 197 #ifdef HAVE_ANDROID_OS
 198     status_t readFromParcel(Parcel* parcel);
 199     status_t writeToParcel(Parcel* parcel) const;
 200 #endif
 201
 202     bool operator==(const PointerCoords& other) const;
 203     inline bool operator!=(const PointerCoords& other) const {
 204         return !(*this == other);
 205     }
 206
 207     void copyFrom(const PointerCoords& other);
 208
 209 private:
 210     void tooManyAxes(int axis);
 211 };
 212
 213 /*
 214  * Pointer property data.
 215  */
 216 struct PointerProperties {
 217     // The id of the pointer.
 218     int32_t id;
 219
 220     // The pointer tool type.
 221     int32_t toolType;
 222
 223     inline void clear() {
 224         id = -1;
 225         toolType = 0;
 226     }
 227
 228     bool operator==(const PointerProperties& other) const;
 229     inline bool operator!=(const PointerProperties& other) const {
 230         return !(*this == other);
 231     }
 232
 233     void copyFrom(const PointerProperties& other);
 234 };
 235
 236 /*
 237  * Input events.
 238  */
 239 class InputEvent : public AInputEvent {
 240 public:
 241     virtual ~InputEvent() { }
 242
 243     virtual int32_t getType() const = 0;
 244
 245     inline int32_t getDeviceId() const { return mDeviceId; }
 246
 247     inline int32_t getSource() const { return mSource; }
 248
 249     inline void setSource(int32_t source) { mSource = source; }
 250
 251 protected:
 252     void initialize(int32_t deviceId, int32_t source);
 253     void initialize(const InputEvent& from);
 254
 255     int32_t mDeviceId;
 256     int32_t mSource;
 257 };
 258
 259 /*
 260  * Key events.
 261  */
 262 class KeyEvent : public InputEvent {
 263 public:
 264     virtual ~KeyEvent() { }
 265
 266     virtual int32_t getType() const { return AINPUT_EVENT_TYPE_KEY; }
 267
 268     inline int32_t getAction() const { return mAction; }
 269
 270     inline int32_t getFlags() const { return mFlags; }
 271
 272     inline void setFlags(int32_t flags) { mFlags = flags; }
 273
 274     inline int32_t getKeyCode() const { return mKeyCode; }
 275
 276     inline int32_t getScanCode() const { return mScanCode; }
 277
 278     inline int32_t getMetaState() const { return mMetaState; }
 279
 280     inline int32_t getRepeatCount() const { return mRepeatCount; }
 281
 282     inline nsecs_t getDownTime() const { return mDownTime; }
 283
 284     inline nsecs_t getEventTime() const { return mEventTime; }
 285
 286     // Return true if this event may have a default action implementation.
 287     static bool hasDefaultAction(int32_t keyCode);
 288     bool hasDefaultAction() const;
 289
 290     // Return true if this event represents a system key.
 291     static bool isSystemKey(int32_t keyCode);
 292     bool isSystemKey() const;
 293
 294     void initialize(
 295             int32_t deviceId,
 296             int32_t source,
 297             int32_t action,
 298             int32_t flags,
 299             int32_t keyCode,
 300             int32_t scanCode,
 301             int32_t metaState,
 302             int32_t repeatCount,
 303             nsecs_t downTime,
 304             nsecs_t eventTime);
 305     void initialize(const KeyEvent& from);
 306
 307 protected:
 308     int32_t mAction;
 309     int32_t mFlags;
 310     int32_t mKeyCode;
 311     int32_t mScanCode;
 312     int32_t mMetaState;
 313     int32_t mRepeatCount;
 314     nsecs_t mDownTime;
 315     nsecs_t mEventTime;
 316 };
 317
 318 /*
 319  * Motion events.
 320  */
 321 class MotionEvent : public InputEvent {
 322 public:
 323     virtual ~MotionEvent() { }
 324
 325     virtual int32_t getType() const { return AINPUT_EVENT_TYPE_MOTION; }
 326
 327     inline int32_t getAction() const { return mAction; }
 328
 329     inline int32_t getActionMasked() const { return mAction & AMOTION_EVENT_ACTION_MASK; }
 330
 331     inline int32_t getActionIndex() const {
 332         return (mAction & AMOTION_EVENT_ACTION_POINTER_INDEX_MASK)
 333                 >> AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT;
 334     }
 335
 336     inline void setAction(int32_t action) { mAction = action; }
 337
 338     inline int32_t getFlags() const { return mFlags; }
 339
 340     inline void setFlags(int32_t flags) { mFlags = flags; }
 341
 342     inline int32_t getEdgeFlags() const { return mEdgeFlags; }
 343
 344     inline void setEdgeFlags(int32_t edgeFlags) { mEdgeFlags = edgeFlags; }
 345
 346     inline int32_t getMetaState() const { return mMetaState; }
 347
 348     inline void setMetaState(int32_t metaState) { mMetaState = metaState; }
 349
 350     inline int32_t getButtonState() const { return mButtonState; }
 351
 352     inline float getXOffset() const { return mXOffset; }
 353
 354     inline float getYOffset() const { return mYOffset; }
 355
 356     inline float getXPrecision() const { return mXPrecision; }
 357
 358     inline float getYPrecision() const { return mYPrecision; }
 359
 360     inline nsecs_t getDownTime() const { return mDownTime; }
 361
 362     inline void setDownTime(nsecs_t downTime) { mDownTime = downTime; }
 363
 364     inline size_t getPointerCount() const { return mPointerProperties.size(); }
 365
 366     inline const PointerProperties* getPointerProperties(size_t pointerIndex) const {
 367         return &mPointerProperties[pointerIndex];
 368     }
 369
 370     inline int32_t getPointerId(size_t pointerIndex) const {
 371         return mPointerProperties[pointerIndex].id;
 372     }
 373
 374     inline int32_t getToolType(size_t pointerIndex) const {
 375         return mPointerProperties[pointerIndex].toolType;
 376     }
 377
 378     inline nsecs_t getEventTime() const { return mSampleEventTimes[getHistorySize()]; }
 379
 380     const PointerCoords* getRawPointerCoords(size_t pointerIndex) const;
 381
 382     float getRawAxisValue(int32_t axis, size_t pointerIndex) const;
 383
 384     inline float getRawX(size_t pointerIndex) const {
 385         return getRawAxisValue(AMOTION_EVENT_AXIS_X, pointerIndex);
 386     }
 387
 388     inline float getRawY(size_t pointerIndex) const {
 389         return getRawAxisValue(AMOTION_EVENT_AXIS_Y, pointerIndex);
 390     }
 391
 392     float getAxisValue(int32_t axis, size_t pointerIndex) const;
 393
 394     inline float getX(size_t pointerIndex) const {
 395         return getAxisValue(AMOTION_EVENT_AXIS_X, pointerIndex);
 396     }
 397
 398     inline float getY(size_t pointerIndex) const {
 399         return getAxisValue(AMOTION_EVENT_AXIS_Y, pointerIndex);
 400     }
 401
 402     inline float getPressure(size_t pointerIndex) const {
 403         return getAxisValue(AMOTION_EVENT_AXIS_PRESSURE, pointerIndex);
 404     }
 405
 406     inline float getSize(size_t pointerIndex) const {
 407         return getAxisValue(AMOTION_EVENT_AXIS_SIZE, pointerIndex);
 408     }
 409
 410     inline float getTouchMajor(size_t pointerIndex) const {
 411         return getAxisValue(AMOTION_EVENT_AXIS_TOUCH_MAJOR, pointerIndex);
 412     }
 413
 414     inline float getTouchMinor(size_t pointerIndex) const {
 415         return getAxisValue(AMOTION_EVENT_AXIS_TOUCH_MINOR, pointerIndex);
 416     }
 417
 418     inline float getToolMajor(size_t pointerIndex) const {
 419         return getAxisValue(AMOTION_EVENT_AXIS_TOOL_MAJOR, pointerIndex);
 420     }
 421
 422     inline float getToolMinor(size_t pointerIndex) const {
 423         return getAxisValue(AMOTION_EVENT_AXIS_TOOL_MINOR, pointerIndex);
 424     }
 425
 426     inline float getOrientation(size_t pointerIndex) const {
 427         return getAxisValue(AMOTION_EVENT_AXIS_ORIENTATION, pointerIndex);
 428     }
 429
 430     inline size_t getHistorySize() const { return mSampleEventTimes.size() - 1; }
 431
 432     inline nsecs_t getHistoricalEventTime(size_t historicalIndex) const {
 433         return mSampleEventTimes[historicalIndex];
 434     }
 435
 436     const PointerCoords* getHistoricalRawPointerCoords(
 437             size_t pointerIndex, size_t historicalIndex) const;
 438
 439     float getHistoricalRawAxisValue(int32_t axis, size_t pointerIndex,
 440             size_t historicalIndex) const;
 441
 442     inline float getHistoricalRawX(size_t pointerIndex, size_t historicalIndex) const {
 443         return getHistoricalRawAxisValue(
 444                 AMOTION_EVENT_AXIS_X, pointerIndex, historicalIndex);
 445     }
 446
 447     inline float getHistoricalRawY(size_t pointerIndex, size_t historicalIndex) const {
 448         return getHistoricalRawAxisValue(
 449                 AMOTION_EVENT_AXIS_Y, pointerIndex, historicalIndex);
 450     }
 451
 452     float getHistoricalAxisValue(int32_t axis, size_t pointerIndex, size_t historicalIndex) const;
 453
 454     inline float getHistoricalX(size_t pointerIndex, size_t historicalIndex) const {
 455         return getHistoricalAxisValue(
 456                 AMOTION_EVENT_AXIS_X, pointerIndex, historicalIndex);
 457     }
 458
 459     inline float getHistoricalY(size_t pointerIndex, size_t historicalIndex) const {
 460         return getHistoricalAxisValue(
 461                 AMOTION_EVENT_AXIS_Y, pointerIndex, historicalIndex);
 462     }
 463
 464     inline float getHistoricalPressure(size_t pointerIndex, size_t historicalIndex) const {
 465         return getHistoricalAxisValue(
 466                 AMOTION_EVENT_AXIS_PRESSURE, pointerIndex, historicalIndex);
 467     }
 468
 469     inline float getHistoricalSize(size_t pointerIndex, size_t historicalIndex) const {
 470         return getHistoricalAxisValue(
 471                 AMOTION_EVENT_AXIS_SIZE, pointerIndex, historicalIndex);
 472     }
 473
 474     inline float getHistoricalTouchMajor(size_t pointerIndex, size_t historicalIndex) const {
 475         return getHistoricalAxisValue(
 476                 AMOTION_EVENT_AXIS_TOUCH_MAJOR, pointerIndex, historicalIndex);
 477     }
 478
 479     inline float getHistoricalTouchMinor(size_t pointerIndex, size_t historicalIndex) const {
 480         return getHistoricalAxisValue(
 481                 AMOTION_EVENT_AXIS_TOUCH_MINOR, pointerIndex, historicalIndex);
 482     }
 483
 484     inline float getHistoricalToolMajor(size_t pointerIndex, size_t historicalIndex) const {
 485         return getHistoricalAxisValue(
 486                 AMOTION_EVENT_AXIS_TOOL_MAJOR, pointerIndex, historicalIndex);
 487     }
 488
 489     inline float getHistoricalToolMinor(size_t pointerIndex, size_t historicalIndex) const {
 490         return getHistoricalAxisValue(
 491                 AMOTION_EVENT_AXIS_TOOL_MINOR, pointerIndex, historicalIndex);
 492     }
 493
 494     inline float getHistoricalOrientation(size_t pointerIndex, size_t historicalIndex) const {
 495         return getHistoricalAxisValue(
 496                 AMOTION_EVENT_AXIS_ORIENTATION, pointerIndex, historicalIndex);
 497     }
 498
 499     ssize_t findPointerIndex(int32_t pointerId) const;
 500
 501     void initialize(
 502             int32_t deviceId,
 503             int32_t source,
 504             int32_t action,
 505             int32_t flags,
 506             int32_t edgeFlags,
 507             int32_t metaState,
 508             int32_t buttonState,
 509             float xOffset,
 510             float yOffset,
 511             float xPrecision,
 512             float yPrecision,
 513             nsecs_t downTime,
 514             nsecs_t eventTime,
 515             size_t pointerCount,
 516             const PointerProperties* pointerProperties,
 517             const PointerCoords* pointerCoords);
 518
 519     void copyFrom(const MotionEvent* other, bool keepHistory);
 520
 521     void addSample(
 522             nsecs_t eventTime,
 523             const PointerCoords* pointerCoords);
 524
 525     void offsetLocation(float xOffset, float yOffset);
 526
 527     void scale(float scaleFactor);
 528
 529     // Apply 3x3 perspective matrix transformation.
 530     // Matrix is in row-major form and compatible with SkMatrix.
 531     void transform(const float matrix[9]);
 532
 533 #ifdef HAVE_ANDROID_OS
 534     status_t readFromParcel(Parcel* parcel);
 535     status_t writeToParcel(Parcel* parcel) const;
 536 #endif
 537
 538     static bool isTouchEvent(int32_t source, int32_t action);
 539     inline bool isTouchEvent() const {
 540         return isTouchEvent(mSource, mAction);
 541     }
 542
 543     // Low-level accessors.
 544     inline const PointerProperties* getPointerProperties() const {
 545         return mPointerProperties.array();
 546     }
 547     inline const nsecs_t* getSampleEventTimes() const { return mSampleEventTimes.array(); }
 548     inline const PointerCoords* getSamplePointerCoords() const {
 549             return mSamplePointerCoords.array();
 550     }
 551
 552 protected:
 553     int32_t mAction;
 554     int32_t mFlags;
 555     int32_t mEdgeFlags;
 556     int32_t mMetaState;
 557     int32_t mButtonState;
 558     float mXOffset;
 559     float mYOffset;
 560     float mXPrecision;
 561     float mYPrecision;
 562     nsecs_t mDownTime;
 563     Vector<PointerProperties> mPointerProperties;
 564     Vector<nsecs_t> mSampleEventTimes;
 565     Vector<PointerCoords> mSamplePointerCoords;
 566 };
 567
 568 /*
 569  * Input event factory.
 570  */
 571 class InputEventFactoryInterface {
 572 protected:
 573     virtual ~InputEventFactoryInterface() { }
 574
 575 public:
 576     InputEventFactoryInterface() { }
 577
 578     virtual KeyEvent* createKeyEvent() = 0;
 579     virtual MotionEvent* createMotionEvent() = 0;
 580 };
 581
 582 /*
 583  * A simple input event factory implementation that uses a single preallocated instance
 584  * of each type of input event that are reused for each request.
 585  */
 586 class PreallocatedInputEventFactory : public InputEventFactoryInterface {
 587 public:
 588     PreallocatedInputEventFactory() { }
 589     virtual ~PreallocatedInputEventFactory() { }
 590
 591     virtual KeyEvent* createKeyEvent() { return & mKeyEvent; }
 592     virtual MotionEvent* createMotionEvent() { return & mMotionEvent; }
 593
 594 private:
 595     KeyEvent mKeyEvent;
 596     MotionEvent mMotionEvent;
 597 };
 598
 599 /*
 600  * An input event factory implementation that maintains a pool of input events.
 601  */
 602 class PooledInputEventFactory : public InputEventFactoryInterface {
 603 public:
 604     PooledInputEventFactory(size_t maxPoolSize = 20);
 605     virtual ~PooledInputEventFactory();
 606
 607     virtual KeyEvent* createKeyEvent();
 608     virtual MotionEvent* createMotionEvent();
 609
 610     void recycle(InputEvent* event);
 611
 612 private:
 613     const size_t mMaxPoolSize;
 614
 615     Vector<KeyEvent*> mKeyEventPool;
 616     Vector<MotionEvent*> mMotionEventPool;
 617 };
 618
 619 } // namespace android
 620
 621 #endif // _LIBINPUT_INPUT_H