Home | History | Annotate | Download | only in input
      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 _UI_INPUT_READER_H
     18 #define _UI_INPUT_READER_H
     19 
     20 #include "EventHub.h"
     21 #include "PointerController.h"
     22 #include "InputListener.h"
     23 
     24 #include <androidfw/Input.h>
     25 #include <androidfw/VelocityControl.h>
     26 #include <androidfw/VelocityTracker.h>
     27 #include <utils/KeyedVector.h>
     28 #include <utils/threads.h>
     29 #include <utils/Timers.h>
     30 #include <utils/RefBase.h>
     31 #include <utils/String8.h>
     32 #include <utils/BitSet.h>
     33 
     34 #include <stddef.h>
     35 #include <unistd.h>
     36 
     37 // Maximum supported size of a vibration pattern.
     38 // Must be at least 2.
     39 #define MAX_VIBRATE_PATTERN_SIZE 100
     40 
     41 // Maximum allowable delay value in a vibration pattern before
     42 // which the delay will be truncated.
     43 #define MAX_VIBRATE_PATTERN_DELAY_NSECS (1000000 * 1000000000LL)
     44 
     45 namespace android {
     46 
     47 class InputDevice;
     48 class InputMapper;
     49 
     50 /*
     51  * Describes how coordinates are mapped on a physical display.
     52  * See com.android.server.display.DisplayViewport.
     53  */
     54 struct DisplayViewport {
     55     int32_t displayId; // -1 if invalid
     56     int32_t orientation;
     57     int32_t logicalLeft;
     58     int32_t logicalTop;
     59     int32_t logicalRight;
     60     int32_t logicalBottom;
     61     int32_t physicalLeft;
     62     int32_t physicalTop;
     63     int32_t physicalRight;
     64     int32_t physicalBottom;
     65     int32_t deviceWidth;
     66     int32_t deviceHeight;
     67 
     68     DisplayViewport() :
     69             displayId(ADISPLAY_ID_NONE), orientation(DISPLAY_ORIENTATION_0),
     70             logicalLeft(0), logicalTop(0), logicalRight(0), logicalBottom(0),
     71             physicalLeft(0), physicalTop(0), physicalRight(0), physicalBottom(0),
     72             deviceWidth(0), deviceHeight(0) {
     73     }
     74 
     75     bool operator==(const DisplayViewport& other) const {
     76         return displayId == other.displayId
     77                 && orientation == other.orientation
     78                 && logicalLeft == other.logicalLeft
     79                 && logicalTop == other.logicalTop
     80                 && logicalRight == other.logicalRight
     81                 && logicalBottom == other.logicalBottom
     82                 && physicalLeft == other.physicalLeft
     83                 && physicalTop == other.physicalTop
     84                 && physicalRight == other.physicalRight
     85                 && physicalBottom == other.physicalBottom
     86                 && deviceWidth == other.deviceWidth
     87                 && deviceHeight == other.deviceHeight;
     88     }
     89 
     90     bool operator!=(const DisplayViewport& other) const {
     91         return !(*this == other);
     92     }
     93 
     94     inline bool isValid() const {
     95         return displayId >= 0;
     96     }
     97 
     98     void setNonDisplayViewport(int32_t width, int32_t height) {
     99         displayId = ADISPLAY_ID_NONE;
    100         orientation = DISPLAY_ORIENTATION_0;
    101         logicalLeft = 0;
    102         logicalTop = 0;
    103         logicalRight = width;
    104         logicalBottom = height;
    105         physicalLeft = 0;
    106         physicalTop = 0;
    107         physicalRight = width;
    108         physicalBottom = height;
    109         deviceWidth = width;
    110         deviceHeight = height;
    111     }
    112 };
    113 
    114 /*
    115  * Input reader configuration.
    116  *
    117  * Specifies various options that modify the behavior of the input reader.
    118  */
    119 struct InputReaderConfiguration {
    120     // Describes changes that have occurred.
    121     enum {
    122         // The pointer speed changed.
    123         CHANGE_POINTER_SPEED = 1 << 0,
    124 
    125         // The pointer gesture control changed.
    126         CHANGE_POINTER_GESTURE_ENABLEMENT = 1 << 1,
    127 
    128         // The display size or orientation changed.
    129         CHANGE_DISPLAY_INFO = 1 << 2,
    130 
    131         // The visible touches option changed.
    132         CHANGE_SHOW_TOUCHES = 1 << 3,
    133 
    134         // The keyboard layouts must be reloaded.
    135         CHANGE_KEYBOARD_LAYOUTS = 1 << 4,
    136 
    137         // The device name alias supplied by the may have changed for some devices.
    138         CHANGE_DEVICE_ALIAS = 1 << 5,
    139 
    140         // All devices must be reopened.
    141         CHANGE_MUST_REOPEN = 1 << 31,
    142     };
    143 
    144     // Gets the amount of time to disable virtual keys after the screen is touched
    145     // in order to filter out accidental virtual key presses due to swiping gestures
    146     // or taps near the edge of the display.  May be 0 to disable the feature.
    147     nsecs_t virtualKeyQuietTime;
    148 
    149     // The excluded device names for the platform.
    150     // Devices with these names will be ignored.
    151     Vector<String8> excludedDeviceNames;
    152 
    153     // Velocity control parameters for mouse pointer movements.
    154     VelocityControlParameters pointerVelocityControlParameters;
    155 
    156     // Velocity control parameters for mouse wheel movements.
    157     VelocityControlParameters wheelVelocityControlParameters;
    158 
    159     // True if pointer gestures are enabled.
    160     bool pointerGesturesEnabled;
    161 
    162     // Quiet time between certain pointer gesture transitions.
    163     // Time to allow for all fingers or buttons to settle into a stable state before
    164     // starting a new gesture.
    165     nsecs_t pointerGestureQuietInterval;
    166 
    167     // The minimum speed that a pointer must travel for us to consider switching the active
    168     // touch pointer to it during a drag.  This threshold is set to avoid switching due
    169     // to noise from a finger resting on the touch pad (perhaps just pressing it down).
    170     float pointerGestureDragMinSwitchSpeed; // in pixels per second
    171 
    172     // Tap gesture delay time.
    173     // The time between down and up must be less than this to be considered a tap.
    174     nsecs_t pointerGestureTapInterval;
    175 
    176     // Tap drag gesture delay time.
    177     // The time between the previous tap's up and the next down must be less than
    178     // this to be considered a drag.  Otherwise, the previous tap is finished and a
    179     // new tap begins.
    180     //
    181     // Note that the previous tap will be held down for this entire duration so this
    182     // interval must be shorter than the long press timeout.
    183     nsecs_t pointerGestureTapDragInterval;
    184 
    185     // The distance in pixels that the pointer is allowed to move from initial down
    186     // to up and still be called a tap.
    187     float pointerGestureTapSlop; // in pixels
    188 
    189     // Time after the first touch points go down to settle on an initial centroid.
    190     // This is intended to be enough time to handle cases where the user puts down two
    191     // fingers at almost but not quite exactly the same time.
    192     nsecs_t pointerGestureMultitouchSettleInterval;
    193 
    194     // The transition from PRESS to SWIPE or FREEFORM gesture mode is made when
    195     // at least two pointers have moved at least this far from their starting place.
    196     float pointerGestureMultitouchMinDistance; // in pixels
    197 
    198     // The transition from PRESS to SWIPE gesture mode can only occur when the
    199     // cosine of the angle between the two vectors is greater than or equal to than this value
    200     // which indicates that the vectors are oriented in the same direction.
    201     // When the vectors are oriented in the exactly same direction, the cosine is 1.0.
    202     // (In exactly opposite directions, the cosine is -1.0.)
    203     float pointerGestureSwipeTransitionAngleCosine;
    204 
    205     // The transition from PRESS to SWIPE gesture mode can only occur when the
    206     // fingers are no more than this far apart relative to the diagonal size of
    207     // the touch pad.  For example, a ratio of 0.5 means that the fingers must be
    208     // no more than half the diagonal size of the touch pad apart.
    209     float pointerGestureSwipeMaxWidthRatio;
    210 
    211     // The gesture movement speed factor relative to the size of the display.
    212     // Movement speed applies when the fingers are moving in the same direction.
    213     // Without acceleration, a full swipe of the touch pad diagonal in movement mode
    214     // will cover this portion of the display diagonal.
    215     float pointerGestureMovementSpeedRatio;
    216 
    217     // The gesture zoom speed factor relative to the size of the display.
    218     // Zoom speed applies when the fingers are mostly moving relative to each other
    219     // to execute a scale gesture or similar.
    220     // Without acceleration, a full swipe of the touch pad diagonal in zoom mode
    221     // will cover this portion of the display diagonal.
    222     float pointerGestureZoomSpeedRatio;
    223 
    224     // True to show the location of touches on the touch screen as spots.
    225     bool showTouches;
    226 
    227     InputReaderConfiguration() :
    228             virtualKeyQuietTime(0),
    229             pointerVelocityControlParameters(1.0f, 500.0f, 3000.0f, 3.0f),
    230             wheelVelocityControlParameters(1.0f, 15.0f, 50.0f, 4.0f),
    231             pointerGesturesEnabled(true),
    232             pointerGestureQuietInterval(100 * 1000000LL), // 100 ms
    233             pointerGestureDragMinSwitchSpeed(50), // 50 pixels per second
    234             pointerGestureTapInterval(150 * 1000000LL), // 150 ms
    235             pointerGestureTapDragInterval(150 * 1000000LL), // 150 ms
    236             pointerGestureTapSlop(10.0f), // 10 pixels
    237             pointerGestureMultitouchSettleInterval(100 * 1000000LL), // 100 ms
    238             pointerGestureMultitouchMinDistance(15), // 15 pixels
    239             pointerGestureSwipeTransitionAngleCosine(0.2588f), // cosine of 75 degrees
    240             pointerGestureSwipeMaxWidthRatio(0.25f),
    241             pointerGestureMovementSpeedRatio(0.8f),
    242             pointerGestureZoomSpeedRatio(0.3f),
    243             showTouches(false) { }
    244 
    245     bool getDisplayInfo(bool external, DisplayViewport* outViewport) const;
    246     void setDisplayInfo(bool external, const DisplayViewport& viewport);
    247 
    248 private:
    249     DisplayViewport mInternalDisplay;
    250     DisplayViewport mExternalDisplay;
    251 };
    252 
    253 
    254 /*
    255  * Input reader policy interface.
    256  *
    257  * The input reader policy is used by the input reader to interact with the Window Manager
    258  * and other system components.
    259  *
    260  * The actual implementation is partially supported by callbacks into the DVM
    261  * via JNI.  This interface is also mocked in the unit tests.
    262  *
    263  * These methods must NOT re-enter the input reader since they may be called while
    264  * holding the input reader lock.
    265  */
    266 class InputReaderPolicyInterface : public virtual RefBase {
    267 protected:
    268     InputReaderPolicyInterface() { }
    269     virtual ~InputReaderPolicyInterface() { }
    270 
    271 public:
    272     /* Gets the input reader configuration. */
    273     virtual void getReaderConfiguration(InputReaderConfiguration* outConfig) = 0;
    274 
    275     /* Gets a pointer controller associated with the specified cursor device (ie. a mouse). */
    276     virtual sp<PointerControllerInterface> obtainPointerController(int32_t deviceId) = 0;
    277 
    278     /* Notifies the input reader policy that some input devices have changed
    279      * and provides information about all current input devices.
    280      */
    281     virtual void notifyInputDevicesChanged(const Vector<InputDeviceInfo>& inputDevices) = 0;
    282 
    283     /* Gets the keyboard layout for a particular input device. */
    284     virtual sp<KeyCharacterMap> getKeyboardLayoutOverlay(const String8& inputDeviceDescriptor) = 0;
    285 
    286     /* Gets a user-supplied alias for a particular input device, or an empty string if none. */
    287     virtual String8 getDeviceAlias(const InputDeviceIdentifier& identifier) = 0;
    288 };
    289 
    290 
    291 /* Processes raw input events and sends cooked event data to an input listener. */
    292 class InputReaderInterface : public virtual RefBase {
    293 protected:
    294     InputReaderInterface() { }
    295     virtual ~InputReaderInterface() { }
    296 
    297 public:
    298     /* Dumps the state of the input reader.
    299      *
    300      * This method may be called on any thread (usually by the input manager). */
    301     virtual void dump(String8& dump) = 0;
    302 
    303     /* Called by the heatbeat to ensures that the reader has not deadlocked. */
    304     virtual void monitor() = 0;
    305 
    306     /* Runs a single iteration of the processing loop.
    307      * Nominally reads and processes one incoming message from the EventHub.
    308      *
    309      * This method should be called on the input reader thread.
    310      */
    311     virtual void loopOnce() = 0;
    312 
    313     /* Gets information about all input devices.
    314      *
    315      * This method may be called on any thread (usually by the input manager).
    316      */
    317     virtual void getInputDevices(Vector<InputDeviceInfo>& outInputDevices) = 0;
    318 
    319     /* Query current input state. */
    320     virtual int32_t getScanCodeState(int32_t deviceId, uint32_t sourceMask,
    321             int32_t scanCode) = 0;
    322     virtual int32_t getKeyCodeState(int32_t deviceId, uint32_t sourceMask,
    323             int32_t keyCode) = 0;
    324     virtual int32_t getSwitchState(int32_t deviceId, uint32_t sourceMask,
    325             int32_t sw) = 0;
    326 
    327     /* Determine whether physical keys exist for the given framework-domain key codes. */
    328     virtual bool hasKeys(int32_t deviceId, uint32_t sourceMask,
    329             size_t numCodes, const int32_t* keyCodes, uint8_t* outFlags) = 0;
    330 
    331     /* Requests that a reconfiguration of all input devices.
    332      * The changes flag is a bitfield that indicates what has changed and whether
    333      * the input devices must all be reopened. */
    334     virtual void requestRefreshConfiguration(uint32_t changes) = 0;
    335 
    336     /* Controls the vibrator of a particular input device. */
    337     virtual void vibrate(int32_t deviceId, const nsecs_t* pattern, size_t patternSize,
    338             ssize_t repeat, int32_t token) = 0;
    339     virtual void cancelVibrate(int32_t deviceId, int32_t token) = 0;
    340 };
    341 
    342 
    343 /* Internal interface used by individual input devices to access global input device state
    344  * and parameters maintained by the input reader.
    345  */
    346 class InputReaderContext {
    347 public:
    348     InputReaderContext() { }
    349     virtual ~InputReaderContext() { }
    350 
    351     virtual void updateGlobalMetaState() = 0;
    352     virtual int32_t getGlobalMetaState() = 0;
    353 
    354     virtual void disableVirtualKeysUntil(nsecs_t time) = 0;
    355     virtual bool shouldDropVirtualKey(nsecs_t now,
    356             InputDevice* device, int32_t keyCode, int32_t scanCode) = 0;
    357 
    358     virtual void fadePointer() = 0;
    359 
    360     virtual void requestTimeoutAtTime(nsecs_t when) = 0;
    361     virtual int32_t bumpGeneration() = 0;
    362 
    363     virtual InputReaderPolicyInterface* getPolicy() = 0;
    364     virtual InputListenerInterface* getListener() = 0;
    365     virtual EventHubInterface* getEventHub() = 0;
    366 };
    367 
    368 
    369 /* The input reader reads raw event data from the event hub and processes it into input events
    370  * that it sends to the input listener.  Some functions of the input reader, such as early
    371  * event filtering in low power states, are controlled by a separate policy object.
    372  *
    373  * The InputReader owns a collection of InputMappers.  Most of the work it does happens
    374  * on the input reader thread but the InputReader can receive queries from other system
    375  * components running on arbitrary threads.  To keep things manageable, the InputReader
    376  * uses a single Mutex to guard its state.  The Mutex may be held while calling into the
    377  * EventHub or the InputReaderPolicy but it is never held while calling into the
    378  * InputListener.
    379  */
    380 class InputReader : public InputReaderInterface {
    381 public:
    382     InputReader(const sp<EventHubInterface>& eventHub,
    383             const sp<InputReaderPolicyInterface>& policy,
    384             const sp<InputListenerInterface>& listener);
    385     virtual ~InputReader();
    386 
    387     virtual void dump(String8& dump);
    388     virtual void monitor();
    389 
    390     virtual void loopOnce();
    391 
    392     virtual void getInputDevices(Vector<InputDeviceInfo>& outInputDevices);
    393 
    394     virtual int32_t getScanCodeState(int32_t deviceId, uint32_t sourceMask,
    395             int32_t scanCode);
    396     virtual int32_t getKeyCodeState(int32_t deviceId, uint32_t sourceMask,
    397             int32_t keyCode);
    398     virtual int32_t getSwitchState(int32_t deviceId, uint32_t sourceMask,
    399             int32_t sw);
    400 
    401     virtual bool hasKeys(int32_t deviceId, uint32_t sourceMask,
    402             size_t numCodes, const int32_t* keyCodes, uint8_t* outFlags);
    403 
    404     virtual void requestRefreshConfiguration(uint32_t changes);
    405 
    406     virtual void vibrate(int32_t deviceId, const nsecs_t* pattern, size_t patternSize,
    407             ssize_t repeat, int32_t token);
    408     virtual void cancelVibrate(int32_t deviceId, int32_t token);
    409 
    410 protected:
    411     // These members are protected so they can be instrumented by test cases.
    412     virtual InputDevice* createDeviceLocked(int32_t deviceId,
    413             const InputDeviceIdentifier& identifier, uint32_t classes);
    414 
    415     class ContextImpl : public InputReaderContext {
    416         InputReader* mReader;
    417 
    418     public:
    419         ContextImpl(InputReader* reader);
    420 
    421         virtual void updateGlobalMetaState();
    422         virtual int32_t getGlobalMetaState();
    423         virtual void disableVirtualKeysUntil(nsecs_t time);
    424         virtual bool shouldDropVirtualKey(nsecs_t now,
    425                 InputDevice* device, int32_t keyCode, int32_t scanCode);
    426         virtual void fadePointer();
    427         virtual void requestTimeoutAtTime(nsecs_t when);
    428         virtual int32_t bumpGeneration();
    429         virtual InputReaderPolicyInterface* getPolicy();
    430         virtual InputListenerInterface* getListener();
    431         virtual EventHubInterface* getEventHub();
    432     } mContext;
    433 
    434     friend class ContextImpl;
    435 
    436 private:
    437     Mutex mLock;
    438 
    439     Condition mReaderIsAliveCondition;
    440 
    441     sp<EventHubInterface> mEventHub;
    442     sp<InputReaderPolicyInterface> mPolicy;
    443     sp<QueuedInputListener> mQueuedListener;
    444 
    445     InputReaderConfiguration mConfig;
    446 
    447     // The event queue.
    448     static const int EVENT_BUFFER_SIZE = 256;
    449     RawEvent mEventBuffer[EVENT_BUFFER_SIZE];
    450 
    451     KeyedVector<int32_t, InputDevice*> mDevices;
    452 
    453     // low-level input event decoding and device management
    454     void processEventsLocked(const RawEvent* rawEvents, size_t count);
    455 
    456     void addDeviceLocked(nsecs_t when, int32_t deviceId);
    457     void removeDeviceLocked(nsecs_t when, int32_t deviceId);
    458     void processEventsForDeviceLocked(int32_t deviceId, const RawEvent* rawEvents, size_t count);
    459     void timeoutExpiredLocked(nsecs_t when);
    460 
    461     void handleConfigurationChangedLocked(nsecs_t when);
    462 
    463     int32_t mGlobalMetaState;
    464     void updateGlobalMetaStateLocked();
    465     int32_t getGlobalMetaStateLocked();
    466 
    467     void fadePointerLocked();
    468 
    469     int32_t mGeneration;
    470     int32_t bumpGenerationLocked();
    471 
    472     void getInputDevicesLocked(Vector<InputDeviceInfo>& outInputDevices);
    473 
    474     nsecs_t mDisableVirtualKeysTimeout;
    475     void disableVirtualKeysUntilLocked(nsecs_t time);
    476     bool shouldDropVirtualKeyLocked(nsecs_t now,
    477             InputDevice* device, int32_t keyCode, int32_t scanCode);
    478 
    479     nsecs_t mNextTimeout;
    480     void requestTimeoutAtTimeLocked(nsecs_t when);
    481 
    482     uint32_t mConfigurationChangesToRefresh;
    483     void refreshConfigurationLocked(uint32_t changes);
    484 
    485     // state queries
    486     typedef int32_t (InputDevice::*GetStateFunc)(uint32_t sourceMask, int32_t code);
    487     int32_t getStateLocked(int32_t deviceId, uint32_t sourceMask, int32_t code,
    488             GetStateFunc getStateFunc);
    489     bool markSupportedKeyCodesLocked(int32_t deviceId, uint32_t sourceMask, size_t numCodes,
    490             const int32_t* keyCodes, uint8_t* outFlags);
    491 };
    492 
    493 
    494 /* Reads raw events from the event hub and processes them, endlessly. */
    495 class InputReaderThread : public Thread {
    496 public:
    497     InputReaderThread(const sp<InputReaderInterface>& reader);
    498     virtual ~InputReaderThread();
    499 
    500 private:
    501     sp<InputReaderInterface> mReader;
    502 
    503     virtual bool threadLoop();
    504 };
    505 
    506 
    507 /* Represents the state of a single input device. */
    508 class InputDevice {
    509 public:
    510     InputDevice(InputReaderContext* context, int32_t id, int32_t generation,
    511             const InputDeviceIdentifier& identifier, uint32_t classes);
    512     ~InputDevice();
    513 
    514     inline InputReaderContext* getContext() { return mContext; }
    515     inline int32_t getId() { return mId; }
    516     inline int32_t getGeneration() { return mGeneration; }
    517     inline const String8& getName() { return mIdentifier.name; }
    518     inline uint32_t getClasses() { return mClasses; }
    519     inline uint32_t getSources() { return mSources; }
    520 
    521     inline bool isExternal() { return mIsExternal; }
    522     inline void setExternal(bool external) { mIsExternal = external; }
    523 
    524     inline bool isIgnored() { return mMappers.isEmpty(); }
    525 
    526     void dump(String8& dump);
    527     void addMapper(InputMapper* mapper);
    528     void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
    529     void reset(nsecs_t when);
    530     void process(const RawEvent* rawEvents, size_t count);
    531     void timeoutExpired(nsecs_t when);
    532 
    533     void getDeviceInfo(InputDeviceInfo* outDeviceInfo);
    534     int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode);
    535     int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
    536     int32_t getSwitchState(uint32_t sourceMask, int32_t switchCode);
    537     bool markSupportedKeyCodes(uint32_t sourceMask, size_t numCodes,
    538             const int32_t* keyCodes, uint8_t* outFlags);
    539     void vibrate(const nsecs_t* pattern, size_t patternSize, ssize_t repeat, int32_t token);
    540     void cancelVibrate(int32_t token);
    541 
    542     int32_t getMetaState();
    543 
    544     void fadePointer();
    545 
    546     void bumpGeneration();
    547 
    548     void notifyReset(nsecs_t when);
    549 
    550     inline const PropertyMap& getConfiguration() { return mConfiguration; }
    551     inline EventHubInterface* getEventHub() { return mContext->getEventHub(); }
    552 
    553     bool hasKey(int32_t code) {
    554         return getEventHub()->hasScanCode(mId, code);
    555     }
    556 
    557     bool hasAbsoluteAxis(int32_t code) {
    558         RawAbsoluteAxisInfo info;
    559         getEventHub()->getAbsoluteAxisInfo(mId, code, &info);
    560         return info.valid;
    561     }
    562 
    563     bool isKeyPressed(int32_t code) {
    564         return getEventHub()->getScanCodeState(mId, code) == AKEY_STATE_DOWN;
    565     }
    566 
    567     int32_t getAbsoluteAxisValue(int32_t code) {
    568         int32_t value;
    569         getEventHub()->getAbsoluteAxisValue(mId, code, &value);
    570         return value;
    571     }
    572 
    573 private:
    574     InputReaderContext* mContext;
    575     int32_t mId;
    576     int32_t mGeneration;
    577     InputDeviceIdentifier mIdentifier;
    578     String8 mAlias;
    579     uint32_t mClasses;
    580 
    581     Vector<InputMapper*> mMappers;
    582 
    583     uint32_t mSources;
    584     bool mIsExternal;
    585     bool mDropUntilNextSync;
    586 
    587     typedef int32_t (InputMapper::*GetStateFunc)(uint32_t sourceMask, int32_t code);
    588     int32_t getState(uint32_t sourceMask, int32_t code, GetStateFunc getStateFunc);
    589 
    590     PropertyMap mConfiguration;
    591 };
    592 
    593 
    594 /* Keeps track of the state of mouse or touch pad buttons. */
    595 class CursorButtonAccumulator {
    596 public:
    597     CursorButtonAccumulator();
    598     void reset(InputDevice* device);
    599 
    600     void process(const RawEvent* rawEvent);
    601 
    602     uint32_t getButtonState() const;
    603 
    604 private:
    605     bool mBtnLeft;
    606     bool mBtnRight;
    607     bool mBtnMiddle;
    608     bool mBtnBack;
    609     bool mBtnSide;
    610     bool mBtnForward;
    611     bool mBtnExtra;
    612     bool mBtnTask;
    613 
    614     void clearButtons();
    615 };
    616 
    617 
    618 /* Keeps track of cursor movements. */
    619 
    620 class CursorMotionAccumulator {
    621 public:
    622     CursorMotionAccumulator();
    623     void reset(InputDevice* device);
    624 
    625     void process(const RawEvent* rawEvent);
    626     void finishSync();
    627 
    628     inline int32_t getRelativeX() const { return mRelX; }
    629     inline int32_t getRelativeY() const { return mRelY; }
    630 
    631 private:
    632     int32_t mRelX;
    633     int32_t mRelY;
    634 
    635     void clearRelativeAxes();
    636 };
    637 
    638 
    639 /* Keeps track of cursor scrolling motions. */
    640 
    641 class CursorScrollAccumulator {
    642 public:
    643     CursorScrollAccumulator();
    644     void configure(InputDevice* device);
    645     void reset(InputDevice* device);
    646 
    647     void process(const RawEvent* rawEvent);
    648     void finishSync();
    649 
    650     inline bool haveRelativeVWheel() const { return mHaveRelWheel; }
    651     inline bool haveRelativeHWheel() const { return mHaveRelHWheel; }
    652 
    653     inline int32_t getRelativeX() const { return mRelX; }
    654     inline int32_t getRelativeY() const { return mRelY; }
    655     inline int32_t getRelativeVWheel() const { return mRelWheel; }
    656     inline int32_t getRelativeHWheel() const { return mRelHWheel; }
    657 
    658 private:
    659     bool mHaveRelWheel;
    660     bool mHaveRelHWheel;
    661 
    662     int32_t mRelX;
    663     int32_t mRelY;
    664     int32_t mRelWheel;
    665     int32_t mRelHWheel;
    666 
    667     void clearRelativeAxes();
    668 };
    669 
    670 
    671 /* Keeps track of the state of touch, stylus and tool buttons. */
    672 class TouchButtonAccumulator {
    673 public:
    674     TouchButtonAccumulator();
    675     void configure(InputDevice* device);
    676     void reset(InputDevice* device);
    677 
    678     void process(const RawEvent* rawEvent);
    679 
    680     uint32_t getButtonState() const;
    681     int32_t getToolType() const;
    682     bool isToolActive() const;
    683     bool isHovering() const;
    684     bool hasStylus() const;
    685 
    686 private:
    687     bool mHaveBtnTouch;
    688     bool mHaveStylus;
    689 
    690     bool mBtnTouch;
    691     bool mBtnStylus;
    692     bool mBtnStylus2;
    693     bool mBtnToolFinger;
    694     bool mBtnToolPen;
    695     bool mBtnToolRubber;
    696     bool mBtnToolBrush;
    697     bool mBtnToolPencil;
    698     bool mBtnToolAirbrush;
    699     bool mBtnToolMouse;
    700     bool mBtnToolLens;
    701     bool mBtnToolDoubleTap;
    702     bool mBtnToolTripleTap;
    703     bool mBtnToolQuadTap;
    704 
    705     void clearButtons();
    706 };
    707 
    708 
    709 /* Raw axis information from the driver. */
    710 struct RawPointerAxes {
    711     RawAbsoluteAxisInfo x;
    712     RawAbsoluteAxisInfo y;
    713     RawAbsoluteAxisInfo pressure;
    714     RawAbsoluteAxisInfo touchMajor;
    715     RawAbsoluteAxisInfo touchMinor;
    716     RawAbsoluteAxisInfo toolMajor;
    717     RawAbsoluteAxisInfo toolMinor;
    718     RawAbsoluteAxisInfo orientation;
    719     RawAbsoluteAxisInfo distance;
    720     RawAbsoluteAxisInfo tiltX;
    721     RawAbsoluteAxisInfo tiltY;
    722     RawAbsoluteAxisInfo trackingId;
    723     RawAbsoluteAxisInfo slot;
    724 
    725     RawPointerAxes();
    726     void clear();
    727 };
    728 
    729 
    730 /* Raw data for a collection of pointers including a pointer id mapping table. */
    731 struct RawPointerData {
    732     struct Pointer {
    733         uint32_t id;
    734         int32_t x;
    735         int32_t y;
    736         int32_t pressure;
    737         int32_t touchMajor;
    738         int32_t touchMinor;
    739         int32_t toolMajor;
    740         int32_t toolMinor;
    741         int32_t orientation;
    742         int32_t distance;
    743         int32_t tiltX;
    744         int32_t tiltY;
    745         int32_t toolType; // a fully decoded AMOTION_EVENT_TOOL_TYPE constant
    746         bool isHovering;
    747     };
    748 
    749     uint32_t pointerCount;
    750     Pointer pointers[MAX_POINTERS];
    751     BitSet32 hoveringIdBits, touchingIdBits;
    752     uint32_t idToIndex[MAX_POINTER_ID + 1];
    753 
    754     RawPointerData();
    755     void clear();
    756     void copyFrom(const RawPointerData& other);
    757     void getCentroidOfTouchingPointers(float* outX, float* outY) const;
    758 
    759     inline void markIdBit(uint32_t id, bool isHovering) {
    760         if (isHovering) {
    761             hoveringIdBits.markBit(id);
    762         } else {
    763             touchingIdBits.markBit(id);
    764         }
    765     }
    766 
    767     inline void clearIdBits() {
    768         hoveringIdBits.clear();
    769         touchingIdBits.clear();
    770     }
    771 
    772     inline const Pointer& pointerForId(uint32_t id) const {
    773         return pointers[idToIndex[id]];
    774     }
    775 
    776     inline bool isHovering(uint32_t pointerIndex) {
    777         return pointers[pointerIndex].isHovering;
    778     }
    779 };
    780 
    781 
    782 /* Cooked data for a collection of pointers including a pointer id mapping table. */
    783 struct CookedPointerData {
    784     uint32_t pointerCount;
    785     PointerProperties pointerProperties[MAX_POINTERS];
    786     PointerCoords pointerCoords[MAX_POINTERS];
    787     BitSet32 hoveringIdBits, touchingIdBits;
    788     uint32_t idToIndex[MAX_POINTER_ID + 1];
    789 
    790     CookedPointerData();
    791     void clear();
    792     void copyFrom(const CookedPointerData& other);
    793 
    794     inline const PointerCoords& pointerCoordsForId(uint32_t id) const {
    795         return pointerCoords[idToIndex[id]];
    796     }
    797 
    798     inline bool isHovering(uint32_t pointerIndex) {
    799         return hoveringIdBits.hasBit(pointerProperties[pointerIndex].id);
    800     }
    801 };
    802 
    803 
    804 /* Keeps track of the state of single-touch protocol. */
    805 class SingleTouchMotionAccumulator {
    806 public:
    807     SingleTouchMotionAccumulator();
    808 
    809     void process(const RawEvent* rawEvent);
    810     void reset(InputDevice* device);
    811 
    812     inline int32_t getAbsoluteX() const { return mAbsX; }
    813     inline int32_t getAbsoluteY() const { return mAbsY; }
    814     inline int32_t getAbsolutePressure() const { return mAbsPressure; }
    815     inline int32_t getAbsoluteToolWidth() const { return mAbsToolWidth; }
    816     inline int32_t getAbsoluteDistance() const { return mAbsDistance; }
    817     inline int32_t getAbsoluteTiltX() const { return mAbsTiltX; }
    818     inline int32_t getAbsoluteTiltY() const { return mAbsTiltY; }
    819 
    820 private:
    821     int32_t mAbsX;
    822     int32_t mAbsY;
    823     int32_t mAbsPressure;
    824     int32_t mAbsToolWidth;
    825     int32_t mAbsDistance;
    826     int32_t mAbsTiltX;
    827     int32_t mAbsTiltY;
    828 
    829     void clearAbsoluteAxes();
    830 };
    831 
    832 
    833 /* Keeps track of the state of multi-touch protocol. */
    834 class MultiTouchMotionAccumulator {
    835 public:
    836     class Slot {
    837     public:
    838         inline bool isInUse() const { return mInUse; }
    839         inline int32_t getX() const { return mAbsMTPositionX; }
    840         inline int32_t getY() const { return mAbsMTPositionY; }
    841         inline int32_t getTouchMajor() const { return mAbsMTTouchMajor; }
    842         inline int32_t getTouchMinor() const {
    843             return mHaveAbsMTTouchMinor ? mAbsMTTouchMinor : mAbsMTTouchMajor; }
    844         inline int32_t getToolMajor() const { return mAbsMTWidthMajor; }
    845         inline int32_t getToolMinor() const {
    846             return mHaveAbsMTWidthMinor ? mAbsMTWidthMinor : mAbsMTWidthMajor; }
    847         inline int32_t getOrientation() const { return mAbsMTOrientation; }
    848         inline int32_t getTrackingId() const { return mAbsMTTrackingId; }
    849         inline int32_t getPressure() const { return mAbsMTPressure; }
    850         inline int32_t getDistance() const { return mAbsMTDistance; }
    851         inline int32_t getToolType() const;
    852 
    853     private:
    854         friend class MultiTouchMotionAccumulator;
    855 
    856         bool mInUse;
    857         bool mHaveAbsMTTouchMinor;
    858         bool mHaveAbsMTWidthMinor;
    859         bool mHaveAbsMTToolType;
    860 
    861         int32_t mAbsMTPositionX;
    862         int32_t mAbsMTPositionY;
    863         int32_t mAbsMTTouchMajor;
    864         int32_t mAbsMTTouchMinor;
    865         int32_t mAbsMTWidthMajor;
    866         int32_t mAbsMTWidthMinor;
    867         int32_t mAbsMTOrientation;
    868         int32_t mAbsMTTrackingId;
    869         int32_t mAbsMTPressure;
    870         int32_t mAbsMTDistance;
    871         int32_t mAbsMTToolType;
    872 
    873         Slot();
    874         void clear();
    875     };
    876 
    877     MultiTouchMotionAccumulator();
    878     ~MultiTouchMotionAccumulator();
    879 
    880     void configure(InputDevice* device, size_t slotCount, bool usingSlotsProtocol);
    881     void reset(InputDevice* device);
    882     void process(const RawEvent* rawEvent);
    883     void finishSync();
    884     bool hasStylus() const;
    885 
    886     inline size_t getSlotCount() const { return mSlotCount; }
    887     inline const Slot* getSlot(size_t index) const { return &mSlots[index]; }
    888 
    889 private:
    890     int32_t mCurrentSlot;
    891     Slot* mSlots;
    892     size_t mSlotCount;
    893     bool mUsingSlotsProtocol;
    894     bool mHaveStylus;
    895 
    896     void clearSlots(int32_t initialSlot);
    897 };
    898 
    899 
    900 /* An input mapper transforms raw input events into cooked event data.
    901  * A single input device can have multiple associated input mappers in order to interpret
    902  * different classes of events.
    903  *
    904  * InputMapper lifecycle:
    905  * - create
    906  * - configure with 0 changes
    907  * - reset
    908  * - process, process, process (may occasionally reconfigure with non-zero changes or reset)
    909  * - reset
    910  * - destroy
    911  */
    912 class InputMapper {
    913 public:
    914     InputMapper(InputDevice* device);
    915     virtual ~InputMapper();
    916 
    917     inline InputDevice* getDevice() { return mDevice; }
    918     inline int32_t getDeviceId() { return mDevice->getId(); }
    919     inline const String8 getDeviceName() { return mDevice->getName(); }
    920     inline InputReaderContext* getContext() { return mContext; }
    921     inline InputReaderPolicyInterface* getPolicy() { return mContext->getPolicy(); }
    922     inline InputListenerInterface* getListener() { return mContext->getListener(); }
    923     inline EventHubInterface* getEventHub() { return mContext->getEventHub(); }
    924 
    925     virtual uint32_t getSources() = 0;
    926     virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
    927     virtual void dump(String8& dump);
    928     virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
    929     virtual void reset(nsecs_t when);
    930     virtual void process(const RawEvent* rawEvent) = 0;
    931     virtual void timeoutExpired(nsecs_t when);
    932 
    933     virtual int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode);
    934     virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
    935     virtual int32_t getSwitchState(uint32_t sourceMask, int32_t switchCode);
    936     virtual bool markSupportedKeyCodes(uint32_t sourceMask, size_t numCodes,
    937             const int32_t* keyCodes, uint8_t* outFlags);
    938     virtual void vibrate(const nsecs_t* pattern, size_t patternSize, ssize_t repeat,
    939             int32_t token);
    940     virtual void cancelVibrate(int32_t token);
    941 
    942     virtual int32_t getMetaState();
    943 
    944     virtual void fadePointer();
    945 
    946 protected:
    947     InputDevice* mDevice;
    948     InputReaderContext* mContext;
    949 
    950     status_t getAbsoluteAxisInfo(int32_t axis, RawAbsoluteAxisInfo* axisInfo);
    951     void bumpGeneration();
    952 
    953     static void dumpRawAbsoluteAxisInfo(String8& dump,
    954             const RawAbsoluteAxisInfo& axis, const char* name);
    955 };
    956 
    957 
    958 class SwitchInputMapper : public InputMapper {
    959 public:
    960     SwitchInputMapper(InputDevice* device);
    961     virtual ~SwitchInputMapper();
    962 
    963     virtual uint32_t getSources();
    964     virtual void process(const RawEvent* rawEvent);
    965 
    966     virtual int32_t getSwitchState(uint32_t sourceMask, int32_t switchCode);
    967 
    968 private:
    969     uint32_t mUpdatedSwitchValues;
    970     uint32_t mUpdatedSwitchMask;
    971 
    972     void processSwitch(int32_t switchCode, int32_t switchValue);
    973     void sync(nsecs_t when);
    974 };
    975 
    976 
    977 class VibratorInputMapper : public InputMapper {
    978 public:
    979     VibratorInputMapper(InputDevice* device);
    980     virtual ~VibratorInputMapper();
    981 
    982     virtual uint32_t getSources();
    983     virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
    984     virtual void process(const RawEvent* rawEvent);
    985 
    986     virtual void vibrate(const nsecs_t* pattern, size_t patternSize, ssize_t repeat,
    987             int32_t token);
    988     virtual void cancelVibrate(int32_t token);
    989     virtual void timeoutExpired(nsecs_t when);
    990     virtual void dump(String8& dump);
    991 
    992 private:
    993     bool mVibrating;
    994     nsecs_t mPattern[MAX_VIBRATE_PATTERN_SIZE];
    995     size_t mPatternSize;
    996     ssize_t mRepeat;
    997     int32_t mToken;
    998     ssize_t mIndex;
    999     nsecs_t mNextStepTime;
   1000 
   1001     void nextStep();
   1002     void stopVibrating();
   1003 };
   1004 
   1005 
   1006 class KeyboardInputMapper : public InputMapper {
   1007 public:
   1008     KeyboardInputMapper(InputDevice* device, uint32_t source, int32_t keyboardType);
   1009     virtual ~KeyboardInputMapper();
   1010 
   1011     virtual uint32_t getSources();
   1012     virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
   1013     virtual void dump(String8& dump);
   1014     virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
   1015     virtual void reset(nsecs_t when);
   1016     virtual void process(const RawEvent* rawEvent);
   1017 
   1018     virtual int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode);
   1019     virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
   1020     virtual bool markSupportedKeyCodes(uint32_t sourceMask, size_t numCodes,
   1021             const int32_t* keyCodes, uint8_t* outFlags);
   1022 
   1023     virtual int32_t getMetaState();
   1024 
   1025 private:
   1026     struct KeyDown {
   1027         int32_t keyCode;
   1028         int32_t scanCode;
   1029     };
   1030 
   1031     uint32_t mSource;
   1032     int32_t mKeyboardType;
   1033 
   1034     int32_t mOrientation; // orientation for dpad keys
   1035 
   1036     Vector<KeyDown> mKeyDowns; // keys that are down
   1037     int32_t mMetaState;
   1038     nsecs_t mDownTime; // time of most recent key down
   1039 
   1040     int32_t mCurrentHidUsage; // most recent HID usage seen this packet, or 0 if none
   1041 
   1042     struct LedState {
   1043         bool avail; // led is available
   1044         bool on;    // we think the led is currently on
   1045     };
   1046     LedState mCapsLockLedState;
   1047     LedState mNumLockLedState;
   1048     LedState mScrollLockLedState;
   1049 
   1050     // Immutable configuration parameters.
   1051     struct Parameters {
   1052         bool hasAssociatedDisplay;
   1053         bool orientationAware;
   1054     } mParameters;
   1055 
   1056     void configureParameters();
   1057     void dumpParameters(String8& dump);
   1058 
   1059     bool isKeyboardOrGamepadKey(int32_t scanCode);
   1060 
   1061     void processKey(nsecs_t when, bool down, int32_t keyCode, int32_t scanCode,
   1062             uint32_t policyFlags);
   1063 
   1064     ssize_t findKeyDown(int32_t scanCode);
   1065 
   1066     void resetLedState();
   1067     void initializeLedState(LedState& ledState, int32_t led);
   1068     void updateLedState(bool reset);
   1069     void updateLedStateForModifier(LedState& ledState, int32_t led,
   1070             int32_t modifier, bool reset);
   1071 };
   1072 
   1073 
   1074 class CursorInputMapper : public InputMapper {
   1075 public:
   1076     CursorInputMapper(InputDevice* device);
   1077     virtual ~CursorInputMapper();
   1078 
   1079     virtual uint32_t getSources();
   1080     virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
   1081     virtual void dump(String8& dump);
   1082     virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
   1083     virtual void reset(nsecs_t when);
   1084     virtual void process(const RawEvent* rawEvent);
   1085 
   1086     virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
   1087 
   1088     virtual void fadePointer();
   1089 
   1090 private:
   1091     // Amount that trackball needs to move in order to generate a key event.
   1092     static const int32_t TRACKBALL_MOVEMENT_THRESHOLD = 6;
   1093 
   1094     // Immutable configuration parameters.
   1095     struct Parameters {
   1096         enum Mode {
   1097             MODE_POINTER,
   1098             MODE_NAVIGATION,
   1099         };
   1100 
   1101         Mode mode;
   1102         bool hasAssociatedDisplay;
   1103         bool orientationAware;
   1104     } mParameters;
   1105 
   1106     CursorButtonAccumulator mCursorButtonAccumulator;
   1107     CursorMotionAccumulator mCursorMotionAccumulator;
   1108     CursorScrollAccumulator mCursorScrollAccumulator;
   1109 
   1110     int32_t mSource;
   1111     float mXScale;
   1112     float mYScale;
   1113     float mXPrecision;
   1114     float mYPrecision;
   1115 
   1116     float mVWheelScale;
   1117     float mHWheelScale;
   1118 
   1119     // Velocity controls for mouse pointer and wheel movements.
   1120     // The controls for X and Y wheel movements are separate to keep them decoupled.
   1121     VelocityControl mPointerVelocityControl;
   1122     VelocityControl mWheelXVelocityControl;
   1123     VelocityControl mWheelYVelocityControl;
   1124 
   1125     int32_t mOrientation;
   1126 
   1127     sp<PointerControllerInterface> mPointerController;
   1128 
   1129     int32_t mButtonState;
   1130     nsecs_t mDownTime;
   1131 
   1132     void configureParameters();
   1133     void dumpParameters(String8& dump);
   1134 
   1135     void sync(nsecs_t when);
   1136 };
   1137 
   1138 
   1139 class TouchInputMapper : public InputMapper {
   1140 public:
   1141     TouchInputMapper(InputDevice* device);
   1142     virtual ~TouchInputMapper();
   1143 
   1144     virtual uint32_t getSources();
   1145     virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
   1146     virtual void dump(String8& dump);
   1147     virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
   1148     virtual void reset(nsecs_t when);
   1149     virtual void process(const RawEvent* rawEvent);
   1150 
   1151     virtual int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode);
   1152     virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
   1153     virtual bool markSupportedKeyCodes(uint32_t sourceMask, size_t numCodes,
   1154             const int32_t* keyCodes, uint8_t* outFlags);
   1155 
   1156     virtual void fadePointer();
   1157     virtual void timeoutExpired(nsecs_t when);
   1158 
   1159 protected:
   1160     CursorButtonAccumulator mCursorButtonAccumulator;
   1161     CursorScrollAccumulator mCursorScrollAccumulator;
   1162     TouchButtonAccumulator mTouchButtonAccumulator;
   1163 
   1164     struct VirtualKey {
   1165         int32_t keyCode;
   1166         int32_t scanCode;
   1167         uint32_t flags;
   1168 
   1169         // computed hit box, specified in touch screen coords based on known display size
   1170         int32_t hitLeft;
   1171         int32_t hitTop;
   1172         int32_t hitRight;
   1173         int32_t hitBottom;
   1174 
   1175         inline bool isHit(int32_t x, int32_t y) const {
   1176             return x >= hitLeft && x <= hitRight && y >= hitTop && y <= hitBottom;
   1177         }
   1178     };
   1179 
   1180     // Input sources and device mode.
   1181     uint32_t mSource;
   1182 
   1183     enum DeviceMode {
   1184         DEVICE_MODE_DISABLED, // input is disabled
   1185         DEVICE_MODE_DIRECT, // direct mapping (touchscreen)
   1186         DEVICE_MODE_UNSCALED, // unscaled mapping (touchpad)
   1187         DEVICE_MODE_NAVIGATION, // unscaled mapping with assist gesture (touch navigation)
   1188         DEVICE_MODE_POINTER, // pointer mapping (pointer)
   1189     };
   1190     DeviceMode mDeviceMode;
   1191 
   1192     // The reader's configuration.
   1193     InputReaderConfiguration mConfig;
   1194 
   1195     // Immutable configuration parameters.
   1196     struct Parameters {
   1197         enum DeviceType {
   1198             DEVICE_TYPE_TOUCH_SCREEN,
   1199             DEVICE_TYPE_TOUCH_PAD,
   1200             DEVICE_TYPE_TOUCH_NAVIGATION,
   1201             DEVICE_TYPE_POINTER,
   1202         };
   1203 
   1204         DeviceType deviceType;
   1205         bool hasAssociatedDisplay;
   1206         bool associatedDisplayIsExternal;
   1207         bool orientationAware;
   1208 
   1209         enum GestureMode {
   1210             GESTURE_MODE_POINTER,
   1211             GESTURE_MODE_SPOTS,
   1212         };
   1213         GestureMode gestureMode;
   1214     } mParameters;
   1215 
   1216     // Immutable calibration parameters in parsed form.
   1217     struct Calibration {
   1218         // Size
   1219         enum SizeCalibration {
   1220             SIZE_CALIBRATION_DEFAULT,
   1221             SIZE_CALIBRATION_NONE,
   1222             SIZE_CALIBRATION_GEOMETRIC,
   1223             SIZE_CALIBRATION_DIAMETER,
   1224             SIZE_CALIBRATION_BOX,
   1225             SIZE_CALIBRATION_AREA,
   1226         };
   1227 
   1228         SizeCalibration sizeCalibration;
   1229 
   1230         bool haveSizeScale;
   1231         float sizeScale;
   1232         bool haveSizeBias;
   1233         float sizeBias;
   1234         bool haveSizeIsSummed;
   1235         bool sizeIsSummed;
   1236 
   1237         // Pressure
   1238         enum PressureCalibration {
   1239             PRESSURE_CALIBRATION_DEFAULT,
   1240             PRESSURE_CALIBRATION_NONE,
   1241             PRESSURE_CALIBRATION_PHYSICAL,
   1242             PRESSURE_CALIBRATION_AMPLITUDE,
   1243         };
   1244 
   1245         PressureCalibration pressureCalibration;
   1246         bool havePressureScale;
   1247         float pressureScale;
   1248 
   1249         // Orientation
   1250         enum OrientationCalibration {
   1251             ORIENTATION_CALIBRATION_DEFAULT,
   1252             ORIENTATION_CALIBRATION_NONE,
   1253             ORIENTATION_CALIBRATION_INTERPOLATED,
   1254             ORIENTATION_CALIBRATION_VECTOR,
   1255         };
   1256 
   1257         OrientationCalibration orientationCalibration;
   1258 
   1259         // Distance
   1260         enum DistanceCalibration {
   1261             DISTANCE_CALIBRATION_DEFAULT,
   1262             DISTANCE_CALIBRATION_NONE,
   1263             DISTANCE_CALIBRATION_SCALED,
   1264         };
   1265 
   1266         DistanceCalibration distanceCalibration;
   1267         bool haveDistanceScale;
   1268         float distanceScale;
   1269 
   1270         enum CoverageCalibration {
   1271             COVERAGE_CALIBRATION_DEFAULT,
   1272             COVERAGE_CALIBRATION_NONE,
   1273             COVERAGE_CALIBRATION_BOX,
   1274         };
   1275 
   1276         CoverageCalibration coverageCalibration;
   1277 
   1278         inline void applySizeScaleAndBias(float* outSize) const {
   1279             if (haveSizeScale) {
   1280                 *outSize *= sizeScale;
   1281             }
   1282             if (haveSizeBias) {
   1283                 *outSize += sizeBias;
   1284             }
   1285         }
   1286     } mCalibration;
   1287 
   1288     // Raw pointer axis information from the driver.
   1289     RawPointerAxes mRawPointerAxes;
   1290 
   1291     // Raw pointer sample data.
   1292     RawPointerData mCurrentRawPointerData;
   1293     RawPointerData mLastRawPointerData;
   1294 
   1295     // Cooked pointer sample data.
   1296     CookedPointerData mCurrentCookedPointerData;
   1297     CookedPointerData mLastCookedPointerData;
   1298 
   1299     // Button state.
   1300     int32_t mCurrentButtonState;
   1301     int32_t mLastButtonState;
   1302 
   1303     // Scroll state.
   1304     int32_t mCurrentRawVScroll;
   1305     int32_t mCurrentRawHScroll;
   1306 
   1307     // Id bits used to differentiate fingers, stylus and mouse tools.
   1308     BitSet32 mCurrentFingerIdBits; // finger or unknown
   1309     BitSet32 mLastFingerIdBits;
   1310     BitSet32 mCurrentStylusIdBits; // stylus or eraser
   1311     BitSet32 mLastStylusIdBits;
   1312     BitSet32 mCurrentMouseIdBits; // mouse or lens
   1313     BitSet32 mLastMouseIdBits;
   1314 
   1315     // True if we sent a HOVER_ENTER event.
   1316     bool mSentHoverEnter;
   1317 
   1318     // The time the primary pointer last went down.
   1319     nsecs_t mDownTime;
   1320 
   1321     // The pointer controller, or null if the device is not a pointer.
   1322     sp<PointerControllerInterface> mPointerController;
   1323 
   1324     Vector<VirtualKey> mVirtualKeys;
   1325 
   1326     virtual void configureParameters();
   1327     virtual void dumpParameters(String8& dump);
   1328     virtual void configureRawPointerAxes();
   1329     virtual void dumpRawPointerAxes(String8& dump);
   1330     virtual void configureSurface(nsecs_t when, bool* outResetNeeded);
   1331     virtual void dumpSurface(String8& dump);
   1332     virtual void configureVirtualKeys();
   1333     virtual void dumpVirtualKeys(String8& dump);
   1334     virtual void parseCalibration();
   1335     virtual void resolveCalibration();
   1336     virtual void dumpCalibration(String8& dump);
   1337     virtual bool hasStylus() const = 0;
   1338 
   1339     virtual void syncTouch(nsecs_t when, bool* outHavePointerIds) = 0;
   1340 
   1341 private:
   1342     // The current viewport.
   1343     // The components of the viewport are specified in the display's rotated orientation.
   1344     DisplayViewport mViewport;
   1345 
   1346     // The surface orientation, width and height set by configureSurface().
   1347     // The width and height are derived from the viewport but are specified
   1348     // in the natural orientation.
   1349     // The surface origin specifies how the surface coordinates should be translated
   1350     // to align with the logical display coordinate space.
   1351     // The orientation may be different from the viewport orientation as it specifies
   1352     // the rotation of the surface coordinates required to produce the viewport's
   1353     // requested orientation, so it will depend on whether the device is orientation aware.
   1354     int32_t mSurfaceWidth;
   1355     int32_t mSurfaceHeight;
   1356     int32_t mSurfaceLeft;
   1357     int32_t mSurfaceTop;
   1358     int32_t mSurfaceOrientation;
   1359 
   1360     // Translation and scaling factors, orientation-independent.
   1361     float mXTranslate;
   1362     float mXScale;
   1363     float mXPrecision;
   1364 
   1365     float mYTranslate;
   1366     float mYScale;
   1367     float mYPrecision;
   1368 
   1369     float mGeometricScale;
   1370 
   1371     float mPressureScale;
   1372 
   1373     float mSizeScale;
   1374 
   1375     float mOrientationScale;
   1376 
   1377     float mDistanceScale;
   1378 
   1379     bool mHaveTilt;
   1380     float mTiltXCenter;
   1381     float mTiltXScale;
   1382     float mTiltYCenter;
   1383     float mTiltYScale;
   1384 
   1385     // Oriented motion ranges for input device info.
   1386     struct OrientedRanges {
   1387         InputDeviceInfo::MotionRange x;
   1388         InputDeviceInfo::MotionRange y;
   1389         InputDeviceInfo::MotionRange pressure;
   1390 
   1391         bool haveSize;
   1392         InputDeviceInfo::MotionRange size;
   1393 
   1394         bool haveTouchSize;
   1395         InputDeviceInfo::MotionRange touchMajor;
   1396         InputDeviceInfo::MotionRange touchMinor;
   1397 
   1398         bool haveToolSize;
   1399         InputDeviceInfo::MotionRange toolMajor;
   1400         InputDeviceInfo::MotionRange toolMinor;
   1401 
   1402         bool haveOrientation;
   1403         InputDeviceInfo::MotionRange orientation;
   1404 
   1405         bool haveDistance;
   1406         InputDeviceInfo::MotionRange distance;
   1407 
   1408         bool haveTilt;
   1409         InputDeviceInfo::MotionRange tilt;
   1410 
   1411         OrientedRanges() {
   1412             clear();
   1413         }
   1414 
   1415         void clear() {
   1416             haveSize = false;
   1417             haveTouchSize = false;
   1418             haveToolSize = false;
   1419             haveOrientation = false;
   1420             haveDistance = false;
   1421             haveTilt = false;
   1422         }
   1423     } mOrientedRanges;
   1424 
   1425     // Oriented dimensions and precision.
   1426     float mOrientedXPrecision;
   1427     float mOrientedYPrecision;
   1428 
   1429     struct CurrentVirtualKeyState {
   1430         bool down;
   1431         bool ignored;
   1432         nsecs_t downTime;
   1433         int32_t keyCode;
   1434         int32_t scanCode;
   1435     } mCurrentVirtualKey;
   1436 
   1437     // Scale factor for gesture or mouse based pointer movements.
   1438     float mPointerXMovementScale;
   1439     float mPointerYMovementScale;
   1440 
   1441     // Scale factor for gesture based zooming and other freeform motions.
   1442     float mPointerXZoomScale;
   1443     float mPointerYZoomScale;
   1444 
   1445     // The maximum swipe width.
   1446     float mPointerGestureMaxSwipeWidth;
   1447 
   1448     struct PointerDistanceHeapElement {
   1449         uint32_t currentPointerIndex : 8;
   1450         uint32_t lastPointerIndex : 8;
   1451         uint64_t distance : 48; // squared distance
   1452     };
   1453 
   1454     enum PointerUsage {
   1455         POINTER_USAGE_NONE,
   1456         POINTER_USAGE_GESTURES,
   1457         POINTER_USAGE_STYLUS,
   1458         POINTER_USAGE_MOUSE,
   1459     };
   1460     PointerUsage mPointerUsage;
   1461 
   1462     struct PointerGesture {
   1463         enum Mode {
   1464             // No fingers, button is not pressed.
   1465             // Nothing happening.
   1466             NEUTRAL,
   1467 
   1468             // No fingers, button is not pressed.
   1469             // Tap detected.
   1470             // Emits DOWN and UP events at the pointer location.
   1471             TAP,
   1472 
   1473             // Exactly one finger dragging following a tap.
   1474             // Pointer follows the active finger.
   1475             // Emits DOWN, MOVE and UP events at the pointer location.
   1476             //
   1477             // Detect double-taps when the finger goes up while in TAP_DRAG mode.
   1478             TAP_DRAG,
   1479 
   1480             // Button is pressed.
   1481             // Pointer follows the active finger if there is one.  Other fingers are ignored.
   1482             // Emits DOWN, MOVE and UP events at the pointer location.
   1483             BUTTON_CLICK_OR_DRAG,
   1484 
   1485             // Exactly one finger, button is not pressed.
   1486             // Pointer follows the active finger.
   1487             // Emits HOVER_MOVE events at the pointer location.
   1488             //
   1489             // Detect taps when the finger goes up while in HOVER mode.
   1490             HOVER,
   1491 
   1492             // Exactly two fingers but neither have moved enough to clearly indicate
   1493             // whether a swipe or freeform gesture was intended.  We consider the
   1494             // pointer to be pressed so this enables clicking or long-pressing on buttons.
   1495             // Pointer does not move.
   1496             // Emits DOWN, MOVE and UP events with a single stationary pointer coordinate.
   1497             PRESS,
   1498 
   1499             // Exactly two fingers moving in the same direction, button is not pressed.
   1500             // Pointer does not move.
   1501             // Emits DOWN, MOVE and UP events with a single pointer coordinate that
   1502             // follows the midpoint between both fingers.
   1503             SWIPE,
   1504 
   1505             // Two or more fingers moving in arbitrary directions, button is not pressed.
   1506             // Pointer does not move.
   1507             // Emits DOWN, POINTER_DOWN, MOVE, POINTER_UP and UP events that follow
   1508             // each finger individually relative to the initial centroid of the finger.
   1509             FREEFORM,
   1510 
   1511             // Waiting for quiet time to end before starting the next gesture.
   1512             QUIET,
   1513         };
   1514 
   1515         // Time the first finger went down.
   1516         nsecs_t firstTouchTime;
   1517 
   1518         // The active pointer id from the raw touch data.
   1519         int32_t activeTouchId; // -1 if none
   1520 
   1521         // The active pointer id from the gesture last delivered to the application.
   1522         int32_t activeGestureId; // -1 if none
   1523 
   1524         // Pointer coords and ids for the current and previous pointer gesture.
   1525         Mode currentGestureMode;
   1526         BitSet32 currentGestureIdBits;
   1527         uint32_t currentGestureIdToIndex[MAX_POINTER_ID + 1];
   1528         PointerProperties currentGestureProperties[MAX_POINTERS];
   1529         PointerCoords currentGestureCoords[MAX_POINTERS];
   1530 
   1531         Mode lastGestureMode;
   1532         BitSet32 lastGestureIdBits;
   1533         uint32_t lastGestureIdToIndex[MAX_POINTER_ID + 1];
   1534         PointerProperties lastGestureProperties[MAX_POINTERS];
   1535         PointerCoords lastGestureCoords[MAX_POINTERS];
   1536 
   1537         // Time the pointer gesture last went down.
   1538         nsecs_t downTime;
   1539 
   1540         // Time when the pointer went down for a TAP.
   1541         nsecs_t tapDownTime;
   1542 
   1543         // Time when the pointer went up for a TAP.
   1544         nsecs_t tapUpTime;
   1545 
   1546         // Location of initial tap.
   1547         float tapX, tapY;
   1548 
   1549         // Time we started waiting for quiescence.
   1550         nsecs_t quietTime;
   1551 
   1552         // Reference points for multitouch gestures.
   1553         float referenceTouchX;    // reference touch X/Y coordinates in surface units
   1554         float referenceTouchY;
   1555         float referenceGestureX;  // reference gesture X/Y coordinates in pixels
   1556         float referenceGestureY;
   1557 
   1558         // Distance that each pointer has traveled which has not yet been
   1559         // subsumed into the reference gesture position.
   1560         BitSet32 referenceIdBits;
   1561         struct Delta {
   1562             float dx, dy;
   1563         };
   1564         Delta referenceDeltas[MAX_POINTER_ID + 1];
   1565 
   1566         // Describes how touch ids are mapped to gesture ids for freeform gestures.
   1567         uint32_t freeformTouchToGestureIdMap[MAX_POINTER_ID + 1];
   1568 
   1569         // A velocity tracker for determining whether to switch active pointers during drags.
   1570         VelocityTracker velocityTracker;
   1571 
   1572         void reset() {
   1573             firstTouchTime = LLONG_MIN;
   1574             activeTouchId = -1;
   1575             activeGestureId = -1;
   1576             currentGestureMode = NEUTRAL;
   1577             currentGestureIdBits.clear();
   1578             lastGestureMode = NEUTRAL;
   1579             lastGestureIdBits.clear();
   1580             downTime = 0;
   1581             velocityTracker.clear();
   1582             resetTap();
   1583             resetQuietTime();
   1584         }
   1585 
   1586         void resetTap() {
   1587             tapDownTime = LLONG_MIN;
   1588             tapUpTime = LLONG_MIN;
   1589         }
   1590 
   1591         void resetQuietTime() {
   1592             quietTime = LLONG_MIN;
   1593         }
   1594     } mPointerGesture;
   1595 
   1596     struct PointerSimple {
   1597         PointerCoords currentCoords;
   1598         PointerProperties currentProperties;
   1599         PointerCoords lastCoords;
   1600         PointerProperties lastProperties;
   1601 
   1602         // True if the pointer is down.
   1603         bool down;
   1604 
   1605         // True if the pointer is hovering.
   1606         bool hovering;
   1607 
   1608         // Time the pointer last went down.
   1609         nsecs_t downTime;
   1610 
   1611         void reset() {
   1612             currentCoords.clear();
   1613             currentProperties.clear();
   1614             lastCoords.clear();
   1615             lastProperties.clear();
   1616             down = false;
   1617             hovering = false;
   1618             downTime = 0;
   1619         }
   1620     } mPointerSimple;
   1621 
   1622     // The pointer and scroll velocity controls.
   1623     VelocityControl mPointerVelocityControl;
   1624     VelocityControl mWheelXVelocityControl;
   1625     VelocityControl mWheelYVelocityControl;
   1626 
   1627     void sync(nsecs_t when);
   1628 
   1629     bool consumeRawTouches(nsecs_t when, uint32_t policyFlags);
   1630     void dispatchVirtualKey(nsecs_t when, uint32_t policyFlags,
   1631             int32_t keyEventAction, int32_t keyEventFlags);
   1632 
   1633     void dispatchTouches(nsecs_t when, uint32_t policyFlags);
   1634     void dispatchHoverExit(nsecs_t when, uint32_t policyFlags);
   1635     void dispatchHoverEnterAndMove(nsecs_t when, uint32_t policyFlags);
   1636     void cookPointerData();
   1637 
   1638     void dispatchPointerUsage(nsecs_t when, uint32_t policyFlags, PointerUsage pointerUsage);
   1639     void abortPointerUsage(nsecs_t when, uint32_t policyFlags);
   1640 
   1641     void dispatchPointerGestures(nsecs_t when, uint32_t policyFlags, bool isTimeout);
   1642     void abortPointerGestures(nsecs_t when, uint32_t policyFlags);
   1643     bool preparePointerGestures(nsecs_t when,
   1644             bool* outCancelPreviousGesture, bool* outFinishPreviousGesture,
   1645             bool isTimeout);
   1646 
   1647     void dispatchPointerStylus(nsecs_t when, uint32_t policyFlags);
   1648     void abortPointerStylus(nsecs_t when, uint32_t policyFlags);
   1649 
   1650     void dispatchPointerMouse(nsecs_t when, uint32_t policyFlags);
   1651     void abortPointerMouse(nsecs_t when, uint32_t policyFlags);
   1652 
   1653     void dispatchPointerSimple(nsecs_t when, uint32_t policyFlags,
   1654             bool down, bool hovering);
   1655     void abortPointerSimple(nsecs_t when, uint32_t policyFlags);
   1656 
   1657     // Dispatches a motion event.
   1658     // If the changedId is >= 0 and the action is POINTER_DOWN or POINTER_UP, the
   1659     // method will take care of setting the index and transmuting the action to DOWN or UP
   1660     // it is the first / last pointer to go down / up.
   1661     void dispatchMotion(nsecs_t when, uint32_t policyFlags, uint32_t source,
   1662             int32_t action, int32_t flags, int32_t metaState, int32_t buttonState,
   1663             int32_t edgeFlags,
   1664             const PointerProperties* properties, const PointerCoords* coords,
   1665             const uint32_t* idToIndex, BitSet32 idBits,
   1666             int32_t changedId, float xPrecision, float yPrecision, nsecs_t downTime);
   1667 
   1668     // Updates pointer coords and properties for pointers with specified ids that have moved.
   1669     // Returns true if any of them changed.
   1670     bool updateMovedPointers(const PointerProperties* inProperties,
   1671             const PointerCoords* inCoords, const uint32_t* inIdToIndex,
   1672             PointerProperties* outProperties, PointerCoords* outCoords,
   1673             const uint32_t* outIdToIndex, BitSet32 idBits) const;
   1674 
   1675     bool isPointInsideSurface(int32_t x, int32_t y);
   1676     const VirtualKey* findVirtualKeyHit(int32_t x, int32_t y);
   1677 
   1678     void assignPointerIds();
   1679 };
   1680 
   1681 
   1682 class SingleTouchInputMapper : public TouchInputMapper {
   1683 public:
   1684     SingleTouchInputMapper(InputDevice* device);
   1685     virtual ~SingleTouchInputMapper();
   1686 
   1687     virtual void reset(nsecs_t when);
   1688     virtual void process(const RawEvent* rawEvent);
   1689 
   1690 protected:
   1691     virtual void syncTouch(nsecs_t when, bool* outHavePointerIds);
   1692     virtual void configureRawPointerAxes();
   1693     virtual bool hasStylus() const;
   1694 
   1695 private:
   1696     SingleTouchMotionAccumulator mSingleTouchMotionAccumulator;
   1697 };
   1698 
   1699 
   1700 class MultiTouchInputMapper : public TouchInputMapper {
   1701 public:
   1702     MultiTouchInputMapper(InputDevice* device);
   1703     virtual ~MultiTouchInputMapper();
   1704 
   1705     virtual void reset(nsecs_t when);
   1706     virtual void process(const RawEvent* rawEvent);
   1707 
   1708 protected:
   1709     virtual void syncTouch(nsecs_t when, bool* outHavePointerIds);
   1710     virtual void configureRawPointerAxes();
   1711     virtual bool hasStylus() const;
   1712 
   1713 private:
   1714     MultiTouchMotionAccumulator mMultiTouchMotionAccumulator;
   1715 
   1716     // Specifies the pointer id bits that are in use, and their associated tracking id.
   1717     BitSet32 mPointerIdBits;
   1718     int32_t mPointerTrackingIdMap[MAX_POINTER_ID + 1];
   1719 };
   1720 
   1721 
   1722 class JoystickInputMapper : public InputMapper {
   1723 public:
   1724     JoystickInputMapper(InputDevice* device);
   1725     virtual ~JoystickInputMapper();
   1726 
   1727     virtual uint32_t getSources();
   1728     virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
   1729     virtual void dump(String8& dump);
   1730     virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
   1731     virtual void reset(nsecs_t when);
   1732     virtual void process(const RawEvent* rawEvent);
   1733 
   1734 private:
   1735     struct Axis {
   1736         RawAbsoluteAxisInfo rawAxisInfo;
   1737         AxisInfo axisInfo;
   1738 
   1739         bool explicitlyMapped; // true if the axis was explicitly assigned an axis id
   1740 
   1741         float scale;   // scale factor from raw to normalized values
   1742         float offset;  // offset to add after scaling for normalization
   1743         float highScale;  // scale factor from raw to normalized values of high split
   1744         float highOffset; // offset to add after scaling for normalization of high split
   1745 
   1746         float min;        // normalized inclusive minimum
   1747         float max;        // normalized inclusive maximum
   1748         float flat;       // normalized flat region size
   1749         float fuzz;       // normalized error tolerance
   1750         float resolution; // normalized resolution in units/mm
   1751 
   1752         float filter;  // filter out small variations of this size
   1753         float currentValue; // current value
   1754         float newValue; // most recent value
   1755         float highCurrentValue; // current value of high split
   1756         float highNewValue; // most recent value of high split
   1757 
   1758         void initialize(const RawAbsoluteAxisInfo& rawAxisInfo, const AxisInfo& axisInfo,
   1759                 bool explicitlyMapped, float scale, float offset,
   1760                 float highScale, float highOffset,
   1761                 float min, float max, float flat, float fuzz, float resolution) {
   1762             this->rawAxisInfo = rawAxisInfo;
   1763             this->axisInfo = axisInfo;
   1764             this->explicitlyMapped = explicitlyMapped;
   1765             this->scale = scale;
   1766             this->offset = offset;
   1767             this->highScale = highScale;
   1768             this->highOffset = highOffset;
   1769             this->min = min;
   1770             this->max = max;
   1771             this->flat = flat;
   1772             this->fuzz = fuzz;
   1773             this->resolution = resolution;
   1774             this->filter = 0;
   1775             resetValue();
   1776         }
   1777 
   1778         void resetValue() {
   1779             this->currentValue = 0;
   1780             this->newValue = 0;
   1781             this->highCurrentValue = 0;
   1782             this->highNewValue = 0;
   1783         }
   1784     };
   1785 
   1786     // Axes indexed by raw ABS_* axis index.
   1787     KeyedVector<int32_t, Axis> mAxes;
   1788 
   1789     void sync(nsecs_t when, bool force);
   1790 
   1791     bool haveAxis(int32_t axisId);
   1792     void pruneAxes(bool ignoreExplicitlyMappedAxes);
   1793     bool filterAxes(bool force);
   1794 
   1795     static bool hasValueChangedSignificantly(float filter,
   1796             float newValue, float currentValue, float min, float max);
   1797     static bool hasMovedNearerToValueWithinFilteredRange(float filter,
   1798             float newValue, float currentValue, float thresholdValue);
   1799 
   1800     static bool isCenteredAxis(int32_t axis);
   1801     static int32_t getCompatAxis(int32_t axis);
   1802 
   1803     static void addMotionRange(int32_t axisId, const Axis& axis, InputDeviceInfo* info);
   1804     static void setPointerCoordsAxisValue(PointerCoords* pointerCoords, int32_t axis,
   1805             float value);
   1806 };
   1807 
   1808 } // namespace android
   1809 
   1810 #endif // _UI_INPUT_READER_H
   1811