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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
<!doctype html>
<!--
Copyright 2018 The Immersive Web Community Group
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-->
<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'>
<!-- Origin Trial Token, feature = WebXR Device API, origin = https://immersive-web.github.io, expires = 2018-08-28 -->
<meta http-equiv="origin-trial" data-feature="WebXR Device API" data-expires="2018-08-28" content="AnNpu7ceXvLew05ccD8Zr1OZsdZiB2hLQKK82kTTMDwF7oRKtP3QEJ4RzkeHrmB8Sq0vSV6ZNmszpBCZ0I8p9gAAAABceyJvcmlnaW4iOiJodHRwczovL2ltbWVyc2l2ZS13ZWIuZ2l0aHViLmlvOjQ0MyIsImZlYXR1cmUiOiJXZWJYUkRldmljZSIsImV4cGlyeSI6MTUzNTQxNDQwMH0=">
<title>Positional Audio</title>
<link href='css/common.css' rel='stylesheet'></link>
<!--The polyfill is not needed for browser that have native API support,
but is linked by these samples for wider compatibility.-->
<!--script src='https://cdn.jsdelivr.net/npm/webxr-polyfill@latest/build/webxr-polyfill.js'></script-->
<script src='js/xrray-polyfill.js' type='module'></script>
<script src='js/webxr-polyfill.js'></script>
<script src="https://cdn.jsdelivr.net/npm/resonance-audio/build/resonance-audio.min.js"></script>
<script src='js/webxr-button.js'></script>
</head>
<body>
<header>
<details open>
<summary>Positional Audio</summary>
<p>
This sample demonstrates playing audio that sounds as if it originates
at a specific point in the space. Audio will begin playing when you
enter XR.
<a class="back" href="./index.html">Back</a>
</p>
</details>
</header>
<script type="module">
import {Scene} from './js/cottontail/src/scenes/scene.js';
import {Renderer, createWebGLContext} from './js/cottontail/src/core/renderer.js';
import {Gltf2Node} from './js/cottontail/src/nodes/gltf2.js';
import {QueryArgs} from './js/cottontail/src/util/query-args.js';
import {FallbackHelper} from './js/cottontail/src/util/fallback-helper.js';
import {UrlTexture} from './js/cottontail/src/core/texture.js';
import {mat4, vec3} from './js/cottontail/src/math/gl-matrix.js';
import {ButtonNode} from './js/cottontail/src/nodes/button.js';
// If requested, initialize the WebXR polyfill
if (QueryArgs.getBool('allowPolyfill', false)) {
var polyfill = new WebXRPolyfill();
}
// If requested, don't display the frame rate info.
let hideStats = QueryArgs.getBool('hideStats', false);
const DEFAULT_HEIGHT = 1.5;
const ANALYSER_FFT_SIZE = 1024;
// XR globals.
let xrButton = null;
let xrImmersiveRefSpace = null;
let xrNonImmersiveRefSpace = null;
// WebGL scene globals.
let gl = null;
let renderer = null;
let scene = new Scene();
if (hideStats) {
scene.enableStats(false);
}
scene.addNode(new Gltf2Node({url: '../media/gltf/garage/garage.gltf'}));
scene.standingStats(true);
let playButton = null;
let playTexture = new UrlTexture('../media/textures/play-button.png');
let pauseTexture = new UrlTexture('../media/textures/pause-button.png');
let stereo = new Gltf2Node({url: '../media/gltf/stereo/stereo.gltf'});
// FIXME: Temporary fix to initialize for cloning.
stereo.visible = false;
scene.addNode(stereo);
// Audio scene globals
let audioContext = new AudioContext();
let resonance = new ResonanceAudio(audioContext);
resonance.output.connect(audioContext.destination);
audioContext.suspend();
// TODO: This is crashing in recent versions of Resonance for me, and I'm
// not sure why. It does run succesfully without it, though.
// Rough room dimensions in meters (estimated from model in Blender.)
/*let roomDimensions = {
width : 6,
height : 3,
depth : 6
};
// Simplified view of the materials that make up the scene.
let roomMaterials = {
left : 'plywood-panel', // Garage walls
right : 'plywood-panel',
front : 'plywood-panel',
back : 'metal', // To account for the garage door
down : 'polished-concrete-or-tile', // garage floor
up : 'wood-ceiling'
};
resonance.setRoomProperties(roomDimensions, roomMaterials);*/
function createAudioSource(options) {
// Create a Resonance source and set its position in space.
let source = resonance.createSource();
let pos = options.position;
source.setPosition(pos[0], pos[1], pos[2]);
// Connect an analyser. This is only for visualization of the audio, and
// in most cases you won't want it.
let analyser = audioContext.createAnalyser();
analyser.fftSize = ANALYSER_FFT_SIZE;
analyser.lastRMSdB = 0;
return fetch(options.url)
.then((response) => response.arrayBuffer())
.then((buffer) => audioContext.decodeAudioData(buffer))
.then((decodedBuffer) => {
let bufferSource = createBufferSource(
source, decodedBuffer, analyser);
return {
buffer: decodedBuffer,
bufferSource: bufferSource,
source: source,
analyser: analyser,
position: pos,
rotateY: options.rotateY,
node: null
};
});
}
function createBufferSource(source, buffer, analyser) {
// Create a buffer source. This will need to be recreated every time
// we wish to start the audio, see
// https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode
let bufferSource = audioContext.createBufferSource();
bufferSource.loop = true;
bufferSource.connect(source.input);
bufferSource.connect(analyser);
bufferSource.buffer = buffer;
return bufferSource;
}
/**
* Returns a floating point value that represents the loudness of the audio
* stream, appropriate for scaling an object with.
* @return {Number} loudness scalar.
*/
let fftBuffer = new Float32Array(ANALYSER_FFT_SIZE);
function getLoudnessScale(analyser) {
analyser.getFloatTimeDomainData(fftBuffer);
let sum = 0;
for (let i = 0; i < fftBuffer.length; ++i)
sum += fftBuffer[i] * fftBuffer[i];
// Calculate RMS and convert it to DB for perceptual loudness.
let rms = Math.sqrt(sum / fftBuffer.length);
let db = 30 + 10 / Math.LN10 * Math.log(rms <= 0 ? 0.0001 : rms);
// Moving average with the alpha of 0.525. Experimentally determined.
analyser.lastRMSdB += 0.525 * ((db < 0 ? 0 : db) - analyser.lastRMSdB);
// Scaling by 1/30 is also experimentally determined. Max is to present
// objects from disappearing entirely.
return Math.max(0.3, analyser.lastRMSdB / 30.0);
}
let audioSources = [];
function updateAudioNodes() {
if (!stereo)
return;
for (let source of audioSources) {
if (!source.node) {
source.node = stereo.clone();
source.node.visible = true;
source.node.selectable = true;
scene.addNode(source.node);
}
let node = source.node;
let matrix = node.matrix;
// Move the node to the right location.
mat4.identity(matrix);
mat4.translate(matrix, matrix, source.position);
mat4.rotateY(matrix, matrix, source.rotateY);
// Scale it based on loudness of the audio channel
let scale = getLoudnessScale(source.analyser);
mat4.scale(matrix, matrix, [scale, scale, scale]);
}
}
function playAudio() {
if (audioContext.state == 'running')
return;
audioContext.resume();
for (let source of audioSources) {
source.bufferSource.start(0);
}
if (playButton) {
playButton.iconTexture = pauseTexture;
}
}
function pauseAudio() {
if (audioContext.state == 'suspended')
return;
for (let source of audioSources) {
source.bufferSource.stop(0);
source.bufferSource = createBufferSource(
source.source, source.buffer, source.analyser);
}
audioContext.suspend();
if (playButton) {
playButton.iconTexture = playTexture;
}
}
window.addEventListener('blur', () => {
// As a general rule you should mute any sounds your page is playing
// whenever the page loses focus.
pauseAudio();
});
function initXR() {
xrButton = new XRDeviceButton({
onRequestSession: onRequestSession,
onEndSession: onEndSession,
supportedSessionTypes: ['immersive-vr']
});
document.querySelector('header').appendChild(xrButton.domElement);
if (navigator.xr) {
// Load multiple audio sources.
Promise.all([
createAudioSource({
url: '../media/sound/guitar.ogg',
position: [0, DEFAULT_HEIGHT, -1],
rotateY: 0
}),
createAudioSource({
url: '../media/sound/drums.ogg',
position: [-1, DEFAULT_HEIGHT, 0],
rotateY: Math.PI * 0.5
}),
createAudioSource({
url: '../media/sound/perc.ogg',
position: [1, DEFAULT_HEIGHT, 0],
rotateY: Math.PI * -0.5
}),
]).then((sources) => {
audioSources = sources;
// Once the audio is loaded, create a button that toggles the
// audio state when clicked.
playButton = new ButtonNode(playTexture, () => {
if (audioContext.state == 'running') {
pauseAudio();
} else {
if ("userActivation" in navigator) {
console.debug(navigator.userActivation);
}
playAudio();
}
});
playButton.translation = [0, 1.2, -0.65];
scene.addNode(playButton);
});
requestInlineSession()
.then((session) => {
gl.canvas.addEventListener('touchend', () => {
session.end().then(() => {
requestInlineSession({ optionalFeatures: ['local-floor'] });
})
}, { once: true });
});
} else {
initFallback();
}
}
function initFallback() {
initGL();
let fallbackHelper = new FallbackHelper(scene, gl);
fallbackHelper.emulateStage = true;
}
function initGL() {
if (gl)
return;
gl = createWebGLContext({
xrCompatible: true
});
document.body.appendChild(gl.canvas);
function onResize () {
gl.canvas.width = (gl.canvas.offsetWidth * window.devicePixelRatio);
gl.canvas.height = (gl.canvas.offsetHeight * window.devicePixelRatio);
}
window.addEventListener('resize', onResize);
onResize();
renderer = new Renderer(gl);
scene.setRenderer(renderer);
scene.inputRenderer.setControllerMesh(new Gltf2Node({url: '../media/gltf/controller/controller.gltf'}));
}
function onRequestSession() {
navigator.xr.requestSession('immersive-vr', {requiredFeatures: ['local-floor']})
.then((session) => {
session.mode = 'immersive-vr';
xrButton.setSession(session);
onSessionStarted(session);
});
}
function requestInlineSession(options) {
return navigator.xr.requestSession('inline', options)
.then((session) => {
session.mode = 'inline';
return onSessionStarted(session);
});
}
function onSessionStarted(session) {
session.addEventListener('end', onSessionEnded);
session.addEventListener('selectstart', onSelectStart);
session.addEventListener('selectend', onSelectEnd);
session.addEventListener('select', (ev) => {
let refSpace = ev.frame.session.mode.startsWith('immersive') ?
xrImmersiveRefSpace :
xrNonImmersiveRefSpace;
scene.handleSelect(ev.inputSource, ev.frame, refSpace);
});
initGL();
session.updateRenderState({
baseLayer: new XRWebGLLayer(session, gl)
});
session.requestReferenceSpace('local-floor').then((refSpace) => {
return refSpace;
}, (e) => {
if (!session.mode.startsWith('immersive')) {
// If we're in inline mode, our underlying platform may not support
// the local-floor reference space, but a viewer space is guaranteed.
return session.requestReferenceSpace('viewer').then((viewerRefSpace) => {
// Adjust the viewer space for an estimated user height. Otherwise,
// the poses queried with this space will originate from the floor.
let xform = new XRRigidTransform({x: 0, y: -1.5, z: 0});
return viewerRefSpace.getOffsetReferenceSpace(xform);
});
} else {
throw e;
}
}).then((refSpace) => {
if (session.mode.startsWith('immersive')) {
xrImmersiveRefSpace = refSpace;
} else {
xrNonImmersiveRefSpace = refSpace;
}
session.requestAnimationFrame(onXRFrame);
});
return session;
}
function onEndSession(session) {
session.end();
}
function onSessionEnded(event) {
if (event.session.mode.startsWith('immersive')) {
xrButton.setSession(null);
// Stop the audio playback when we exit XR.
pauseAudio();
}
}
function hitTest(inputSource, frame, refSpace) {
let pose = frame.getPose(inputSource.targetRaySpace, refSpace);
if (pose) {
let targetRay = new XRRay(pose.transform);
let hitResult = scene.hitTest(targetRay)
if (hitResult) {
for (let source of audioSources) {
if (hitResult.node === source.node) {
// Associate the input source with the audio source object until
// onSelectEnd event is raised with the same input source.
source.draggingInput = inputSource;
source.draggingTransform = mat4.create();
mat4.invert(source.draggingTransform, targetRay.matrix);
mat4.multiply(source.draggingTransform, source.draggingTransform, source.node.matrix);
return true;
}
}
}
}
return false;
}
function onSelectStart(ev) {
let refSpace = ev.frame.session.mode.startsWith('immersive') ?
xrImmersiveRefSpace :
xrNonImmersiveRefSpace;
hitTest(ev.inputSource, ev.frame, refSpace);
}
// Remove any references to the input source from the audio sources so
// that the objects are not dragged any further after the user releases
// the trigger.
function onSelectEnd(ev) {
for (let source of audioSources) {
if (source.draggingInput === ev.inputSource) {
source.draggingInput = undefined;
source.draggingTransform = undefined;
}
}
}
let tmpMatrix = mat4.create();
function onXRFrame(t, frame) {
let session = frame.session;
let refSpace = session.mode.startsWith('immersive') ?
xrImmersiveRefSpace :
xrNonImmersiveRefSpace;
let pose = frame.getViewerPose(refSpace);
scene.startFrame();
session.requestAnimationFrame(onXRFrame);
scene.updateInputSources(frame, refSpace);
// Update the position of all currently selected audio sources. It's
// possible to select multiple audio sources and drag them at the same
// time (one per controller that has the trigger held down).
for (let draggingSource of audioSources) {
if (draggingSource.draggingInput) {
let draggingPose = frame.getPose(draggingSource.draggingInput.targetRaySpace, refSpace);
if (draggingPose) {
let position = draggingSource.position;
mat4.multiply(tmpMatrix, draggingPose.transform.matrix, draggingSource.draggingTransform);
vec3.transformMat4(position, [0, 0, 0], tmpMatrix);
draggingSource.source.setPosition(position[0], position[1], position[2]);
}
}
}
updateAudioNodes();
scene.drawXRFrame(frame, pose);
if (pose) {
resonance.setListenerFromMatrix({ elements: pose.transform.matrix });
}
scene.endFrame();
}
// Start the XR application.
initXR();
</script>
</body>
</html>
|
