@woosh/meep-engine 2.155.0 → 2.157.0

package/src/engine/sound/ecs/emitter/SoundEmitter.d.ts

@@ -1,4 +1,7 @@
 /**
+ * @deprecated Legacy sound component — superseded by the native {@link AudioEmitter}, which owns a
+ * sopra `EventDescription` directly. Retained as a deprecate-and-plumb compat reader (it still routes
+ * through sopra via {@link SoundEmitterSystem}); prefer `AudioEmitter` for new content.
  * @class
  */
 export class SoundEmitter {
@@ -30,12 +33,6 @@ export class SoundEmitter {
      * @private
      */
     private __distanceMax;
-    /**
-     * @deprecated
-     * @type {number}
-     * @private
-     */
-    private __distanceRolloff;
     /**
      * TODO add to binary serialization
      * @type {SoundPanningModelType}
@@ -51,38 +48,22 @@ export class SoundEmitter {
      * @type {number|SoundEmitterFlags}
      */
     flags: number | SoundEmitterFlags;
-    /**
-     * @readonly
-     */
-    readonly nodes: {
-        /**
-         * @type {GainNode}
-         */
-        volume: GainNode;
-        /**
-         * @type {PannerNode}
-         */
-        panner: PannerNode;
-        /**
-         * @type {GainNode}
-         */
-        attenuation: GainNode;
-        /**
-         * One of the other nodes, depending on the configuration
-         * @type {AudioNode}
-         */
-        endpoint: AudioNode;
-    };
     /**
      *
      * @type {Vector1}
      */
     volume: Vector1;
     /**
-     * @readonly
-     * @type {BvhClient}
+     * Back-reference to the per-entity sopra translation record (set on link by
+     * {@link SoundEmitterComponentContext}). Used by the deprecated fade/stop helpers to reach the
+     * live sopra instances.
+     * @type {SoundEmitterComponentContext|null}
+     */
+    __soundRuntime: SoundEmitterComponentContext | null;
+    /**
+     * @deprecated sopra owns the audio graph — the emitter no longer holds WebAudio nodes.
      */
-    readonly bvh: BvhClient;
+    get nodes(): void;
     /**
      *
      * @param {SoundEmitter} other
@@ -123,10 +104,6 @@ export class SoundEmitter {
      * @return {boolean}
      */
     get isPositioned(): boolean;
-    /**
-     * @return {AudioNode}
-     */
-    getTargetNode(): AudioNode;
     /**
      * @returns {boolean}
      * @param {SoundEmitter} other
@@ -137,16 +114,6 @@ export class SoundEmitter {
      * @return {number}
      */
     hash(): number;
-    /**
-     *
-     * @param {AudioContext} ctx
-     */
-    buildNodes(ctx: AudioContext): void;
-    /**
-     * @private
-     * @param {number} distance
-     */
-    private writeAttenuationVolume;
     /**
      * @param {number} v
      */
@@ -166,28 +133,13 @@ export class SoundEmitter {
      */
     get distanceMax(): number;
     /**
-     * @deprecated
-     * @param {number} v
-     */
-    set distanceRolloff(arg: number);
-    /**
-     * @deprecated
-     * @returns {number}
-     */
-    get distanceRolloff(): number;
-    /**
-     *
-     * @param {number} x
-     * @param {number} y
-     * @param {number} z
+     * @deprecated plumbs into sopra — fades every playing track out and stops it.
+     * @param {number} [duration] fade duration in seconds
      */
-    updatePosition(x: number, y: number, z: number): void;
+    fadeOutAllTracks(duration?: number): void;
     /**
-     *
-     * @param {number} [duration] fade duration in seconds
-     * @param startAfter
+     * @deprecated plumbs into sopra — stops every playing track on this emitter.
      */
-    fadeOutAllTracks(duration?: number, startAfter?: number): void;
     stopAllTracks(): void;
     toJSON(): {
         isPositioned: boolean;
@@ -211,5 +163,4 @@ import { SoundPanningModelType } from "./SoundPanningModelType.js";
 import { SoundAttenuationFunction } from "./SoundAttenuationFunction.js";
 import { SoundEmitterFlags } from "./SoundEmitterFlags.js";
 import Vector1 from "../../../../core/geom/Vector1.js";
-import { BvhClient } from "../../../../core/bvh2/bvh3/BvhClient.js";
 //# sourceMappingURL=SoundEmitter.d.ts.map

package/src/engine/sound/ecs/emitter/SoundEmitter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SoundEmitter.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitter.js"],"names":[],"mappings":"AA2BA;;GAEG;AACH;IA4hBI;;;;OAIG;IACH,4BAFa,YAAY,CAQxB;IApiBD;;;OAGG;IACH,iBAFU,KAAK,UAAU,CAAC,CAEN;IAEpB;;;OAGG;IACH,SAFU,gCAA4B,IAAI,CAEhB;IAE1B;;;;OAIG;IACH,sBAAkB;IAElB;;;;OAIG;IACH,sBAAsB;IAEtB;;;;OAIG;IACH,0BAAsB;IAEtB;;;OAGG;IACH,cAFU,qBAAqB,CAEW;IAE1C;;;OAGG;IACH,aAFU,wBAAwB,GAAC,MAAM,CAEI;IAE7C;;;OAGG;IACH,OAFU,MAAM,GAAC,iBAAiB,CAExB;IAEV;;OAEG;IACH;QACI;;WAEG;gBADO,QAAQ;QAGlB;;WAEG;gBADO,UAAU;QAGpB;;WAEG;qBADO,QAAQ;QAGlB;;;WAGG;kBADO,SAAS;MAGrB;IAEF;;;OAGG;IACH,QAFU,OAAO,CAEO;IAExB;;;OAGG;IACH,cAFU,SAAS,CAEG;IAkBtB;;;;OAIG;IACH,eAHW,YAAY,OAqDtB;IAGD;;;;OAIG;IACH,cAHW,MAAM,GAAC,iBAAiB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,iBAAiB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,iBAAiB,SACxB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,iBAAiB,GACtB,OAAO,CAInB;IAGD;;;OAGG;IACH,+BAEC;IAED;;;OAGG;IACH,4BAEC;IAED;;OAEG;IACH,iBAFY,SAAS,CAIpB;IAED;;;OAGG;IACH,cAFW,YAAY,GADV,OAAO,CAWnB;IAED;;;OAGG;IACH,QAFY,MAAM,CAWjB;IAED;;;OAGG;IACH,gBAFW,YAAY,QAqDtB;IAED;;;OAGG;IACH,+BA6BC;IAUD;;OAEG;IACH,6BAEC;IAbD;;;OAGG;IACH,0BAEC;IAiBD;;OAEG;IACH,6BAEC;IAbD;;;OAGG;IACH,0BAEC;IAkBD;;;OAGG;IACH,iCAQC;IApBD;;;OAGG;IACH,8BAEC;IAgBD;;;;;OAKG;IACH,kBAJW,MAAM,KACN,MAAM,KACN,MAAM,QAyBhB;IAED;;;;OAIG;IACH,4BAHW,MAAM,6BAahB;IAED,sBASC;IAED;;;;;;;;;;MAYC;IAED,0BA+DC;CAeJ;;;;iBApkBgB,0CAA0C;2BAkBhC,iBAAiB;sCADN,4BAA4B;yCAFzB,+BAA+B;kCACtC,wBAAwB;oBAdtC,kCAAkC;0BAJ5B,yCAAyC"}
+{"version":3,"file":"SoundEmitter.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitter.js"],"names":[],"mappings":"AAkBA;;;;;GAKG;AACH;IAqVI;;;;OAIG;IACH,4BAFa,YAAY,CAQxB;IA7VD;;;OAGG;IACH,iBAFU,KAAK,UAAU,CAAC,CAEN;IAEpB;;;OAGG;IACH,SAFU,gCAA4B,IAAI,CAEhB;IAE1B;;;;OAIG;IACH,sBAAkB;IAElB;;;;OAIG;IACH,sBAAsB;IAEtB;;;OAGG;IACH,cAFU,qBAAqB,CAEW;IAE1C;;;OAGG;IACH,aAFU,wBAAwB,GAAC,MAAM,CAEI;IAE7C;;;OAGG;IACH,OAFU,MAAM,GAAC,iBAAiB,CAExB;IAEV;;;OAGG;IACH,QAFU,OAAO,CAEO;IAExB;;;;;OAKG;IACH,gBAFU,+BAA6B,IAAI,CAErB;IAEtB;;OAEG;IACH,kBAEC;IAED;;;;OAIG;IACH,eAHW,YAAY,OAqDtB;IAGD;;;;OAIG;IACH,cAHW,MAAM,GAAC,iBAAiB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,iBAAiB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,iBAAiB,SACxB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,iBAAiB,GACtB,OAAO,CAInB;IAGD;;;OAGG;IACH,+BAEC;IAED;;;OAGG;IACH,4BAEC;IAED;;;OAGG;IACH,cAFW,YAAY,GADV,OAAO,CAWnB;IAED;;;OAGG;IACH,QAFY,MAAM,CAWjB;IAUD;;OAEG;IACH,6BAEC;IAbD;;;OAGG;IACH,0BAEC;IAiBD;;OAEG;IACH,6BAEC;IAbD;;;OAGG;IACH,0BAEC;IASD;;;OAGG;IACH,4BAFW,MAAM,QAMhB;IAED;;OAEG;IACH,sBAIC;IAED;;;;;;;;;;MAYC;IAED,0BA+DC;CAeJ;;;;iBAxXgB,0CAA0C;2BAUhC,iBAAiB;sCADN,4BAA4B;yCAFzB,+BAA+B;kCACtC,wBAAwB;oBAPtC,kCAAkC"}

package/src/engine/sound/ecs/emitter/SoundEmitter.js

@@ -1,15 +1,6 @@
-import { BvhClient } from "../../../../core/bvh2/bvh3/BvhClient.js";
 import { combine_hash } from "../../../../core/collection/array/combine_hash.js";
 import List from '../../../../core/collection/list/List.js';
-import { aabb3_array_compute_from_sphere } from "../../../../core/geom/3d/aabb/aabb3_array_compute_from_sphere.js";
 import Vector1 from "../../../../core/geom/Vector1.js";
-import {
-    interpolate_irradiance_linear
-} from "../../../../core/math/physics/irradiance/interpolate_irradiance_linear.js";
-import {
-    interpolate_irradiance_lograrithmic
-} from "../../../../core/math/physics/irradiance/interpolate_irradiance_lograrithmic.js";
-import { interpolate_irradiance_smith } from "../../../../core/math/physics/irradiance/interpolate_irradiance_smith.js";
 import { objectKeyByValue } from "../../../../core/model/object/objectKeyByValue.js";
 import { computeHashFloat } from "../../../../core/primitives/numbers/computeHashFloat.js";
 import { number_compare_ascending } from "../../../../core/primitives/numbers/number_compare_ascending.js";
@@ -26,6 +17,9 @@ const DEFAULT_DISTANCE_MAX = 10000;
 const DEFAULT_CHANNEL = null;
 
 /**
+ * @deprecated Legacy sound component — superseded by the native {@link AudioEmitter}, which owns a
+ * sopra `EventDescription` directly. Retained as a deprecate-and-plumb compat reader (it still routes
+ * through sopra via {@link SoundEmitterSystem}); prefer `AudioEmitter` for new content.
  * @class
  */
 export class SoundEmitter {
@@ -57,13 +51,6 @@ export class SoundEmitter {
      */
     __distanceMax = 10000;
 
-    /**
-     * @deprecated
-     * @type {number}
-     * @private
-     */
-    __distanceRolloff = 1;
-
     /**
      * TODO add to binary serialization
      * @type {SoundPanningModelType}
@@ -82,29 +69,6 @@ export class SoundEmitter {
      */
     flags = 0;
 
-    /**
-     * @readonly
-     */
-    nodes = {
-        /**
-         * @type {GainNode}
-         */
-        volume: null,
-        /**
-         * @type {PannerNode}
-         */
-        panner: null,
-        /**
-         * @type {GainNode}
-         */
-        attenuation: null,
-        /**
-         * One of the other nodes, depending on the configuration
-         * @type {AudioNode}
-         */
-        endpoint: null
-    };
-
     /**
      *
      * @type {Vector1}
@@ -112,25 +76,18 @@ export class SoundEmitter {
     volume = new Vector1(1);
 
     /**
-     * @readonly
-     * @type {BvhClient}
+     * Back-reference to the per-entity sopra translation record (set on link by
+     * {@link SoundEmitterComponentContext}). Used by the deprecated fade/stop helpers to reach the
+     * live sopra instances.
+     * @type {SoundEmitterComponentContext|null}
      */
-    bvh = new BvhClient();
+    __soundRuntime = null;
 
     /**
-     *
-     * @constructor
+     * @deprecated sopra owns the audio graph — the emitter no longer holds WebAudio nodes.
      */
-    constructor() {
-
-        this.volume.onChanged.add((value) => {
-            const volume_node = this.nodes.volume;
-
-            if (volume_node !== null) {
-                volume_node.gain.setValueAtTime(value, 0);
-            }
-        });
-
+    get nodes() {
+        throw new Error("SoundEmitter.nodes is deprecated — sopra owns the audio graph");
     }
 
     /**
@@ -248,13 +205,6 @@ export class SoundEmitter {
         return this.getFlag(SoundEmitterFlags.Spatialization);
     }
 
-    /**
-     * @return {AudioNode}
-     */
-    getTargetNode() {
-        return this.nodes.endpoint;
-    }
-
     /**
      * @returns {boolean}
      * @param {SoundEmitter} other
@@ -284,98 +234,6 @@ export class SoundEmitter {
         );
     }
 
-    /**
-     *
-     * @param {AudioContext} ctx
-     */
-    buildNodes(ctx) {
-        const nodes = this.nodes;
-
-        nodes.volume = ctx.createGain();
-
-        if (this.getFlag(SoundEmitterFlags.Attenuation)) {
-            nodes.attenuation = ctx.createGain();
-        }
-
-        if (this.getFlag(SoundEmitterFlags.Spatialization)) {
-            nodes.panner = ctx.createPanner();
-
-
-            //
-            if (this.panningModel === SoundPanningModelType.HRTF) {
-                nodes.panner.panningModel = 'HRTF';
-            } else if (this.panningModel === SoundPanningModelType.EqualPower) {
-                nodes.panner.panningModel = 'equalpower';
-            } else {
-                console.error('Invalid value of panning model type:', this.panningModel);
-
-                nodes.panner.panningModel = 'equalpower';
-            }
-
-            // we set up distance model in the most efficient way, since we are ignoring it anyway and use custom distance model via a GainNode instead
-            nodes.panner.distanceModel = 'linear';
-            nodes.panner.rolloffFactor = 0;
-            nodes.panner.refDistance = this.distanceMin;
-            nodes.panner.maxDistance = this.distanceMax;
-
-        }
-
-        //do wiring
-        if (this.getFlag(SoundEmitterFlags.Attenuation | SoundEmitterFlags.Spatialization)) {
-            nodes.attenuation.connect(nodes.panner);
-            nodes.volume.connect(nodes.attenuation);
-
-            nodes.endpoint = nodes.panner;
-        } else if (this.getFlag(SoundEmitterFlags.Spatialization)) {
-            nodes.volume.connect(nodes.panner);
-
-            nodes.endpoint = nodes.panner;
-        } else if (this.getFlag(SoundEmitterFlags.Attenuation)) {
-            nodes.volume.connect(nodes.attenuation);
-
-            nodes.endpoint = nodes.attenuation;
-        } else {
-            nodes.endpoint = nodes.volume;
-        }
-
-        nodes.volume.gain.setValueAtTime(this.volume.getValue(), 0);
-    }
-
-    /**
-     * @private
-     * @param {number} distance
-     */
-    writeAttenuationVolume(distance) {
-
-        let volume;
-
-        const attenuation = this.attenuation;
-
-        const distance_min = this.__distanceMin;
-        const distance_max = this.__distanceMax;
-
-        if (attenuation === SoundAttenuationFunction.Linear) {
-            volume = interpolate_irradiance_linear(distance, distance_min, distance_max);
-        } else if (attenuation === SoundAttenuationFunction.Logarithmic) {
-            volume = interpolate_irradiance_lograrithmic(distance, distance_min, distance_max);
-        } else if (attenuation === SoundAttenuationFunction.Smith) {
-            volume = interpolate_irradiance_smith(distance, distance_min, distance_max);
-        } else {
-            //unsupported function, don't attenuate
-            volume = 1;
-        }
-
-        /**
-         *
-         * @type {GainNode}
-         */
-        const pv = this.nodes.attenuation;
-
-        if (pv !== null) {
-            pv.gain.setValueAtTime(volume, 0);
-        }
-    }
-
     /**
      *
      * @returns {number}
@@ -406,85 +264,22 @@ export class SoundEmitter {
         this.__distanceMax = v;
     }
 
-
     /**
-     * @deprecated
-     * @returns {number}
-     */
-    get distanceRolloff() {
-        return this.__distanceRolloff;
-    }
-
-    /**
-     * @deprecated
-     * @param {number} v
-     */
-    set distanceRolloff(v) {
-        this.__distanceRolloff = v;
-
-        const panner = this.nodes.panner;
-
-        if (panner !== null) {
-            panner.rolloffFactor = v;
-        }
-    }
-
-    /**
-     *
-     * @param {number} x
-     * @param {number} y
-     * @param {number} z
+     * @deprecated plumbs into sopra — fades every playing track out and stops it.
+     * @param {number} [duration] fade duration in seconds
      */
-    updatePosition(x, y, z) {
-        if (this.getFlag(SoundEmitterFlags.Spatialization)) {
-            //update position of the panner node
-            const nodes = this.nodes;
-
-            /**
-             *
-             * @type {PannerNode}
-             */
-            const panner = nodes.panner;
-
-            if (panner !== null) {
-                panner.setPosition(x, y, z);
-            }
+    fadeOutAllTracks(duration = 1) {
+        if (this.__soundRuntime !== null) {
+            this.__soundRuntime.fadeOutAll(duration);
         }
-
-        const distanceMax = this.distanceMax;
-
-        const bounds = this.bvh.bounds;
-
-        aabb3_array_compute_from_sphere(bounds, 0, x, y, z, distanceMax);
-
-        this.bvh.write_bounds();
     }
 
     /**
-     *
-     * @param {number} [duration] fade duration in seconds
-     * @param startAfter
+     * @deprecated plumbs into sopra — stops every playing track on this emitter.
      */
-    fadeOutAllTracks(duration = 1, startAfter = 0) {
-
-        const tracks = this.tracks;
-        const n = tracks.length;
-
-        for (let i = 0; i < n; i++) {
-            const soundTrack = tracks.get(i);
-
-            soundTrack.setVolumeOverTime(0, duration, startAfter);
-        }
-    }
-
     stopAllTracks() {
-        const tracks = this.tracks;
-        const n = tracks.length;
-
-        for (let i = 0; i < n; i++) {
-            const soundTrack = tracks.get(i);
-
-            soundTrack.playing = false;
+        if (this.__soundRuntime !== null) {
+            this.__soundRuntime.stopAll();
         }
     }
 

package/src/engine/sound/ecs/emitter/SoundEmitterComponentContext.d.ts

@@ -1,58 +1,55 @@
+/**
+ * Per-entity translation record: turns a legacy {@link SoundEmitter}'s mutable track list into sopra
+ * {@link EventInstance}s and keeps them in sync. This is NOT a WebAudio renderer anymore — sopra owns
+ * the audio graph. One persistent/looping track ⇒ one persistent instance; a non-looping track ⇒ a
+ * one-shot instance that self-ends (firing the track's `on.ended`).
+ */
 export class SoundEmitterComponentContext {
     /**
-     *
      * @type {SoundEmitter}
      */
     emitter: SoundEmitter;
     /**
-     *
      * @type {Transform}
      */
     transform: Transform;
     /**
-     *
      * @type {SoundEmitterSystem}
      */
     system: SoundEmitterSystem;
     /**
-     *
-     * @type {AudioNode}
+     * @type {SopraEngine}
      */
-    targetNode: AudioNode;
-    /**
-     *
-     * @type {boolean}
-     * @private
-     */
-    private __isConnected;
+    sopra: SopraEngine;
+    link(): void;
+    unlink(): void;
     /**
-     *
-     * @param {SoundEmitterComponentContext} other
+     * @param {SoundTrack} track
      */
-    compare(other: SoundEmitterComponentContext): any;
-    update(): void;
+    addTrack(track: SoundTrack): void;
     /**
-     *
-     * @param {SoundTrack} soundTrack
+     * @param {SoundTrack} track
      */
-    addTrack(soundTrack: SoundTrack): void;
+    removeTrack(track: SoundTrack): void;
     /**
-     *
+     * Re-apply a single track's live volume to its instance gain. Called by SoundTrack's volume setter
+     * (via the track's __soundRuntime back-ref) so a mid-playback `track.volume = x` is heard live.
      * @param {SoundTrack} track
      */
-    removeTrack(track: SoundTrack): void;
+    refreshTrackVolume(track: SoundTrack): void;
     /**
-     * @param {SoundTrack} t
+     * Fade every owned instance out and stop it (backs SoundEmitter.fadeOutAllTracks).
+     * @param {number} duration
      */
-    suspendTrack(t: SoundTrack): void;
+    fadeOutAll(duration: number): void;
     /**
+     * Stop every owned instance immediately (backs SoundEmitter.stopAllTracks + unlink).
      *
-     * @param {SoundTrack} t
+     * Detach the track↔instance bindings BEFORE stopping: stop() fires onEnded synchronously, and
+     * #onInstanceEnded must bail out (it keys off #instances) so teardown doesn't fire track.on.ended
+     * or mutate the emitter's authored track list.
      */
-    resumeTrack(t: SoundTrack): void;
-    connect(): void;
-    disconnect(): void;
-    link(): void;
-    unlink(): void;
+    stopAll(): void;
+    #private;
 }
 //# sourceMappingURL=SoundEmitterComponentContext.d.ts.map

package/src/engine/sound/ecs/emitter/SoundEmitterComponentContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SoundEmitterComponentContext.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitterComponentContext.js"],"names":[],"mappings":"AAGA;IAGQ;;;OAGG;IACH,sBAAmB;IAEnB;;;OAGG;IACH,qBAAqB;IAErB;;;OAGG;IACH,2BAAkB;IAElB;;;OAGG;IACH,YAFU,SAAS,CAEG;IAEtB;;;;OAIG;IACH,sBAA0B;IAG9B;;;OAGG;IACH,eAFW,4BAA4B,OAItC;IAED,eAeC;IAED;;;OAGG;IACH,uCAmCC;IAED;;;OAGG;IACH,qCAYC;IAED;;OAEG;IACH,kCAIC;IAED;;;OAGG;IACH,iCAKC;IAED,gBAcC;IAED,mBAoBC;IAED,aAOC;IAED,eASC;CAGJ"}
+{"version":3,"file":"SoundEmitterComponentContext.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitterComponentContext.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH;IAEI;;OAEG;IACH,sBAAe;IAEf;;OAEG;IACH,qBAAiB;IAEjB;;OAEG;IACH,2BAAc;IAEd;;OAEG;IACH,mBAAa;IAYb,aAkBC;IAED,eAUC;IAED;;OAEG;IACH,kCAgCC;IAED;;OAEG;IACH,qCAWC;IAoDD;;;;OAIG;IACH,4CAQC;IAWD;;;OAGG;IACH,qBAFW,MAAM,QAMhB;IAED;;;;;;OAMG;IACH,gBAcC;;CACJ"}