Welcome to the spessasynth_core wiki!

This should serve as the complete documentation of the library. (And my attempt to explain the program :-)

Danger

The next major update (4.0) will include many breaking changes. The documentation will be updated when the update releases The migration guide is available.

Tip

If you encounter any errors in this documentation, please open an issue!

Documentation

• Getting started with spessasynth_core
• SpessaSynthProcessor - Responsible for generating sound.
• SpessaSynthSequencer - Responsible for playing MIDI sequences.
• Sound Banks - Responsible for parsing an SF2 file.
• MIDI parser - Responsible for parsing a MIDI file.
• Logging - How to control spessasynth_core’s console output.
• Writing MIDI files - How to write MIDI and RMID files.
• Writing Wave files - How to write WAV files from PCM audio data.
• Converting between formats - How to convert between various file formats.

Extra Info

• SF2 RMIDI Extension Specification - The specification for the SF2 RMIDI format that spessasynth supports.
• SpessaSynth’s MIDI Implementation - A MIDI Implementation chart for spessasynth’s synthesizer.
• Multi-Port files explained - Explanation of the Multi-Port MIDI feature.
• The DLS Conversion problem - The limits of the SF2 -> DLS conversion.
• NPM Exports - a listing of all the NPN exports in the spessasynth_core NPM package.