Welcome to the spessasynth_core documentation!

You've reached the central documentation for the spessasynth_core library, a powerful SF2/DLS/MIDI TypeScript/JavaScript library.

If you're looking for the SpessaSynth web app, it can be found here.

Table of contents

Getting Started

• Getting started with spessasynth_core

Main Classes

• SpessaSynthProcessor - Responsible for generating sound.
• SpessaSynthSequencer - Responsible for playing MIDI sequences.
• SoundBankLoader - Responsible for loading SF2, SF3 and DLS files.
• BasicSoundBank - Represents a sound bank with samples, which can be used by SpessaSynthProcessor.
• BasicMIDI - Represents a MIDI sequence, which can be used by SpessaSynthSequencer.

Other Useful API Docs

• MIDI Implementation - A MIDI Implementation chart for spessasynth_core's synthesizer. This describes all the features of the synthesis engine.
• Modulator Information - Information on spessasynth_core's SF2 modulator implementation.
• Generator Types - All SF2 generators, with their limits and default values.
• Kinds Of Parameters - spessasynth_core's parameters explained.
• Console Output - How to control spessasynth_core's console output.
• MIDI Utilities - Useful MIDI SysEx utilities.
• Writing MIDI files - How to create MIDI files from scratch.
• Writing Wave files - How to write WAV files from PCM audio data.

Extra Info

• SF2 RMIDI Extension Specification - The specification for the SF2 RMIDI format that spessasynth supports.
• Multi-Port files explained - Explanation of the Multi-Port MIDI feature.
• The DLS Conversion problem - The limits of converting between SF2 and DLS.
• Converting between formats - How to convert between various file formats.
• Contributing to spessasynth_core