@driftengine/audio 3.61.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Drift Technologies
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+DriftEngine
+Copyright 2026 Drift Technologies
+
+This product includes software developed at Drift Technologies
+(https://github.com/drftrun/driftengine).
+
+Licensed under the Apache License, Version 2.0. Section 4(d) of that licence
+requires this NOTICE to be reproduced in any derivative work you distribute,
+in the source, the documentation, or a display generated by the work.

package/README.md

@@ -0,0 +1,11 @@
+# @driftengine/audio
+
+Layered stems, synthesis, rhythm and kick detection, distance and stereo placement, HRTF-panned
+sources, reverb zones a **source** can be inside as well as the listener, and first-order
+ambisonic soundfields decoded through six virtual speakers.
+
+**Cost: 6.0 KB gzipped on top of core.** Measured by `scripts/size-gate.test.mjs`, which fails if it drifts more than
+3% — the number is a fact about the build rather than a claim in a document.
+
+Part of [DriftEngine](../../README.md). See [`docs/ARCHITECTURE.md`](../../docs/ARCHITECTURE.md)
+for how the packages divide, and why some features are compiled into core on demand instead.

package/dist/ambientLoop.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Where "now" comes from, for work this loop schedules.
+ *
+ * Supplied rather than read off the context, because a *rendered* mix has no
+ * "now": an `OfflineAudioContext` holds `currentTime` at zero for as long as the
+ * caller is describing the timeline, so a loop reading it directly would stack
+ * every level change a clip ever makes onto instant zero and play the last one
+ * for the whole file. A fire the character sprints past would sit at its parting
+ * distance from the opening frame.
+ *
+ * The graph that owns the loop already has exactly one answer to this question
+ * for exactly this reason; this is how a loop gets to share it.
+ */
+export type ScheduleClock = () => number;
+export declare class AmbientLoop {
+    private readonly scheduleAt;
+    private readonly source;
+    private readonly gainNode;
+    private readonly panNode;
+    private lastGain;
+    private lastPan;
+    private stopped;
+    /**
+     * @param scheduleAt the instant this loop's changes land on. See `ScheduleClock`.
+     * @param source the looping buffer source, already started.
+     * @param gainNode its level, initially silent.
+     * @param panNode present only where the browser supports stereo panning.
+     */
+    constructor(scheduleAt: ScheduleClock, source: AudioBufferSourceNode, gainNode: GainNode, panNode: StereoPannerNode | null);
+    private rate;
+    /** 0 is silent, 1 is the buffer at its authored level. */
+    setGain(gain: number): void;
+    /**
+     * Pitch the bed, for a loop whose *state* should be audible.
+     *
+     * Ramped like gain and pan rather than set, because a stepped playback rate
+     * on a continuous source is a click. Change-gated by the same rule: a rate
+     * written every frame would schedule sixty ramps a second.
+     */
+    setRate(rate: number): void;
+    /** -1 hard left, 0 centre, 1 hard right. A no-op without stereo panning. */
+    setPan(pan: number): void;
+    stop(): void;
+    private ramp;
+}

package/dist/ambientLoop.js

@@ -0,0 +1,88 @@
+/**
+ * A continuous environmental sound: a looping buffer whose level and stereo
+ * position are driven every frame by whatever the game decides is nearby.
+ *
+ * Not a full spatial audio node. A panner per source with an HRTF would be the
+ * general answer, but the sources this is for — a fire, a shoreline, wind —
+ * are diffuse and often several at once, and what actually communicates them is
+ * "how close" and "which side". Those are two numbers, and paying for a panner
+ * graph per brazier to produce them would be the expensive way to get the same
+ * result.
+ *
+ * Both setters are change-gated. They are called once per frame, and scheduling
+ * an `AudioParam` ramp sixty times a second for a value that has not moved is
+ * work the audio thread does not need.
+ */
+const RAMP = 0.12;
+/** Below this the ramp is inaudible; above it, skipping the update is not. */
+const EPSILON = 0.004;
+export class AmbientLoop {
+    scheduleAt;
+    source;
+    gainNode;
+    panNode;
+    lastGain = 0;
+    lastPan = 0;
+    stopped = false;
+    /**
+     * @param scheduleAt the instant this loop's changes land on. See `ScheduleClock`.
+     * @param source the looping buffer source, already started.
+     * @param gainNode its level, initially silent.
+     * @param panNode present only where the browser supports stereo panning.
+     */
+    constructor(scheduleAt, source, gainNode, panNode) {
+        this.scheduleAt = scheduleAt;
+        this.source = source;
+        this.gainNode = gainNode;
+        this.panNode = panNode;
+    }
+    rate = 1;
+    /** 0 is silent, 1 is the buffer at its authored level. */
+    setGain(gain) {
+        const next = Number.isFinite(gain) ? Math.min(Math.max(gain, 0), 1) : 0;
+        if (Math.abs(next - this.lastGain) < EPSILON)
+            return;
+        this.lastGain = next;
+        this.ramp(this.gainNode.gain, next);
+    }
+    /**
+     * Pitch the bed, for a loop whose *state* should be audible.
+     *
+     * Ramped like gain and pan rather than set, because a stepped playback rate
+     * on a continuous source is a click. Change-gated by the same rule: a rate
+     * written every frame would schedule sixty ramps a second.
+     */
+    setRate(rate) {
+        const next = Math.max(0.05, rate);
+        if (Math.abs(next - this.rate) < 0.005)
+            return;
+        this.rate = next;
+        this.ramp(this.source.playbackRate, next);
+    }
+    /** -1 hard left, 0 centre, 1 hard right. A no-op without stereo panning. */
+    setPan(pan) {
+        if (this.panNode === null)
+            return;
+        const next = Number.isFinite(pan) ? Math.min(Math.max(pan, -1), 1) : 0;
+        if (Math.abs(next - this.lastPan) < EPSILON)
+            return;
+        this.lastPan = next;
+        this.ramp(this.panNode.pan, next);
+    }
+    stop() {
+        if (this.stopped)
+            return;
+        this.stopped = true;
+        try {
+            this.source.stop();
+        }
+        catch {
+            // Never started, or already stopped. Nothing to undo.
+        }
+    }
+    ramp(param, value) {
+        const at = this.scheduleAt();
+        param.cancelScheduledValues(at);
+        param.setTargetAtTime(value, at, RAMP);
+    }
+}

package/dist/audioHarness.d.ts

@@ -0,0 +1,180 @@
+/**
+ * A Web Audio context that answers everything, for tests that need a graph and not a browser.
+ *
+ * **Not a `.test.ts` file, and that is the point.** Vitest registers a test when the file declaring
+ * it is imported, so a test file importing a stub from beside another file's tests would re-run
+ * every test in that file too. Split out so importing the harness costs nothing but the harness —
+ * the same reasoning, and the same shape, as `rendererHarness.ts` in core.
+ *
+ * **It exists because there were three of these.** `autoplay.test.ts`, `graph.test.ts` and
+ * `mixOutput.test.ts` each carried their own `StubNode` and their own `param()`, and they had
+ * already drifted: one recorded what was connected to it and two did not, one had an
+ * `fftSize` of 512 and another 2048, one could decode audio and the others could not. `AGENTS.md`'s
+ * 2026-08-17 rule is exactly this — two implementations of one decision drift, and they drift
+ * invisibly when the constants look identical.
+ *
+ * **A stub is not a contract and nothing here is tested directly.** What it must do is let the real
+ * graph build and let a test read back what the graph did. Where a member exists only so a
+ * constructor does not throw, it does nothing and says so.
+ */
+/** A parameter that remembers every move asked of it, so a test can ask when a fade was scheduled. */
+export interface StubParam {
+    value: number;
+    readonly ramps: {
+        value: number;
+        at: number;
+    }[];
+    setValueAtTime(value: number, at: number): void;
+    linearRampToValueAtTime(value: number, at: number): void;
+    cancelScheduledValues(at: number): void;
+    setTargetAtTime(value: number, at: number, tc: number): void;
+}
+export declare function stubParam(): StubParam;
+/**
+ * A node that remembers what was connected to it. Enough graph to build against.
+ *
+ * `inputs` is what makes a topology assertable at all: the browser's own graph is write-only, so a
+ * test asking "is the send taken from the output or the input" has nowhere else to look.
+ */
+export declare class StubNode {
+    readonly inputs: StubNode[];
+    /** Instants `stop` was asked for, so a test can see whether a fade preceded one. */
+    readonly stops: number[];
+    /** Instants `start` was asked for, so a test can see an offline launch has no lead. */
+    readonly starts: number[];
+    type: string;
+    buffer: unknown;
+    loop: boolean;
+    readonly gain: StubParam;
+    readonly frequency: StubParam;
+    readonly Q: StubParam;
+    readonly delayTime: StubParam;
+    readonly playbackRate: StubParam;
+    readonly pan: StubParam;
+    fftSize: number;
+    smoothingTimeConstant: number;
+    readonly frequencyBinCount = 1024;
+    /** A buffer source answers this; the spatial layer drives it for doppler. */
+    readonly detune: StubParam;
+    /**
+     * The channel plumbing a multi-channel source needs.
+     *
+     * `channelInterpretation` is the one that matters and is the one a test asserts: the default
+     * up-mixes or down-mixes by *meaning*, and W, Y, Z, X are not left, right, centre and low
+     * frequency, so a field read that way comes out as a blur that still plays.
+     */
+    channelCount: number;
+    channelCountMode: string;
+    channelInterpretation: string;
+    panningModel: string;
+    distanceModel: string;
+    refDistance: number;
+    maxDistance: number;
+    rolloffFactor: number;
+    readonly positionX: StubParam;
+    readonly positionY: StubParam;
+    readonly positionZ: StubParam;
+    /**
+     * `output` is accepted and ignored, which is enough for what these tests ask.
+     *
+     * A splitter's outputs go to different nodes, and what a test here checks is *which node* was
+     * connected rather than from which output — the coefficient gains are one per (speaker, channel)
+     * pair, so the pair is already carried by the node's identity.
+     */
+    connect(target: StubNode, output?: number): StubNode;
+    disconnect(): void;
+    start(at?: number): void;
+    stop(at?: number): void;
+    getByteFrequencyData(): void;
+    getFloatFrequencyData(): void;
+}
+/**
+ * The listener, in both shapes a browser might offer it.
+ *
+ * Both are present deliberately, because the code under test picks one and the choice is a feature
+ * detection rather than a preference: a test that only had the modern form could not tell whether
+ * the legacy branch was ever written. `positions` records the legacy calls so a test can assert
+ * which branch ran.
+ */
+export declare class StubListener {
+    readonly positionX: StubParam;
+    readonly positionY: StubParam;
+    readonly positionZ: StubParam;
+    readonly forwardX: StubParam;
+    readonly forwardY: StubParam;
+    readonly forwardZ: StubParam;
+    readonly upX: StubParam;
+    readonly upY: StubParam;
+    readonly upZ: StubParam;
+    readonly positions: number[][];
+    readonly orientations: number[][];
+    setPosition(x: number, y: number, z: number): void;
+    setOrientation(fx: number, fy: number, fz: number, ux: number, uy: number, uz: number): void;
+}
+export interface StubContextOptions {
+    /** `suspended` is a browser that has not been given a gesture yet. */
+    readonly state?: string;
+    /** A context that refuses to resume, which is what a blocked autoplay policy looks like. */
+    readonly refuseResume?: boolean;
+    /** Absent on a browser too old for it; `createLoop` falls back rather than skipping the loop. */
+    readonly stereoPanner?: boolean;
+    /** Absent where the browser has only the deprecated `setPosition`/`setOrientation` pair. */
+    readonly listenerParams?: boolean;
+}
+export declare class StubContext {
+    private readonly options;
+    readonly destination: StubNode;
+    /** Every buffer source built, in order, so a test can inspect the transport. */
+    readonly sources: StubNode[];
+    readonly listener: StubListener;
+    /** Every panner built, in order, so a test can inspect what was placed in the world. */
+    readonly panners: StubNode[];
+    /**
+     * Every convolver built, in order.
+     *
+     * Counted because "a second routing rather than a second convolver" is a claim about how many of
+     * them exist, and a convolver is the most expensive node in this graph. A test that asserted the
+     * send worked would not notice one being built per source.
+     */
+    readonly convolvers: StubNode[];
+    outputLatency: number;
+    readonly tap: StubNode & {
+        stream: MediaStream;
+    };
+    state: string;
+    currentTime: number;
+    sampleRate: number;
+    /** How many times a resume was attempted, for the tests about a context that will not start. */
+    resumeCalls: number;
+    constructor(options?: StubContextOptions);
+    createGain(): StubNode;
+    createBiquadFilter(): StubNode;
+    createConvolver(): StubNode;
+    createWaveShaper(): StubNode;
+    createDelay(): StubNode;
+    createAnalyser(): StubNode;
+    createPanner(): StubNode;
+    createBufferSource(): StubNode;
+    createStereoPanner(): StubNode;
+    createMediaStreamDestination(): StubNode;
+    createChannelSplitter(): StubNode;
+    createChannelMerger(): StubNode;
+    createBuffer(channels: number, length: number): {
+        numberOfChannels: number;
+        length: number;
+        getChannelData(): Float32Array;
+    };
+    decodeAudioData(): Promise<AudioBuffer>;
+    resume(): Promise<void>;
+    close(): Promise<void>;
+}
+/** The context most tests want: running, complete, and recording what was done to it. */
+export declare function stubContext(options?: StubContextOptions): StubContext;
+/**
+ * Install a stub as the page's `AudioContext` and hand back the one that gets built.
+ *
+ * The graph constructs its own context through the global, so a test that wants to look at the
+ * nodes has to intercept the construction rather than pass one in. Returns a getter rather than
+ * the context, because nothing exists until the code under test asks for it.
+ */
+export declare function installStubAudioContext(options?: StubContextOptions): () => StubContext | null;