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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
content / browser / xr / service / browser_xr_runtime_impl.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.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/342213636): Remove this and spanify to fix the errors.
#pragma allow_unsafe_buffers
#endif
#include "content/browser/xr/service/browser_xr_runtime_impl.h"
#include <algorithm>
#include <memory>
#include <utility>
#include "base/containers/contains.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/observer_list.h"
#include "build/build_config.h"
#include "content/browser/xr/service/vr_service_impl.h"
#include "content/browser/xr/xr_utils.h"
#include "content/public/browser/browser_xr_runtime.h"
#include "content/public/browser/xr_install_helper.h"
#include "content/public/browser/xr_integration_client.h"
#include "content/public/common/content_features.h"
#include "device/vr/buildflags/buildflags.h"
#include "device/vr/public/cpp/session_mode.h"
#include "device/vr/public/mojom/vr_service.mojom-shared.h"
#include "device/vr/public/mojom/xr_device.mojom-shared.h"
#include "device/vr/public/mojom/xr_session.mojom-shared.h"
#include "ui/gfx/geometry/decomposed_transform.h"
#include "ui/gfx/geometry/transform.h"
#if BUILDFLAG(IS_WIN)
#include "base/win/windows_types.h"
#endif
#if BUILDFLAG(IS_ANDROID)
#include "base/android/android_hardware_buffer_compat.h"
#endif
namespace content {
namespace {
bool IsValidTransform(const gfx::Transform& transform) {
if (!transform.IsInvertible() || transform.HasPerspective())
return false;
std::optional<gfx::DecomposedTransform> decomp = transform.Decompose();
if (!decomp)
return false;
float kEpsilon = 0.1f;
if (abs(decomp->perspective[3] - 1) > kEpsilon) {
// If testing with unexpectedly high values, catch on debug builds rather
// than silently change data. On release builds its better to be safe and
// validate.
DCHECK(false);
return false;
}
for (int i = 0; i < 3; ++i) {
if (abs(decomp->scale[i] - 1) > kEpsilon)
return false;
if (abs(decomp->skew[i]) > kEpsilon)
return false;
if (abs(decomp->perspective[i]) > kEpsilon)
return false;
}
// Only rotate and translate.
return true;
}
device::mojom::XRViewPtr ValidateXRView(const device::mojom::XRView* view) {
if (!view) {
return nullptr;
}
device::mojom::XRViewPtr ret = device::mojom::XRView::New();
ret->eye = view->eye;
// FOV
float kDefaultFOV = 45;
ret->field_of_view = device::mojom::VRFieldOfView::New();
if (view->field_of_view->up_degrees < 90 &&
view->field_of_view->up_degrees > -90 &&
view->field_of_view->up_degrees > -view->field_of_view->down_degrees &&
view->field_of_view->down_degrees < 90 &&
view->field_of_view->down_degrees > -90 &&
view->field_of_view->down_degrees > -view->field_of_view->up_degrees &&
view->field_of_view->left_degrees < 90 &&
view->field_of_view->left_degrees > -90 &&
view->field_of_view->left_degrees > -view->field_of_view->right_degrees &&
view->field_of_view->right_degrees < 90 &&
view->field_of_view->right_degrees > -90 &&
view->field_of_view->right_degrees > -view->field_of_view->left_degrees) {
ret->field_of_view->up_degrees = view->field_of_view->up_degrees;
ret->field_of_view->down_degrees = view->field_of_view->down_degrees;
ret->field_of_view->left_degrees = view->field_of_view->left_degrees;
ret->field_of_view->right_degrees = view->field_of_view->right_degrees;
} else {
ret->field_of_view->up_degrees = kDefaultFOV;
ret->field_of_view->down_degrees = kDefaultFOV;
ret->field_of_view->left_degrees = kDefaultFOV;
ret->field_of_view->right_degrees = kDefaultFOV;
}
if (IsValidTransform(view->mojo_from_view)) {
ret->mojo_from_view = view->mojo_from_view;
}
// else, ret->mojo_from_view remains the identity transform
// Renderwidth/height
int kMaxSize = 16384;
int kMinSize = 2;
// DCHECK on debug builds to catch legitimate large sizes, but clamp on
// release builds to ensure valid state.
DCHECK_LT(view->viewport.width() + view->viewport.x(), kMaxSize);
DCHECK_LT(view->viewport.height() + view->viewport.y(), kMaxSize);
DCHECK_GT(view->viewport.width() + view->viewport.x(), kMinSize);
DCHECK_GT(view->viewport.height() + view->viewport.y(), kMinSize);
ret->viewport =
gfx::Rect(std::clamp(view->viewport.x(), 0, kMaxSize),
std::clamp(view->viewport.y(), 0, kMaxSize),
std::clamp(view->viewport.width(), kMinSize, kMaxSize),
std::clamp(view->viewport.height(), kMinSize, kMaxSize));
return ret;
}
} // anonymous namespace
BrowserXRRuntimeImpl::BrowserXRRuntimeImpl(
device::mojom::XRDeviceId id,
device::mojom::XRDeviceDataPtr device_data,
mojo::PendingRemote<device::mojom::XRRuntime> runtime)
: id_(id),
device_data_(std::move(device_data)),
runtime_(std::move(runtime)) {
DVLOG(2) << __func__ << ": id=" << id;
runtime_->ListenToDeviceChanges(receiver_.BindNewEndpointAndPassRemote());
// TODO(crbug.com/40662458): Convert this to a query for the client off of
// ContentBrowserClient once BrowserXRRuntimeImpl moves to content.
auto* integration_client = GetXrIntegrationClient();
if (integration_client) {
install_helper_ = integration_client->GetInstallHelper(id_);
runtime_observer_ = integration_client->CreateRuntimeObserver();
if (runtime_observer_) {
AddObserver(runtime_observer_.get());
}
}
}
BrowserXRRuntimeImpl::~BrowserXRRuntimeImpl() {
DVLOG(2) << __func__ << ": id=" << id_;
if (runtime_observer_) {
RemoveObserver(runtime_observer_.get());
}
if (install_finished_callback_) {
std::move(install_finished_callback_).Run(false);
}
}
void BrowserXRRuntimeImpl::ExitActiveImmersiveSession() {
DVLOG(2) << __func__;
auto* service = GetServiceWithActiveImmersiveSession();
if (service) {
service->ExitPresent(base::DoNothing());
}
}
bool BrowserXRRuntimeImpl::SupportsFeature(
device::mojom::XRSessionFeature feature) const {
if(id_ == device::mojom::XRDeviceId::WEB_TEST_DEVICE_ID ||
id_ == device::mojom::XRDeviceId::FAKE_DEVICE_ID)
return true;
return base::Contains(device_data_->supported_features, feature);
}
bool BrowserXRRuntimeImpl::SupportsAllFeatures(
const std::vector<device::mojom::XRSessionFeature>& features) const {
for (const auto& feature : features) {
if (!SupportsFeature(feature))
return false;
}
return true;
}
bool BrowserXRRuntimeImpl::SupportsCustomIPD() const {
switch (id_) {
case device::mojom::XRDeviceId::WEB_TEST_DEVICE_ID:
case device::mojom::XRDeviceId::FAKE_DEVICE_ID:
case device::mojom::XRDeviceId::ORIENTATION_DEVICE_ID:
#if BUILDFLAG(ENABLE_ARCORE)
case device::mojom::XRDeviceId::ARCORE_DEVICE_ID:
#endif // ENABLE_ARCORE
#if BUILDFLAG(ENABLE_CARDBOARD)
case device::mojom::XRDeviceId::CARDBOARD_DEVICE_ID:
#endif // ENABLE_CARDBOARD
return false;
#if BUILDFLAG(ENABLE_OPENXR)
case device::mojom::XRDeviceId::OPENXR_DEVICE_ID:
return true;
#endif
}
NOTREACHED_IN_MIGRATION();
}
bool BrowserXRRuntimeImpl::SupportsNonEmulatedHeight() const {
switch (id_) {
case device::mojom::XRDeviceId::WEB_TEST_DEVICE_ID:
case device::mojom::XRDeviceId::FAKE_DEVICE_ID:
case device::mojom::XRDeviceId::ORIENTATION_DEVICE_ID:
#if BUILDFLAG(ENABLE_ARCORE)
case device::mojom::XRDeviceId::ARCORE_DEVICE_ID:
#endif // ENABLE_ARCORE
return false;
#if BUILDFLAG(ENABLE_CARDBOARD)
case device::mojom::XRDeviceId::CARDBOARD_DEVICE_ID:
return true;
#endif // ENABLE_CARDBOARD
#if BUILDFLAG(ENABLE_OPENXR)
case device::mojom::XRDeviceId::OPENXR_DEVICE_ID:
return true;
#endif // ENABLE_OPENXR
}
NOTREACHED_IN_MIGRATION();
}
bool BrowserXRRuntimeImpl::SupportsArBlendMode() {
return device_data_->is_ar_blend_mode_supported;
}
void BrowserXRRuntimeImpl::StopImmersiveSession() {
DVLOG(2) << __func__;
if (immersive_session_has_camera_access_) {
for (Observer& observer : observers_) {
observer.WebXRCameraInUseChanged(nullptr, false);
}
immersive_session_has_camera_access_ = false;
}
if (immersive_session_controller_) {
immersive_session_controller_.reset();
if (presenting_service_) {
presenting_service_->OnExitPresent();
presenting_service_ = nullptr;
}
}
vr_ui_host_.reset();
}
void BrowserXRRuntimeImpl::OnExitPresent() {
DVLOG(2) << __func__;
if (presenting_service_) {
presenting_service_->OnExitPresent();
presenting_service_ = nullptr;
}
}
void BrowserXRRuntimeImpl::OnVisibilityStateChanged(
device::mojom::XRVisibilityState visibility_state) {
for (VRServiceImpl* service : services_) {
service->OnVisibilityStateChanged(visibility_state);
}
}
void BrowserXRRuntimeImpl::OnServiceAdded(VRServiceImpl* service) {
DVLOG(2) << __func__ << ": id=" << id_;
services_.insert(service);
}
void BrowserXRRuntimeImpl::OnServiceRemoved(VRServiceImpl* service) {
DVLOG(2) << __func__ << ": id=" << id_;
DCHECK(service);
services_.erase(service);
if (service == presenting_service_) {
presenting_service_ = nullptr;
// Note that we replicate the logic in ExitPresent because we need to clear
// our presenting_service_ as it is no longer valid. However, the Runtime
// may still need to be notified to terminate its session. ExitPresent may
// be called when the service *is* still valid and would need to be notified
// of this shutdown.
runtime_->ShutdownSession(
base::BindOnce(&BrowserXRRuntimeImpl::StopImmersiveSession,
weak_ptr_factory_.GetWeakPtr()));
}
}
void BrowserXRRuntimeImpl::ExitPresent(VRServiceImpl* service) {
DVLOG(2) << __func__ << ": id=" << id_ << " service=" << service
<< " presenting_service_=" << presenting_service_;
if (service == presenting_service_) {
runtime_->ShutdownSession(
base::BindOnce(&BrowserXRRuntimeImpl::StopImmersiveSession,
weak_ptr_factory_.GetWeakPtr()));
}
}
void BrowserXRRuntimeImpl::SetFramesThrottled(const VRServiceImpl* service,
bool throttled) {
if (service == presenting_service_ && vr_ui_host_) {
vr_ui_host_->WebXRFramesThrottledChanged(throttled);
}
}
void BrowserXRRuntimeImpl::RequestInlineSession(
device::mojom::XRRuntimeSessionOptionsPtr options,
device::mojom::XRRuntime::RequestSessionCallback callback) {
runtime_->RequestSession(std::move(options), std::move(callback));
}
void BrowserXRRuntimeImpl::RequestImmersiveSession(
VRServiceImpl* service,
device::mojom::XRRuntimeSessionOptionsPtr options,
RequestSessionCallback callback) {
DVLOG(2) << __func__ << ": id=" << id_;
// base::Unretained is safe because we won't be called back after runtime_ is
// destroyed.
has_pending_immersive_session_request_ = true;
runtime_->RequestSession(
options->Clone(),
base::BindOnce(&BrowserXRRuntimeImpl::OnRequestSessionResult,
base::Unretained(this), service->GetWeakPtr(),
options->Clone(), std::move(callback)));
}
void BrowserXRRuntimeImpl::OnRequestSessionResult(
base::WeakPtr<VRServiceImpl> service,
device::mojom::XRRuntimeSessionOptionsPtr options,
RequestSessionCallback callback,
device::mojom::XRRuntimeSessionResultPtr session_result) {
has_pending_immersive_session_request_ = false;
if (session_result && service) {
DVLOG(2) << __func__ << ": id=" << id_;
if (device::XRSessionModeUtils::IsImmersive(options->mode)) {
presenting_service_ = service.get();
immersive_session_controller_.Bind(std::move(session_result->controller));
immersive_session_controller_.set_disconnect_handler(
base::BindOnce(&BrowserXRRuntimeImpl::OnImmersiveSessionError,
base::Unretained(this)));
content::WebContents* web_contents = service->GetWebContents();
auto* integration_client = GetXrIntegrationClient();
if (session_result->overlay && integration_client && web_contents) {
// We have enough information to create a VrUiHost, so validate that
// information then attempt to create it.
std::vector<device::mojom::XRViewPtr>& views =
session_result->session->device_config->views;
for (device::mojom::XRViewPtr& view : views) {
view = ValidateXRView(view.get());
}
// The overlay code requires the left and right views to render.
if (!base::Contains(views, device::mojom::XREye::kLeft,
&device::mojom::XRView::eye) ||
!base::Contains(views, device::mojom::XREye::kRight,
&device::mojom::XRView::eye)) {
// Notify the service to cleanup any session that it's started to
// setup, and when that and our corresponding runtime shutdown have
// finished, notify the page that the session request failed.
service->ExitPresent(base::BindOnce(
[](RequestSessionCallback callback) {
std::move(callback).Run(nullptr);
},
std::move(callback)));
return;
}
vr_ui_host_ = integration_client->CreateVrUiHost(
*web_contents, views, std::move(session_result->overlay));
}
immersive_session_has_camera_access_ =
base::Contains(session_result->session->enabled_features,
device::mojom::XRSessionFeature::CAMERA_ACCESS);
if (immersive_session_has_camera_access_) {
for (Observer& observer : observers_) {
observer.WebXRCameraInUseChanged(web_contents, true);
}
}
}
std::move(callback).Run(std::move(session_result));
} else {
std::move(callback).Run(nullptr);
if (session_result) {
// The service has been removed, but we still got a session, so make
// sure to clean up this weird state.
immersive_session_controller_.Bind(std::move(session_result->controller));
StopImmersiveSession();
}
}
}
void BrowserXRRuntimeImpl::EnsureInstalled(
int render_process_id,
int render_frame_id,
base::OnceCallback<void(bool)> install_callback) {
DVLOG(2) << __func__;
// If there's no install helper, then we can assume no install is needed.
if (!install_helper_) {
std::move(install_callback).Run(true);
return;
}
// Only the most recent caller will be notified of a successful install.
bool had_outstanding_callback = false;
if (install_finished_callback_) {
had_outstanding_callback = true;
std::move(install_finished_callback_).Run(false);
}
install_finished_callback_ = std::move(install_callback);
// If we already had a cached install callback, then we don't need to query
// for installation again.
if (had_outstanding_callback)
return;
install_helper_->EnsureInstalled(
render_process_id, render_frame_id,
base::BindOnce(&BrowserXRRuntimeImpl::OnInstallFinished,
weak_ptr_factory_.GetWeakPtr()));
}
void BrowserXRRuntimeImpl::OnInstallFinished(bool succeeded) {
DCHECK(install_finished_callback_);
std::move(install_finished_callback_).Run(succeeded);
}
void BrowserXRRuntimeImpl::OnImmersiveSessionError() {
DVLOG(2) << __func__ << ": id=" << id_;
StopImmersiveSession();
}
void BrowserXRRuntimeImpl::AddObserver(Observer* observer) {
observers_.AddObserver(observer);
}
void BrowserXRRuntimeImpl::RemoveObserver(Observer* observer) {
observers_.RemoveObserver(observer);
}
void BrowserXRRuntimeImpl::BeforeRuntimeRemoved() {
DVLOG(1) << __func__ << ": id=" << id_;
// If the device process crashes or otherwise gets removed, it's a race as to
// whether or not our mojo interface to the device gets reset before we're
// deleted as the result of the device provider being destroyed.
// Since this no-ops if we don't have an active immersive session, try to end
// any immersive session we may be currently responsible for.
StopImmersiveSession();
}
std::vector<device::mojom::XRSessionFeature>
BrowserXRRuntimeImpl::GetSupportedFeatures() {
return device_data_->supported_features;
}
#if BUILDFLAG(IS_WIN)
std::optional<CHROME_LUID> BrowserXRRuntimeImpl::GetLuid() const {
return device_data_->luid;
}
#endif
} // namespace content