@woosh/meep-engine 3.3.0 → 3.4.0

package/src/engine/sound/ecs/SoundControllerSystem.js

@@ -1,103 +0,0 @@
-import { randomFromArray } from "../../../core/math/random/randomFromArray.js";
-import { ResourceAccessKind } from "../../../core/model/ResourceAccessKind.js";
-import { ResourceAccessSpecification } from "../../../core/model/ResourceAccessSpecification.js";
-import { System } from '../../ecs/System.js';
-import { SoundEmitter } from './emitter/SoundEmitter.js';
-import { SoundTrack } from "./emitter/SoundTrack.js";
-import SoundController from './SoundController.js';
-
-/**
- *
- * @param {Rule} rule
- * @returns {string}
- */
-function pickTackFromRule(rule) {
-    return randomFromArray(Math.random, rule.tracks);
-}
-
-/**
- * @deprecated Legacy sound-controller system — superseded by the native audio path
- * ({@link AudioEmitterSystem} and the forthcoming `AudioEventTrigger`). Retained for existing callers
- * during the strangler migration.
- */
-class SoundControllerSystem extends System {
-    dependencies = [SoundController];
-    components_used = [
-        ResourceAccessSpecification.from(SoundEmitter, ResourceAccessKind.Write)
-    ];
-    removers = [];
-
-    /**
-     *
-     * @param {SoundController} component
-     * @param {number} entity
-     */
-    link(component, entity) {
-
-        const em = this.entityManager;
-
-        const dataset = em.dataset;
-
-        const callbacks = this.removers[entity] = [];
-
-
-        /**
-         *
-         * @param {SoundController.Rule} rule
-         */
-        function registerRule(rule) {
-            function startEventHandler() {
-                const emitter = dataset.getComponent(entity, SoundEmitter);
-
-                if (emitter === undefined) {
-                    //do nothing?
-                    console.error("Entity " + entity + " has no SoundEmitter to control");
-                }
-
-                const track = new SoundTrack();
-
-                const url = pickTackFromRule(rule);
-
-                track.fromJSON({
-                    url,
-                    loop: rule.loop,
-                    volume: rule.volume,
-                    channel: rule.channel
-                });
-
-                emitter.tracks.add(track);
-            }
-
-            function stopEventHandler() {
-                const emitter = dataset.getComponent(entity, SoundEmitter);
-                emitter.tracks.removeOneIf(function (t) {
-                    return rule.tracks.indexOf(t.url) !== -1;
-                });
-            }
-
-            if (typeof rule.stopEvent === "string") {
-                dataset.addEntityEventListener(entity, rule.stopEvent, stopEventHandler);
-                callbacks.push({ name: rule.stopEvent, handler: stopEventHandler });
-            }
-            dataset.addEntityEventListener(entity, rule.startEvent, startEventHandler);
-            callbacks.push({ name: rule.startEvent, handler: startEventHandler });
-        }
-
-        component.rules.forEach(registerRule);
-    }
-
-    unlink(component, entity) {
-        const callbacks = this.removers[entity];
-        delete this.removers[entity];
-        const em = this.entityManager;
-
-        const dataset = em.dataset;
-
-        callbacks.forEach(function (cb) {
-            dataset.removeEntityEventListener(entity, cb.name, cb.handler);
-        });
-    }
-}
-
-
-export default SoundControllerSystem;

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

@@ -1 +0,0 @@
-{"version":3,"file":"SoundAttenuationFunction.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundAttenuationFunction.js"],"names":[],"mappings":"uCAEU,MAAM"}

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

@@ -1 +0,0 @@
-{"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,UAqDtB;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/SoundEmitterComponentContext.d.ts

@@ -1,55 +0,0 @@
-/**
- * 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 {SopraEngine}
-     */
-    sopra: SopraEngine;
-    link(): void;
-    unlink(): void;
-    /**
-     * @param {SoundTrack} track
-     */
-    addTrack(track: SoundTrack): void;
-    /**
-     * @param {SoundTrack} track
-     */
-    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
-     */
-    refreshTrackVolume(track: SoundTrack): void;
-    /**
-     * Fade every owned instance out and stop it (backs SoundEmitter.fadeOutAllTracks).
-     * @param {number} duration
-     */
-    fadeOutAll(duration: number): void;
-    /**
-     * Stop every owned instance immediately (backs SoundEmitter.stopAllTracks + unlink).
-     *
-     * 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.
-     */
-    stopAll(): void;
-    #private;
-}
-//# sourceMappingURL=SoundEmitterComponentContext.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"SoundEmitterComponentContext.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitterComponentContext.js"],"names":[],"mappings":"AAQA;;;;;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,kCAkCC;IAED;;OAEG;IACH,qCAWC;IAoDD;;;;OAIG;IACH,4CAQC;IAoCD;;;OAGG;IACH,qBAFW,MAAM,QAMhB;IAED;;;;;;OAMG;IACH,gBAcC;;CACJ"}

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

