smplr 0.4.1 → 0.4.3

package/README.md

@@ -178,7 +178,7 @@ A Soundfont player. By default it loads audio from Benjamin Gleitzman's package
 [pre-rendered sound fonts](https://github.com/gleitz/midi-js-soundfonts).
 
 ```js
-import { Soundfont } from "smplr";
+import { Soundfont, getSoundfontNames } from "smplr";
 
 const marimba = new Soundfont(new AudioContext(), { instrument: "marimba" });
 marimba.start({ note: "C4" });
@@ -186,6 +186,28 @@ marimba.start({ note: "C4" });
 
 It's intended to be a modern replacement of [soundfont-player](https://github.com/danigb/soundfont-player)
 
+#### Soundfont instruments and kits
+
+Use `getSoundfontNames` to get all available instrument names.
+
+Two kits are available: `MusyngKit` or `FluidR3_GM`. The first is used by default: it sounds better but it weights more.
+
+```js
+const marimba = new Soundfont(context, {
+  instrument: "clavinet",
+  kit: "FluidR3_GM", // "MusyngKit" is used by default if not specified
+});
+```
+
+Alternatively, you can pass your custom url as the instrument. In that case, the `kit` is ignored:
+
+```js
+const marimba = new Soundfont(context, {
+  instrument:
+    "https://gleitz.github.io/midi-js-soundfonts/MusyngKite/marimba-mp3.js",
+});
+```
+
 ### Piano
 
 A sampled acoustic piano. It uses Steinway samples with 4 velocity layers from

package/dist/index.d.ts

@@ -199,7 +199,7 @@ declare class Mallet extends SfzSampler {
         instrument: string;
     });
 }
-declare const DATA: Record<string, string | undefined>;
+declare const NAME_TO_PATH: Record<string, string | undefined>;
 
 declare const PARAMS: readonly ["preDelay", "bandwidth", "inputDiffusion1", "inputDiffusion2", "decay", "decayDiffusion1", "decayDiffusion2", "damping", "excursionRate", "excursionDepth", "wet", "dry"];
 declare class Reverb {
@@ -214,7 +214,7 @@ declare class Reverb {
 }
 
 type SoundfontConfig = {
-    library: SoundfontLibrary | LibraryUrlBuilder;
+    kit: "FluidR3_GM" | "MusyngKite";
     instrument: string;
     destination: AudioNode;
     detune: number;
@@ -229,16 +229,7 @@ declare class Soundfont extends Sampler {
         instrument: string;
     });
 }
-declare function gleitzKitUrl(kit: "FluidR3_GM" | "MusyngKite", name: string, format: string): string;
-type LibraryUrlBuilder = (instrument: string, format?: string) => string;
-type SoundfontLibrary = {
-    name: string;
-    url: (name: string, format?: "ogg" | "mp3") => string;
-    instruments: string[];
-};
-declare const FluidR3: SoundfontLibrary;
-declare const MusyngKite: SoundfontLibrary;
-declare const SoundfontLibraries: Record<string, SoundfontLibrary>;
+declare function getSoundfontNames(): string[];
 
 /**
  * Splendid Grand Piano options
@@ -267,4 +258,4 @@ declare const LAYERS: ({
     cutoff?: undefined;
 })[];
 
-export { DATA, DrumMachine, DrumMachineConfig, ElectricPiano, FluidR3, LAYERS, LibraryUrlBuilder, Mallet, MusyngKite, Reverb, Sampler, SamplerAudioLoader, SamplerConfig, SamplerNote, Soundfont, SoundfontConfig, SoundfontLibraries, SoundfontLibrary, SplendidGrandPiano, SplendidGrandPianoConfig, getDrumMachineNames, getElectricPianoNames, getMalletNames, gleitzKitUrl };
+export { DrumMachine, DrumMachineConfig, ElectricPiano, LAYERS, Mallet, NAME_TO_PATH, Reverb, Sampler, SamplerAudioLoader, SamplerConfig, SamplerNote, Soundfont, SoundfontConfig, SplendidGrandPiano, SplendidGrandPianoConfig, getDrumMachineNames, getElectricPianoNames, getMalletNames, getSoundfontNames };

package/dist/index.js

@@ -75,22 +75,19 @@ var __async = (__this, __arguments, generator) => {
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  DATA: () => DATA,
   DrumMachine: () => DrumMachine,
   ElectricPiano: () => ElectricPiano,
-  FluidR3: () => FluidR3,
   LAYERS: () => LAYERS,
   Mallet: () => Mallet,
-  MusyngKite: () => MusyngKite,
+  NAME_TO_PATH: () => NAME_TO_PATH,
   Reverb: () => Reverb,
   Sampler: () => Sampler,
   Soundfont: () => Soundfont,
-  SoundfontLibraries: () => SoundfontLibraries,
   SplendidGrandPiano: () => SplendidGrandPiano,
   getDrumMachineNames: () => getDrumMachineNames,
   getElectricPianoNames: () => getElectricPianoNames,
   getMalletNames: () => getMalletNames,
-  gleitzKitUrl: () => gleitzKitUrl
+  getSoundfontNames: () => getSoundfontNames
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -402,7 +399,7 @@ var Sampler = class {
     );
     const buffer = this.buffers[sample];
     if (!buffer) {
-      console.warn(`Sample not found: ${sample}`);
+      console.warn(`Sample not found: '${sample}'`);
       return () => void 0;
     }
     return startSample({
@@ -797,7 +794,7 @@ var ElectricPiano = class extends SfzSampler {
 
 // src/mallet.ts
 function getMalletNames() {
-  return Object.keys(DATA);
+  return Object.keys(NAME_TO_PATH);
 }
 var Mallet = class extends SfzSampler {
   constructor(context, options) {
@@ -808,16 +805,16 @@ var Mallet = class extends SfzSampler {
   }
 };
 function getMallet(name) {
-  if (!DATA[name])
+  if (!NAME_TO_PATH[name])
     throw Error(`Mallet instrument "${name}" not valid`);
   return {
     name,
-    websfzUrl: BASE_URL + DATA[name] + EXT
+    websfzUrl: BASE_URL + NAME_TO_PATH[name] + EXT
   };
 }
 var BASE_URL = "https://danigb.github.io/samples/vcsl/";
 var EXT = ".websfz.json";
-var DATA = {
+var NAME_TO_PATH = {
   "Balafon - Hard Mallet": "Struck Idiophones/balafon-hard-mallet",
   "Balafon - Keyswitch": "Struck Idiophones/balafon-keyswitch",
   "Balafon - Soft Mallet": "Struck Idiophones/balafon-soft-mallet",
@@ -912,8 +909,7 @@ _output3 = new WeakMap();
 var Soundfont = class extends Sampler {
   constructor(context, options) {
     var _a, _b;
-    const urlBuilder = getUrlBuilder(options.library);
-    const url = urlBuilder(options.instrument);
+    const url = options.instrument.startsWith("http") ? options.instrument : gleitzKitUrl(options.instrument, options.kit);
     super(context, {
       destination: options.destination,
       detune: options.detune,
@@ -932,9 +928,6 @@ var Soundfont = class extends Sampler {
     this.output.addInsert(gain);
   }
 };
-function getUrlBuilder(library) {
-  return library === void 0 ? (instrument, format) => gleitzKitUrl("MusyngKite", instrument, format != null ? format : "ogg") : typeof library === "function" ? library : library.url;
-}
 function soundfontLoader(url) {
   return (context, buffers) => __async(this, null, function* () {
     const sourceFile = yield (yield fetch(url)).text();
@@ -974,148 +967,13 @@ function base64ToArrayBuffer(base64) {
   }
   return bytes.buffer;
 }
-function gleitzKitUrl(kit, name, format) {
+function gleitzKitUrl(name, kit = "MusyngKite") {
+  var _a;
+  const format = (_a = findFirstSupportedFormat(["ogg", "mp3"])) != null ? _a : "mp3";
   return `https://gleitz.github.io/midi-js-soundfonts/${kit}/${name}-${format}.js`;
 }
