blob: ebc622bae302671e4064e631671bd124599bc8d1 [file] [log] [blame]
Jeff Brownb4ff35d2011-01-02 16:37:43 -08001/*
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_POINTER_CONTROLLER_H
18#define _UI_POINTER_CONTROLLER_H
19
Jeff Brown5541de92011-04-11 11:54:25 -070020#include "SpriteController.h"
21
Jun Mukai1db53972015-09-11 18:08:31 -070022#include <map>
Jun Mukai808196f2015-10-28 16:46:44 -070023#include <vector>
Jun Mukai1db53972015-09-11 18:08:31 -070024
Jeff Brownb4ff35d2011-01-02 16:37:43 -080025#include <ui/DisplayInfo.h>
Arthur Hungb9b32002018-12-18 17:39:43 +080026#include <input/DisplayViewport.h>
Jeff Brown9d3b1a42013-07-01 19:07:15 -070027#include <input/Input.h>
Prabir Pradhane5696a52018-11-14 19:55:21 -080028#include <PointerControllerInterface.h>
Jeff Brown8a90e6e2012-05-11 12:24:35 -070029#include <utils/BitSet.h>
Jeff Brownb4ff35d2011-01-02 16:37:43 -080030#include <utils/RefBase.h>
Jeff Brown05dc66a2011-03-02 14:41:58 -080031#include <utils/Looper.h>
Jun Mukaic0c0ac32015-10-27 10:09:21 -070032#include <gui/DisplayEventReceiver.h>
Jeff Brownb4ff35d2011-01-02 16:37:43 -080033
Jeff Brownb4ff35d2011-01-02 16:37:43 -080034namespace android {
35
Jeff Brown2352b972011-04-12 22:39:53 -070036/*
37 * Pointer resources.
38 */
39struct PointerResources {
40 SpriteIcon spotHover;
41 SpriteIcon spotTouch;
42 SpriteIcon spotAnchor;
43};
44
Jun Mukai808196f2015-10-28 16:46:44 -070045struct PointerAnimation {
46 std::vector<SpriteIcon> animationFrames;
47 nsecs_t durationPerFrame;
48};
49
Jeff Brown2352b972011-04-12 22:39:53 -070050/*
51 * Pointer controller policy interface.
52 *
53 * The pointer controller policy is used by the pointer controller to interact with
54 * the Window Manager and other system components.
55 *
56 * The actual implementation is partially supported by callbacks into the DVM
57 * via JNI. This interface is also mocked in the unit tests.
58 */
59class PointerControllerPolicyInterface : public virtual RefBase {
60protected:
61 PointerControllerPolicyInterface() { }
62 virtual ~PointerControllerPolicyInterface() { }
63
64public:
Andrii Kulianfd8666d2018-10-05 16:58:39 -070065 virtual void loadPointerIcon(SpriteIcon* icon, int32_t displayId) = 0;
66 virtual void loadPointerResources(PointerResources* outResources, int32_t displayId) = 0;
Jun Mukai808196f2015-10-28 16:46:44 -070067 virtual void loadAdditionalMouseResources(std::map<int32_t, SpriteIcon>* outResources,
Andrii Kulianfd8666d2018-10-05 16:58:39 -070068 std::map<int32_t, PointerAnimation>* outAnimationResources, int32_t displayId) = 0;
Jun Mukai5ec74202015-10-07 16:58:09 +090069 virtual int32_t getDefaultPointerIconId() = 0;
Jun Mukaid4eaef72015-10-30 15:54:33 -070070 virtual int32_t getCustomPointerIconId() = 0;
Jeff Brownb4ff35d2011-01-02 16:37:43 -080071};
72
73
74/*
75 * Tracks pointer movements and draws the pointer sprite to a surface.
76 *
77 * Handles pointer acceleration and animation.
78 */
Jun Mukaic0c0ac32015-10-27 10:09:21 -070079class PointerController : public PointerControllerInterface, public MessageHandler,
80 public LooperCallback {
Jeff Brownb4ff35d2011-01-02 16:37:43 -080081protected:
82 virtual ~PointerController();
83
84public:
Jeff Brown2352b972011-04-12 22:39:53 -070085 enum InactivityTimeout {
86 INACTIVITY_TIMEOUT_NORMAL = 0,
87 INACTIVITY_TIMEOUT_SHORT = 1,
Jeff Brown05dc66a2011-03-02 14:41:58 -080088 };
89
Jeff Brown2352b972011-04-12 22:39:53 -070090 PointerController(const sp<PointerControllerPolicyInterface>& policy,
91 const sp<Looper>& looper, const sp<SpriteController>& spriteController);
Jeff Brownb4ff35d2011-01-02 16:37:43 -080092
93 virtual bool getBounds(float* outMinX, float* outMinY,
94 float* outMaxX, float* outMaxY) const;
95 virtual void move(float deltaX, float deltaY);
Jeff Brownfe9f8ab2011-05-06 18:20:01 -070096 virtual void setButtonState(int32_t buttonState);
97 virtual int32_t getButtonState() const;
Jeff Brownb4ff35d2011-01-02 16:37:43 -080098 virtual void setPosition(float x, float y);
99 virtual void getPosition(float* outX, float* outY) const;
Arthur Hungb9b32002018-12-18 17:39:43 +0800100 virtual int32_t getDisplayId() const;
Jeff Brown538881e2011-05-25 18:23:38 -0700101 virtual void fade(Transition transition);
102 virtual void unfade(Transition transition);
Garfield Tan68ede072020-01-09 11:30:04 -0800103 virtual void setDisplayViewport(const DisplayViewport& viewport);
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800104
Jeff Brown2352b972011-04-12 22:39:53 -0700105 virtual void setPresentation(Presentation presentation);
Jeff Browncb5ffcf2011-06-06 20:03:18 -0700106 virtual void setSpots(const PointerCoords* spotCoords,
Arthur Hungd25699a2019-01-25 17:53:22 +0800107 const uint32_t* spotIdToIndex, BitSet32 spotIdBits, int32_t displayId);
Jeff Brown2352b972011-04-12 22:39:53 -0700108 virtual void clearSpots();
109
Michael Wrightf9d9ce772016-05-13 17:44:16 +0100110 void updatePointerIcon(int32_t iconId);
Jun Mukaid4eaef72015-10-30 15:54:33 -0700111 void setCustomPointerIcon(const SpriteIcon& icon);
Jeff Brown2352b972011-04-12 22:39:53 -0700112 void setInactivityTimeout(InactivityTimeout inactivityTimeout);
Jun Mukai19a56012015-11-24 11:25:52 -0800113 void reloadPointerResources();
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800114
115private:
Jeff Brown2352b972011-04-12 22:39:53 -0700116 static const size_t MAX_RECYCLED_SPRITES = 12;
117 static const size_t MAX_SPOTS = 12;
118
Jeff Brown05dc66a2011-03-02 14:41:58 -0800119 enum {
Jeff Brown2352b972011-04-12 22:39:53 -0700120 MSG_INACTIVITY_TIMEOUT,
121 };
122
123 struct Spot {
124 static const uint32_t INVALID_ID = 0xffffffff;
125
126 uint32_t id;
127 sp<Sprite> sprite;
128 float alpha;
129 float scale;
130 float x, y;
131
132 inline Spot(uint32_t id, const sp<Sprite>& sprite)
133 : id(id), sprite(sprite), alpha(1.0f), scale(1.0f),
134 x(0.0f), y(0.0f), lastIcon(NULL) { }
135
Arthur Hungd25699a2019-01-25 17:53:22 +0800136 void updateSprite(const SpriteIcon* icon, float x, float y, int32_t displayId);
Jeff Brown2352b972011-04-12 22:39:53 -0700137
138 private:
139 const SpriteIcon* lastIcon;
Jeff Brown05dc66a2011-03-02 14:41:58 -0800140 };
141
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800142 mutable Mutex mLock;
143
Jeff Brown2352b972011-04-12 22:39:53 -0700144 sp<PointerControllerPolicyInterface> mPolicy;
Jeff Brown05dc66a2011-03-02 14:41:58 -0800145 sp<Looper> mLooper;
Jeff Brown5541de92011-04-11 11:54:25 -0700146 sp<SpriteController> mSpriteController;
147 sp<WeakMessageHandler> mHandler;
Vladislav Kaznacheev33c59032016-09-09 10:03:31 -0700148 sp<LooperCallback> mCallback;
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800149
Jun Mukaic0c0ac32015-10-27 10:09:21 -0700150 DisplayEventReceiver mDisplayEventReceiver;
151
Jeff Brown2352b972011-04-12 22:39:53 -0700152 PointerResources mResources;
153
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800154 struct Locked {
Jeff Brown2352b972011-04-12 22:39:53 -0700155 bool animationPending;
156 nsecs_t animationTime;
157
Jun Mukai808196f2015-10-28 16:46:44 -0700158 size_t animationFrameIndex;
159 nsecs_t lastFrameUpdatedTime;
160
Arthur Hungb9b32002018-12-18 17:39:43 +0800161 DisplayViewport viewport;
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800162
Jeff Brown2352b972011-04-12 22:39:53 -0700163 InactivityTimeout inactivityTimeout;
164
165 Presentation presentation;
166 bool presentationChanged;
167
Jeff Brown538881e2011-05-25 18:23:38 -0700168 int32_t pointerFadeDirection;
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800169 float pointerX;
170 float pointerY;
Jeff Brown2352b972011-04-12 22:39:53 -0700171 float pointerAlpha;
172 sp<Sprite> pointerSprite;
173 SpriteIcon pointerIcon;
174 bool pointerIconChanged;
175
Jun Mukai808196f2015-10-28 16:46:44 -0700176 std::map<int32_t, SpriteIcon> additionalMouseResources;
177 std::map<int32_t, PointerAnimation> animationResources;
Jun Mukai1db53972015-09-11 18:08:31 -0700178
Michael Wrightf9d9ce772016-05-13 17:44:16 +0100179 int32_t requestedPointerType;
Jun Mukai1db53972015-09-11 18:08:31 -0700180
Jeff Brownfe9f8ab2011-05-06 18:20:01 -0700181 int32_t buttonState;
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800182
Arthur Hungd25699a2019-01-25 17:53:22 +0800183 std::map<int32_t /* displayId */, std::vector<Spot*>> spotsByDisplay;
184 std::vector<sp<Sprite> > recycledSprites;
Arthur Hungb9b32002018-12-18 17:39:43 +0800185 } mLocked GUARDED_BY(mLock);
Jeff Brown05dc66a2011-03-02 14:41:58 -0800186
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800187 bool getBoundsLocked(float* outMinX, float* outMinY, float* outMaxX, float* outMaxY) const;
188 void setPositionLocked(float x, float y);
Jeff Brown05dc66a2011-03-02 14:41:58 -0800189
190 void handleMessage(const Message& message);
Jun Mukaic0c0ac32015-10-27 10:09:21 -0700191 int handleEvent(int fd, int events, void* data);
192 void doAnimate(nsecs_t timestamp);
Jun Mukai808196f2015-10-28 16:46:44 -0700193 bool doFadingAnimationLocked(nsecs_t timestamp);
194 bool doBitmapAnimationLocked(nsecs_t timestamp);
Jeff Brown2352b972011-04-12 22:39:53 -0700195 void doInactivityTimeout();
196
197 void startAnimationLocked();
198
199 void resetInactivityTimeoutLocked();
Jeff Brown538881e2011-05-25 18:23:38 -0700200 void removeInactivityTimeoutLocked();
Jeff Brown2352b972011-04-12 22:39:53 -0700201 void updatePointerLocked();
202
Arthur Hungd25699a2019-01-25 17:53:22 +0800203 Spot* getSpot(uint32_t id, const std::vector<Spot*>& spots);
204 Spot* createAndAddSpotLocked(uint32_t id, std::vector<Spot*>& spots);
205 Spot* removeFirstFadingSpotLocked(std::vector<Spot*>& spots);
Jeff Brown2352b972011-04-12 22:39:53 -0700206 void releaseSpotLocked(Spot* spot);
207 void fadeOutAndReleaseSpotLocked(Spot* spot);
208 void fadeOutAndReleaseAllSpotsLocked();
209
Arthur Hungb9b32002018-12-18 17:39:43 +0800210 void loadResourcesLocked();
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800211};
212
213} // namespace android
214
215#endif // _UI_POINTER_CONTROLLER_H