@adatechnology/game-audio 0.7.0 → 0.9.0

package/dist/fitted.d.ts

@@ -0,0 +1,89 @@
+import { B as BusId, F as Falloff, S as SoundRegistry, a as SoundBank, L as LoopRecipe, b as SoundRecipe } from './bank-Dsj1VAht.js';
+
+/** One band layer (`band`) or one partial (`frequency` + `wave`) of a fitted take: peak gain and its curve, `[seconds, 0..1]` points. */
+type FittedLayer = {
+    readonly band?: number;
+    readonly frequency?: number;
+    readonly wave?: 'sine';
+    readonly gain: number;
+    readonly env: readonly (readonly [number, number])[];
+};
+type FittedTake = {
+    readonly duration: number;
+    readonly layers: readonly FittedLayer[];
+};
+type FittedSound = {
+    readonly id: string;
+    readonly category: string;
+    readonly takes?: readonly FittedTake[];
+    readonly loop?: {
+        readonly bands: readonly {
+            readonly band: number;
+            readonly gain: number;
+        }[];
+    };
+    readonly sources: readonly string[];
+};
+/** A band: its centre, its Q and how many bandpass biquads in series (2 makes the skirts fall 12 dB an octave instead of 6). */
+type FittedBand = {
+    readonly frequency: number;
+    readonly q: number;
+    readonly stages?: number;
+};
+type FittedData = {
+    readonly rate: number;
+    readonly bands: readonly FittedBand[];
+    /** The bands of the loops (a parallel bank of single biquads); the take bands when left out. */
+    readonly loopBands?: readonly FittedBand[];
+    readonly sounds: readonly FittedSound[];
+};
+/** The fitted numbers of every recorded sound of the kit. */
+declare const FITTED_SFX: FittedData;
+/** Ids whose older recipe reads params (a hiss of `seconds`): the fitted copy does not replace it. */
+declare const FITTED_KEEPS_RECIPE: ReadonlySet<string>;
+/** How far each bus carries, the same curves the recordings play with. */
+declare const FITTED_FALLOFF: Readonly<Record<BusId, Falloff>>;
+/** The bus of a fitted sound. */
+declare function fittedBus(sound: {
+    readonly id: string;
+    readonly category: string;
+}): BusId;
+/** The id of take `index` (from 1) of a sound: `door_wood_shut~2`. */
+declare const fittedTakeId: (id: string, index: number) => string;
+/** The recipe of one take. */
+declare function fittedTakeRecipe(sound: FittedSound, take: FittedTake, index: number, data?: FittedData): SoundRecipe;
+/** The loop of a loop or an ambience. */
+declare function fittedLoopRecipe(sound: FittedSound, data?: FittedData): LoopRecipe | null;
+type FittedBankOptions = {
+    readonly id?: string;
+    /** Leave out sounds (by id or by a test). */
+    readonly skip?: (sound: FittedSound) => boolean;
+    /** Playback rate range of each play of a set (default ±3 %). */
+    readonly rate?: readonly [number, number];
+    readonly data?: FittedData;
+    /**
+     * Recipe id → recorded id, answered by the recorded id's fitted takes as the files answer it once loaded (default `KIT_SAMPLE_ALIASES`, so
+     * `shut_wood` plays the fitted `door_wood_shut`). An alias whose target is not fitted is left alone.
+     */
+    readonly aliases?: Readonly<Record<string, string>>;
+};
+/** The bank: one recipe per take, one set per id (its takes), one loop per loop sound. */
+declare function fittedSoundBank(options?: FittedBankOptions): SoundBank;
+/** Ids of the recorded sounds that have fitted numbers (takes or a loop). */
+declare function fittedIds(data?: FittedData): string[];
+type RegisterFittedOptions = FittedBankOptions & {
+    /** Let a fitted set or loop replace the older recipe of the same id (default true; `FITTED_KEEPS_RECIPE` always keeps theirs). */
+    readonly replace?: boolean;
+};
+/** What `registerFittedSounds` needs of an engine: its registry and `register`. */
+type FittedHost = {
+    readonly registry: SoundRegistry;
+    register(bank: SoundBank): void;
+};
+/**
+ * Registers the fitted bank. A set loses to a recipe of the same id, so with `replace` the older one-shot recipe of each fitted id is removed (its
+ * samples stay); a fitted loop simply replaces the older loop. Returns the ids now answered by a fitted sound.
+ */
+declare function registerFittedSounds(host: FittedHost, options?: RegisterFittedOptions): string[];
+
+export { FITTED_FALLOFF, FITTED_KEEPS_RECIPE, FITTED_SFX, type FittedBand, type FittedBankOptions, type FittedData, type FittedHost, type FittedLayer, type FittedSound, type FittedTake, type RegisterFittedOptions, fittedBus, fittedIds, fittedLoopRecipe, fittedSoundBank, fittedTakeId, fittedTakeRecipe, registerFittedSounds };