1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
content / browser / media / capture / mouse_cursor_overlay_controller.cc [blame]
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/media/capture/mouse_cursor_overlay_controller.h"
#include <cmath>
#include <utility>
#include "base/check_op.h"
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/task/sequenced_task_runner.h"
#include "base/time/default_tick_clock.h"
#include "base/time/time.h"
#include "third_party/blink/public/common/features_generated.h"
namespace content {
// static
constexpr base::TimeDelta MouseCursorOverlayController::kIdleTimeout;
void MouseCursorOverlayController::Start(
std::unique_ptr<Overlay> overlay,
scoped_refptr<base::SequencedTaskRunner> task_runner) {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
DCHECK(overlay);
DCHECK(task_runner);
Stop();
tick_clock_ = base::DefaultTickClock::GetInstance();
overlay_ = std::move(overlay);
overlay_task_runner_ = std::move(task_runner);
should_send_mouse_events_ =
base::FeatureList::IsEnabled(blink::features::kCapturedMouseEvents);
}
void MouseCursorOverlayController::Stop() {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
if (overlay_) {
tick_clock_ = nullptr;
overlay_task_runner_->DeleteSoon(FROM_HERE, overlay_.release());
overlay_task_runner_ = nullptr;
should_send_mouse_events_ = false;
}
}
bool MouseCursorOverlayController::IsUserInteractingWithView() const {
return mouse_move_behavior() == kRecentlyMovedOrClicked;
}
base::WeakPtr<MouseCursorOverlayController>
MouseCursorOverlayController::GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
void MouseCursorOverlayController::SendMouseEvent() {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
if (!overlay_task_runner_) {
return;
}
CHECK(overlay_);
if (!last_emitted_coordinates_.has_value() ||
last_observed_coordinates_ != *last_emitted_coordinates_) {
last_emitted_coordinates_ = last_observed_coordinates_;
last_emitted_coordinates_time_ = tick_clock_->NowTicks();
// base::Unretained(overlay_.get()) is safe because DeleteSoon() is used to
// queue a task to free overlay_ and no more tasks can be queued after that.
overlay_task_runner_->PostTask(
FROM_HERE, base::BindOnce(&Overlay::OnCapturedMouseEvent,
base::Unretained(overlay_.get()),
last_observed_coordinates_));
}
}
void MouseCursorOverlayController::OnMouseCoordinatesUpdated(
const gfx::Point& coordinates) {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
DCHECK(should_send_mouse_events_);
last_observed_coordinates_ = coordinates;
if (last_observed_coordinates_timer_.IsRunning()) {
return;
}
base::TimeDelta wait_time;
if (last_emitted_coordinates_) {
// Ensure we wait at least kMinWaitInterval since the previous event.
const base::TimeDelta time_since_last_event =
tick_clock_->NowTicks() - last_emitted_coordinates_time_;
wait_time = kMinWaitInterval - time_since_last_event;
}
if (wait_time.is_positive()) {
// base::Unretained(this) is safe because we own
// last_observed_coordinates_timer_ and its destructor calls
// TimerBase::AbandonScheduledTask().
last_observed_coordinates_timer_.Start(
FROM_HERE, wait_time,
base::BindRepeating(&MouseCursorOverlayController::SendMouseEvent,
base::Unretained(this)));
} else {
SendMouseEvent();
}
}
void MouseCursorOverlayController::OnMouseMoved(const gfx::PointF& location) {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
switch (mouse_move_behavior()) {
case kNotMoving:
set_mouse_move_behavior(kStartingToMove);
mouse_move_start_location_ = location;
mouse_activity_ended_timer_.Reset();
break;
case kStartingToMove:
if (std::abs(location.x() - mouse_move_start_location_.x()) >
kMinMovementPixels ||
std::abs(location.y() - mouse_move_start_location_.y()) >
kMinMovementPixels) {
set_mouse_move_behavior(kRecentlyMovedOrClicked);
mouse_activity_ended_timer_.Reset();
}
break;
case kRecentlyMovedOrClicked:
mouse_activity_ended_timer_.Reset();
break;
}
if (mouse_move_behavior() == kRecentlyMovedOrClicked) {
UpdateOverlay(location);
}
}
void MouseCursorOverlayController::OnMouseClicked(const gfx::PointF& location) {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
mouse_activity_ended_timer_.Reset();
set_mouse_move_behavior(kRecentlyMovedOrClicked);
UpdateOverlay(location);
}
void MouseCursorOverlayController::OnMouseHasGoneIdle() {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
// Note that the following is not redundant since callers other than the timer
// may have invoked this method.
mouse_activity_ended_timer_.Stop();
set_mouse_move_behavior(kNotMoving);
UpdateOverlay(gfx::PointF());
}
void MouseCursorOverlayController::UpdateOverlay(const gfx::PointF& location) {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
if (!overlay_task_runner_) {
return;
}
CHECK(overlay_);
// Breaking out of the following do-block indicates one or more prerequisites
// are not met and the cursor should be(come) hidden.
do {
// If the mouse has not recently moved, hide the overlay.
if (mouse_move_behavior() != kRecentlyMovedOrClicked) {
break;
}
const gfx::NativeCursor cursor = GetCurrentCursorOrDefault();
const gfx::RectF relative_bounds =
ComputeRelativeBoundsForOverlay(cursor, location);
// If the cursor (and, by implication, the cursor image) has not changed,
// just move the overlay to its new position, if any.
if (cursor == last_cursor_) {
if (bounds_ != relative_bounds) {
bounds_ = relative_bounds;
// base::Unretained(overlay_.get()) is safe because DeleteSoon() is used
// to queue a task to free overlay_ and no more tasks can be queued
// after that.
overlay_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&Overlay::SetBounds,
base::Unretained(overlay_.get()), bounds_));
}
return;
}
// The cursor image has changed. Edge-case: If the platform does not provide
// a cursor image (e.g., this can occur at browser shutdown), just hide the
// overlay.
const SkBitmap cursor_image = GetCursorImage(cursor);
if (cursor_image.drawsNothing()) {
last_cursor_ = gfx::NativeCursor();
break;
}
last_cursor_ = cursor;
bounds_ = relative_bounds;
// base::Unretained(overlay_.get()) is safe because DeleteSoon() is used to
// queue a task to free overlay_ and no more tasks can be queued after that.
overlay_task_runner_->PostTask(
FROM_HERE, base::BindOnce(&Overlay::SetImageAndBounds,
base::Unretained(overlay_.get()),
cursor_image, bounds_));
return;
} while (false);
// If this point has been reached, then the overlay should be hidden.
if (!bounds_.IsEmpty()) {
bounds_ = gfx::RectF();
// base::Unretained(overlay_.get()) is safe because DeleteSoon() is used to
// queue a task to free overlay_ and no more tasks can be queued after that.
overlay_task_runner_->PostTask(
FROM_HERE, base::BindOnce(&Overlay::SetBounds,
base::Unretained(overlay_.get()), bounds_));
}
}
void MouseCursorOverlayController::SetTickClockForTesting(
const base::TickClock* tick_clock) {
DCHECK_CALLED_ON_VALID_SEQUENCE(ui_sequence_checker_);
tick_clock_ = tick_clock;
}
} // namespace content