InputReader.h revision 83d616a9c7b9505153d258511eb5c16b552e268d 
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
45namespace android {
46
47class InputDevice;
48class InputMapper;
49
50/*
51 * Describes how coordinates are mapped on a physical display.
52 * See com.android.server.display.DisplayViewport.
53 */
54struct 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 */
119struct 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
248private:
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 */
266class InputReaderPolicyInterface : public virtual RefBase {
267protected:
268    InputReaderPolicyInterface() { }
269    virtual ~InputReaderPolicyInterface() { }
270
271public:
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. */
292class InputReaderInterface : public virtual RefBase {
293protected:
294    InputReaderInterface() { }
295    virtual ~InputReaderInterface() { }
296
297public:
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 */
346class InputReaderContext {
347public:
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 */
380class InputReader : public InputReaderInterface {
381public:
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
410protected:
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
436private:
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. */
495class InputReaderThread : public Thread {
496public:
497    InputReaderThread(const sp<InputReaderInterface>& reader);
498    virtual ~InputReaderThread();
499
500private:
501    sp<InputReaderInterface> mReader;
502
503    virtual bool threadLoop();
504};
505
506
507/* Represents the state of a single input device. */
508class InputDevice {
509public:
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
573private:
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. */
595class CursorButtonAccumulator {
596public:
597    CursorButtonAccumulator();
598    void reset(InputDevice* device);
599
600    void process(const RawEvent* rawEvent);
601
602    uint32_t getButtonState() const;
603
604private:
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
620class CursorMotionAccumulator {
621public:
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
631private:
632    int32_t mRelX;
633    int32_t mRelY;
634
635    void clearRelativeAxes();
636};
637
638
639/* Keeps track of cursor scrolling motions. */
640
641class CursorScrollAccumulator {
642public:
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
658private:
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. */
672class TouchButtonAccumulator {
673public:
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
686private:
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. */
710struct 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. */
731struct 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. */
783struct 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 bool isHovering(uint32_t pointerIndex) {
795        return hoveringIdBits.hasBit(pointerProperties[pointerIndex].id);
796    }
797};
798
799
800/* Keeps track of the state of single-touch protocol. */
801class SingleTouchMotionAccumulator {
802public:
803    SingleTouchMotionAccumulator();
804
805    void process(const RawEvent* rawEvent);
806    void reset(InputDevice* device);
807
808    inline int32_t getAbsoluteX() const { return mAbsX; }
809    inline int32_t getAbsoluteY() const { return mAbsY; }
810    inline int32_t getAbsolutePressure() const { return mAbsPressure; }
811    inline int32_t getAbsoluteToolWidth() const { return mAbsToolWidth; }
812    inline int32_t getAbsoluteDistance() const { return mAbsDistance; }
813    inline int32_t getAbsoluteTiltX() const { return mAbsTiltX; }
814    inline int32_t getAbsoluteTiltY() const { return mAbsTiltY; }
815
816private:
817    int32_t mAbsX;
818    int32_t mAbsY;
819    int32_t mAbsPressure;
820    int32_t mAbsToolWidth;
821    int32_t mAbsDistance;
822    int32_t mAbsTiltX;
823    int32_t mAbsTiltY;
824
825    void clearAbsoluteAxes();
826};
827
828
829/* Keeps track of the state of multi-touch protocol. */
830class MultiTouchMotionAccumulator {
831public:
832    class Slot {
833    public:
834        inline bool isInUse() const { return mInUse; }
835        inline int32_t getX() const { return mAbsMTPositionX; }
836        inline int32_t getY() const { return mAbsMTPositionY; }
837        inline int32_t getTouchMajor() const { return mAbsMTTouchMajor; }
838        inline int32_t getTouchMinor() const {
839            return mHaveAbsMTTouchMinor ? mAbsMTTouchMinor : mAbsMTTouchMajor; }
840        inline int32_t getToolMajor() const { return mAbsMTWidthMajor; }
841        inline int32_t getToolMinor() const {
842            return mHaveAbsMTWidthMinor ? mAbsMTWidthMinor : mAbsMTWidthMajor; }
843        inline int32_t getOrientation() const { return mAbsMTOrientation; }
844        inline int32_t getTrackingId() const { return mAbsMTTrackingId; }
845        inline int32_t getPressure() const { return mAbsMTPressure; }
846        inline int32_t getDistance() const { return mAbsMTDistance; }
847        inline int32_t getToolType() const;
848
849    private:
850        friend class MultiTouchMotionAccumulator;
851
852        bool mInUse;
853        bool mHaveAbsMTTouchMinor;
854        bool mHaveAbsMTWidthMinor;
855        bool mHaveAbsMTToolType;
856
857        int32_t mAbsMTPositionX;
858        int32_t mAbsMTPositionY;
859        int32_t mAbsMTTouchMajor;
860        int32_t mAbsMTTouchMinor;
861        int32_t mAbsMTWidthMajor;
862        int32_t mAbsMTWidthMinor;
863        int32_t mAbsMTOrientation;
864        int32_t mAbsMTTrackingId;
865        int32_t mAbsMTPressure;
866        int32_t mAbsMTDistance;
867        int32_t mAbsMTToolType;
868
869        Slot();
870        void clear();
871    };
872
873    MultiTouchMotionAccumulator();
874    ~MultiTouchMotionAccumulator();
875
876    void configure(InputDevice* device, size_t slotCount, bool usingSlotsProtocol);
877    void reset(InputDevice* device);
878    void process(const RawEvent* rawEvent);
879    void finishSync();
880    bool hasStylus() const;
881
882    inline size_t getSlotCount() const { return mSlotCount; }
883    inline const Slot* getSlot(size_t index) const { return &mSlots[index]; }
884
885private:
886    int32_t mCurrentSlot;
887    Slot* mSlots;
888    size_t mSlotCount;
889    bool mUsingSlotsProtocol;
890    bool mHaveStylus;
891
892    void clearSlots(int32_t initialSlot);
893};
894
895
896/* An input mapper transforms raw input events into cooked event data.
897 * A single input device can have multiple associated input mappers in order to interpret
898 * different classes of events.
899 *
900 * InputMapper lifecycle:
901 * - create
902 * - configure with 0 changes
903 * - reset
904 * - process, process, process (may occasionally reconfigure with non-zero changes or reset)
905 * - reset
906 * - destroy
907 */
908class InputMapper {
909public:
910    InputMapper(InputDevice* device);
911    virtual ~InputMapper();
912
913    inline InputDevice* getDevice() { return mDevice; }
914    inline int32_t getDeviceId() { return mDevice->getId(); }
915    inline const String8 getDeviceName() { return mDevice->getName(); }
916    inline InputReaderContext* getContext() { return mContext; }
917    inline InputReaderPolicyInterface* getPolicy() { return mContext->getPolicy(); }
918    inline InputListenerInterface* getListener() { return mContext->getListener(); }
919    inline EventHubInterface* getEventHub() { return mContext->getEventHub(); }
920
921    virtual uint32_t getSources() = 0;
922    virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
923    virtual void dump(String8& dump);
924    virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
925    virtual void reset(nsecs_t when);
926    virtual void process(const RawEvent* rawEvent) = 0;
927    virtual void timeoutExpired(nsecs_t when);
928
929    virtual int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode);
930    virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
931    virtual int32_t getSwitchState(uint32_t sourceMask, int32_t switchCode);
932    virtual bool markSupportedKeyCodes(uint32_t sourceMask, size_t numCodes,
933            const int32_t* keyCodes, uint8_t* outFlags);
934    virtual void vibrate(const nsecs_t* pattern, size_t patternSize, ssize_t repeat,
935            int32_t token);
936    virtual void cancelVibrate(int32_t token);
937
938    virtual int32_t getMetaState();
939
940    virtual void fadePointer();
941
942protected:
943    InputDevice* mDevice;
944    InputReaderContext* mContext;
945
946    status_t getAbsoluteAxisInfo(int32_t axis, RawAbsoluteAxisInfo* axisInfo);
947    void bumpGeneration();
948
949    static void dumpRawAbsoluteAxisInfo(String8& dump,
950            const RawAbsoluteAxisInfo& axis, const char* name);
951};
952
953
954class SwitchInputMapper : public InputMapper {
955public:
956    SwitchInputMapper(InputDevice* device);
957    virtual ~SwitchInputMapper();
958
959    virtual uint32_t getSources();
960    virtual void process(const RawEvent* rawEvent);
961
962    virtual int32_t getSwitchState(uint32_t sourceMask, int32_t switchCode);
963
964private:
965    void processSwitch(nsecs_t when, int32_t switchCode, int32_t switchValue);
966};
967
968
969class VibratorInputMapper : public InputMapper {
970public:
971    VibratorInputMapper(InputDevice* device);
972    virtual ~VibratorInputMapper();
973
974    virtual uint32_t getSources();
975    virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
976    virtual void process(const RawEvent* rawEvent);
977
978    virtual void vibrate(const nsecs_t* pattern, size_t patternSize, ssize_t repeat,
979            int32_t token);
980    virtual void cancelVibrate(int32_t token);
981    virtual void timeoutExpired(nsecs_t when);
982    virtual void dump(String8& dump);
983
984private:
985    bool mVibrating;
986    nsecs_t mPattern[MAX_VIBRATE_PATTERN_SIZE];
987    size_t mPatternSize;
988    ssize_t mRepeat;
989    int32_t mToken;
990    ssize_t mIndex;
991    nsecs_t mNextStepTime;
992
993    void nextStep();
994    void stopVibrating();
995};
996
997
998class KeyboardInputMapper : public InputMapper {
999public:
1000    KeyboardInputMapper(InputDevice* device, uint32_t source, int32_t keyboardType);
1001    virtual ~KeyboardInputMapper();
1002
1003    virtual uint32_t getSources();
1004    virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
1005    virtual void dump(String8& dump);
1006    virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
1007    virtual void reset(nsecs_t when);
1008    virtual void process(const RawEvent* rawEvent);
1009
1010    virtual int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode);
1011    virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
1012    virtual bool markSupportedKeyCodes(uint32_t sourceMask, size_t numCodes,
1013            const int32_t* keyCodes, uint8_t* outFlags);
1014
1015    virtual int32_t getMetaState();
1016
1017private:
1018    struct KeyDown {
1019        int32_t keyCode;
1020        int32_t scanCode;
1021    };
1022
1023    uint32_t mSource;
1024    int32_t mKeyboardType;
1025
1026    int32_t mOrientation; // orientation for dpad keys
1027
1028    Vector<KeyDown> mKeyDowns; // keys that are down
1029    int32_t mMetaState;
1030    nsecs_t mDownTime; // time of most recent key down
1031
1032    int32_t mCurrentHidUsage; // most recent HID usage seen this packet, or 0 if none
1033
1034    struct LedState {
1035        bool avail; // led is available
1036        bool on;    // we think the led is currently on
1037    };
1038    LedState mCapsLockLedState;
1039    LedState mNumLockLedState;
1040    LedState mScrollLockLedState;
1041
1042    // Immutable configuration parameters.
1043    struct Parameters {
1044        bool hasAssociatedDisplay;
1045        bool orientationAware;
1046    } mParameters;
1047
1048    void configureParameters();
1049    void dumpParameters(String8& dump);
1050
1051    bool isKeyboardOrGamepadKey(int32_t scanCode);
1052
1053    void processKey(nsecs_t when, bool down, int32_t keyCode, int32_t scanCode,
1054            uint32_t policyFlags);
1055
1056    ssize_t findKeyDown(int32_t scanCode);
1057
1058    void resetLedState();
1059    void initializeLedState(LedState& ledState, int32_t led);
1060    void updateLedState(bool reset);
1061    void updateLedStateForModifier(LedState& ledState, int32_t led,
1062            int32_t modifier, bool reset);
1063};
1064
1065
1066class CursorInputMapper : public InputMapper {
1067public:
1068    CursorInputMapper(InputDevice* device);
1069    virtual ~CursorInputMapper();
1070
1071    virtual uint32_t getSources();
1072    virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
1073    virtual void dump(String8& dump);
1074    virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
1075    virtual void reset(nsecs_t when);
1076    virtual void process(const RawEvent* rawEvent);
1077
1078    virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
1079
1080    virtual void fadePointer();
1081
1082private:
1083    // Amount that trackball needs to move in order to generate a key event.
1084    static const int32_t TRACKBALL_MOVEMENT_THRESHOLD = 6;
1085
1086    // Immutable configuration parameters.
1087    struct Parameters {
1088        enum Mode {
1089            MODE_POINTER,
1090            MODE_NAVIGATION,
1091        };
1092
1093        Mode mode;
1094        bool hasAssociatedDisplay;
1095        bool orientationAware;
1096    } mParameters;
1097
1098    CursorButtonAccumulator mCursorButtonAccumulator;
1099    CursorMotionAccumulator mCursorMotionAccumulator;
1100    CursorScrollAccumulator mCursorScrollAccumulator;
1101
1102    int32_t mSource;
1103    float mXScale;
1104    float mYScale;
1105    float mXPrecision;
1106    float mYPrecision;
1107
1108    float mVWheelScale;
1109    float mHWheelScale;
1110
1111    // Velocity controls for mouse pointer and wheel movements.
1112    // The controls for X and Y wheel movements are separate to keep them decoupled.
1113    VelocityControl mPointerVelocityControl;
1114    VelocityControl mWheelXVelocityControl;
1115    VelocityControl mWheelYVelocityControl;
1116
1117    int32_t mOrientation;
1118
1119    sp<PointerControllerInterface> mPointerController;
1120
1121    int32_t mButtonState;
1122    nsecs_t mDownTime;
1123
1124    void configureParameters();
1125    void dumpParameters(String8& dump);
1126
1127    void sync(nsecs_t when);
1128};
1129
1130
1131class TouchInputMapper : public InputMapper {
1132public:
1133    TouchInputMapper(InputDevice* device);
1134    virtual ~TouchInputMapper();
1135
1136    virtual uint32_t getSources();
1137    virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
1138    virtual void dump(String8& dump);
1139    virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
1140    virtual void reset(nsecs_t when);
1141    virtual void process(const RawEvent* rawEvent);
1142
1143    virtual int32_t getKeyCodeState(uint32_t sourceMask, int32_t keyCode);
1144    virtual int32_t getScanCodeState(uint32_t sourceMask, int32_t scanCode);
1145    virtual bool markSupportedKeyCodes(uint32_t sourceMask, size_t numCodes,
1146            const int32_t* keyCodes, uint8_t* outFlags);
1147
1148    virtual void fadePointer();
1149    virtual void timeoutExpired(nsecs_t when);
1150
1151protected:
1152    CursorButtonAccumulator mCursorButtonAccumulator;
1153    CursorScrollAccumulator mCursorScrollAccumulator;
1154    TouchButtonAccumulator mTouchButtonAccumulator;
1155
1156    struct VirtualKey {
1157        int32_t keyCode;
1158        int32_t scanCode;
1159        uint32_t flags;
1160
1161        // computed hit box, specified in touch screen coords based on known display size
1162        int32_t hitLeft;
1163        int32_t hitTop;
1164        int32_t hitRight;
1165        int32_t hitBottom;
1166
1167        inline bool isHit(int32_t x, int32_t y) const {
1168            return x >= hitLeft && x <= hitRight && y >= hitTop && y <= hitBottom;
1169        }
1170    };
1171
1172    // Input sources and device mode.
1173    uint32_t mSource;
1174
1175    enum DeviceMode {
1176        DEVICE_MODE_DISABLED, // input is disabled
1177        DEVICE_MODE_DIRECT, // direct mapping (touchscreen)
1178        DEVICE_MODE_UNSCALED, // unscaled mapping (touchpad)
1179        DEVICE_MODE_POINTER, // pointer mapping (pointer)
1180    };
1181    DeviceMode mDeviceMode;
1182
1183    // The reader's configuration.
1184    InputReaderConfiguration mConfig;
1185
1186    // Immutable configuration parameters.
1187    struct Parameters {
1188        enum DeviceType {
1189            DEVICE_TYPE_TOUCH_SCREEN,
1190            DEVICE_TYPE_TOUCH_PAD,
1191            DEVICE_TYPE_POINTER,
1192        };
1193
1194        DeviceType deviceType;
1195        bool hasAssociatedDisplay;
1196        bool associatedDisplayIsExternal;
1197        bool orientationAware;
1198
1199        enum GestureMode {
1200            GESTURE_MODE_POINTER,
1201            GESTURE_MODE_SPOTS,
1202        };
1203        GestureMode gestureMode;
1204    } mParameters;
1205
1206    // Immutable calibration parameters in parsed form.
1207    struct Calibration {
1208        // Size
1209        enum SizeCalibration {
1210            SIZE_CALIBRATION_DEFAULT,
1211            SIZE_CALIBRATION_NONE,
1212            SIZE_CALIBRATION_GEOMETRIC,
1213            SIZE_CALIBRATION_DIAMETER,
1214            SIZE_CALIBRATION_BOX,
1215            SIZE_CALIBRATION_AREA,
1216        };
1217
1218        SizeCalibration sizeCalibration;
1219
1220        bool haveSizeScale;
1221        float sizeScale;
1222        bool haveSizeBias;
1223        float sizeBias;
1224        bool haveSizeIsSummed;
1225        bool sizeIsSummed;
1226
1227        // Pressure
1228        enum PressureCalibration {
1229            PRESSURE_CALIBRATION_DEFAULT,
1230            PRESSURE_CALIBRATION_NONE,
1231            PRESSURE_CALIBRATION_PHYSICAL,
1232            PRESSURE_CALIBRATION_AMPLITUDE,
1233        };
1234
1235        PressureCalibration pressureCalibration;
1236        bool havePressureScale;
1237        float pressureScale;
1238
1239        // Orientation
1240        enum OrientationCalibration {
1241            ORIENTATION_CALIBRATION_DEFAULT,
1242            ORIENTATION_CALIBRATION_NONE,
1243            ORIENTATION_CALIBRATION_INTERPOLATED,
1244            ORIENTATION_CALIBRATION_VECTOR,
1245        };
1246
1247        OrientationCalibration orientationCalibration;
1248
1249        // Distance
1250        enum DistanceCalibration {
1251            DISTANCE_CALIBRATION_DEFAULT,
1252            DISTANCE_CALIBRATION_NONE,
1253            DISTANCE_CALIBRATION_SCALED,
1254        };
1255
1256        DistanceCalibration distanceCalibration;
1257        bool haveDistanceScale;
1258        float distanceScale;
1259
1260        inline void applySizeScaleAndBias(float* outSize) const {
1261            if (haveSizeScale) {
1262                *outSize *= sizeScale;
1263            }
1264            if (haveSizeBias) {
1265                *outSize += sizeBias;
1266            }
1267        }
1268    } mCalibration;
1269
1270    // Raw pointer axis information from the driver.
1271    RawPointerAxes mRawPointerAxes;
1272
1273    // Raw pointer sample data.
1274    RawPointerData mCurrentRawPointerData;
1275    RawPointerData mLastRawPointerData;
1276
1277    // Cooked pointer sample data.
1278    CookedPointerData mCurrentCookedPointerData;
1279    CookedPointerData mLastCookedPointerData;
1280
1281    // Button state.
1282    int32_t mCurrentButtonState;
1283    int32_t mLastButtonState;
1284
1285    // Scroll state.
1286    int32_t mCurrentRawVScroll;
1287    int32_t mCurrentRawHScroll;
1288
1289    // Id bits used to differentiate fingers, stylus and mouse tools.
1290    BitSet32 mCurrentFingerIdBits; // finger or unknown
1291    BitSet32 mLastFingerIdBits;
1292    BitSet32 mCurrentStylusIdBits; // stylus or eraser
1293    BitSet32 mLastStylusIdBits;
1294    BitSet32 mCurrentMouseIdBits; // mouse or lens
1295    BitSet32 mLastMouseIdBits;
1296
1297    // True if we sent a HOVER_ENTER event.
1298    bool mSentHoverEnter;
1299
1300    // The time the primary pointer last went down.
1301    nsecs_t mDownTime;
1302
1303    // The pointer controller, or null if the device is not a pointer.
1304    sp<PointerControllerInterface> mPointerController;
1305
1306    Vector<VirtualKey> mVirtualKeys;
1307
1308    virtual void configureParameters();
1309    virtual void dumpParameters(String8& dump);
1310    virtual void configureRawPointerAxes();
1311    virtual void dumpRawPointerAxes(String8& dump);
1312    virtual void configureSurface(nsecs_t when, bool* outResetNeeded);
1313    virtual void dumpSurface(String8& dump);
1314    virtual void configureVirtualKeys();
1315    virtual void dumpVirtualKeys(String8& dump);
1316    virtual void parseCalibration();
1317    virtual void resolveCalibration();
1318    virtual void dumpCalibration(String8& dump);
1319    virtual bool hasStylus() const = 0;
1320
1321    virtual void syncTouch(nsecs_t when, bool* outHavePointerIds) = 0;
1322
1323private:
1324    // The current viewport.
1325    // The components of the viewport are specified in the display's rotated orientation.
1326    DisplayViewport mViewport;
1327
1328    // The surface orientation, width and height set by configureSurface().
1329    // The width and height are derived from the viewport but are specified
1330    // in the natural orientation.
1331    // The surface origin specifies how the surface coordinates should be translated
1332    // to align with the logical display coordinate space.
1333    // The orientation may be different from the viewport orientation as it specifies
1334    // the rotation of the surface coordinates required to produce the viewport's
1335    // requested orientation, so it will depend on whether the device is orientation aware.
1336    int32_t mSurfaceWidth;
1337    int32_t mSurfaceHeight;
1338    int32_t mSurfaceLeft;
1339    int32_t mSurfaceTop;
1340    int32_t mSurfaceOrientation;
1341
1342    // Translation and scaling factors, orientation-independent.
1343    float mXTranslate;
1344    float mXScale;
1345    float mXPrecision;
1346
1347    float mYTranslate;
1348    float mYScale;
1349    float mYPrecision;
1350
1351    float mGeometricScale;
1352
1353    float mPressureScale;
1354
1355    float mSizeScale;
1356
1357    float mOrientationScale;
1358
1359    float mDistanceScale;
1360
1361    bool mHaveTilt;
1362    float mTiltXCenter;
1363    float mTiltXScale;
1364    float mTiltYCenter;
1365    float mTiltYScale;
1366
1367    // Oriented motion ranges for input device info.
1368    struct OrientedRanges {
1369        InputDeviceInfo::MotionRange x;
1370        InputDeviceInfo::MotionRange y;
1371        InputDeviceInfo::MotionRange pressure;
1372
1373        bool haveSize;
1374        InputDeviceInfo::MotionRange size;
1375
1376        bool haveTouchSize;
1377        InputDeviceInfo::MotionRange touchMajor;
1378        InputDeviceInfo::MotionRange touchMinor;
1379
1380        bool haveToolSize;
1381        InputDeviceInfo::MotionRange toolMajor;
1382        InputDeviceInfo::MotionRange toolMinor;
1383
1384        bool haveOrientation;
1385        InputDeviceInfo::MotionRange orientation;
1386
1387        bool haveDistance;
1388        InputDeviceInfo::MotionRange distance;
1389
1390        bool haveTilt;
1391        InputDeviceInfo::MotionRange tilt;
1392
1393        OrientedRanges() {
1394            clear();
1395        }
1396
1397        void clear() {
1398            haveSize = false;
1399            haveTouchSize = false;
1400            haveToolSize = false;
1401            haveOrientation = false;
1402            haveDistance = false;
1403            haveTilt = false;
1404        }
1405    } mOrientedRanges;
1406
1407    // Oriented dimensions and precision.
1408    float mOrientedXPrecision;
1409    float mOrientedYPrecision;
1410
1411    struct CurrentVirtualKeyState {
1412        bool down;
1413        bool ignored;
1414        nsecs_t downTime;
1415        int32_t keyCode;
1416        int32_t scanCode;
1417    } mCurrentVirtualKey;
1418
1419    // Scale factor for gesture or mouse based pointer movements.
1420    float mPointerXMovementScale;
1421    float mPointerYMovementScale;
1422
1423    // Scale factor for gesture based zooming and other freeform motions.
1424    float mPointerXZoomScale;
1425    float mPointerYZoomScale;
1426
1427    // The maximum swipe width.
1428    float mPointerGestureMaxSwipeWidth;
1429
1430    struct PointerDistanceHeapElement {
1431        uint32_t currentPointerIndex : 8;
1432        uint32_t lastPointerIndex : 8;
1433        uint64_t distance : 48; // squared distance
1434    };
1435
1436    enum PointerUsage {
1437        POINTER_USAGE_NONE,
1438        POINTER_USAGE_GESTURES,
1439        POINTER_USAGE_STYLUS,
1440        POINTER_USAGE_MOUSE,
1441    };
1442    PointerUsage mPointerUsage;
1443
1444    struct PointerGesture {
1445        enum Mode {
1446            // No fingers, button is not pressed.
1447            // Nothing happening.
1448            NEUTRAL,
1449
1450            // No fingers, button is not pressed.
1451            // Tap detected.
1452            // Emits DOWN and UP events at the pointer location.
1453            TAP,
1454
1455            // Exactly one finger dragging following a tap.
1456            // Pointer follows the active finger.
1457            // Emits DOWN, MOVE and UP events at the pointer location.
1458            //
1459            // Detect double-taps when the finger goes up while in TAP_DRAG mode.
1460            TAP_DRAG,
1461
1462            // Button is pressed.
1463            // Pointer follows the active finger if there is one.  Other fingers are ignored.
1464            // Emits DOWN, MOVE and UP events at the pointer location.
1465            BUTTON_CLICK_OR_DRAG,
1466
1467            // Exactly one finger, button is not pressed.
1468            // Pointer follows the active finger.
1469            // Emits HOVER_MOVE events at the pointer location.
1470            //
1471            // Detect taps when the finger goes up while in HOVER mode.
1472            HOVER,
1473
1474            // Exactly two fingers but neither have moved enough to clearly indicate
1475            // whether a swipe or freeform gesture was intended.  We consider the
1476            // pointer to be pressed so this enables clicking or long-pressing on buttons.
1477            // Pointer does not move.
1478            // Emits DOWN, MOVE and UP events with a single stationary pointer coordinate.
1479            PRESS,
1480
1481            // Exactly two fingers moving in the same direction, button is not pressed.
1482            // Pointer does not move.
1483            // Emits DOWN, MOVE and UP events with a single pointer coordinate that
1484            // follows the midpoint between both fingers.
1485            SWIPE,
1486
1487            // Two or more fingers moving in arbitrary directions, button is not pressed.
1488            // Pointer does not move.
1489            // Emits DOWN, POINTER_DOWN, MOVE, POINTER_UP and UP events that follow
1490            // each finger individually relative to the initial centroid of the finger.
1491            FREEFORM,
1492
1493            // Waiting for quiet time to end before starting the next gesture.
1494            QUIET,
1495        };
1496
1497        // Time the first finger went down.
1498        nsecs_t firstTouchTime;
1499
1500        // The active pointer id from the raw touch data.
1501        int32_t activeTouchId; // -1 if none
1502
1503        // The active pointer id from the gesture last delivered to the application.
1504        int32_t activeGestureId; // -1 if none
1505
1506        // Pointer coords and ids for the current and previous pointer gesture.
1507        Mode currentGestureMode;
1508        BitSet32 currentGestureIdBits;
1509        uint32_t currentGestureIdToIndex[MAX_POINTER_ID + 1];
1510        PointerProperties currentGestureProperties[MAX_POINTERS];
1511        PointerCoords currentGestureCoords[MAX_POINTERS];
1512
1513        Mode lastGestureMode;
1514        BitSet32 lastGestureIdBits;
1515        uint32_t lastGestureIdToIndex[MAX_POINTER_ID + 1];
1516        PointerProperties lastGestureProperties[MAX_POINTERS];
1517        PointerCoords lastGestureCoords[MAX_POINTERS];
1518
1519        // Time the pointer gesture last went down.
1520        nsecs_t downTime;
1521
1522        // Time when the pointer went down for a TAP.
1523        nsecs_t tapDownTime;
1524
1525        // Time when the pointer went up for a TAP.
1526        nsecs_t tapUpTime;
1527
1528        // Location of initial tap.
1529        float tapX, tapY;
1530
1531        // Time we started waiting for quiescence.
1532        nsecs_t quietTime;
1533
1534        // Reference points for multitouch gestures.
1535        float referenceTouchX;    // reference touch X/Y coordinates in surface units
1536        float referenceTouchY;
1537        float referenceGestureX;  // reference gesture X/Y coordinates in pixels
1538        float referenceGestureY;
1539
1540        // Distance that each pointer has traveled which has not yet been
1541        // subsumed into the reference gesture position.
1542        BitSet32 referenceIdBits;
1543        struct Delta {
1544            float dx, dy;
1545        };
1546        Delta referenceDeltas[MAX_POINTER_ID + 1];
1547
1548        // Describes how touch ids are mapped to gesture ids for freeform gestures.
1549        uint32_t freeformTouchToGestureIdMap[MAX_POINTER_ID + 1];
1550
1551        // A velocity tracker for determining whether to switch active pointers during drags.
1552        VelocityTracker velocityTracker;
1553
1554        void reset() {
1555            firstTouchTime = LLONG_MIN;
1556            activeTouchId = -1;
1557            activeGestureId = -1;
1558            currentGestureMode = NEUTRAL;
1559            currentGestureIdBits.clear();
1560            lastGestureMode = NEUTRAL;
1561            lastGestureIdBits.clear();
1562            downTime = 0;
1563            velocityTracker.clear();
1564            resetTap();
1565            resetQuietTime();
1566        }
1567
1568        void resetTap() {
1569            tapDownTime = LLONG_MIN;
1570            tapUpTime = LLONG_MIN;
1571        }
1572
1573        void resetQuietTime() {
1574            quietTime = LLONG_MIN;
1575        }
1576    } mPointerGesture;
1577
1578    struct PointerSimple {
1579        PointerCoords currentCoords;
1580        PointerProperties currentProperties;
1581        PointerCoords lastCoords;
1582        PointerProperties lastProperties;
1583
1584        // True if the pointer is down.
1585        bool down;
1586
1587        // True if the pointer is hovering.
1588        bool hovering;
1589
1590        // Time the pointer last went down.
1591        nsecs_t downTime;
1592
1593        void reset() {
1594            currentCoords.clear();
1595            currentProperties.clear();
1596            lastCoords.clear();
1597            lastProperties.clear();
1598            down = false;
1599            hovering = false;
1600            downTime = 0;
1601        }
1602    } mPointerSimple;
1603
1604    // The pointer and scroll velocity controls.
1605    VelocityControl mPointerVelocityControl;
1606    VelocityControl mWheelXVelocityControl;
1607    VelocityControl mWheelYVelocityControl;
1608
1609    void sync(nsecs_t when);
1610
1611    bool consumeRawTouches(nsecs_t when, uint32_t policyFlags);
1612    void dispatchVirtualKey(nsecs_t when, uint32_t policyFlags,
1613            int32_t keyEventAction, int32_t keyEventFlags);
1614
1615    void dispatchTouches(nsecs_t when, uint32_t policyFlags);
1616    void dispatchHoverExit(nsecs_t when, uint32_t policyFlags);
1617    void dispatchHoverEnterAndMove(nsecs_t when, uint32_t policyFlags);
1618    void cookPointerData();
1619
1620    void dispatchPointerUsage(nsecs_t when, uint32_t policyFlags, PointerUsage pointerUsage);
1621    void abortPointerUsage(nsecs_t when, uint32_t policyFlags);
1622
1623    void dispatchPointerGestures(nsecs_t when, uint32_t policyFlags, bool isTimeout);
1624    void abortPointerGestures(nsecs_t when, uint32_t policyFlags);
1625    bool preparePointerGestures(nsecs_t when,
1626            bool* outCancelPreviousGesture, bool* outFinishPreviousGesture,
1627            bool isTimeout);
1628
1629    void dispatchPointerStylus(nsecs_t when, uint32_t policyFlags);
1630    void abortPointerStylus(nsecs_t when, uint32_t policyFlags);
1631
1632    void dispatchPointerMouse(nsecs_t when, uint32_t policyFlags);
1633    void abortPointerMouse(nsecs_t when, uint32_t policyFlags);
1634
1635    void dispatchPointerSimple(nsecs_t when, uint32_t policyFlags,
1636            bool down, bool hovering);
1637    void abortPointerSimple(nsecs_t when, uint32_t policyFlags);
1638
1639    // Dispatches a motion event.
1640    // If the changedId is >= 0 and the action is POINTER_DOWN or POINTER_UP, the
1641    // method will take care of setting the index and transmuting the action to DOWN or UP
1642    // it is the first / last pointer to go down / up.
1643    void dispatchMotion(nsecs_t when, uint32_t policyFlags, uint32_t source,
1644            int32_t action, int32_t flags, int32_t metaState, int32_t buttonState,
1645            int32_t edgeFlags,
1646            const PointerProperties* properties, const PointerCoords* coords,
1647            const uint32_t* idToIndex, BitSet32 idBits,
1648            int32_t changedId, float xPrecision, float yPrecision, nsecs_t downTime);
1649
1650    // Updates pointer coords and properties for pointers with specified ids that have moved.
1651    // Returns true if any of them changed.
1652    bool updateMovedPointers(const PointerProperties* inProperties,
1653            const PointerCoords* inCoords, const uint32_t* inIdToIndex,
1654            PointerProperties* outProperties, PointerCoords* outCoords,
1655            const uint32_t* outIdToIndex, BitSet32 idBits) const;
1656
1657    bool isPointInsideSurface(int32_t x, int32_t y);
1658    const VirtualKey* findVirtualKeyHit(int32_t x, int32_t y);
1659
1660    void assignPointerIds();
1661};
1662
1663
1664class SingleTouchInputMapper : public TouchInputMapper {
1665public:
1666    SingleTouchInputMapper(InputDevice* device);
1667    virtual ~SingleTouchInputMapper();
1668
1669    virtual void reset(nsecs_t when);
1670    virtual void process(const RawEvent* rawEvent);
1671
1672protected:
1673    virtual void syncTouch(nsecs_t when, bool* outHavePointerIds);
1674    virtual void configureRawPointerAxes();
1675    virtual bool hasStylus() const;
1676
1677private:
1678    SingleTouchMotionAccumulator mSingleTouchMotionAccumulator;
1679};
1680
1681
1682class MultiTouchInputMapper : public TouchInputMapper {
1683public:
1684    MultiTouchInputMapper(InputDevice* device);
1685    virtual ~MultiTouchInputMapper();
1686
1687    virtual void reset(nsecs_t when);
1688    virtual void process(const RawEvent* rawEvent);
1689
1690protected:
1691    virtual void syncTouch(nsecs_t when, bool* outHavePointerIds);
1692    virtual void configureRawPointerAxes();
1693    virtual bool hasStylus() const;
1694
1695private:
1696    MultiTouchMotionAccumulator mMultiTouchMotionAccumulator;
1697
1698    // Specifies the pointer id bits that are in use, and their associated tracking id.
1699    BitSet32 mPointerIdBits;
1700    int32_t mPointerTrackingIdMap[MAX_POINTER_ID + 1];
1701};
1702
1703
1704class JoystickInputMapper : public InputMapper {
1705public:
1706    JoystickInputMapper(InputDevice* device);
1707    virtual ~JoystickInputMapper();
1708
1709    virtual uint32_t getSources();
1710    virtual void populateDeviceInfo(InputDeviceInfo* deviceInfo);
1711    virtual void dump(String8& dump);
1712    virtual void configure(nsecs_t when, const InputReaderConfiguration* config, uint32_t changes);
1713    virtual void reset(nsecs_t when);
1714    virtual void process(const RawEvent* rawEvent);
1715
1716private:
1717    struct Axis {
1718        RawAbsoluteAxisInfo rawAxisInfo;
1719        AxisInfo axisInfo;
1720
1721        bool explicitlyMapped; // true if the axis was explicitly assigned an axis id
1722
1723        float scale;   // scale factor from raw to normalized values
1724        float offset;  // offset to add after scaling for normalization
1725        float highScale;  // scale factor from raw to normalized values of high split
1726        float highOffset; // offset to add after scaling for normalization of high split
1727
1728        float min;     // normalized inclusive minimum
1729        float max;     // normalized inclusive maximum
1730        float flat;    // normalized flat region size
1731        float fuzz;    // normalized error tolerance
1732
1733        float filter;  // filter out small variations of this size
1734        float currentValue; // current value
1735        float newValue; // most recent value
1736        float highCurrentValue; // current value of high split
1737        float highNewValue; // most recent value of high split
1738
1739        void initialize(const RawAbsoluteAxisInfo& rawAxisInfo, const AxisInfo& axisInfo,
1740                bool explicitlyMapped, float scale, float offset,
1741                float highScale, float highOffset,
1742                float min, float max, float flat, float fuzz) {
1743            this->rawAxisInfo = rawAxisInfo;
1744            this->axisInfo = axisInfo;
1745            this->explicitlyMapped = explicitlyMapped;
1746            this->scale = scale;
1747            this->offset = offset;
1748            this->highScale = highScale;
1749            this->highOffset = highOffset;
1750            this->min = min;
1751            this->max = max;
1752            this->flat = flat;
1753            this->fuzz = fuzz;
1754            this->filter = 0;
1755            resetValue();
1756        }
1757
1758        void resetValue() {
1759            this->currentValue = 0;
1760            this->newValue = 0;
1761            this->highCurrentValue = 0;
1762            this->highNewValue = 0;
1763        }
1764    };
1765
1766    // Axes indexed by raw ABS_* axis index.
1767    KeyedVector<int32_t, Axis> mAxes;
1768
1769    void sync(nsecs_t when, bool force);
1770
1771    bool haveAxis(int32_t axisId);
1772    void pruneAxes(bool ignoreExplicitlyMappedAxes);
1773    bool filterAxes(bool force);
1774
1775    static bool hasValueChangedSignificantly(float filter,
1776            float newValue, float currentValue, float min, float max);
1777    static bool hasMovedNearerToValueWithinFilteredRange(float filter,
1778            float newValue, float currentValue, float thresholdValue);
1779
1780    static bool isCenteredAxis(int32_t axis);
1781};
1782
1783} // namespace android
1784
1785#endif // _UI_INPUT_READER_H
1786