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 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/viz/service/input/android_state_transfer_handler.h"
#include <utility>
#include "base/check_deref.h"
#include "base/notreached.h"
#include "ui/events/android/events_android_utils.h"
#include "ui/events/android/motion_event_android_native.h"
namespace viz {
namespace {
base::TimeTicks GetEventDowntime(const base::android::ScopedInputEvent& event) {
return base::TimeTicks::FromUptimeMillis(
AMotionEvent_getDownTime(event.a_input_event()) /
base::Time::kNanosecondsPerMillisecond);
}
} // namespace
AndroidStateTransferHandler::TransferState::TransferState(
base::WeakPtr<RenderInputRouterSupportAndroidInterface> support,
input::mojom::TouchTransferStatePtr state)
: rir_support(support), transfer_state(std::move(state)) {
CHECK(transfer_state);
}
AndroidStateTransferHandler::TransferState::~TransferState() = default;
AndroidStateTransferHandler::TransferState::TransferState(
TransferState&& other) {
rir_support = other.rir_support;
other.rir_support = nullptr;
transfer_state = std::move(other.transfer_state);
}
AndroidStateTransferHandler::AndroidStateTransferHandler(
AndroidStateTransferHandlerClient& client)
: client_(client) {}
AndroidStateTransferHandler::~AndroidStateTransferHandler() = default;
void AndroidStateTransferHandler::StateOnTouchTransfer(
input::mojom::TouchTransferStatePtr state,
base::WeakPtr<RenderInputRouterSupportAndroidInterface> rir_support) {
TRACE_EVENT("viz", "AndroidStateTransferHandler::StateOnTouchTransfer");
EmitPendingTransfersHistogram();
const bool state_received_out_of_order =
(!pending_transferred_states_.empty() &&
(state->down_time_ms <
pending_transferred_states_.back().transfer_state->down_time_ms));
CHECK(!state_received_out_of_order);
MaybeDropEventsFromEarlierSequences(state);
pending_transferred_states_.emplace(rir_support, std::move(state));
if (pending_transferred_states_.size() > kMaxPendingTransferredStates) {
pending_transferred_states_.pop();
}
if (events_buffer_.empty()) {
return;
}
if (CanStartProcessingVizEvents(events_buffer_.front())) {
while (!events_buffer_.empty()) {
if (!state_for_curr_sequence_.has_value()) {
// This can happen if the whole sequence was received on Viz before the
// state could be transferred from Browser. Early out since we wouldn't
// want to process the events from next sequence if they made it to
// queue as well. `state_for_curr_sequence_` is reset at the end of
// touch sequence when touch up or cancel is seen in `HandleTouchEvent`
// method.
return;
}
HandleTouchEvent(std::move(events_buffer_.front()));
events_buffer_.pop();
}
}
}
bool AndroidStateTransferHandler::OnMotionEvent(
base::android::ScopedInputEvent input_event,
const FrameSinkId& root_frame_sink_id) {
TRACE_EVENT("input", "AndroidStateTransferHandler::OnMotionEvent",
[&](perfetto::EventContext& ctx) {
auto* chrome_track_event =
ctx.event<perfetto::protos::pbzero::ChromeTrackEvent>();
auto* forwarder = chrome_track_event->set_event_forwarder();
input_event.WriteIntoTrace(ctx.Wrap(forwarder));
});
const int action = AMotionEvent_getAction(input_event.a_input_event()) &
AMOTION_EVENT_ACTION_MASK;
// Viz only handles touch events, actions like button press/release are not
// supported and should ideally not be arriving.
if (!IsExpectedMotionEventAction(action)) {
return true;
}
if (ignore_remaining_touch_sequence_) {
if (action == AMOTION_EVENT_ACTION_CANCEL ||
action == AMOTION_EVENT_ACTION_UP) {
ignore_remaining_touch_sequence_ = false;
state_for_curr_sequence_.reset();
}
return true;
}
if (state_for_curr_sequence_.has_value() ||
CanStartProcessingVizEvents(input_event)) {
HandleTouchEvent(std::move(input_event));
return true;
}
bool events_from_dropped_sequence =
!pending_transferred_states_.empty() &&
(GetEventDowntime(input_event) <
pending_transferred_states_.front().transfer_state->down_time_ms);
if (events_from_dropped_sequence) {
return true;
}
// Queue events until we can start processing events received directly on
// Viz.
// TODO(crbug.com/384424270): Coalesce touch moves instead of pushing
// individual events to queue.
events_buffer_.push(std::move(input_event));
// Always return true since we are receiving input on Viz after hit testing on
// Browser already determined that web contents are being hit.
return true;
}
bool AndroidStateTransferHandler::IsExpectedMotionEventAction(int action) {
switch (action) {
case AMOTION_EVENT_ACTION_DOWN:
case AMOTION_EVENT_ACTION_UP:
case AMOTION_EVENT_ACTION_MOVE:
case AMOTION_EVENT_ACTION_CANCEL:
case AMOTION_EVENT_ACTION_POINTER_DOWN:
case AMOTION_EVENT_ACTION_POINTER_UP:
return true;
default:
break;
}
base::UmaHistogramEnumeration(kDroppedNonTouchActions,
ui::FromAndroidAction(action));
return false;
}
bool AndroidStateTransferHandler::CanStartProcessingVizEvents(
const base::android::ScopedInputEvent& event) {
CHECK(!state_for_curr_sequence_.has_value());
const jlong j_event_down_time =
base::TimeTicks::FromJavaNanoTime(
AMotionEvent_getDownTime(event.a_input_event()))
.ToUptimeMillis();
base::TimeTicks event_down_time =
base::TimeTicks::FromUptimeMillis(j_event_down_time);
// Drop states with smaller down time i.e. the states corresponding to pointer
// down events.
while (!pending_transferred_states_.empty() &&
(pending_transferred_states_.front().transfer_state->down_time_ms <
event_down_time)) {
pending_transferred_states_.pop();
}
if (pending_transferred_states_.empty()) {
return false;
}
auto& state = pending_transferred_states_.front();
// Touch event corresponding to previous state transfer should be
// processed before next sequence starts.
if (event_down_time == state.transfer_state->down_time_ms) {
if (state.transfer_state->browser_would_have_handled) {
client_->TransferInputBackToBrowser();
ignore_remaining_touch_sequence_ = true;
}
state_for_curr_sequence_.emplace(std::move(state));
pending_transferred_states_.pop();
return true;
}
return false;
}
void AndroidStateTransferHandler::MaybeDropEventsFromEarlierSequences(
const input::mojom::TouchTransferStatePtr& state) {
if (events_buffer_.empty()) {
return;
}
while (!events_buffer_.empty() &&
GetEventDowntime(events_buffer_.front()) < state->down_time_ms) {
events_buffer_.pop();
}
}
void AndroidStateTransferHandler::EmitPendingTransfersHistogram() {
const char* histogram_name;
if (state_for_curr_sequence_.has_value()) {
histogram_name = kPendingTransfersHistogramNonNull;
} else {
histogram_name = kPendingTransfersHistogramNull;
}
// We don't expect histogram value i.e. `pending_transferred_states_.size()`
// to be more than 3(`kMaxPendingTransferredStates`, but leaving histogram max
// to 10 to have some space to increase `kMaxPendingTransferredStates`.
base::UmaHistogramCustomCounts(histogram_name,
pending_transferred_states_.size(), /*min=*/1,
/*exclusive_max=*/10, /*buckets=*/10u);
}
void AndroidStateTransferHandler::HandleTouchEvent(
base::android::ScopedInputEvent input_event) {
// TODO(crbug.com/406986388) : Add flow events to track the events starting
// from when they were first were processed by Viz.
TRACE_EVENT("input", "AndroidStateTransferHandler::HandleTouchEvent");
CHECK(state_for_curr_sequence_.has_value());
const int action = AMotionEvent_getAction(input_event.a_input_event()) &
AMOTION_EVENT_ACTION_MASK;
if (GetEventDowntime(input_event) !=
state_for_curr_sequence_->transfer_state->down_time_ms) {
TRACE_EVENT_INSTANT("input,input.scrolling", "DifferentDownTimeInSequence");
}
if (!state_for_curr_sequence_->rir_support) {
if (action == AMOTION_EVENT_ACTION_CANCEL ||
action == AMOTION_EVENT_ACTION_UP) {
state_for_curr_sequence_.reset();
ignore_remaining_touch_sequence_ = false;
} else {
ignore_remaining_touch_sequence_ = true;
}
return;
}
// Ignore any already queued events for the touch sequence. This can happen if
// we are returning the sequence back to browser.
if (ignore_remaining_touch_sequence_) {
return;
}
std::optional<ui::MotionEventAndroidNative::EventTimes> event_times =
std::nullopt;
if (action == AMOTION_EVENT_ACTION_DOWN) {
event_times = ui::MotionEventAndroidNative::EventTimes();
// AMotionEvent_getDownTime returns down time in nanoseconds precision.
event_times->latest = base::TimeTicks::FromJavaNanoTime(
AMotionEvent_getDownTime(input_event.a_input_event()));
event_times->oldest = event_times->latest;
}
auto event = ui::MotionEventAndroidNative::Create(
std::move(input_event),
1.f / state_for_curr_sequence_->transfer_state->dip_scale,
state_for_curr_sequence_->transfer_state->web_contents_y_offset_pix,
event_times);
state_for_curr_sequence_->rir_support->OnTouchEvent(
*event.get(), /* emit_histograms= */ true);
if (event->GetAction() == ui::MotionEvent::Action::UP ||
event->GetAction() == ui::MotionEvent::Action::CANCEL) {
state_for_curr_sequence_.reset();
}
}
} // namespace viz
|