@kidlib/web-audio 0.1.2 → 0.1.4

package/README.md

@@ -27,3 +27,5 @@ player.play(60);
 
 UI elements such as `KnobElement` are available only from the optional
 `@kidlib/web-audio/components` entry point.
+
+### Live demo app: [Hljóð-Smali](https://kristinnroach.github.io/hljod-smali)

package/dist/index.d.ts

@@ -667,7 +667,7 @@ declare class MacroParam {
     protected sendMessage(type: string, data: any): void;
     dispose(): void;
     connect(target: AudioParam, nodeType: NodeType, scaleFactor?: number): this;
-    disconnect(target?: AudioParam | TODO): void;
+    disconnect(target?: AudioParam): void;
 }
 
 declare interface Message {
@@ -788,8 +788,6 @@ declare type RecorderOptions = {
     autoStop: boolean;
     stopThreshold: number;
     silenceTimeoutMs: number;
-    preprocess: boolean;
-    preprocessOptions: object;
 };
 
 export declare type RecorderStartOptions = Partial<RecorderOptions> & {
@@ -817,7 +815,7 @@ declare const ROOT_NOTES: {
 };
 
 export declare interface SampleLoader {
-    loadSample(...args: TODO[]): Promise<TODO>;
+    loadSample(buffer: AudioBuffer | ArrayBuffer): Promise<AudioBuffer | null>;
 }
 
 export declare class SamplePlayer implements ILibInstrumentNode {
@@ -825,6 +823,7 @@ export declare class SamplePlayer implements ILibInstrumentNode {
     readonly nodeId: NodeID_2;
     readonly nodeType: "sample-player";
     readonly context: AudioContext;
+    static readonly MAX_LAYERS = 4;
     randomizeVelocity: boolean;
     voicePool: SampleVoicePool;
     outBus: InstrumentBus;
@@ -851,7 +850,18 @@ export declare class SamplePlayer implements ILibInstrumentNode {
     setModulationWaveform(modType?: "AM" | "FM", waveform?: CustomLibWaveform | OscillatorType | PeriodicWave, customWaveOptions?: WaveformOptions): void;
     syncLFOsToNoteFreq(lfoId: "gain-lfo" | "pitch-lfo", enabled: boolean): void;
     freezeActiveVoices(freeze: boolean): this;
+    /**
+     * Load a single sample. Equivalent to `loadLayers([buffer])`: any previously
+     * loaded extra layers are cleared.
+     */
     loadSample(buffer: AudioBuffer | ArrayBuffer, modSampleRate?: number, preprocessOptions?: Partial<PreProcessOptions>): Promise<AudioBuffer | null>;
+    /**
+     * Replace the whole layer set. Layers are summed inside the voice worklet at
+     * one shared playhead, so they play in unison and layer 0 is the authority
+     * for duration, loop points, start/end and zero crossings. Layers shorter
+     * than layer 0 fall silent at their own end; longer ones are truncated.
+     */
+    loadLayers(buffers: (AudioBuffer | ArrayBuffer)[], modSampleRate?: number, preprocessOptions?: Partial<PreProcessOptions>): Promise<AudioBuffer[] | null>;
     cropSample(startSeconds?: number, endSeconds?: number, fadeMs?: number): Promise<AudioBuffer | null>;
     detectPitch(buffer: AudioBuffer): Promise<{
         frequency: number;
@@ -906,7 +916,7 @@ export declare class SamplePlayer implements ILibInstrumentNode {
     setLoopPoint(loopPoint: "start" | "end", loopStartSeconds: number, loopEndSeconds: number, rampDuration?: number): this;
     scrollLoopPoints(loopStart: number, loopEnd: number): this;
     setParam(name: string, value: number): this;
-    applyParams(params: SamplerParamPatch): this;
+    applyParams(params: SamplerParams): this;
     /** PARAM GETTERS  */
     getAudioParam(name: string): AudioParam | null;
     getStartPoint(): number;
@@ -956,6 +966,8 @@ export declare class SamplePlayer implements ILibInstrumentNode {
     get loopEnd(): number;
     get isLoaded(): boolean;
     get audiobuffer(): AudioBuffer | null;
+    /** All loaded layers. Index 0 is the authority layer (=== `audiobuffer`). */
+    get layers(): readonly AudioBuffer[];
     dispose(): void;
 }
 
@@ -976,7 +988,10 @@ export declare interface SamplerParamDescriptor {
 
 export declare type SamplerParamKey = keyof typeof samplerParams;
 
-export declare type SamplerParamPatch = Partial<SamplerParamValues>;
+/** @deprecated Renamed to {@link SamplerParams}. Removed in the next minor. */
+export declare type SamplerParamPatch = SamplerParams;
+
+export declare type SamplerParams = Partial<SamplerParamValues>;
 
 export declare const samplerParams: Record<"distortion" | "delayTime" | "feedback" | "feedbackDecay" | "drive" | "loopEnd" | "loopStart" | "volume" | "dryWet" | "glide" | "tempo" | "lowpassFilter" | "highpassFilter" | "feedbackPitch" | "feedbackLpf" | "clipping" | "amMod" | "reverbSend" | "reverbSize" | "delaySend" | "delayFeedback" | "gainLFORate" | "gainLFODepth" | "pitchLFORate" | "pitchLFODepth" | "trimStart" | "trimEnd" | "loopDuration" | "loopRampDuration" | "loopDurationDrift" | "keytrackLoop", SamplerParamDescriptor>;
 
@@ -1035,6 +1050,13 @@ declare class SampleVoice {
     });
     init(): Promise<void>;
     loadBuffer(buffer: AudioBuffer, zeroCrossings?: number[]): Promise<boolean>;
+    /**
+     * Replace the whole layer set. Layers are summed at one shared playhead, so
+     * layer 0 is the authority for duration and all range math; the rest only
+     * add samples. A layer at the wrong sample rate is dropped on its own,
+     * leaving the others playable, except layer 0: losing it fails the load.
+     */
+    loadLayers(buffers: AudioBuffer[], zeroCrossings?: number[]): Promise<boolean>;
     freeze(freeze: boolean): this;
     setGlideTime(seconds: number): void;
     trigger(options: {
@@ -1144,7 +1166,7 @@ declare class SampleVoicePool implements LibNode {
     disconnect(): void;
     onMessage(type: string, handler: MessageHandler<Message>): () => void;
     sendUpstreamMessage(type: string, data: any): this;
-    setBuffer(buffer: AudioBuffer, zeroCrossings?: number[]): this;
+    setLayers(buffers: AudioBuffer[], zeroCrossings?: number[]): this;
     allocate(available?: Set<SampleVoice>, releasing?: Set<SampleVoice>): SampleVoice | undefined;
     prevMidiNote: number;
     noteOn(midiNote: MidiValue, velocity?: MidiValue, secondsFromNow?: number, glideTime?: number): MidiValue | null;