Skip to content

Commit

Permalink
ENH: Update https support and add WebXR demo as transform controller
Browse files Browse the repository at this point in the history
HTTPS support updated to support both the .pem file and .key file.
This allows the server to be configured to support https if the .pem
file is shared with a client (note - for Android phones the .pem
file may need to be converted to .der format).  Adding a way to
help generate and configure these files without editing the code
can be addressed in future work.

HTTPS is required to use the WebXR interface on the mobile phone
due to security concerns (WebXR uses cameras and other tracking
data that is considered a potential privacy issue, so https is required).

The WebXR demo allows the user to manage a MRML linear transform node
based on the position and orientation of the phone.  See this page for
an example video and more information:

https://projectweek.na-mic.org/PW40_2024_GranCanaria/Projects/AugmentedRealityExperimentsForCardiologyImaging/
  • Loading branch information
pieper committed Feb 2, 2024
1 parent 4efda83 commit 5aea7cc
Show file tree
Hide file tree
Showing 3 changed files with 230 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
<!doctype html>
<!--
Started from: https://raw.githubusercontent.com/immersive-web/webxr-samples/main/ar-barebones.html
-->
<html>
<head>
<meta charset='utf-8'>
<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no'>
<meta name='mobile-web-app-capable' content='yes'>
<meta name='apple-mobile-web-app-capable' content='yes'>
<link rel='icon' type='image/png' sizes='32x32' href='favicon-32x32.png'>
<link rel='icon' type='image/png' sizes='96x96' href='favicon-96x96.png'>
<link rel='stylesheet' href='./stylesheets/application.css'>

<title>Barebones AR</title>
</head>
<body>
<div id="overlay">
<header>
<details open>
<summary>Barebones WebXR DOM Overlay</summary>
<p>
This sample demonstrates extremely simple use of an "immersive-ar"
session with no library dependencies, with an optional DOM overlay.
It doesn't render anything exciting, just draws a rectangle with a
slowly changing color to prove it's working.
<a class="back" href="./index.html">Back</a>
</p>
<div id="session-info"></div>
<div id="pose"></div>
<div id="warning-zone"></div>
<button id="xr-button" class="barebones-button" disabled>XR not found</button>
</details>
</header>
</div>
<main style='text-align: center;'>
<p>Click 'Enter AR' to see content</p>
</main>
<script type="module">
// XR globals.
let xrButton = document.getElementById('xr-button');
let xrSession = null;
let xrRefSpace = null;
let currentPose = null;
let currentURL = "Nothing sent";

// WebGL scene globals.
let gl = null;

function checkSupportedState() {
navigator.xr.isSessionSupported('immersive-ar').then((supported) => {
if (supported) {
xrButton.innerHTML = 'Enter AR';
} else {
xrButton.innerHTML = 'AR not found';
}

xrButton.disabled = !supported;
});
}

function initXR() {
if (!window.isSecureContext) {
let message = "WebXR unavailable due to insecure context";
document.getElementById("warning-zone").innerText = message;
}

if (navigator.xr) {
xrButton.addEventListener('click', onButtonClicked);
navigator.xr.addEventListener('devicechange', checkSupportedState);
checkSupportedState();
}
}

function onButtonClicked() {
if (!xrSession) {
// Ask for an optional DOM Overlay, see https://immersive-web.github.io/dom-overlays/
navigator.xr.requestSession('immersive-ar', {
optionalFeatures: ['dom-overlay'],
domOverlay: {root: document.getElementById('overlay')}
}).then(onSessionStarted, onRequestSessionError);
} else {
xrSession.end();
}
}

function onSessionStarted(session) {
xrSession = session;
xrButton.innerHTML = 'Exit AR';

// Show which type of DOM Overlay got enabled (if any)
if (session.domOverlayState) {
document.getElementById('session-info').innerHTML = 'DOM Overlay type: ' + session.domOverlayState.type;
}

session.addEventListener('end', onSessionEnded);
let canvas = document.createElement('canvas');
gl = canvas.getContext('webgl', {
xrCompatible: true
});
session.updateRenderState({ baseLayer: new XRWebGLLayer(session, gl) });
session.requestReferenceSpace('local').then((refSpace) => {
xrRefSpace = refSpace;
session.requestAnimationFrame(onXRFrame);
});
}

function onRequestSessionError(ex) {
alert("Failed to start immersive AR session.");
console.error(ex.message);
}

function onEndSession(session) {
session.end();
}

function onSessionEnded(event) {
xrSession = null;
xrButton.innerHTML = 'Enter AR';
document.getElementById('session-info').innerHTML = '';
gl = null;
}

