smplr 0.13.4 → 0.15.0

package/README.md

@@ -121,6 +121,7 @@ All instruments share some configuration options that are passed as second argum
 - `volume`: A number from 0 to 127 representing the instrument global volume. 100 by default
 - `destination`: An `AudioNode` that is the output of the instrument. `AudioContext.destination` is used by default
 - `volumeToGain`: a function to convert the volume to gain. It uses MIDI standard as default.
+- `disableScheduler`: disable internal scheduler. `false` by default.
 - `scheduleLookaheadMs`: the lookahead of the scheduler. If the start time of the note is less than current time plus this lookahead time, the note will be started. 200ms by default.
 - `scheduleIntervalMs`: the interval of the scheduler. 50ms by default.
 - `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.
@@ -498,9 +499,34 @@ import { Versilian, getVersilianInstruments } from "smplr";
 const instrumentNames = await getVersilianInstruments();
 
 const context = new AudioContext();
-const sampler = new Versilian(context, { instrument: instrumentNAmes[0] });
+const sampler = new Versilian(context, { instrument: instrumentNames[0] });
 ```
 
+### Soundfont2Sampler
+
+Sampler capable of reading .sf2 files directly:
+
+```ts
+import { Soundfont2Sampler } from "smplr";
+import { SoundFont2 } from "soundfont2";
+
+const context = new AudioContext();
+const sampler = new Soundfont2Sampler(context, {
+  url: "https://smpldsnds.github.io/soundfonts/soundfonts/galaxy-electric-pianos.sf2",
+  createSoundfont: (data) => new SoundFont2(data),
+});
+
+sampler.load.then(() => {
+  // list all available instruments for the soundfont
+  console.log(sampler.instrumentNames);
+
+  // load the first available instrument
+  sampler.loadInstrument(sampler.instrumentNames[0]);
+});
+```
+
+Still limited support. API may vary.
+
 ## License
 
 MIT License

package/dist/index.d.mts