@@ -1,265 +0,0 @@
-import { EventInstanceState } from "../../sopra/runtime/EventInstance.js";
-import {
-    LEGACY_FALLBACK_BUS_ID,
-    soundTrackToEventDescription
-} from "../../sopra/legacy/soundEmitterToEventDescription.js";
-import { volume2dB } from "../../volume2dB.js";
-import { SoundTrackFlags } from "./SoundTrackFlags.js";
-
-/**
- * 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 = null;
-
-    /**
-     * @type {Transform}
-     */
-    transform = null;
-
-    /**
-     * @type {SoundEmitterSystem}
-     */
-    system = null;
-
-    /**
-     * @type {SopraEngine}
-     */
-    sopra = null;
-
-    /**
-     * track → its live sopra instance
-     * @type {Map<SoundTrack, EventInstance>}
-     */
-    #instances = new Map();
-
-    #boundAddTrack = (track) => this.addTrack(track);
-    #boundRemoveTrack = (track) => this.removeTrack(track);
-    #boundUpdateVolume = () => this.#updateVolume();
-
-    link() {
-        const emitter = this.emitter;
-
-        // back-reference so the emitter's deprecated fade/stop helpers can reach the live instances
-        emitter.__soundRuntime = this;
-
-        // snapshot the initial tracks before adding: addTrack can synchronously remove a track (a
-        // zero-duration / synchronously-failed one-shot self-ends inside playEvent), and List.forEach
-        // is NOT safe against re-entrant removal (it iterates by a fixed index over the live array).
-        const initial = [];
-        emitter.tracks.forEach((track) => initial.push(track));
-        for (let i = 0; i < initial.length; i++) {
-            this.addTrack(initial[i]);
-        }
-
-        emitter.tracks.on.added.add(this.#boundAddTrack);
-        emitter.tracks.on.removed.add(this.#boundRemoveTrack);
-        emitter.volume.onChanged.add(this.#boundUpdateVolume);
-    }
-
-    unlink() {
-        const emitter = this.emitter;
-
-        emitter.tracks.on.added.remove(this.#boundAddTrack);
-        emitter.tracks.on.removed.remove(this.#boundRemoveTrack);
-        emitter.volume.onChanged.remove(this.#boundUpdateVolume);
-
-        this.stopAll();
-
-        emitter.__soundRuntime = null;
-    }
-
-    /**
-     * @param {SoundTrack} track
-     */
-    addTrack(track) {
-        const emitter = this.emitter;
-
-        const description = soundTrackToEventDescription(emitter, track);
-
-        this.#resolveBus(description);
-
-        // a looping track is persistent; a one-shot self-ends (and then fires track.on.ended)
-        const oneShot = !track.getFlag(SoundTrackFlags.Loop);
-
-        const instance = this.sopra.playEvent(description, {
-            busId: description.busId,
-            position: this.transform.position, // shared Vector3 — tracks the entity as it moves
-            oneShot
-        });
-
-        if (instance === null) {
-            // play denied (instance limit) — drop, matching the steal/limit policy
-            return;
-        }
-
-        this.#bind(track, instance);
-
-        // live volume = emitter.volume × track.volume, carried by the instance gain
-        instance.setGainDb(this.#trackGainDb(track));
-
-        instance.onEnded.addOne(() => this.#onInstanceEnded(track, instance));
-
-        // A zero-duration (or synchronously-failed) one-shot self-ends inside playEvent's start(),
-        // firing onEnded BEFORE the subscription above — so run the end path now, else the instance
-        // leaks in #instances and the dead track never leaves the list.
-        if (instance.state === EventInstanceState.Stopped) {
-            this.#onInstanceEnded(track, instance);
-        }
-    }
-
-    /**
-     * @param {SoundTrack} track
-     */
-    removeTrack(track) {
-        const instance = this.#instances.get(track);
-
-        if (instance === undefined) {
-            return;
-        }
-
-        // detach BEFORE stopping so the onEnded handler (which stop() fires synchronously) bails out
-        this.#unbind(track);
-
-        instance.stop();
-    }
-
-    /**
-     * Bind a track to its live instance.
-     * @param {SoundTrack} track
-     * @param {EventInstance} instance
-     */
-    #bind(track, instance) {
-        track.__instance = instance;
-        track.__soundRuntime = this;
-        this.#instances.set(track, instance);
-    }
-
-    /**
-     * Detach a track from its (now gone) instance.
-     * @param {SoundTrack} track
-     */
-    #unbind(track) {
-        this.#instances.delete(track);
-        track.__instance = null;
-        track.__soundRuntime = null;
-    }
-
-    /**
-     * @param {SoundTrack} track
-     * @param {EventInstance} instance
-     */
-    #onInstanceEnded(track, instance) {
-        if (this.#instances.get(track) !== instance) {
-            // already removed via removeTrack() — nothing to do
-            return;
-        }
-
-        this.#unbind(track);
-
-        // legacy contract: a finished track fires on.ended and leaves the list. Remove by IDENTITY
-        // (not value-equality) so a value-equal sibling track is never removed by mistake.
-        track.on.ended.send1(track);
-
-        const tracks = this.emitter.tracks;
-        const index = tracks.indexOf(track);
-        if (index !== -1) {
-            tracks.remove(index);
-        }
-    }
-
-    #updateVolume() {
-        this.#instances.forEach((instance, track) => {
-            instance.setGainDb(this.#trackGainDb(track));
-        });
-    }
-
-    /**
-     * 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
-     */
-    refreshTrackVolume(track) {
-        const instance = this.#instances.get(track);
-
-        if (instance === undefined) {
-            return;
-        }
-
-        instance.setGainDb(this.#trackGainDb(track));
-    }
-
-    /**
-     * Composed live gain for a track: emitter.volume × track.volume, in dB.
-     * @param {SoundTrack} track
-     * @returns {number}
-     */
-    #trackGainDb(track) {
-        return volume2dB(this.emitter.volume.getValue() * track.volume);
-    }
-
-    /**
-     * Point a translated description at a bus that actually exists, falling back to `effects` if the
-     * emitter's channel names one the mixer does not have.
-     *
-     * A legacy emitter's `channel` is a free string on decade-old authored data, and the mixer it was
-     * written against is not the one running: sopra's `BusGraph.getInput` THROWS on an unknown id, so a
-     * single stale channel name would fail the emitter's first play and, from `link`, take the level
-     * load with it. The pre-sopra system logged the name and carried on with effects; so does this.
-     *
-     * Checked here rather than in the translation because only this side can see the live bus graph —
-     * a game that installs its own buses through `setBuses` must not have its channel names rejected
-     * against some hardcoded list of the defaults.
-     *
-     * @param {EventDescription} description mutated in place, before it is ever played or registered
-     */
-    #resolveBus(description) {
-        if (this.sopra.busGraph.has(description.busId)) {
-            return;
-        }
-
-        console.error(`sopra: no bus named '${description.busId}', falling back to '${LEGACY_FALLBACK_BUS_ID}'`);
-
-        description.busId = LEGACY_FALLBACK_BUS_ID;
-    }
-
-    /**
-     * Fade every owned instance out and stop it (backs SoundEmitter.fadeOutAllTracks).
-     * @param {number} duration
-     */
-    fadeOutAll(duration) {
-        this.#instances.forEach((instance) => {
-            instance.fadeOutAndStop(duration);
-        });
-    }
-
-    /**
-     * Stop every owned instance immediately (backs SoundEmitter.stopAllTracks + unlink).
-     *
-     * 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.
-     */
-    stopAll() {
-        const instances = [];
-
-        this.#instances.forEach((instance, track) => {
-            track.__instance = null;
-            track.__soundRuntime = null;
-            instances.push(instance);
-        });
-
-        this.#instances.clear();
-
-        for (let i = 0; i < instances.length; i++) {
-            instances[i].stop();
-        }
-    }
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"SoundEmitterFlags.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitterFlags.js"],"names":[],"mappings":"gCAEU,MAAM"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"SoundEmitterSerializationAdapter.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitterSerializationAdapter.js"],"names":[],"mappings":"AAIA;;IAEI,2BAAqB;IAGrB;;;;OAIG;IACH,uCAFW,YAAY,QAyBtB;IAED;;;;OAIG;IACH,yCAFW,YAAY,QAmCtB;CAEJ;gDA/E+C,gEAAgE;6BACnF,mBAAmB"}

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