function onXRFrame(t, frame) {
let session = frame.session;
session.requestAnimationFrame(onXRFrame);

gl.bindFramebuffer(gl.FRAMEBUFFER, session.renderState.baseLayer.framebuffer);

// Update the clear color so that we can observe the color in the
// headset changing over time. Use a scissor rectangle to keep the AR
// scene visible.
const width = session.renderState.baseLayer.framebufferWidth;
const height = session.renderState.baseLayer.framebufferHeight;
gl.enable(gl.SCISSOR_TEST);
gl.scissor(width / 4, height / 4, width / 2, height / 2);
let time = Date.now();
gl.clearColor(Math.cos(time / 2000), Math.cos(time / 4000), Math.cos(time / 6000), 0.5);
gl.clear(gl.COLOR_BUFFER_BIT | gl.DEPTH_BUFFER_BIT);

let pose = frame.getViewerPose(xrRefSpace);
if (pose) {
const p = pose.transform.position;
const m = pose.transform.matrix;
document.getElementById('pose').innerText = "" +
"Position: " + 1000 * p.x.toFixed(3) + ", " + 1000* p.y.toFixed(3) + ", " + 1000 * p.z.toFixed(3) + "\n" +
"matrix:\n" +
m[0].toFixed(3) + ", " + m[4].toFixed(3) + ", " + m[8].toFixed(3) + ", " + m[12].toFixed(3) + "\n" +
m[1].toFixed(3) + ", " + m[5].toFixed(3) + ", " + m[9].toFixed(3) + ", " + m[13].toFixed(3) + "\n" +
m[2].toFixed(3) + ", " + m[6].toFixed(3) + ", " + m[10].toFixed(3) + ", " + m[14].toFixed(3) + "\n" +
m[3].toFixed(3) + ", " + m[7].toFixed(3) + ", " + m[11].toFixed(3) + ", " + m[15].toFixed(3) + "\n" + currentURL;

if (currentPose == null) {
currentPose = pose;
sendTracker();
}
currentPose = pose;

} else {
document.getElementById('pose').innerText = "Position: (null pose)";
}
}

function sendTracker() {
let putRequest = new XMLHttpRequest();
putRequest.onload = function (event) {
if (xrSession != null) {
sendTracker(); // trigger another round
}
};
putRequest.onerror = function () {
console.log(`Got a ${putRequest.status} with text ${putRequest.statusText}`);
};
let pose = currentPose;
if (pose) {
let putURL = "./slicer/tracking";
const p = pose.transform.position;
const o = pose.transform.orientation;
const m = pose.transform.matrix;

/*
putURL += "?m=";
for (let row = 0; row < 4; row++) {
for (let column = 0; column < 4; column++) {
let value = m[row*4 + column];
if (row == column) {
value = 1;
} else if (column < 3) {
value = 0;
} else {
value = p[row];
}
putURL += `${value},`;
}
}
putURL = putURL.slice(0,-1); // strip last comma
*/

putURL += `?p=${1000*p.x},${1000*p.y},${1000*p.z}`;
putURL += `&q=${o.w},${o.x},${o.y},${o.z}`;

putRequest.open("PUT", putURL, true);
putRequest.send();
currentURL = putURL;
}
}

initXR();
</script>
</body>
</html>
9 changes: 9 additions & 0 deletions Modules/Scripted/WebServer/Resources/docroot/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,15 @@ <h3>VolView examples</h3>
</li>
</ul>

<ul>
<li>
<h3>WebXR controller</h3>
<p><b>Requires https and a compatible device.</b> Setting up https currently requires editing the source code of this module to specify certificate and key files. Compatible devices include Android phones from about 2022 or later.</p>
<p>See <a href='https://projectweek.na-mic.org/PW40_2024_GranCanaria/Projects/AugmentedRealityExperimentsForCardiologyImaging/'>this page from Project Week 40</a> for more background.</p>
<p>Uses <a href='https://developer.mozilla.org/en-US/docs/Web/API/WebXR_Device_API'>WebXR</a> to interact with Slicer scene.</p>
<a href='./ServerTests/WebXR-controller/index.html'>WebXR-controller</a> (requires WebXR browser and https cert enabled)<br>
</li>
</ul>

</body>

Expand Down
16 changes: 10 additions & 6 deletions Modules/Scripted/WebServer/WebServer.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ def setup(self):
# TODO: warning dialog on first connect
# TODO: config option for port
# TODO: config option for optional plugins
# TODO: config option for certfile (https)

self.advancedCollapsibleButton = ctk.ctkCollapsibleButton()
self.advancedCollapsibleButton.text = _("Advanced")
Expand Down Expand Up @@ -283,6 +282,7 @@ def __init__(self,
docroot:str=".",
logMessage:Callable=None,
certfile:str=None,
keyfile:str=None,
enableCORS:bool=False):
"""
:param server_address: passed to parent class (default ("", 8070))
Expand All @@ -291,19 +291,20 @@ def __init__(self,
:param docroot: used to serve static pages content
:param logMessage: a callable for messages
:param certfile: path to a file with an ssl certificate (.pem file)
(something like: openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem
:param keyfile: path to a file with an ssl certificate key (.key file)
"""
HTTPServer.__init__(self, server_address, SlicerHTTPServer.DummyRequestHandler)

self.requestHandlers = requestHandlers or []
self.docroot = docroot
self.timeout = 1.0
if certfile:
if certfile and keyfile:
# https://stackoverflow.com/questions/19705785/python-3-simple-https-server
import ssl
self.socket = ssl.wrap_socket(self.socket,
server_side=True,
certfile=certfile,
ssl_version=ssl.PROTOCOL_TLS)
context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
context.load_cert_chain(certfile, keyfile)
self.socket = context.wrap_socket(self.socket, server_side=True)
self.socket.settimeout(5.0)
if logMessage:
self.logMessage = logMessage
Expand Down Expand Up @@ -631,12 +632,15 @@ def start(self):
self.logMessage("Starting server on port %d" % self.port)
self.logMessage("docroot: %s" % self.docroot)
# example: certfile = '/Users/pieper/slicer/latest/SlicerWeb/localhost.pem'
# example: keyfile = '/Users/pieper/slicer/latest/SlicerWeb/localhost.key'
certfile = None
keyfile = None
self.server = SlicerHTTPServer(requestHandlers=self.requestHandlers,
docroot=self.docroot,
server_address=("", self.port),
logMessage=self.logMessage,
certfile=certfile,
keyfile=keyfile,
enableCORS=self.enableCORS)
self.server.start()
self.serverStarted = True
Expand Down

0 comments on commit 5aea7cc

Please sign in to comment.