Add WebAudio listener fallback implementation (#16797)

Firefox does not implement the audio context listener `forwardX/Y/Z`,
`positionX/Y/Z` and `upX/Y/Z` properties, so the deprecated
`setPosition` and `setOrientation` methods must be used.

This change detects when the newer properties are not available and
falls back to the deprecated methods if needed.

Author: docEdub

packages/dev/core/src/AudioV2/webAudio/subProperties/spatialWebAudioListener.ts

@@ -5,24 +5,36 @@ import type { _WebAudioEngine } from "../webAudioEngine";
 
 const TmpMatrix = Matrix.Zero();
 const TmpQuaternion = new Quaternion();
-const TmpVector = Vector3.Zero();
+const TmpVector1 = Vector3.Zero();
+const TmpVector2 = Vector3.Zero();
 
 /** @internal */
 export function _CreateSpatialAudioListener(engine: _WebAudioEngine, autoUpdate: boolean, minUpdateTime: number): _SpatialAudioListener {
-    return new _SpatialWebAudioListener(engine, autoUpdate, minUpdateTime);
+    const listener = engine._audioContext.listener;
+    if (
+        listener.forwardX &&
+        listener.forwardY &&
+        listener.forwardZ &&
+        listener.positionX &&
+        listener.positionY &&
+        listener.positionZ &&
+        listener.upX &&
+        listener.upY &&
+        listener.upZ
+    ) {
+        return new _SpatialWebAudioListener(engine, autoUpdate, minUpdateTime);
+    } else {
+        return new _SpatialWebAudioListenerFallback(engine, autoUpdate, minUpdateTime);
+    }
 }
 
-/**
- * This sub property is not backed by a sub node and all properties are set directly on the audio context listener.
- *
- * @internal
- */
-class _SpatialWebAudioListener extends _SpatialAudioListener {
-    private _audioContext: AudioContext;
-    private _lastPosition: Vector3 = Vector3.Zero();
-    private _lastRotation: Vector3 = Vector3.Zero();
-    private _lastRotationQuaternion: Quaternion = new Quaternion();
-    private _updaterComponent: _SpatialWebAudioUpdaterComponent;
+abstract class _AbstractSpatialWebAudioListener extends _SpatialAudioListener {
+    protected readonly _listener: AudioListener;
+
+    protected _lastPosition: Vector3 = Vector3.Zero();
+    protected _lastRotation: Vector3 = Vector3.Zero();
+    protected _lastRotationQuaternion: Quaternion = new Quaternion();
+    protected _updaterComponent: _SpatialWebAudioUpdaterComponent;
 
     /** @internal */
     public readonly engine: _WebAudioEngine;
@@ -38,12 +50,20 @@ class _SpatialWebAudioListener extends _SpatialAudioListener {
     public constructor(engine: _WebAudioEngine, autoUpdate: boolean, minUpdateTime: number) {
         super();
 
+        this._listener = engine._audioContext.listener;
         this.engine = engine;
 
-        this._audioContext = engine._audioContext;
         this._updaterComponent = new _SpatialWebAudioUpdaterComponent(this, autoUpdate, minUpdateTime);
     }
 
+    /** @internal */
+    public override dispose(): void {
+        super.dispose();
+
+        this._updaterComponent.dispose();
+        this._updaterComponent = null!;
+    }
+
     /** @internal */
     public get minUpdateTime(): number {
         return this._updaterComponent.minUpdateTime;
@@ -54,14 +74,6 @@ class _SpatialWebAudioListener extends _SpatialAudioListener {
         this._updaterComponent.minUpdateTime = value;
     }
 
-    /** @internal */
-    public override dispose(): void {
-        super.dispose();
-
-        this._updaterComponent.dispose();
-        this._updaterComponent = null!;
-    }
-
     /** @internal */
     public update(): void {
         if (this.isAttached) {
@@ -72,22 +84,16 @@ class _SpatialWebAudioListener extends _SpatialAudioListener {
         }
     }
 
-    /** @internal */
     public _updatePosition(): void {
         if (this._lastPosition.equalsWithEpsilon(this.position)) {
             return;
         }
 
-        const listener = this._audioContext.listener;
-
-        this.engine._setAudioParam(listener.positionX, this.position.x);
-        this.engine._setAudioParam(listener.positionY, this.position.y);
-        this.engine._setAudioParam(listener.positionZ, this.position.z);
+        this._setWebAudioPosition(this.position);
 
         this._lastPosition.copyFrom(this.position);
     }
 
-    /** @internal */
     public _updateRotation(): void {
         if (!this._lastRotationQuaternion.equalsWithEpsilon(this.rotationQuaternion)) {
             TmpQuaternion.copyFrom(this.rotationQuaternion);
@@ -100,17 +106,68 @@ class _SpatialWebAudioListener extends _SpatialAudioListener {
         }
 
         Matrix.FromQuaternionToRef(TmpQuaternion, TmpMatrix);
-        const listener = this._audioContext.listener;
 
         // NB: The WebAudio API is right-handed.
-        Vector3.TransformNormalToRef(Vector3.RightHandedForwardReadOnly, TmpMatrix, TmpVector);
-        this.engine._setAudioParam(listener.forwardX, TmpVector.x);
-        this.engine._setAudioParam(listener.forwardY, TmpVector.y);
-        this.engine._setAudioParam(listener.forwardZ, TmpVector.z);
-
-        Vector3.TransformNormalToRef(Vector3.Up(), TmpMatrix, TmpVector);
-        this.engine._setAudioParam(listener.upX, TmpVector.x);
-        this.engine._setAudioParam(listener.upY, TmpVector.y);
-        this.engine._setAudioParam(listener.upZ, TmpVector.z);
+        Vector3.TransformNormalToRef(Vector3.RightHandedForwardReadOnly, TmpMatrix, TmpVector1);
+        Vector3.TransformNormalToRef(Vector3.Up(), TmpMatrix, TmpVector2);
+
+        this._setWebAudioOrientation(TmpVector1, TmpVector2);
+    }
+
+    protected abstract _setWebAudioPosition(position: Vector3): void;
+    protected abstract _setWebAudioOrientation(forward: Vector3, up: Vector3): void;
+}
+
+/**
+ * Full-featured spatial audio listener for the Web Audio API.
+ *
+ * Used in browsers that support the `forwardX/Y/Z`, `positionX/Y/Z`, and `upX/Y/Z` properties on the AudioContext listener.
+ *
+ * NB: Firefox falls back to using this implementation.
+ *
+ * @see _SpatialWebAudioListenerFallback for the implementation used if only `setPosition` and `setOrientation` are available.
+ *
+ * NB: This sub property is not backed by a sub node and all properties are set directly on the audio context listener.
+ *
+ * @internal
+ */
+class _SpatialWebAudioListener extends _AbstractSpatialWebAudioListener {
+    protected override _setWebAudioPosition(position: Vector3): void {
+        this.engine._setAudioParam(this._listener.positionX, position.x);
+        this.engine._setAudioParam(this._listener.positionY, position.y);
+        this.engine._setAudioParam(this._listener.positionZ, position.z);
+    }
+
+    protected override _setWebAudioOrientation(forward: Vector3, up: Vector3): void {
+        this.engine._setAudioParam(this._listener.forwardX, forward.x);
+        this.engine._setAudioParam(this._listener.forwardY, forward.y);
+        this.engine._setAudioParam(this._listener.forwardZ, forward.z);
+
+        this.engine._setAudioParam(this._listener.upX, up.x);
+        this.engine._setAudioParam(this._listener.upY, up.y);
+        this.engine._setAudioParam(this._listener.upZ, up.z);
+    }
+}
+
+/**
+ * Fallback spatial audio listener for the Web Audio API.
+ *
+ * Used in browsers that do not support the `forwardX/Y/Z`, `positionX/Y/Z`, and `upX/Y/Z` properties on the
+ * AudioContext listener.
+ *
+ * @see _SpatialWebAudioListener for the implementation used if the `forwardX/Y/Z`, `positionX/Y/Z`, and `upX/Y/Z`
+ * properties are available.
+ *
+ * NB: This sub property is not backed by a sub node and all properties are set directly on the audio context listener.
+ *
+ * @internal
+ */
+class _SpatialWebAudioListenerFallback extends _AbstractSpatialWebAudioListener {
+    protected override _setWebAudioPosition(position: Vector3): void {
+        this._listener.setPosition(this.position.x, this.position.y, this.position.z);
+    }
+
+    protected override _setWebAudioOrientation(forward: Vector3, up: Vector3): void {
+        this._listener.setOrientation(forward.x, forward.y, forward.z, up.x, up.y, up.z);
     }
 }