smplr 0.11.1 → 0.11.3

package/README.md

@@ -126,6 +126,27 @@ All instruments share some configuration options that are passed as second argum
 - `onStart`: a function that is called when starting a note. It receives the note started as parameter. Bear in mind that the time this function is called is not precise, and it's determined by lookahead.
 - `onEnded`: a function that is called when the note ends. It receives the started note as parameter.
 
+#### Usage with standardized-audio-context
+
+This package should be compatible with [standardized-audio-context](https://github.com/chrisguttandin/standardized-audio-context):
+
+```js
+import { AudioContext } from "standardized-audio-context";
+
+const context = new AudioContext();
+const piano = new SplendidGrandPiano(context);
+```
+
+However, if you are using Typescript, you might need to "force cast" the types:
+
+```ts
+import { Soundfont } from "smplr";
+import { AudioContext as StandardizedAudioContext } from "standardized-audio-context";
+
+const context = new StandardizedAudioContext() as unknown as AudioContext;
+const marimba = new Soundfont(context, { instrument: "marimba" });
+```
+
 ### Play
 
 #### Start and stop notes

package/dist/index.d.mts

@@ -27,28 +27,6 @@ declare class Channel {
     disconnect(): void;
 }
 
-type StorageResponse$1 = {
-    readonly status: number;
-    arrayBuffer(): Promise<ArrayBuffer>;
-    json(): Promise<any>;
-    text(): Promise<string>;
-};
-type Storage$1 = {
-    fetch: (url: string) => Promise<StorageResponse$1>;
-};
-declare const HttpStorage: Storage$1;
-declare class CacheStorage implements Storage$1 {
-    #private;
-    constructor(name?: string);
-    fetch(url: string): Promise<StorageResponse$1>;
-}
-
-type AudioBuffers$1 = Record<string | number, AudioBuffer | undefined>;
-/**
- * A function that downloads audio into a AudioBuffers
- */
-type AudioBuffersLoader$1 = (context: BaseAudioContext, buffers: AudioBuffers$1) => Promise<void>;
-
 type StorageResponse = {
     readonly status: number;
     arrayBuffer(): Promise<ArrayBuffer>;
@@ -58,6 +36,12 @@ type StorageResponse = {
 type Storage = {
     fetch: (url: string) => Promise<StorageResponse>;
 };
+declare const HttpStorage: Storage;
+declare class CacheStorage implements Storage {
+    #private;
+    constructor(name?: string);
+    fetch(url: string): Promise<StorageResponse>;
+}
 
 type AudioBuffers = Record<string | number, AudioBuffer | undefined>;
 /**
@@ -65,18 +49,6 @@ type AudioBuffers = Record<string | number, AudioBuffer | undefined>;
  */
 type AudioBuffersLoader = (context: BaseAudioContext, buffers: AudioBuffers) => Promise<void>;
 
-type SamplerConfig$1 = {
-    storage?: Storage;
-    detune: number;
-    volume: number;
-    velocity: number;
-    decayTime?: number;
-    lpfCutoffHz?: number;
-    destination: AudioNode;
-    buffers: Record<string | number, string | AudioBuffers> | AudioBuffersLoader;
-    volumeToGain: (volume: number) => number;
-};
-
 /**
  * A function to unsubscribe from an event or control
  */
@@ -94,7 +66,7 @@ type Subscribe<T> = (listener: Listener<T>) => Unsubscribe;
  * @private
  */
 type InternalPlayer = {
-    readonly buffers: AudioBuffers$1;
+    readonly buffers: AudioBuffers;
     readonly context: BaseAudioContext;
     start(sample: SampleStart): (time?: number) => void;
     stop(sample?: SampleStop): void;
@@ -214,6 +186,35 @@ type RegionGroup = {
     sample: Partial<SampleOptions>;
 };
 
+type SamplerConfig = {
+    storage?: Storage;
+    detune: number;
+    volume: number;
+    velocity: number;
+    decayTime?: number;
+    lpfCutoffHz?: number;
+    destination: AudioNode;
+    buffers: Record<string | number, string | AudioBuffers> | AudioBuffersLoader;
+    volumeToGain: (volume: number) => number;
+};
+/**
+ * A Sampler instrument
+ *
+ * @private
+ */
+declare class Sampler {
+    #private;
+    readonly context: AudioContext;
+    private readonly player;
+    readonly load: Promise<this>;
+    constructor(context: AudioContext, options?: Partial<SamplerConfig>);
+    loaded(): Promise<this>;
+    get output(): OutputChannel;
+    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
+    stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
+}
+
 type QueuedPlayerConfig = {
     scheduleLookaheadMs: number;
     scheduleIntervalMs: number;
@@ -221,13 +222,13 @@ type QueuedPlayerConfig = {
     onEnded?: (sample: SampleStart) => void;
 };
 
-type DefaultPlayerConfig = ChannelConfig & SamplerConfig$1 & QueuedPlayerConfig;
+type DefaultPlayerConfig = ChannelConfig & SamplerConfig & QueuedPlayerConfig;
 
 declare function getDrumMachineNames(): string[];
 type DrumMachineConfig = {
     instrument: string;
     url: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type DrumMachineOptions = Partial<DrumMachineConfig & DefaultPlayerConfig>;
 declare class DrumMachine {
@@ -312,23 +313,20 @@ type WebsfzRegion = {
     tune_oncc123?: number;
 };
 
-/**
- * Splendid Grand Piano options
- */
 type SfzSamplerConfig = {
     instrument: SfzInstrument | Websfz | string;
-    storage?: Storage$1;
+    storage: Storage;
     destination: AudioNode;
     volume: number;
     velocity: number;
     detune: number;
-    decayTime: number;
+    decayTime?: number;
     lpfCutoffHz?: number;
 };
 declare class SfzSampler {
     #private;
     readonly context: AudioContext;
-    readonly options: Readonly<Partial<SfzSamplerConfig>>;
+    readonly options: Readonly<SfzSamplerConfig>;
     private readonly player;
     readonly load: Promise<this>;
     constructor(context: AudioContext, options: Partial<SfzSamplerConfig & DefaultPlayerConfig> & Pick<SfzSamplerConfig, "instrument">);
@@ -350,10 +348,10 @@ declare class ElectricPiano extends SfzSampler {
 }
 
 declare function getVersilianInstruments(): Promise<string[]>;
-declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers$1, group: RegionGroup): (context: BaseAudioContext, storage: Storage$1) => Promise<void[]>;
+declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers, group: RegionGroup): (context: BaseAudioContext, storage: Storage) => Promise<void[]>;
 type VersilianConfig = {
     instrument: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type VersilianOptions = Partial<VersilianConfig & DefaultPlayerConfig>;
 /**
@@ -368,7 +366,7 @@ declare class Versilian implements InternalPlayer {
     private config;
     constructor(context: BaseAudioContext, options?: VersilianOptions);
     get output(): OutputChannel;
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     get context(): BaseAudioContext;
     start(sample: SampleStart | string | number): (time?: number | undefined) => void;
     stop(sample?: SampleStop | string | number): void;
@@ -384,7 +382,7 @@ declare const NAME_TO_PATH: Record<string, string | undefined>;
 declare function getMellotronNames(): string[];
 type MellotronConfig = {
     instrument: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type MellotronOptions = Partial<MellotronConfig & DefaultPlayerConfig>;
 declare class Mellotron implements InternalPlayer {
@@ -394,7 +392,7 @@ declare class Mellotron implements InternalPlayer {
     private readonly group;
     readonly load: Promise<this>;
     constructor(context: BaseAudioContext, options: MellotronOptions);
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     get output(): OutputChannel;
     start(sample: SampleStart | string | number): (time?: number | undefined) => void;
     stop(sample?: SampleStop | string | number): void;
@@ -413,39 +411,10 @@ declare class Reverb {
     connect(output: AudioNode): void;
 }
 
-type SamplerConfig = {
-    storage?: Storage$1;
-    detune: number;
-    volume: number;
-    velocity: number;
-    decayTime?: number;
-    lpfCutoffHz?: number;
-    destination: AudioNode;
-    buffers: Record<string | number, string | AudioBuffers$1> | AudioBuffersLoader$1;
-    volumeToGain: (volume: number) => number;
-};
-/**
- * A Sampler instrument
- *
- * @private
- */
-declare class Sampler {
-    #private;
-    readonly context: AudioContext;
-    private readonly player;
-    readonly load: Promise<this>;
-    constructor(context: AudioContext, options?: Partial<SamplerConfig>);
-    loaded(): Promise<this>;
-    get output(): OutputChannel;
-    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
-    stop(sample?: SampleStop | string | number): void;
-    disconnect(): void;
-}
-
 declare function getSmolkenNames(): string[];
 type SmolkenConfig = {
     instrument: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type SmolkenOptions = Partial<SmolkenConfig & DefaultPlayerConfig>;
 declare class Smolken implements InternalPlayer {
@@ -456,7 +425,7 @@ declare class Smolken implements InternalPlayer {
     private seqNum;
     constructor(context: BaseAudioContext, options?: SmolkenOptions);
     get output(): OutputChannel;
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     get context(): BaseAudioContext;
     start(sample: SampleStart | string | number): (time?: number) => void;
     stop(sample?: SampleStop | string | number): void;
@@ -469,7 +438,7 @@ type SoundfontConfig = {
     kit: "FluidR3_GM" | "MusyngKite" | string;
     instrument?: string;
     instrumentUrl: string;
-    storage: Storage$1;
+    storage: Storage;
     extraGain: number;
     loadLoopData: boolean;
     loopDataUrl?: string;
@@ -496,7 +465,7 @@ declare class Soundfont {
  */
 type SplendidGrandPianoConfig = {
     baseUrl: string;
-    storage: Storage$1;
+    storage: Storage;
     detune: number;
     velocity: number;
     decayTime: number;
@@ -509,7 +478,7 @@ declare class SplendidGrandPiano {
     readonly load: Promise<this>;
     constructor(context: AudioContext, options?: Partial<SplendidGrandPianoConfig>);
     get output(): OutputChannel;
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     loaded(): Promise<this>;
     start(sampleOrNote: SampleStart | number | string): (time?: number | undefined) => void;
     stop(sample?: SampleStop | number | string): void;
@@ -526,4 +495,4 @@ declare const LAYERS: ({
     cutoff?: undefined;
 })[];
 
-export { CacheStorage, DrumMachine, DrumMachineOptions, ElectricPiano, HttpStorage, LAYERS, Mallet, Mellotron, MellotronConfig, MellotronOptions, NAME_TO_PATH, Reverb, Sampler, SamplerConfig, Smolken, SmolkenConfig, SmolkenOptions, Soundfont, SoundfontOptions, SplendidGrandPiano, SplendidGrandPianoConfig, Storage$1 as Storage, StorageResponse$1 as StorageResponse, VcslInstrumentLoader, Versilian, VersilianConfig, VersilianOptions, getDrumMachineNames, getElectricPianoNames, getMalletNames, getMellotronNames, getSmolkenNames, getSoundfontKits, getSoundfontNames, getVersilianInstruments };
+export { CacheStorage, DrumMachine, type DrumMachineOptions, ElectricPiano, HttpStorage, LAYERS, Mallet, Mellotron, type MellotronConfig, type MellotronOptions, NAME_TO_PATH, Reverb, Sampler, type SamplerConfig, Smolken, type SmolkenConfig, type SmolkenOptions, Soundfont, type SoundfontOptions, SplendidGrandPiano, type SplendidGrandPianoConfig, type Storage, type StorageResponse, VcslInstrumentLoader, Versilian, type VersilianConfig, type VersilianOptions, getDrumMachineNames, getElectricPianoNames, getMalletNames, getMellotronNames, getSmolkenNames, getSoundfontKits, getSoundfontNames, getVersilianInstruments };

package/dist/index.d.ts

@@ -27,28 +27,6 @@ declare class Channel {
     disconnect(): void;
 }
 
-type StorageResponse$1 = {
-    readonly status: number;
-    arrayBuffer(): Promise<ArrayBuffer>;
-    json(): Promise<any>;
-    text(): Promise<string>;
-};
-type Storage$1 = {
-    fetch: (url: string) => Promise<StorageResponse$1>;
-};
-declare const HttpStorage: Storage$1;
-declare class CacheStorage implements Storage$1 {
-    #private;
-    constructor(name?: string);
-    fetch(url: string): Promise<StorageResponse$1>;
-}
-
-type AudioBuffers$1 = Record<string | number, AudioBuffer | undefined>;
-/**
- * A function that downloads audio into a AudioBuffers
- */
-type AudioBuffersLoader$1 = (context: BaseAudioContext, buffers: AudioBuffers$1) => Promise<void>;
-
 type StorageResponse = {
     readonly status: number;
     arrayBuffer(): Promise<ArrayBuffer>;
@@ -58,6 +36,12 @@ type StorageResponse = {
 type Storage = {
     fetch: (url: string) => Promise<StorageResponse>;
 };
+declare const HttpStorage: Storage;
+declare class CacheStorage implements Storage {
+    #private;
+    constructor(name?: string);
+    fetch(url: string): Promise<StorageResponse>;
+}
 
 type AudioBuffers = Record<string | number, AudioBuffer | undefined>;
 /**
@@ -65,18 +49,6 @@ type AudioBuffers = Record<string | number, AudioBuffer | undefined>;
  */
 type AudioBuffersLoader = (context: BaseAudioContext, buffers: AudioBuffers) => Promise<void>;
 
-type SamplerConfig$1 = {
-    storage?: Storage;
-    detune: number;
-    volume: number;
-    velocity: number;
-    decayTime?: number;
-    lpfCutoffHz?: number;
-    destination: AudioNode;
-    buffers: Record<string | number, string | AudioBuffers> | AudioBuffersLoader;
-    volumeToGain: (volume: number) => number;
-};
-
 /**
  * A function to unsubscribe from an event or control
  */
@@ -94,7 +66,7 @@ type Subscribe<T> = (listener: Listener<T>) => Unsubscribe;
  * @private
  */
 type InternalPlayer = {
-    readonly buffers: AudioBuffers$1;
+    readonly buffers: AudioBuffers;
     readonly context: BaseAudioContext;
     start(sample: SampleStart): (time?: number) => void;
     stop(sample?: SampleStop): void;
@@ -214,6 +186,35 @@ type RegionGroup = {
     sample: Partial<SampleOptions>;
 };
 
+type SamplerConfig = {
+    storage?: Storage;
+    detune: number;
+    volume: number;
+    velocity: number;
+    decayTime?: number;
+    lpfCutoffHz?: number;
+    destination: AudioNode;
+    buffers: Record<string | number, string | AudioBuffers> | AudioBuffersLoader;
+    volumeToGain: (volume: number) => number;
+};
+/**
+ * A Sampler instrument
+ *
+ * @private
+ */
+declare class Sampler {
+    #private;
+    readonly context: AudioContext;
+    private readonly player;
+    readonly load: Promise<this>;
+    constructor(context: AudioContext, options?: Partial<SamplerConfig>);
+    loaded(): Promise<this>;
+    get output(): OutputChannel;
+    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
+    stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
+}
+
 type QueuedPlayerConfig = {
     scheduleLookaheadMs: number;
     scheduleIntervalMs: number;
@@ -221,13 +222,13 @@ type QueuedPlayerConfig = {
     onEnded?: (sample: SampleStart) => void;
 };
 
-type DefaultPlayerConfig = ChannelConfig & SamplerConfig$1 & QueuedPlayerConfig;
+type DefaultPlayerConfig = ChannelConfig & SamplerConfig & QueuedPlayerConfig;
 
 declare function getDrumMachineNames(): string[];
 type DrumMachineConfig = {
     instrument: string;
     url: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type DrumMachineOptions = Partial<DrumMachineConfig & DefaultPlayerConfig>;
 declare class DrumMachine {
@@ -312,23 +313,20 @@ type WebsfzRegion = {
     tune_oncc123?: number;
 };
 
-/**
- * Splendid Grand Piano options
- */
 type SfzSamplerConfig = {
     instrument: SfzInstrument | Websfz | string;
-    storage?: Storage$1;
+    storage: Storage;
     destination: AudioNode;
     volume: number;
     velocity: number;
     detune: number;
-    decayTime: number;
+    decayTime?: number;
     lpfCutoffHz?: number;
 };
 declare class SfzSampler {
     #private;
     readonly context: AudioContext;
-    readonly options: Readonly<Partial<SfzSamplerConfig>>;
+    readonly options: Readonly<SfzSamplerConfig>;
     private readonly player;
     readonly load: Promise<this>;
     constructor(context: AudioContext, options: Partial<SfzSamplerConfig & DefaultPlayerConfig> & Pick<SfzSamplerConfig, "instrument">);
@@ -350,10 +348,10 @@ declare class ElectricPiano extends SfzSampler {
 }
 
 declare function getVersilianInstruments(): Promise<string[]>;
-declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers$1, group: RegionGroup): (context: BaseAudioContext, storage: Storage$1) => Promise<void[]>;
+declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers, group: RegionGroup): (context: BaseAudioContext, storage: Storage) => Promise<void[]>;
 type VersilianConfig = {
     instrument: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type VersilianOptions = Partial<VersilianConfig & DefaultPlayerConfig>;
 /**
@@ -368,7 +366,7 @@ declare class Versilian implements InternalPlayer {
     private config;
     constructor(context: BaseAudioContext, options?: VersilianOptions);
     get output(): OutputChannel;
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     get context(): BaseAudioContext;
     start(sample: SampleStart | string | number): (time?: number | undefined) => void;
     stop(sample?: SampleStop | string | number): void;
@@ -384,7 +382,7 @@ declare const NAME_TO_PATH: Record<string, string | undefined>;
 declare function getMellotronNames(): string[];
 type MellotronConfig = {
     instrument: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type MellotronOptions = Partial<MellotronConfig & DefaultPlayerConfig>;
 declare class Mellotron implements InternalPlayer {
@@ -394,7 +392,7 @@ declare class Mellotron implements InternalPlayer {
     private readonly group;
     readonly load: Promise<this>;
     constructor(context: BaseAudioContext, options: MellotronOptions);
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     get output(): OutputChannel;
     start(sample: SampleStart | string | number): (time?: number | undefined) => void;
     stop(sample?: SampleStop | string | number): void;
@@ -413,39 +411,10 @@ declare class Reverb {
     connect(output: AudioNode): void;
 }
 
-type SamplerConfig = {
-    storage?: Storage$1;
-    detune: number;
-    volume: number;
-    velocity: number;
-    decayTime?: number;
-    lpfCutoffHz?: number;
-    destination: AudioNode;
-    buffers: Record<string | number, string | AudioBuffers$1> | AudioBuffersLoader$1;
-    volumeToGain: (volume: number) => number;
-};
-/**
- * A Sampler instrument
- *
- * @private
- */
-declare class Sampler {
-    #private;
-    readonly context: AudioContext;
-    private readonly player;
-    readonly load: Promise<this>;
-    constructor(context: AudioContext, options?: Partial<SamplerConfig>);
-    loaded(): Promise<this>;
-    get output(): OutputChannel;
-    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
-    stop(sample?: SampleStop | string | number): void;
-    disconnect(): void;
-}
-
 declare function getSmolkenNames(): string[];
 type SmolkenConfig = {
     instrument: string;
-    storage: Storage$1;
+    storage: Storage;
 };
 type SmolkenOptions = Partial<SmolkenConfig & DefaultPlayerConfig>;
 declare class Smolken implements InternalPlayer {
@@ -456,7 +425,7 @@ declare class Smolken implements InternalPlayer {
     private seqNum;
     constructor(context: BaseAudioContext, options?: SmolkenOptions);
     get output(): OutputChannel;
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     get context(): BaseAudioContext;
     start(sample: SampleStart | string | number): (time?: number) => void;
     stop(sample?: SampleStop | string | number): void;
@@ -469,7 +438,7 @@ type SoundfontConfig = {
     kit: "FluidR3_GM" | "MusyngKite" | string;
     instrument?: string;
     instrumentUrl: string;
-    storage: Storage$1;
+    storage: Storage;
     extraGain: number;
     loadLoopData: boolean;
     loopDataUrl?: string;
@@ -496,7 +465,7 @@ declare class Soundfont {
  */
 type SplendidGrandPianoConfig = {
     baseUrl: string;
-    storage: Storage$1;
+    storage: Storage;
     detune: number;
     velocity: number;
     decayTime: number;
@@ -509,7 +478,7 @@ declare class SplendidGrandPiano {
     readonly load: Promise<this>;
     constructor(context: AudioContext, options?: Partial<SplendidGrandPianoConfig>);
     get output(): OutputChannel;
-    get buffers(): AudioBuffers$1;
+    get buffers(): AudioBuffers;
     loaded(): Promise<this>;
     start(sampleOrNote: SampleStart | number | string): (time?: number | undefined) => void;
     stop(sample?: SampleStop | number | string): void;
@@ -526,4 +495,4 @@ declare const LAYERS: ({
     cutoff?: undefined;
 })[];
 
-export { CacheStorage, DrumMachine, DrumMachineOptions, ElectricPiano, HttpStorage, LAYERS, Mallet, Mellotron, MellotronConfig, MellotronOptions, NAME_TO_PATH, Reverb, Sampler, SamplerConfig, Smolken, SmolkenConfig, SmolkenOptions, Soundfont, SoundfontOptions, SplendidGrandPiano, SplendidGrandPianoConfig, Storage$1 as Storage, StorageResponse$1 as StorageResponse, VcslInstrumentLoader, Versilian, VersilianConfig, VersilianOptions, getDrumMachineNames, getElectricPianoNames, getMalletNames, getMellotronNames, getSmolkenNames, getSoundfontKits, getSoundfontNames, getVersilianInstruments };
+export { CacheStorage, DrumMachine, type DrumMachineOptions, ElectricPiano, HttpStorage, LAYERS, Mallet, Mellotron, type MellotronConfig, type MellotronOptions, NAME_TO_PATH, Reverb, Sampler, type SamplerConfig, Smolken, type SmolkenConfig, type SmolkenOptions, Soundfont, type SoundfontOptions, SplendidGrandPiano, type SplendidGrandPianoConfig, type Storage, type StorageResponse, VcslInstrumentLoader, Versilian, type VersilianConfig, type VersilianOptions, getDrumMachineNames, getElectricPianoNames, getMalletNames, getMellotronNames, getSmolkenNames, getSoundfontKits, getSoundfontNames, getVersilianInstruments };