@@ -1,32 +1,3 @@
-type AudioInsert = {
-    input: AudioNode;
-    output: AudioNode;
-};
-
-type ChannelConfig = {
-    destination: AudioNode;
-    volume: number;
-    volumeToGain: (volume: number) => number;
-};
-type OutputChannel = Omit<Channel, "input">;
-/**
- * An output channel with audio effects
- * @private
- */
-declare class Channel {
-    #private;
-    readonly context: BaseAudioContext;
-    readonly setVolume: (vol: number) => void;
-    readonly input: AudioNode;
-    constructor(context: BaseAudioContext, options?: Partial<ChannelConfig>);
-    addInsert(effect: AudioNode | AudioInsert): void;
-    addEffect(name: string, effect: AudioNode | {
-        input: AudioNode;
-    }, mixValue: number): void;
-    sendEffect(name: string, mix: number): void;
-    disconnect(): void;
-}
-
 type StorageResponse = {
     readonly status: number;
     arrayBuffer(): Promise<ArrayBuffer>;
@@ -62,13 +33,14 @@ type Listener<T> = (value: T) => void;
  */
 type Subscribe<T> = (listener: Listener<T>) => Unsubscribe;
 
+type StopFn = (time?: number) => void;
 /**
  * @private
  */
 type InternalPlayer = {
     readonly buffers: AudioBuffers;
     readonly context: BaseAudioContext;
-    start(sample: SampleStart): (time?: number) => void;
+    start(sample: SampleStart): StopFn;
     stop(sample?: SampleStop): void;
     disconnect(): void;
 };
@@ -195,8 +167,40 @@ type SampleRegion = {
 };
 type RegionGroup = {
     regions: SampleRegion[];
-    sample: Partial<SampleOptions>;
 };
+type SamplerInstrument = {
+    groups: RegionGroup[];
+    options: Partial<SampleOptions>;
+};
+
+type AudioInsert = {
+    input: AudioNode;
+    output: AudioNode;
+};
+
+type ChannelConfig = {
+    destination: AudioNode;
+    volume: number;
+    volumeToGain: (volume: number) => number;
+};
+type OutputChannel = Omit<Channel, "input">;
+/**
+ * An output channel with audio effects
+ * @private
+ */
+declare class Channel {
+    #private;
+    readonly context: BaseAudioContext;
+    readonly setVolume: (vol: number) => void;
+    readonly input: AudioNode;
+    constructor(context: BaseAudioContext, options?: Partial<ChannelConfig>);
+    addInsert(effect: AudioNode | AudioInsert): void;
+    addEffect(name: string, effect: AudioNode | {
+        input: AudioNode;
+    }, mixValue: number): void;
+    sendEffect(name: string, mix: number): void;
+    disconnect(): void;
+}
 
 type SamplerConfig = {
     storage?: Storage;
@@ -222,7 +226,7 @@ declare class Sampler {
     constructor(context: AudioContext, options?: Partial<SamplerConfig>);
     loaded(): Promise<this>;
     get output(): OutputChannel;
-    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
+    start(sample: SampleStart | string | number): StopFn;
     stop(sample?: SampleStop | string | number): void;
     disconnect(): void;
 }
@@ -261,7 +265,7 @@ declare class DrumMachine {
     loaded(): Promise<this>;
     get sampleNames(): string[];
     getVariations(name: string): string[];
-    start(sample: SampleStart): (time?: number | undefined) => void;
+    start(sample: SampleStart): StopFn;
     stop(sample: SampleStop): void;
 }
 
@@ -369,7 +373,7 @@ declare class ElectricPiano extends SfzSampler {
 }
 
 declare function getVersilianInstruments(): Promise<string[]>;
-declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers, group: RegionGroup): (context: BaseAudioContext, storage: Storage) => Promise<void[]>;
+declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers): (context: BaseAudioContext, storage: Storage) => Promise<RegionGroup>;
 type VersilianConfig = {
     instrument: string;
     storage: Storage;
@@ -408,6 +412,7 @@ type MellotronConfig = {
 type MellotronOptions = Partial<MellotronConfig & DefaultPlayerConfig>;
 declare class Mellotron implements InternalPlayer {
     readonly context: BaseAudioContext;
+    private readonly options;
     private readonly config;
     private readonly player;
     private readonly group;
@@ -415,7 +420,7 @@ declare class Mellotron implements InternalPlayer {
     constructor(context: BaseAudioContext, options: MellotronOptions);
     get buffers(): AudioBuffers;
     get output(): OutputChannel;
-    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
+    start(sample: SampleStart | string | number): StopFn;
     stop(sample?: SampleStop | string | number): void;
     disconnect(): void;
 }
@@ -477,8 +482,75 @@ declare class Soundfont {
     get hasLoops(): boolean;
     loaded(): Promise<this>;
     disconnect(): void;
+    start(sample: SampleStart | string | number): StopFn;
+    stop(sample?: SampleStop | string | number): void;
+}
+
+type RegionPlayerOptions = ChannelConfig & SampleOptions & QueuedPlayerConfig;
+/**
+ * A player with an channel output and a region group to read samples info from
+ * @private
+ */
+declare class RegionPlayer implements InternalPlayer {
+    readonly context: BaseAudioContext;
+    readonly output: OutputChannel;
+    instrument: SamplerInstrument;
+    private readonly player;
+    private seqNum;
+    constructor(context: BaseAudioContext, options: Partial<RegionPlayerOptions>);
+    get buffers(): AudioBuffers;
+    start(sample: SampleStart | string | number): (time?: number) => void;
+    stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
+}
+
+type Sf2 = {
+    instruments: Sf2Instrument[];
+};
+type Sf2Instrument = {
+    header: {
+        name: string;
+    };
+    zones: Sf2Zone[];
+};
+type Sf2Zone = {
+    sample: Sf2Sample;
+    keyRange?: {
+        lo: number;
+        hi: number;
+    };
+};
+type Sf2Sample = {
+    data: Int16Array;
+    header: {
+        name: string;
+        sampleRate: number;
+        originalPitch: number;
+        pitchCorrection: number;
+        start: number;
+        end: number;
+        startLoop: number;
+        endLoop: number;
+    };
+};
+type Soundfont2Options = Partial<RegionPlayerOptions> & {
+    url: string;
+    createSoundfont: (data: Uint8Array) => Sf2;
+};
+declare class Soundfont2Sampler {
+    #private;
+    readonly context: AudioContext;
+    readonly options: Soundfont2Options;
+    player: RegionPlayer;
+    soundfont: Sf2 | undefined;
+    load: Promise<this>;
+    constructor(context: AudioContext, options: Soundfont2Options);
+    get instrumentNames(): string[];
+    loadInstrument(instrumentName: string): (AudioBuffers | SamplerInstrument)[] | undefined;
+    get output(): OutputChannel;
     start(sample: SampleStart | string | number): (time?: number | undefined) => void;
     stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
 }
 
 /**
@@ -505,7 +577,7 @@ declare class SplendidGrandPiano {
     get output(): OutputChannel;
     get buffers(): AudioBuffers;
     loaded(): Promise<this>;
-    start(sampleOrNote: SampleStart | number | string): (time?: number | undefined) => void;
+    start(sampleOrNote: SampleStart | number | string): StopFn;
     stop(sample?: SampleStop | number | string): void;
 }
 declare const LAYERS: ({
@@ -520,4 +592,4 @@ declare const LAYERS: ({
     cutoff?: undefined;
 })[];
 
-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 };
+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 Soundfont2Options, Soundfont2Sampler, 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

@@ -1,32 +1,3 @@
-type AudioInsert = {
-    input: AudioNode;
-    output: AudioNode;
-};
-
-type ChannelConfig = {
-    destination: AudioNode;
-    volume: number;
-    volumeToGain: (volume: number) => number;
-};
-type OutputChannel = Omit<Channel, "input">;
-/**
- * An output channel with audio effects
- * @private
- */
-declare class Channel {
-    #private;
-    readonly context: BaseAudioContext;
-    readonly setVolume: (vol: number) => void;
-    readonly input: AudioNode;
-    constructor(context: BaseAudioContext, options?: Partial<ChannelConfig>);
-    addInsert(effect: AudioNode | AudioInsert): void;
-    addEffect(name: string, effect: AudioNode | {
-        input: AudioNode;
-    }, mixValue: number): void;
-    sendEffect(name: string, mix: number): void;
-    disconnect(): void;
-}
-
 type StorageResponse = {
     readonly status: number;
     arrayBuffer(): Promise<ArrayBuffer>;
@@ -62,13 +33,14 @@ type Listener<T> = (value: T) => void;
  */
 type Subscribe<T> = (listener: Listener<T>) => Unsubscribe;
 
+type StopFn = (time?: number) => void;
 /**
  * @private
  */
 type InternalPlayer = {
     readonly buffers: AudioBuffers;
     readonly context: BaseAudioContext;
-    start(sample: SampleStart): (time?: number) => void;
+    start(sample: SampleStart): StopFn;
     stop(sample?: SampleStop): void;
     disconnect(): void;
 };
@@ -195,8 +167,40 @@ type SampleRegion = {
 };
 type RegionGroup = {
     regions: SampleRegion[];
-    sample: Partial<SampleOptions>;
 };
+type SamplerInstrument = {
+    groups: RegionGroup[];
+    options: Partial<SampleOptions>;
+};
+
+type AudioInsert = {
+    input: AudioNode;
+    output: AudioNode;
+};
+
+type ChannelConfig = {
+    destination: AudioNode;
+    volume: number;
+    volumeToGain: (volume: number) => number;
+};
+type OutputChannel = Omit<Channel, "input">;
+/**
+ * An output channel with audio effects
+ * @private
+ */
+declare class Channel {
+    #private;
+    readonly context: BaseAudioContext;
+    readonly setVolume: (vol: number) => void;
+    readonly input: AudioNode;
+    constructor(context: BaseAudioContext, options?: Partial<ChannelConfig>);
+    addInsert(effect: AudioNode | AudioInsert): void;
+    addEffect(name: string, effect: AudioNode | {
+        input: AudioNode;
+    }, mixValue: number): void;
+    sendEffect(name: string, mix: number): void;
+    disconnect(): void;
+}
 
 type SamplerConfig = {
     storage?: Storage;
@@ -222,7 +226,7 @@ declare class Sampler {
     constructor(context: AudioContext, options?: Partial<SamplerConfig>);
     loaded(): Promise<this>;
     get output(): OutputChannel;
-    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
+    start(sample: SampleStart | string | number): StopFn;
     stop(sample?: SampleStop | string | number): void;
     disconnect(): void;
 }
@@ -261,7 +265,7 @@ declare class DrumMachine {
     loaded(): Promise<this>;
     get sampleNames(): string[];
     getVariations(name: string): string[];
-    start(sample: SampleStart): (time?: number | undefined) => void;
+    start(sample: SampleStart): StopFn;
     stop(sample: SampleStop): void;
 }
 
@@ -369,7 +373,7 @@ declare class ElectricPiano extends SfzSampler {
 }
 
 declare function getVersilianInstruments(): Promise<string[]>;
-declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers, group: RegionGroup): (context: BaseAudioContext, storage: Storage) => Promise<void[]>;
+declare function VcslInstrumentLoader(instrument: string, buffers: AudioBuffers): (context: BaseAudioContext, storage: Storage) => Promise<RegionGroup>;
 type VersilianConfig = {
     instrument: string;
     storage: Storage;
@@ -408,6 +412,7 @@ type MellotronConfig = {
 type MellotronOptions = Partial<MellotronConfig & DefaultPlayerConfig>;
 declare class Mellotron implements InternalPlayer {
     readonly context: BaseAudioContext;
+    private readonly options;
     private readonly config;
     private readonly player;
     private readonly group;
@@ -415,7 +420,7 @@ declare class Mellotron implements InternalPlayer {
     constructor(context: BaseAudioContext, options: MellotronOptions);
     get buffers(): AudioBuffers;
     get output(): OutputChannel;
-    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
+    start(sample: SampleStart | string | number): StopFn;
     stop(sample?: SampleStop | string | number): void;
     disconnect(): void;
 }
@@ -477,8 +482,75 @@ declare class Soundfont {
     get hasLoops(): boolean;
     loaded(): Promise<this>;
     disconnect(): void;
+    start(sample: SampleStart | string | number): StopFn;
+    stop(sample?: SampleStop | string | number): void;
+}
+
+type RegionPlayerOptions = ChannelConfig & SampleOptions & QueuedPlayerConfig;
+/**
+ * A player with an channel output and a region group to read samples info from
+ * @private
+ */
+declare class RegionPlayer implements InternalPlayer {
+    readonly context: BaseAudioContext;
+    readonly output: OutputChannel;
+    instrument: SamplerInstrument;
+    private readonly player;
+    private seqNum;
+    constructor(context: BaseAudioContext, options: Partial<RegionPlayerOptions>);
+    get buffers(): AudioBuffers;
+    start(sample: SampleStart | string | number): (time?: number) => void;
+    stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
+}
+
+type Sf2 = {
+    instruments: Sf2Instrument[];
+};
+type Sf2Instrument = {
+    header: {
+        name: string;
+    };
+    zones: Sf2Zone[];
+};
+type Sf2Zone = {
+    sample: Sf2Sample;
+    keyRange?: {
+        lo: number;
+        hi: number;
+    };
+};
+type Sf2Sample = {
+    data: Int16Array;
+    header: {
+        name: string;
+        sampleRate: number;
+        originalPitch: number;
+        pitchCorrection: number;
+        start: number;
+        end: number;
+        startLoop: number;
+        endLoop: number;
+    };
+};
+type Soundfont2Options = Partial<RegionPlayerOptions> & {
+    url: string;
+    createSoundfont: (data: Uint8Array) => Sf2;
+};
+declare class Soundfont2Sampler {
+    #private;
+    readonly context: AudioContext;
+    readonly options: Soundfont2Options;
+    player: RegionPlayer;
+    soundfont: Sf2 | undefined;
+    load: Promise<this>;
+    constructor(context: AudioContext, options: Soundfont2Options);
+    get instrumentNames(): string[];
+    loadInstrument(instrumentName: string): (AudioBuffers | SamplerInstrument)[] | undefined;
+    get output(): OutputChannel;
     start(sample: SampleStart | string | number): (time?: number | undefined) => void;
     stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
 }
 
 /**
@@ -505,7 +577,7 @@ declare class SplendidGrandPiano {
     get output(): OutputChannel;
     get buffers(): AudioBuffers;
     loaded(): Promise<this>;
-    start(sampleOrNote: SampleStart | number | string): (time?: number | undefined) => void;
+    start(sampleOrNote: SampleStart | number | string): StopFn;
     stop(sample?: SampleStop | number | string): void;
 }
 declare const LAYERS: ({
@@ -520,4 +592,4 @@ declare const LAYERS: ({
     cutoff?: undefined;
 })[];
 
-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 };
+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 Soundfont2Options, Soundfont2Sampler, type SoundfontOptions, SplendidGrandPiano, type SplendidGrandPianoConfig, type Storage, type StorageResponse, VcslInstrumentLoader, Versilian, type VersilianConfig, type VersilianOptions, getDrumMachineNames, getElectricPianoNames, getMalletNames, getMellotronNames, getSmolkenNames, getSoundfontKits, getSoundfontNames, getVersilianInstruments };