smplr 0.11.2 → 0.12.0

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
@@ -350,6 +371,30 @@ const piano = new SplendidGrandPiano(new AudioContext());
 piano.start({ note: "C4" });
 ```
 
+#### SplendidGrandPiano constructor
+
+The second argument of the constructor accepts the following options:
+
+- `baseUrl`:
+- `detune`: global detune in cents (0 if not specified)
+- `velocity`: default velocity (100 if not specified)
+- `volume`: default volume (100 if not specified)
+- `decayTime`: default decay time (0.5 seconds)
+- `notesToLoad`: an object with the following shape: `{ notes: number[], velocityRange: [number, number]}` to specify a subset of notes to load
+
+Example:
+
+```ts
+const piano = new SplendidGrandPiano(context, {
+  detune: -20,
+  volume: 80,
+  notesToLoad: {
+    notes: [60],
+    velocityRange: [1, 127],
+  },
+});
+```
+
 ### Electric Piano
 
 A sampled electric pianos. Samples from https://github.com/sfzinstruments/GregSullivan.E-Pianos

package/dist/index.d.mts

@@ -49,34 +49,6 @@ type AudioBuffers = Record<string | number, AudioBuffer | undefined>;
  */
 type AudioBuffersLoader = (context: BaseAudioContext, buffers: AudioBuffers) => Promise<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>;
-};
-
-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 SamplerConfig$1 = {
-    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 function to unsubscribe from an event or control
  */
@@ -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,7 +222,7 @@ type QueuedPlayerConfig = {
     onEnded?: (sample: SampleStart) => void;
 };
 
-type DefaultPlayerConfig = ChannelConfig & SamplerConfig$1 & QueuedPlayerConfig;
+type DefaultPlayerConfig = ChannelConfig & SamplerConfig & QueuedPlayerConfig;
 
 declare function getDrumMachineNames(): string[];
 type DrumMachineConfig = {
@@ -410,35 +411,6 @@ declare class Reverb {
     connect(output: AudioNode): void;
 }
 
-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;
-}
-
 declare function getSmolkenNames(): string[];
 type SmolkenConfig = {
     instrument: string;
@@ -523,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, 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

@@ -49,34 +49,6 @@ type AudioBuffers = Record<string | number, AudioBuffer | undefined>;
  */
 type AudioBuffersLoader = (context: BaseAudioContext, buffers: AudioBuffers) => Promise<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>;
-};
-
-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 SamplerConfig$1 = {
-    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 function to unsubscribe from an event or control
  */
@@ -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,7 +222,7 @@ type QueuedPlayerConfig = {
     onEnded?: (sample: SampleStart) => void;
 };
 
-type DefaultPlayerConfig = ChannelConfig & SamplerConfig$1 & QueuedPlayerConfig;
+type DefaultPlayerConfig = ChannelConfig & SamplerConfig & QueuedPlayerConfig;
 
 declare function getDrumMachineNames(): string[];
 type DrumMachineConfig = {
@@ -410,35 +411,6 @@ declare class Reverb {
     connect(output: AudioNode): void;
 }
 
-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;
-}
-
 declare function getSmolkenNames(): string[];
 type SmolkenConfig = {
     instrument: string;
@@ -523,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, 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.js

@@ -226,7 +226,7 @@ var Channel = class {
     if (__privateGet(this, _disconnected)) {
       throw Error("Can't add effect to disconnected channel");
     }
-    const mix = new GainNode(this.context);
+    const mix = this.context.createGain();
     mix.gain.value = mixValue;
     const input = "input" in effect ? effect.input : effect;
     const disconnect = connectSerial([__privateGet(this, _volume), mix, input]);
@@ -446,12 +446,18 @@ var SamplePlayer = class {
     }
     const source = context.createBufferSource();
     source.buffer = buffer;
-    source.detune.value = (_b = (_a = sample.detune) != null ? _a : this.options.detune) != null ? _b : 0;
+    const cents = (_b = (_a = sample.detune) != null ? _a : this.options.detune) != null ? _b : 0;
+    if (source.detune) {
+      source.detune.value = cents;
+    } else if (source.playbackRate) {
+      source.playbackRate.value = Math.pow(2, cents / 1200);
+    }
     const lpfCutoffHz = (_c = sample.lpfCutoffHz) != null ? _c : this.options.lpfCutoffHz;
-    const lpf = lpfCutoffHz ? new BiquadFilterNode(context, {
-      type: "lowpass",
-      frequency: sample.lpfCutoffHz
-    }) : void 0;
+    const lpf = lpfCutoffHz ? context.createBiquadFilter() : void 0;
+    if (lpfCutoffHz && lpf) {
+      lpf.type = "lowpass";
+      lpf.frequency.value = lpfCutoffHz;
+    }
     const volume = context.createGain();
     const velocity = (_e = (_d = sample.velocity) != null ? _d : this.options.velocity) != null ? _e : 100;
     volume.gain.value = __privateGet(this, _config3).velocityToGain(velocity);
@@ -472,7 +478,10 @@ var SamplePlayer = class {
         source.stop(stopAt);
       }
     }
-    const gainCompensation = sample.gainOffset ? new GainNode(context, { gain: sample.gainOffset }) : void 0;
+    const gainCompensation = sample.gainOffset ? context.createGain() : void 0;
+    if (gainCompensation && sample.gainOffset) {
+      gainCompensation.gain.value = sample.gainOffset;
+    }
     const stopId = (_j = sample.stopId) != null ? _j : sample.note;
     const cleanup = unsubscribeAll([
       connectSerial([
@@ -525,7 +534,8 @@ _disconnected2 = new WeakMap();
 _stop = new WeakMap();
 function createDecayEnvelope(context, envelopeTime = 0.2) {
   let stopAt = 0;
-  const envelope = new GainNode(context, { gain: 1 });
+  const envelope = context.createGain();
+  envelope.gain.value = 1;
   function start(time) {
     if (stopAt)
       return stopAt;
@@ -992,26 +1002,26 @@ startLayers_fn = function(sample) {
 
 // src/tremolo.ts
 function createTremolo(context, depth) {
-  const input = new GainNode(context);
-  const output = new GainNode(context);
+  const input = context.createGain();
+  const output = context.createGain();
   input.channelCount = 2;
   input.channelCountMode = "explicit";
   const splitter = new ChannelSplitterNode(context, { numberOfOutputs: 2 });
-  const ampL = new GainNode(context);
-  const ampR = new GainNode(context);
+  const ampL = context.createGain();
+  const ampR = context.createGain();
   const merger = new ChannelMergerNode(context, { numberOfInputs: 2 });
   const lfoL = new OscillatorNode(context, {
     type: "sine",
     frequency: 1
   });
   lfoL.start();
-  const lfoLAmp = new GainNode(context);
+  const lfoLAmp = context.createGain();
   const lfoR = new OscillatorNode(context, {
     type: "sine",
     frequency: 1.1
   });
   lfoR.start();
-  const lfoRAmp = new GainNode(context);
+  const lfoRAmp = context.createGain();
   input.connect(splitter);
   splitter.connect(ampL, 0);
   splitter.connect(ampR, 1);
@@ -2041,7 +2051,8 @@ var Soundfont = class {
       __privateSet(this, _hasLoops, hasLoops);
       return this;
     });
-    const gain = new GainNode(context, { gain: this.config.extraGain });
+    const gain = context.createGain();
+    gain.gain.value = this.config.extraGain;
     this.player.output.addInsert(gain);
   }
   get output() {