@@ -1,88 +0,0 @@
-export type SoundEmitterChannels = string;
-export namespace SoundEmitterChannels {
-    let Effects: string;
-    let Music: string;
-    let Ambient: string;
-}
-/**
- * @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<any> {
-    /**
-     * @param {AssetManager} assetManager
-     * @param {SoundEngine} soundEngine owns the AudioContext + master destination + sopra engine
-     * @constructor
-     */
-    constructor(assetManager: AssetManager, soundEngine: SoundEngine);
-    dependencies: (typeof Transform | typeof SoundEmitter)[];
-    /**
-     * Per-entity translation records.
-     * @type {SoundEmitterComponentContext[]}
-     */
-    data: SoundEmitterComponentContext[];
-    /**
-     * @type {SoundEngine}
-     */
-    soundEngine: SoundEngine;
-    /**
-     * @type {AudioContext}
-     */
-    webAudioContext: AudioContext;
-    destinationNode: any;
-    assetManager: AssetManager;
-    /**
-     * 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}
-     */
-    sopra: SopraEngine;
-    /**
-     * @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>}
-     */
-    channels: {
-        [x: string]: string;
-    };
-    /**
-     * @deprecated channel volume is a sopra bus volume now; proxies to it.
-     * @param {String} name
-     * @returns {number}
-     */
-    getChannelVolume(name: string): number;
-    /**
-     * @deprecated channel volume is a sopra bus volume now; proxies to it.
-     * @param {String} name
-     * @param {number} value
-     */
-    setChannelVolume(name: string, value: number): void;
-    /**
-     * @param {SoundEmitter} emitter
-     * @param {Transform} transform
-     * @param {number} entity
-     */
-    link(emitter: SoundEmitter, transform: Transform, entity: number): void;
-    /**
-     * @param {SoundEmitter} emitter
-     * @param {Transform} transform
-     * @param {number} entity
-     */
-    unlink(emitter: SoundEmitter, transform: Transform, entity: number): void;
-    update(timeDelta: any): void;
-}
-import { System } from '../../../ecs/System.js';
-import { Transform } from '../../../ecs/transform/Transform.js';
-import { SoundEmitter } from './SoundEmitter.js';
-import { SoundEmitterComponentContext } from "./SoundEmitterComponentContext.js";
-//# sourceMappingURL=SoundEmitterSystem.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"SoundEmitterSystem.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/sound/ecs/emitter/SoundEmitterSystem.js"],"names":[],"mappings":"mCAWU,MAAM;;;;;;AAQhB;;;;;;;;;;;;;GAaG;AACH;IASI;;;;OAIG;IACH,kEAoCC;IAjDD,yDAAyC;IAEzC;;;OAGG;IACH,MAFU,4BAA4B,EAAE,CAE9B;IAUN;;OAEG;IACH,yBAA8B;IAE9B;;OAEG;IACH,iBAFU,YAAY,CAEoB;IAE1C,qBAA8C;IAE9C,2BAAgC;IAIhC;;;;OAIG;IACH,mBAAkF;IAElF;;;;OAIG;IACH;YAFiB,MAAM,GAAC,MAAM;MAM7B;IAGL;;;;OAIG;IACH,gCAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,sCAFW,MAAM,QAIhB;IAED;;;;OAIG;IACH,cAJW,YAAY,aACZ,SAAS,UACT,MAAM,QAahB;IAED;;;;OAIG;IACH,gBAJW,YAAY,aACZ,SAAS,UACT,MAAM,QAUhB;IAED,6BAqBC;CACJ;uBA5JsB,wBAAwB;0BACrB,qCAAqC;6BAGlC,mBAAmB;6CACH,mCAAmC"}