@woosh/meep-engine 2.154.0 → 2.156.0

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

@@ -1,390 +1,154 @@
-import { BVH } from "../../../../core/bvh2/bvh3/BVH.js";
-import { bvh_query_user_data_generic } from "../../../../core/bvh2/bvh3/query/bvh_query_user_data_generic.js";
-import { BVHQueryIntersectsSphere } from "../../../../core/bvh2/bvh3/query/BVHQueryIntersectsSphere.js";
-import Vector3 from "../../../../core/geom/Vector3.js";
-import { invokeObjectCompare } from "../../../../core/model/object/invokeObjectCompare.js";
-import { GameAssetType } from "../../../asset/GameAssetType.js";
-import { SoundAssetLoader } from "../../../asset/loaders/SoundAssetLoader.js";
-import { System } from '../../../ecs/System.js';
-import { Transform } from '../../../ecs/transform/Transform.js';
-import { IncrementalDeltaSet } from "../../../graphics/render/visibility/IncrementalDeltaSet.js";
-import SoundListener from "../SoundListener.js";
-import { SoundEmitter } from './SoundEmitter.js';
-import { SoundEmitterChannel } from "./SoundEmitterChannel.js";
-import { SoundEmitterComponentContext } from "./SoundEmitterComponentContext.js";
-import { SoundEmitterFlags } from "./SoundEmitterFlags.js";
-import { SoundTrackFlags } from "./SoundTrackFlags.js";
-
-/**
- * @readonly
- * @enum {string}
- */
-export const SoundEmitterChannels = {
-    Effects: 'effects',
-    Music: 'music',
-    Ambient: 'ambient'
-};
-
-/**
- *
- * @type {number[]}
- */
-const scratch_array = [];
-
-export class SoundEmitterSystem extends System {
-    /**
-     *
-     * @param {AssetManager} assetManager
-     * @param {AudioNode} destinationNode
-     * @param {AudioContext} context
-     * @constructor
-     * @property {AssetManager} assetManager
-     */
-    constructor(assetManager, destinationNode, context) {
-        super();
-
-        this.dependencies = [SoundEmitter, Transform];
-
-        //
-        this.destinationNode = destinationNode;
-        /**
-         *
-         * @type {AudioContext}
-         */
-        this.webAudioContext = context;
-        this.assetManager = assetManager;
-
-        /**
-         *
-         * @type {Object<SoundEmitterChannel>}
-         */
-        this.channels = {};
-
-        this.addChannel(SoundEmitterChannels.Effects)
-            .addChannel(SoundEmitterChannels.Music)
-            .addChannel(SoundEmitterChannels.Ambient);
-
-        this.channels[SoundEmitterChannels.Effects].volume = 1.2;
-        this.channels[SoundEmitterChannels.Music].volume = 0.1;
-
-        assetManager.registerLoader(GameAssetType.Sound, new SoundAssetLoader(context));
-
-        /**
-         *
-         * @type {SoundEmitterComponentContext[]}
-         */
-        this.data = [];
-
-        /**
-         *
-         * @type {IncrementalDeltaSet<SoundEmitterComponentContext>}
-         */
-        this.activeSet = new IncrementalDeltaSet(invokeObjectCompare);
-
-        /**
-         * Spatial index
-         * @type {BVH}
-         * @private
-         */
-        this.__bvh = new BVH();
-
-        /**
-         * Number of currently linked entities
-         * @type {number}
-         * @private
-         */
-        this.__linkedCount = 0;
-    }
-
-    async startup(entityManager) {
-        this.activeSet.onAdded.add(this.handleContextActivation, this);
-        this.activeSet.onRemoved.add(this.handleContextDeactivation, this);
-    }
-
-    async shutdown(entityManager) {
-        this.activeSet.onAdded.remove(this.handleContextActivation, this);
-        this.activeSet.onRemoved.remove(this.handleContextDeactivation, this);
-    }
-
-    /**
-     *
-     * @param {SoundEmitterComponentContext} ctx
-     */
-    handleContextActivation(ctx) {
-        ctx.connect();
-    }
-
-    /**
-     *
-     * @param {SoundEmitterComponentContext} ctx
-     */
-    handleContextDeactivation(ctx) {
-        ctx.disconnect();
-    }
-
-    /**
-     *
-     * @param {String} name
-     * @returns {number}
-     */
-    getChannelVolume(name) {
-        return this.channels[name].volume;
-    }
-
-    /**
-     *
-     * @param {String} name
-     * @param {number} value
-     */
-    setChannelVolume(name, value) {
-        this.channels[name].volume = value;
-    }
-
-    addChannel(name) {
-        const channels = this.channels;
-        if (!this.hasChannel(name)) {
-            const channel = new SoundEmitterChannel();
-
-            channel.id = name;
-            channel.sink = this.webAudioContext.createGain();
-
-            channel.sink.connect(this.destinationNode);
-
-            channels[name] = channel;
-        } else {
-            console.error("Channel " + name + " already exists");
-        }
-        return this;
-    }
-
-    /**
-     *
-     * @param {String} name
-     * @returns {boolean}
-     */
-    hasChannel(name) {
-        return this.channels.hasOwnProperty(name);
-    }
-
-    /**
-     *
-     * @param {SoundEmitter} emitter
-     * @param {Transform} transform
-     * @param {number} entity
-     */
-    link(emitter, transform, entity) {
-        const context = this.webAudioContext;
-
-        //what channel do we use?
-        let channelName = emitter.channel;
-
-        if (!this.hasChannel(channelName)) {
-            console.error(`channel named '${channelName}' does not exist, defaulting to '${SoundEmitterChannels.Effects}'`);
-
-            channelName = SoundEmitterChannels.Effects;
-
-        }
-
-        const channel = this.channels[channelName];
-
-        const targetNode = channel.sink;
-
-        const nodes = emitter.nodes;
-
-        if (nodes.volume === null) {
-            emitter.buildNodes(context);
-        }
-
-        emitter.bvh.link(this.__bvh, entity);
-
-        const ctx = new SoundEmitterComponentContext();
-
-        ctx.system = this;
-        ctx.transform = transform;
-        ctx.emitter = emitter;
-
-        ctx.targetNode = targetNode;
-
-        ctx.update();
-
-        ctx.link();
-
-        {
-            // wire context if it's in hearing range
-            const distance = ctx.transform.position.distanceTo(this.#cached_listener_position);
-
-
-            if (distance <= ctx.emitter.distanceMax) {
-
-                // add immediately
-                this.activeSet.forceAdd(ctx);
-
-                if (ctx.emitter.getFlag(SoundEmitterFlags.Attenuation)) {
-                    // is attenuated
-                    ctx.emitter.writeAttenuationVolume(distance);
-                }
-
-                ctx.connect();
-            }
-        }
-
-        this.data[entity] = ctx;
-
-        this.__linkedCount++;
-    }
-
-    /**
-     *
-     * @param {SoundEmitter} emitter
-     * @param {Transform} transform
-     * @param {number} entity
-     */
-    unlink(emitter, transform, entity) {
-        //stop all tracks
-        emitter.stopAllTracks();
-
-        const ctx = this.data[entity];
-
-        if (ctx !== undefined) {
-
-            delete this.data[entity];
-
-            ctx.unlink();
-
-        }
-
-        emitter.bvh.unlink();
-
-        this.__linkedCount--;
-    }
-
-    /**
-     *
-     * @param {SoundEmitterComponentContext} emitter
-     * @returns {boolean}
-     */
-    emitter_in_hearing_range(emitter) {
-
-
-    }
-
-    /**
-     * Used to decide whether emitter is in hearing range when it is being added
-     * @type {Vector3}
-     */
-    #cached_listener_position = new Vector3();
-
-    update(timeDelta) {
-        const entityManager = this.entityManager;
-        const ecd = entityManager.dataset;
-
-        if (ecd === null) {
-            return;
-        }
-
-        const activeSet = this.activeSet;
-        activeSet.initializeUpdate();
-
-        const soundListener = ecd.getAnyComponent(SoundListener);
-
-        if (soundListener.entity !== -1) {
-            const listenerTransform = ecd.getComponent(soundListener.entity, Transform);
-
-            const listenerPosition = listenerTransform.position;
-
-            this.#cached_listener_position.copy(listenerPosition);
-
-            const query = BVHQueryIntersectsSphere.from([listenerPosition.x, listenerPosition.y, listenerPosition.z, 0]);
-
-            const matchCount = bvh_query_user_data_generic(
-                scratch_array, 0,
-                this.__bvh, this.__bvh.root, query
-            );
-
-            for (let i = 0; i < matchCount; i++) {
-                const entity = scratch_array[i];
-
-                /**
-                 * @type {SoundEmitterComponentContext}
-                 */
-                const ctx = this.data[entity];
-
-                const emitter = ctx.emitter;
-
-                if (emitter.tracks.isEmpty()) {
-                    // no tracks to play, don't render
-                    continue;
-                }
-
-                if (emitter.getFlag(SoundEmitterFlags.Attenuation)) {
-                    const distance = listenerPosition.distanceTo(ctx.transform.position);
-
-                    if (distance > emitter.distanceMax) {
-                        //emitter is too far away
-                        continue;
-                    }
-
-                    emitter.writeAttenuationVolume(distance);
-                }
-
-                activeSet.push(ctx);
-
-            }
-
-        }
-
-
-        for (let entity in this.data) {
-            /**
-             *
-             * @type {SoundEmitterComponentContext}
-             */
-            const ctx = this.data[entity];
-
-            /**
-             *
-             * @type {SoundEmitter}
-             */
-            const emitter = ctx.emitter;
-
-            if (emitter === undefined) {
-                console.error('Context.emitter is undefined. Context: ', ctx);
-            }
-
-            /**
-             *
-             * @type {List<SoundTrack>}
-             */
-            const tracks = emitter.tracks;
-
-            let trackCount = tracks.length;
-
-
-            //update play time
-            for (let i = 0; i < trackCount; i++) {
-                const soundTrack = tracks.get(i);
-
-                soundTrack.time += timeDelta;
-
-                if (
-                    soundTrack.setFlag(SoundTrackFlags.Suspended | SoundTrackFlags.Playing)
-                    && !soundTrack.getFlag(SoundTrackFlags.Loop)
-                    && soundTrack.time > soundTrack.duration
-                ) {
-                    // track is suspended, but should have ended, trigger this state manually
-                    emitter.endTrack(soundTrack);
-
-                    // update cursors
-                    trackCount--;
-                    i--;
-                }
-            }
-
-        }
-
-        activeSet.finalizeUpdate();
-    }
-
-
-}
-
+import { GameAssetType } from "../../../asset/GameAssetType.js";
+import { SoundAssetLoader } from "../../../asset/loaders/SoundAssetLoader.js";
+import { System } from '../../../ecs/System.js';
+import { Transform } from '../../../ecs/transform/Transform.js';
+import { AssetManagerBufferProvider } from "../../sopra/asset/AssetManagerBufferProvider.js";
+import SoundListener from "../SoundListener.js";
+import { SoundEmitter } from './SoundEmitter.js';
+import { SoundEmitterComponentContext } from "./SoundEmitterComponentContext.js";
+
+/**
+ * @readonly
+ * @enum {string}
+ */
+export const SoundEmitterChannels = {
+    Effects: 'effects',
+    Music: 'music',
+    Ambient: 'ambient'
+};
+
+/**
+ * @deprecated Legacy emitter system — superseded by {@link AudioEmitterSystem} (which drives the native
+ * {@link AudioEmitter}). Retained to keep existing {@link SoundEmitter} content working during the
+ * strangler migration; not for new content.
+ *
+ * Routes the legacy {@link SoundEmitter} component through the sopra engine — sopra is the single
+ * renderer. The system no longer builds a WebAudio graph: it creates + owns-on-{@link SoundEngine} the
+ * sopra engine, and per linked emitter builds a {@link SoundEmitterComponentContext} translation record
+ * that turns the emitter's tracks into sopra event instances. Each frame it forwards the listener pose
+ * and ticks sopra.
+ *
+ * The channel ids (effects/music/ambient) are sopra bus ids 1:1 at the same legacy mix; the deprecated
+ * get/setChannelVolume proxy onto the sopra buses.
+ */
+export class SoundEmitterSystem extends System {
+    /**
+     * @param {AssetManager} assetManager
+     * @param {SoundEngine} soundEngine owns the AudioContext + master destination + sopra engine
+     * @constructor
+     */
+    constructor(assetManager, soundEngine) {
+        super();
+
+        this.dependencies = [SoundEmitter, Transform];
+
+        /**
+         * @type {SoundEngine}
+         */
+        this.soundEngine = soundEngine;
+
+        /**
+         * @type {AudioContext}
+         */
+        this.webAudioContext = soundEngine.context;
+
+        this.destinationNode = soundEngine.destination;
+
+        this.assetManager = assetManager;
+
+        assetManager.registerLoader(GameAssetType.Sound, new SoundAssetLoader(soundEngine.context));
+
+        /**
+         * The sopra engine — the single renderer. Owned by SoundEngine; created here because we have
+         * the AssetManager. Reuses the single SoundAssetLoader registered above (no double registration).
+         * @type {SopraEngine}
+         */
+        this.sopra = soundEngine.createSopra(new AssetManagerBufferProvider(assetManager));
+
+        /**
+         * @deprecated channel ids are sopra bus ids now; retained as a name set for the editor's
+         * channel dropdown. Volume lives on the sopra buses (see get/setChannelVolume).
+         * @type {Object<string,string>}
+         */
+        this.channels = {
+            [SoundEmitterChannels.Effects]: SoundEmitterChannels.Effects,
+            [SoundEmitterChannels.Music]: SoundEmitterChannels.Music,
+            [SoundEmitterChannels.Ambient]: SoundEmitterChannels.Ambient
+        };
+
+        /**
+         * Per-entity translation records.
+         * @type {SoundEmitterComponentContext[]}
+         */
+        this.data = [];
+    }
+
+    /**
+     * @deprecated channel volume is a sopra bus volume now; proxies to it.
+     * @param {String} name
+     * @returns {number}
+     */
+    getChannelVolume(name) {
+        return this.sopra.getBusVolume(name);
+    }
+
+    /**
+     * @deprecated channel volume is a sopra bus volume now; proxies to it.
+     * @param {String} name
+     * @param {number} value
+     */
+    setChannelVolume(name, value) {
+        this.sopra.setBusVolume(name, value);
+    }
+
+    /**
+     * @param {SoundEmitter} emitter
+     * @param {Transform} transform
+     * @param {number} entity
+     */
+    link(emitter, transform, entity) {
+        const ctx = new SoundEmitterComponentContext();
+
+        ctx.system = this;
+        ctx.sopra = this.sopra;
+        ctx.emitter = emitter;
+        ctx.transform = transform;
+
+        ctx.link();
+
+        this.data[entity] = ctx;
+    }
+
+    /**
+     * @param {SoundEmitter} emitter
+     * @param {Transform} transform
+     * @param {number} entity
+     */
+    unlink(emitter, transform, entity) {
+        const ctx = this.data[entity];
+
+        if (ctx !== undefined) {
+            delete this.data[entity];
+
+            ctx.unlink();
+        }
+    }
+
+    update(timeDelta) {
+        const sopra = this.sopra;
+
+        const ecd = this.entityManager.dataset;
+
+        if (ecd !== null) {
+            const soundListener = ecd.getAnyComponent(SoundListener);
+
+            if (soundListener.entity !== -1) {
+                const listenerTransform = ecd.getComponent(soundListener.entity, Transform);
+
+                sopra.setListener(listenerTransform.position);
+            }
+        }
+
+        sopra.update(this.webAudioContext.currentTime);
+    }
+}

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

@@ -6,10 +6,17 @@ export class SoundTrack {
      */
     url: string | null;
     /**
-     *
-     * @type {number}
+     * Bound sopra EventInstance (set by SoundEmitterComponentContext while this track is linked), or
+     * null. Lets time reads/seeks plumb into sopra.
+     * @type {EventInstance|null}
+     */
+    __instance: EventInstance | null;
+    /**
+     * Owning translation record while this track is linked, or null. Lets a live `volume` set plumb
+     * into the bound sopra instance gain.
+     * @type {SoundEmitterComponentContext|null}
      */
-    time: number;
+    __soundRuntime: SoundEmitterComponentContext | null;
     /**
      * @deprecated Not used
      * @type {String|null}
@@ -20,12 +27,6 @@ export class SoundTrack {
      * @type {number}
      */
     private __volume;
-    /**
-     * In seconds
-     * Obtained once clip is loaded
-     * @type {number}
-     */
-    duration: number;
     /**
      *
      * @type {number|SoundTrackFlags}
@@ -38,23 +39,20 @@ export class SoundTrack {
         ended: Signal<this>;
     };
     /**
-     *
-     * @return {SoundTrackNodes}
+     * @deprecated sopra owns the audio graph — the track no longer holds WebAudio nodes.
      */
-    get nodes(): SoundTrackNodes;
+    get nodes(): void;
     /**
-     *
-     * @param {AudioContext} context
+     * Setting the cursor seeks the bound sopra instance (e.g. resetSoundEmitterTracks sets 0).
+     * @param {number} v
      */
-    initializeNodes(context: AudioContext): void;
+    set time(arg: number);
     /**
-     *
-     * @param {AudioBuffer} v
+     * Playback cursor in seconds. Reads the bound sopra instance's playhead when linked, else the
+     * last value set.
+     * @returns {number}
      */
-    set buffer(arg: AudioBuffer);
-    get buffer(): AudioBuffer;
-    start(startTime?: number): void;
-    suspend(): void;
+    get time(): number;
     /**
      *
      * @param {SoundTrack} other
@@ -95,7 +93,7 @@ export class SoundTrack {
      * @param {number} duration How long the transition should take, in seconds
      * @param {number} [startAfter] when fading should start, see WebAudio docs on {@link AudioContext#currentTime}
      */
-    setVolumeOverTime(target: number, duration: number, startAfter?: number): void;
+    setVolumeOverTime(): void;
     /**
      *
      * @param {number} v
@@ -181,5 +179,4 @@ export class SoundTrack {
 }
 import { SoundTrackFlags } from "./SoundTrackFlags.js";
 import Signal from "../../../../core/events/signal/Signal.js";
-import { SoundTrackNodes } from "./SoundTrackNodes.js";
 //# sourceMappingURL=SoundTrack.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SoundTrack.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundTrack.js"],"names":[],"mappings":"AAYA;IAscI,uCAMC;IApcD;;;OAGG;IACH,KAFU,SAAO,IAAI,CAEV;IAEX;;;OAGG;IACH,MAFU,MAAM,CAEP;IAET;;;OAGG;IACH,SAFU,SAAO,IAAI,CAER;IAEb;;;OAGG;IACH,iBAAa;IAEb;;;;OAIG;IACH,UAFU,MAAM,CAEF;IAGd;;;OAGG;IACH,OAFU,MAAM,GAAC,eAAe,CAEV;IAEtB;QACI;;WAEG;eADO,OAAO,IAAI,CAAC;MAGxB;IAQF;;;OAGG;IACH,6BAEC;IAED;;;OAGG;IACH,yBAFW,YAAY,QAItB;IAED;;;OAGG;IACH,6BAMC;IAED,0BAEC;IAUD,gCAiDC;IAED,gBAaC;IAED;;;;OAIG;IACH,eAHW,UAAU,UAmCpB;IAED;;;;OAIG;IACH,cAHW,MAAM,oBAAkB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,oBAAkB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,oBAAkB,SACxB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,oBAAkB,GACtB,OAAO,CAInB;IAED;;;;;;;;;OASG;IACH,0BAJW,MAAM,YACN,MAAM,eACN,MAAM,QAuChB;IAED;;;OAGG;IACH,wBAMC;IAED;;;OAGG;IACH,qBAEC;IAUD;;;OAGG;IACH,uBAEC;IAdD;;;OAGG;IACH,oBAEC;IAkBD;;;OAGG;IACH,0BAEC;IAdD;;;OAGG;IACH,uBAEC;IAkBD;;;OAGG;IACH,iCAEC;IAdD;;;OAGG;IACH,8BAEC;IAUD;;;OAGG;IACH,YAFW,UAAU,QAOpB;IAED;;;;OAIG;IACH,cAHW,UAAU,GACR,OAAO,CAQnB;IAED;;;OAGG;IACH,QAFY,MAAM,CASjB;IAED;;;OAGG;IACH,SAFY,UAAU,CAQrB;IAED;;;;;;;;;MAWC;IAED;;;;;;;;;aA6BC;;CAUJ;gCAnd+B,sBAAsB;mBALnC,0CAA0C;gCAM7B,sBAAsB"}
+{"version":3,"file":"SoundTrack.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundTrack.js"],"names":[],"mappings":"AAWA;IAiVI,uCAMC;IArVD;;;OAGG;IACH,KAFU,SAAO,IAAI,CAEV;IAQX;;;;OAIG;IACH,YAFU,gBAAc,IAAI,CAEV;IAElB;;;;OAIG;IACH,gBAFU,+BAA6B,IAAI,CAErB;IAEtB;;;OAGG;IACH,SAFU,SAAO,IAAI,CAER;IAEb;;;OAGG;IACH,iBAAa;IAGb;;;OAGG;IACH,OAFU,MAAM,GAAC,eAAe,CAEV;IAEtB;QACI;;WAEG;eADO,OAAO,IAAI,CAAC;MAGxB;IAEF;;OAEG;IACH,kBAEC;IAWD;;;OAGG;IACH,sBAMC;IAnBD;;;;OAIG;IACH,mBAEC;IAcD;;;;OAIG;IACH,eAHW,UAAU,UAmCpB;IAED;;;;OAIG;IACH,cAHW,MAAM,oBAAkB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,oBAAkB,GACtB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,oBAAkB,SACxB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,oBAAkB,GACtB,OAAO,CAInB;IAED;;;;;;;;;OASG;IACH,0BAEC;IAED;;;OAGG;IACH,wBAOC;IAED;;;OAGG;IACH,qBAEC;IAUD;;;OAGG;IACH,uBAEC;IAdD;;;OAGG;IACH,oBAEC;IAkBD;;;OAGG;IACH,0BAEC;IAdD;;;OAGG;IACH,uBAEC;IAkBD;;;OAGG;IACH,iCAEC;IAdD;;;OAGG;IACH,8BAEC;IAUD;;;OAGG;IACH,YAFW,UAAU,QAOpB;IAED;;;;OAIG;IACH,cAHW,UAAU,GACR,OAAO,CAQnB;IAED;;;OAGG;IACH,QAFY,MAAM,CASjB;IAED;;;OAGG;IACH,SAFY,UAAU,CAQrB;IAED;;;;;;;;;MAWC;IAED;;;;;;;;;aA6BC;;CAUJ;gCA7V+B,sBAAsB;mBALnC,0CAA0C"}