-var FluidR3 = {
-  name: "FluidR3_GM",
-  url: (name, format = "mp3") => gleitzKitUrl("FluidR3_GM", name, format),
-  instruments: [
-    "accordion",
-    "acoustic_bass",
-    "acoustic_grand_piano",
-    "acoustic_guitar_nylon",
-    "acoustic_guitar_steel",
-    "agogo",
-    "alto_sax",
-    "applause",
-    "bagpipe",
-    "banjo",
-    "baritone_sax",
-    "bassoon",
-    "bird_tweet",
-    "blown_bottle",
-    "brass_section",
-    "breath_noise",
-    "bright_acoustic_piano",
-    "celesta",
-    "cello",
-    "choir_aahs",
-    "church_organ",
-    "clarinet",
-    "clavinet",
-    "contrabass",
-    "distortion_guitar",
-    "drawbar_organ",
-    "dulcimer",
-    "electric_bass_finger",
-    "electric_bass_pick",
-    "electric_grand_piano",
-    "electric_guitar_clean",
-    "electric_guitar_jazz",
-    "electric_guitar_muted",
-    "electric_piano_1",
-    "electric_piano_2",
-    "english_horn",
-    "fiddle",
-    "flute",
-    "french_horn",
-    "fretless_bass",
-    "fx_1_rain",
-    "fx_2_soundtrack",
-    "fx_3_crystal",
-    "fx_4_atmosphere",
-    "fx_5_brightness",
-    "fx_6_goblins",
-    "fx_7_echoes",
-    "fx_8_scifi",
-    "glockenspiel",
-    "guitar_fret_noise",
-    "guitar_harmonics",
-    "gunshot",
-    "harmonica",
-    "harpsichord",
-    "helicopter",
-    "honkytonk_piano",
-    "kalimba",
-    "koto",
-    "lead_1_square",
-    "lead_2_sawtooth",
-    "lead_3_calliope",
-    "lead_4_chiff",
-    "lead_5_charang",
-    "lead_6_voice",
-    "lead_7_fifths",
-    "lead_8_bass__lead",
-    "marimba",
-    "melodic_tom",
-    "music_box",
-    "muted_trumpet",
-    "oboe",
-    "ocarina",
-    "orchestra_hit",
-    "orchestral_harp",
-    "overdriven_guitar",
-    "pad_1_new_age",
-    "pad_2_warm",
-    "pad_3_polysynth",
-    "pad_4_choir",
-    "pad_5_bowed",
-    "pad_6_metallic",
-    "pad_7_halo",
-    "pad_8_sweep",
-    "pan_flute",
-    "percussive_organ",
-    "percussion",
-    "piccolo",
-    "pizzicato_strings",
-    "recorder",
-    "reed_organ",
-    "reverse_cymbal",
-    "rock_organ",
-    "seashore",
-    "shakuhachi",
-    "shamisen",
-    "shanai",
-    "sitar",
-    "slap_bass_1",
-    "slap_bass_2",
-    "soprano_sax",
-    "steel_drums",
-    "string_ensemble_1",
-    "string_ensemble_2",
-    "synth_bass_1",
-    "synth_bass_2",
-    "synth_brass_1",
-    "synth_brass_2",
-    "synth_choir",
-    "synth_drum",
-    "synth_strings_1",
-    "synth_strings_2",
-    "taiko_drum",
-    "tango_accordion",
-    "telephone_ring",
-    "tenor_sax",
-    "timpani",
-    "tinkle_bell",
-    "tremolo_strings",
-    "trombone",
-    "trumpet",
-    "tuba",
-    "tubular_bells",
-    "vibraphone",
-    "viola",
-    "violin",
-    "voice_oohs",
-    "whistle",
-    "woodblock",
-    "xylophone"
-  ]
-};
-var MusyngKite = {
-  name: "MusyngKite",
-  url: (name, format = "mp3") => gleitzKitUrl("MusyngKite", name, format),
-  instruments: [
+function getSoundfontNames() {
+  return [
     "accordion",
     "acoustic_bass",
     "acoustic_grand_piano",
@@ -1244,12 +1102,8 @@ var MusyngKite = {
     "whistle",
     "woodblock",
     "xylophone"
-  ]
-};
-var SoundfontLibraries = {
-  FluidR3,
-  MusyngKite
-};
+  ];
+}
 
 // src/splendid-grand-piano.ts
 var BASE_URL2 = "https://danigb.github.io/samples/splendid-grand-piano";
@@ -1645,21 +1499,18 @@ var LAYERS = [
 ];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  DATA,
   DrumMachine,
   ElectricPiano,
-  FluidR3,
   LAYERS,
   Mallet,
-  MusyngKite,
+  NAME_TO_PATH,
   Reverb,
   Sampler,
   Soundfont,
-  SoundfontLibraries,
   SplendidGrandPiano,
   getDrumMachineNames,
   getElectricPianoNames,
   getMalletNames,
-  gleitzKitUrl
+  getSoundfontNames
 });
 //# sourceMappingURL=index.js.map