smplr 0.8.1 → 0.10.0

package/README.md

@@ -280,7 +280,7 @@ Bear in mind that currently that feature produces click on lot of instruments.
 
 ### Piano
 
-A sampled acoustic piano. It uses Steinway samples with 4 velocity layers from
+A sampled acoustic piano. It uses Steinway samples with 4 velocity groups from
 [SplendidGrandPiano](https://github.com/sfzinstruments/SplendidGrandPiano)
 
 ```js
@@ -364,6 +364,38 @@ drums.getVariations("kick").forEach((variation, index) => {
 });
 ```
 
+### Smolken double bass
+
+```js
+import { Smolken, getSmolkenNames } from "smplr";
+
+const instruments = getSmolkenNames(); // => Arco, Pizzicato & Switched
+
+// Create an instrument
+const context = new AudioContext();
+const doubleBass = await new Smolken(context, { instrument: "Arco" }).load;
+```
+
+### Versilian
+
+Versilian is a sample capable of using the [Versilian Community Sample Library](https://github.com/sgossner/VCSL).
+
+⚠️ Not all features are implemented. Some instruments may sound incorrect ⚠️
+
+```js
+import { Versilian, getVersilianInstruments } from "smplr";
+
+// getVersilianInstruments returns a Promise
+const instrumentNames = await getVersilianInstruments();
+
+const context = new AudioContext();
+const sampler = new Versilian(context, { instrument: instrumentNAmes[0] });
+```
+
 ## License
 
 MIT License
+
+```
+
+```

package/dist/index.d.ts

@@ -85,6 +85,7 @@ type SampleOptions = {
     loop?: boolean;
     loopStart?: number;
     loopEnd?: number;
+    gainOffset?: number;
 };
 type SampleStart = {
     name?: string;
@@ -94,16 +95,92 @@ type SampleStart = {
     stopId?: string | number;
     time?: number;
 } & SampleOptions;
+/**
+ * Heavily inspired by SFZ format
+ */
 type SampleRegion = {
     sampleName: string;
-    sampleCenter: number;
-    rangeMidi?: [number, number];
-    rangeVol?: [number, number];
-    offsetVol?: number;
-    offsetDetune?: number;
+    /**
+     * This specifies the MIDI key number that corresponds to the sample's original pitch
+     */
+    midiPitch: number;
+    /**
+     * This defines the lowest MIDI key number that will trigger this sample.
+     */
+    midiLow?: number;
+    /**
+     * This specifies the highest MIDI key number that will trigger this sample.
+     */
+    midiHigh?: number;
+    velLow?: number;
+    /**
+     * This determines the highest MIDI velocity at which this sample will be triggered.
+     */
+    velHigh?: number;
+    /**
+     * These define the pitch bend range for the samples in this group. The values are given in cents
+     */
+    bendUp?: number;
+    bendDown?: number;
+    /**
+     * Velocity-based amplitude scaling. [Vel, Gain] tells the sampler to play the sample
+     * at volume Gain when the note's velocity is Vel
+     */
+    ampVelCurve?: [number, number];
+    /**
+     * Amplitude envelope release time in seconds.
+     * Stored here for convenience (flatness) but needs to be
+     * copied inside sample options before playback
+     */
+    ampRelease?: number;
+    /**
+     * Attack time in seconds. Currently not implemented
+     *
+     * @see http://sfzformat.com/opcodes/amp_attack.html
+     */
+    ampAttack?: number;
+    /**
+     * seqLength defines how many samples are in the sequence.
+     * When using the seqPosition and seqLength , you can set up round-robin
+     * or sequential sample playback.
+     */
+    seqLength?: number;
+    /**
+     * Determine the position of this particular sample within the sequence
+     * 1 means first element of the sequence (not zero based!)
+     */
+    seqPosition?: number;
+    /**
+     * This assigns the group to a specific number.
+     * Group numbers can be used in combination with groupOffBy to implement
+     * exclusive groups, where playing one sample can stop another sample from playing.
+     */
+    group?: number;
+    /**
+     * Triggering a sample in this region will stop (or "turn off") any samples
+     * currently playing in the specified group number
+     */
+    groupOffBy?: number;
+    /**
+     * Start offset (in samples). Not implemented (yet)
+     */
+    offset?: number;
+    /**
+     * Adjust the playback pitch of a sample (in semitones)
+     */
+    tune?: number;
+    /**
+     * The volume opcode in SFZ defines the default playback volume for a given region.
+     * It specifies an adjustment to the sample's original amplitude.
+     * The unit for the volume opcode is decibels (dB).
+     */
+    volume?: number;
+    /**
+     * sample options for this particular region
+     */
     sample?: Partial<SampleOptions>;
 };
-type SampleLayer = {
+type RegionGroup = {
     regions: SampleRegion[];
     sample: Partial<SampleOptions>;
 };
@@ -232,11 +309,35 @@ 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[]>;
+type VersilianConfig = {
+    instrument: string;
+    storage: Storage;
+};
+type VersilianOptions = Partial<VersilianConfig & SampleOptions & ChannelOptions>;
+/**
+ * Versilian
+ *
+ * The Versilian Community Sample Library is an open CC0 general-purpose sample library created by Versilian Studios LLC
+ * for the purpose of introducing a set of quality, publicly available samples suitable for use in software and media of all kinds.
+ */
+declare class Versilian implements InternalPlayer {
+    private readonly player;
+    readonly load: Promise<this>;
+    private config;
+    constructor(context: BaseAudioContext, options?: VersilianOptions);
+    get output(): OutputChannel;
+    get buffers(): AudioBuffers;
+    get context(): BaseAudioContext;
+    start(sample: SampleStart | string | number): (time?: number | undefined) => void;
+    stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
+}
+
 declare function getMalletNames(): string[];
-declare class Mallet extends SfzSampler {
-    constructor(context: AudioContext, options: Partial<SfzSamplerConfig> & {
-        instrument: string;
-    });
+declare class Mallet extends Versilian {
+    constructor(context: AudioContext, options: VersilianOptions);
 }
 declare const NAME_TO_PATH: Record<string, string | undefined>;
 
@@ -250,7 +351,7 @@ declare class Mellotron implements InternalPlayer {
     readonly context: BaseAudioContext;
     private readonly config;
     private readonly player;
-    private readonly layer;
+    private readonly group;
     readonly load: Promise<this>;
     constructor(context: BaseAudioContext, options: MellotronOptions);
     get buffers(): AudioBuffers;
@@ -301,6 +402,27 @@ declare class Sampler {
     disconnect(): void;
 }
 
+declare function getSmolkenNames(): string[];
+type SmolkenConfig = {
+    instrument: string;
+    storage: Storage;
+};
+type SmolkenOptions = Partial<SmolkenConfig & SampleOptions & ChannelOptions>;
+declare class Smolken implements InternalPlayer {
+    private readonly player;
+    private readonly group;
+    readonly load: Promise<this>;
+    private config;
+    private seqNum;
+    constructor(context: BaseAudioContext, options?: SmolkenOptions);
+    get output(): OutputChannel;
+    get buffers(): AudioBuffers;
+    get context(): BaseAudioContext;
+    start(sample: SampleStart | string | number): (time?: number) => void;
+    stop(sample?: SampleStop | string | number): void;
+    disconnect(): void;
+}
+
 declare function getSoundfontKits(): string[];
 declare function getSoundfontNames(): string[];
 type SoundfontConfig = {
@@ -319,7 +441,7 @@ declare class Soundfont {
     readonly config: Readonly<SoundfontConfig>;
     private readonly player;
     readonly load: Promise<this>;
-    readonly layer: SampleLayer;
+    readonly group: RegionGroup;
     constructor(context: AudioContext, options: SoundfontOptions);
     get output(): OutputChannel;
     get hasLoops(): boolean;
@@ -367,4 +489,4 @@ declare const LAYERS: ({
     cutoff?: undefined;
 })[];
 
-export { CacheStorage, DrumMachine, DrumMachineConfig, ElectricPiano, HttpStorage, LAYERS, Mallet, Mellotron, MellotronConfig, MellotronOptions, NAME_TO_PATH, Reverb, Sampler, SamplerConfig, Soundfont, SoundfontOptions, SplendidGrandPiano, SplendidGrandPianoConfig, Storage, StorageResponse, getDrumMachineNames, getElectricPianoNames, getMalletNames, getMellotronNames, getSoundfontKits, getSoundfontNames };
+export { CacheStorage, DrumMachine, DrumMachineConfig, 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 };