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