@babylonjs/core 7.21.4 → 7.22.0

package/Audio/sound.js

@@ -1,11 +1,11 @@
 import { Tools } from "../Misc/tools.js";
 import { Observable } from "../Misc/observable.js";
 import { Vector3 } from "../Maths/math.vector.js";
-import { Engine } from "../Engines/engine.js";
 import { Logger } from "../Misc/logger.js";
 import { _WarnImport } from "../Misc/devTools.js";
 import { EngineStore } from "../Engines/engineStore.js";
 import { RegisterClass } from "../Misc/typeStore.js";
+import { AbstractEngine } from "../Engines/abstractEngine.js";
 /**
  * Defines a sound that can be played in the application.
  * The sound can either be an ambient track or a simple sound played in reaction to a user action.
@@ -32,10 +32,10 @@ export class Sound {
         if (this._htmlAudioElement) {
             return this._htmlAudioElement.currentTime;
         }
-        if (Engine.audioEngine?.audioContext && (this.isPlaying || this.isPaused)) {
+        if (AbstractEngine.audioEngine?.audioContext && (this.isPlaying || this.isPaused)) {
             // The `_currentTime` member is only updated when the sound is paused. Add the time since the last start
             // to get the actual current time.
-            const timeSinceLastStart = this.isPaused ? 0 : Engine.audioEngine.audioContext.currentTime - this._startTime;
+            const timeSinceLastStart = this.isPaused ? 0 : AbstractEngine.audioEngine.audioContext.currentTime - this._startTime;
             return this._currentTime + timeSinceLastStart;
         }
         return 0;
@@ -178,8 +178,8 @@ export class Sound {
             this._length = options.length;
             this._offset = options.offset;
         }
-        if (Engine.audioEngine?.canUseWebAudio && Engine.audioEngine.audioContext) {
-            this._soundGain = Engine.audioEngine.audioContext.createGain();
+        if (AbstractEngine.audioEngine?.canUseWebAudio && AbstractEngine.audioEngine.audioContext) {
+            this._soundGain = AbstractEngine.audioEngine.audioContext.createGain();
             this._soundGain.gain.value = this._volume;
             this._inputAudioNode = this._soundGain;
             this._outputAudioNode = this._soundGain;
@@ -216,7 +216,7 @@ export class Sound {
                         case "MediaElement":
                             this._streaming = true;
                             this._isReadyToPlay = true;
-                            this._streamingSource = Engine.audioEngine.audioContext.createMediaElementSource(urlOrArrayBuffer);
+                            this._streamingSource = AbstractEngine.audioEngine.audioContext.createMediaElementSource(urlOrArrayBuffer);
                             if (this.autoplay) {
                                 this.play(0, this._offset, this._length);
                             }
@@ -227,7 +227,7 @@ export class Sound {
                         case "MediaStream":
                             this._streaming = true;
                             this._isReadyToPlay = true;
-                            this._streamingSource = Engine.audioEngine.audioContext.createMediaStreamSource(urlOrArrayBuffer);
+                            this._streamingSource = AbstractEngine.audioEngine.audioContext.createMediaStreamSource(urlOrArrayBuffer);
                             if (this.autoplay) {
                                 this.play(0, this._offset, this._length);
                             }
@@ -256,8 +256,8 @@ export class Sound {
                                 const url = urls[i];
                                 codecSupportedFound =
                                     (options && options.skipCodecCheck) ||
-                                        (url.indexOf(".mp3", url.length - 4) !== -1 && Engine.audioEngine.isMP3supported) ||
-                                        (url.indexOf(".ogg", url.length - 4) !== -1 && Engine.audioEngine.isOGGsupported) ||
+                                        (url.indexOf(".mp3", url.length - 4) !== -1 && AbstractEngine.audioEngine.isMP3supported) ||
+                                        (url.indexOf(".ogg", url.length - 4) !== -1 && AbstractEngine.audioEngine.isOGGsupported) ||
                                         url.indexOf(".wav", url.length - 4) !== -1 ||
                                         url.indexOf(".m4a", url.length - 4) !== -1 ||
                                         url.indexOf(".mp4", url.length - 4) !== -1 ||
@@ -328,9 +328,9 @@ export class Sound {
         else {
             // Adding an empty sound to avoid breaking audio calls for non Web Audio browsers
             this._scene.mainSoundTrack.addSound(this);
-            if (Engine.audioEngine && !Engine.audioEngine.WarnedWebAudioUnsupported) {
+            if (AbstractEngine.audioEngine && !AbstractEngine.audioEngine.WarnedWebAudioUnsupported) {
                 Logger.Error("Web Audio is not supported by your browser.");
-                Engine.audioEngine.WarnedWebAudioUnsupported = true;
+                AbstractEngine.audioEngine.WarnedWebAudioUnsupported = true;
             }
             // Simulating a ready to play event to avoid breaking code for non web audio browsers
             if (this._readyToPlayCallback) {
@@ -346,7 +346,7 @@ export class Sound {
      * Release the sound and its associated resources
      */
     dispose() {
-        if (Engine.audioEngine?.canUseWebAudio) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio) {
             if (this.isPlaying) {
                 this.stop();
             }
@@ -400,7 +400,7 @@ export class Sound {
         return "Sound";
     }
     _audioBufferLoaded(buffer) {
-        if (!Engine.audioEngine?.audioContext) {
+        if (!AbstractEngine.audioEngine?.audioContext) {
             return;
         }
         this._audioBuffer = buffer;
@@ -413,10 +413,10 @@ export class Sound {
         }
     }
     _soundLoaded(audioData) {
-        if (!Engine.audioEngine?.audioContext) {
+        if (!AbstractEngine.audioEngine?.audioContext) {
             return;
         }
-        Engine.audioEngine.audioContext.decodeAudioData(audioData, (buffer) => {
+        AbstractEngine.audioEngine.audioContext.decodeAudioData(audioData, (buffer) => {
             this._audioBufferLoaded(buffer);
         }, (err) => {
             Logger.Error("Error while decoding audio data for: " + this.name + " / Error: " + err);
@@ -427,7 +427,7 @@ export class Sound {
      * @param audioBuffer The audioBuffer containing the data
      */
     setAudioBuffer(audioBuffer) {
-        if (Engine.audioEngine?.canUseWebAudio) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio) {
             this._audioBuffer = audioBuffer;
             this._isReadyToPlay = true;
         }
@@ -475,11 +475,11 @@ export class Sound {
         }
     }
     _createSpatialParameters() {
-        if (Engine.audioEngine?.canUseWebAudio && Engine.audioEngine.audioContext) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio && AbstractEngine.audioEngine.audioContext) {
             if (this._scene.headphone) {
                 this._panningModel = "HRTF";
             }
-            this._soundPanner = this._soundPanner ?? Engine.audioEngine.audioContext.createPanner();
+            this._soundPanner = this._soundPanner ?? AbstractEngine.audioEngine.audioContext.createPanner();
             if (this._soundPanner && this._outputAudioNode) {
                 this._updateSpatialParameters();
                 this._soundPanner.connect(this._outputAudioNode);
@@ -540,7 +540,7 @@ export class Sound {
         this._switchPanningModel();
     }
     _switchPanningModel() {
-        if (Engine.audioEngine?.canUseWebAudio && this._spatialSound && this._soundPanner) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio && this._spatialSound && this._soundPanner) {
             this._soundPanner.panningModel = this._panningModel;
         }
     }
@@ -549,7 +549,7 @@ export class Sound {
      * @param soundTrackAudioNode the sound track audio node to connect to
      */
     connectToSoundTrackAudioNode(soundTrackAudioNode) {
-        if (Engine.audioEngine?.canUseWebAudio && this._outputAudioNode) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio && this._outputAudioNode) {
             if (this._isOutputConnected) {
                 this._outputAudioNode.disconnect();
             }
@@ -593,7 +593,7 @@ export class Sound {
                 return;
             }
             this._coneInnerAngle = value;
-            if (Engine.audioEngine?.canUseWebAudio && this._spatialSound && this._soundPanner) {
+            if (AbstractEngine.audioEngine?.canUseWebAudio && this._spatialSound && this._soundPanner) {
                 this._soundPanner.coneInnerAngle = this._coneInnerAngle;
             }
         }
@@ -614,7 +614,7 @@ export class Sound {
                 return;
             }
             this._coneOuterAngle = value;
-            if (Engine.audioEngine?.canUseWebAudio && this._spatialSound && this._soundPanner) {
+            if (AbstractEngine.audioEngine?.canUseWebAudio && this._spatialSound && this._soundPanner) {
                 this._soundPanner.coneOuterAngle = this._coneOuterAngle;
             }
         }
@@ -628,7 +628,12 @@ export class Sound {
             return;
         }
         this._position.copyFrom(newPosition);
-        if (Engine.audioEngine?.canUseWebAudio && this._spatialSound && this._soundPanner && !isNaN(this._position.x) && !isNaN(this._position.y) && !isNaN(this._position.z)) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio &&
+            this._spatialSound &&
+            this._soundPanner &&
+            !isNaN(this._position.x) &&
+            !isNaN(this._position.y) &&
+            !isNaN(this._position.z)) {
             this._soundPanner.positionX.value = this._position.x;
             this._soundPanner.positionY.value = this._position.y;
             this._soundPanner.positionZ.value = this._position.z;
@@ -640,7 +645,7 @@ export class Sound {
      */
     setLocalDirectionToMesh(newLocalDirection) {
         this._localDirection = newLocalDirection;
-        if (Engine.audioEngine?.canUseWebAudio && this._connectedTransformNode && this.isPlaying) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio && this._connectedTransformNode && this.isPlaying) {
             this._updateDirection();
         }
     }
@@ -657,7 +662,7 @@ export class Sound {
     }
     /** @internal */
     updateDistanceFromListener() {
-        if (Engine.audioEngine?.canUseWebAudio && this._connectedTransformNode && this.useCustomAttenuation && this._soundGain && this._scene.activeCamera) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio && this._connectedTransformNode && this.useCustomAttenuation && this._soundGain && this._scene.activeCamera) {
             const distance = this._scene.audioListenerPositionProvider
                 ? this._connectedTransformNode.position.subtract(this._scene.audioListenerPositionProvider()).length()
                 : this._connectedTransformNode.getDistanceToCamera(this._scene.activeCamera);
@@ -679,10 +684,10 @@ export class Sound {
      * @param length (optional) Sound duration (in seconds)
      */
     play(time, offset, length) {
-        if (this._isReadyToPlay && this._scene.audioEnabled && Engine.audioEngine?.audioContext) {
+        if (this._isReadyToPlay && this._scene.audioEnabled && AbstractEngine.audioEngine?.audioContext) {
             try {
                 this._clearTimeoutsAndObservers();
-                let startTime = time ? Engine.audioEngine?.audioContext.currentTime + time : Engine.audioEngine?.audioContext.currentTime;
+                let startTime = time ? AbstractEngine.audioEngine?.audioContext.currentTime + time : AbstractEngine.audioEngine?.audioContext.currentTime;
                 if (!this._soundSource || !this._streamingSource) {
                     if (this._spatialSound && this._soundPanner) {
                         if (!isNaN(this._position.x) && !isNaN(this._position.y) && !isNaN(this._position.z)) {
@@ -705,7 +710,7 @@ export class Sound {
                 }
                 if (this._streaming) {
                     if (!this._streamingSource) {
-                        this._streamingSource = Engine.audioEngine.audioContext.createMediaElementSource(this._htmlAudioElement);
+                        this._streamingSource = AbstractEngine.audioEngine.audioContext.createMediaElementSource(this._htmlAudioElement);
                         this._htmlAudioElement.onended = () => {
                             this._onended();
                         };
@@ -721,7 +726,7 @@ export class Sound {
                         // the audio engine to be unlocked by a user gesture before trying to play
                         // an HTML Audio element
                         const tryToPlay = () => {
-                            if (Engine.audioEngine?.unlocked) {
+                            if (AbstractEngine.audioEngine?.unlocked) {
                                 const playPromise = this._htmlAudioElement.play();
                                 // In browsers that don’t yet support this functionality,
                                 // playPromise won’t be defined.
@@ -729,9 +734,9 @@ export class Sound {
                                     playPromise.catch(() => {
                                         // Automatic playback failed.
                                         // Waiting for the audio engine to be unlocked by user click on unmute
-                                        Engine.audioEngine?.lock();
+                                        AbstractEngine.audioEngine?.lock();
                                         if (this.loop || this.autoplay) {
-                                            this._audioUnlockedObserver = Engine.audioEngine?.onAudioUnlockedObservable.addOnce(() => {
+                                            this._audioUnlockedObserver = AbstractEngine.audioEngine?.onAudioUnlockedObservable.addOnce(() => {
                                                 tryToPlay();
                                             });
                                         }
@@ -740,7 +745,7 @@ export class Sound {
                             }
                             else {
                                 if (this.loop || this.autoplay) {
-                                    this._audioUnlockedObserver = Engine.audioEngine?.onAudioUnlockedObservable.addOnce(() => {
+                                    this._audioUnlockedObserver = AbstractEngine.audioEngine?.onAudioUnlockedObservable.addOnce(() => {
                                         tryToPlay();
                                     });
                                 }
@@ -751,7 +756,7 @@ export class Sound {
                 }
                 else {
                     const tryToPlay = () => {
-                        if (Engine.audioEngine?.audioContext) {
+                        if (AbstractEngine.audioEngine?.audioContext) {
                             length = length || this._length;
                             if (offset !== undefined) {
                                 this._setOffset(offset);
@@ -762,7 +767,7 @@ export class Sound {
                                     oldSource.disconnect();
                                 };
                             }
-                            this._soundSource = Engine.audioEngine?.audioContext.createBufferSource();
+                            this._soundSource = AbstractEngine.audioEngine?.audioContext.createBufferSource();
                             if (this._soundSource && this._inputAudioNode) {
                                 this._soundSource.buffer = this._audioBuffer;
                                 this._soundSource.connect(this._inputAudioNode);
@@ -777,21 +782,21 @@ export class Sound {
                                 this._soundSource.onended = () => {
                                     this._onended();
                                 };
-                                startTime = time ? Engine.audioEngine?.audioContext.currentTime + time : Engine.audioEngine.audioContext.currentTime;
+                                startTime = time ? AbstractEngine.audioEngine?.audioContext.currentTime + time : AbstractEngine.audioEngine.audioContext.currentTime;
                                 const actualOffset = ((this.isPaused ? this.currentTime : 0) + (this._offset ?? 0)) % this._soundSource.buffer.duration;
                                 this._soundSource.start(startTime, actualOffset, this.loop ? undefined : length);
                             }
                         }
                     };
-                    if (Engine.audioEngine?.audioContext.state === "suspended") {
+                    if (AbstractEngine.audioEngine?.audioContext.state === "suspended") {
                         // Wait a bit for FF as context seems late to be ready.
                         this._tryToPlayTimeout = setTimeout(() => {
-                            if (Engine.audioEngine?.audioContext.state === "suspended") {
+                            if (AbstractEngine.audioEngine?.audioContext.state === "suspended") {
                                 // Automatic playback failed.
                                 // Waiting for the audio engine to be unlocked by user click on unmute
-                                Engine.audioEngine.lock();
+                                AbstractEngine.audioEngine.lock();
                                 if (this.loop || this.autoplay) {
-                                    this._audioUnlockedObserver = Engine.audioEngine.onAudioUnlockedObservable.addOnce(() => {
+                                    this._audioUnlockedObserver = AbstractEngine.audioEngine.onAudioUnlockedObservable.addOnce(() => {
                                         tryToPlay();
                                     });
                                 }
@@ -843,8 +848,8 @@ export class Sound {
                 }
                 this.isPlaying = false;
             }
-            else if (Engine.audioEngine?.audioContext && this._soundSource) {
-                const stopTime = time ? Engine.audioEngine.audioContext.currentTime + time : undefined;
+            else if (AbstractEngine.audioEngine?.audioContext && this._soundSource) {
+                const stopTime = time ? AbstractEngine.audioEngine.audioContext.currentTime + time : undefined;
                 this._soundSource.onended = () => {
                     this.isPlaying = false;
                     this.isPaused = false;
@@ -883,12 +888,12 @@ export class Sound {
                 this.isPlaying = false;
                 this.isPaused = true;
             }
-            else if (Engine.audioEngine?.audioContext && this._soundSource) {
+            else if (AbstractEngine.audioEngine?.audioContext && this._soundSource) {
                 this._soundSource.onended = () => void 0;
                 this._soundSource.stop();
                 this.isPlaying = false;
                 this.isPaused = true;
-                this._currentTime += Engine.audioEngine.audioContext.currentTime - this._startTime;
+                this._currentTime += AbstractEngine.audioEngine.audioContext.currentTime - this._startTime;
             }
         }
     }
@@ -898,11 +903,11 @@ export class Sound {
      * @param time Define time for gradual change to new volume
      */
     setVolume(newVolume, time) {
-        if (Engine.audioEngine?.canUseWebAudio && this._soundGain) {
-            if (time && Engine.audioEngine.audioContext) {
-                this._soundGain.gain.cancelScheduledValues(Engine.audioEngine.audioContext.currentTime);
-                this._soundGain.gain.setValueAtTime(this._soundGain.gain.value, Engine.audioEngine.audioContext.currentTime);
-                this._soundGain.gain.linearRampToValueAtTime(newVolume, Engine.audioEngine.audioContext.currentTime + time);
+        if (AbstractEngine.audioEngine?.canUseWebAudio && this._soundGain) {
+            if (time && AbstractEngine.audioEngine.audioContext) {
+                this._soundGain.gain.cancelScheduledValues(AbstractEngine.audioEngine.audioContext.currentTime);
+                this._soundGain.gain.setValueAtTime(this._soundGain.gain.value, AbstractEngine.audioEngine.audioContext.currentTime);
+                this._soundGain.gain.linearRampToValueAtTime(newVolume, AbstractEngine.audioEngine.audioContext.currentTime + time);
             }
             else {
                 this._soundGain.gain.value = newVolume;
@@ -982,7 +987,7 @@ export class Sound {
             const boundingInfo = mesh.getBoundingInfo();
             this.setPosition(boundingInfo.boundingSphere.centerWorld);
         }
-        if (Engine.audioEngine?.canUseWebAudio && this._isDirectional && this.isPlaying) {
+        if (AbstractEngine.audioEngine?.canUseWebAudio && this._isDirectional && this.isPlaying) {
             this._updateDirection();
         }
     }
@@ -1175,7 +1180,7 @@ export class Sound {
             this._tryToPlayTimeout = null;
         }
         if (this._audioUnlockedObserver) {
-            Engine.audioEngine?.onAudioUnlockedObservable.remove(this._audioUnlockedObserver);
+            AbstractEngine.audioEngine?.onAudioUnlockedObservable.remove(this._audioUnlockedObserver);
             this._audioUnlockedObserver = null;
         }
     }