Added TinySoundFont bindings

Author: lemcoder

app/src/nativeMain/kotlin/Main.kt

@@ -36,7 +36,6 @@ fun main() {
         next = g
     )
 
-
     val e = MidiMessageNoteOn(
         time = 1_000u,
         channel = 7u,

core/src/commonMain/kotlin/pl/lemanski/pandamidi/soundFont/SoundFont.kt

@@ -0,0 +1,130 @@
+package pl.lemanski.pandamidi.soundFont
+
+interface SoundFont {
+    /**
+     * Copy a tsf instance from an existing one, use tsf_close to close it as well.
+     * All copied tsf instances and their original instance are linked, and share the underlying soundfont.
+     * This allows loading a soundfont only once, but using it for multiple independent playbacks.
+     * (This function isn't thread-safe without locking.)
+     */
+    fun copy(): SoundFont
+
+    /**
+     * Free the memory related to this tsf instance
+     */
+    fun close()
+
+    /**
+     * Stop all playing notes immediately and reset all channel parameters
+     */
+    fun reset()
+
+    /**
+     * Returns the preset index from a bank and preset number, or -1 if it does not exist in the loaded SoundFont
+     */
+    fun getPresetIndex(bank: Int, presetNumber: Int): Int
+
+    /**
+     * Returns the number of presets in the loaded SoundFont
+     */
+    fun getPresetsCount(): Int
+
+    /**
+     * Returns the name of a preset index >= 0 and < tsf_get_presetcount()
+     */
+    fun getPresetName(presetIndex: Int): String
+
+    /**
+     * Returns the name of a preset by bank and preset number
+     */
+    fun bankGetPresetName(bank: Int, presetNumber: Int): String
+
+    /**
+     * Setup the parameters for the voice render methods
+     * @param outputMode: if mono or stereo and how stereo channel data is ordered
+     * @param sampleRate: the number of samples per second (output frequency)
+     * @param globalGainDb: volume gain in decibels (>0 means higher, <0 means lower)
+     */
+    fun setOutput(outputMode: OutputMode, sampleRate: Int, globalGainDb: Float)
+
+    /**
+     * Set the global gain as a volume factor
+     * @param globalGain: the desired volume where 1.0 is 100%
+     */
+    fun setVolume(globalGain: Float)
+
+    /**
+     * Set the maximum number of voices to play simultaneously
+     * Depending on the soundfont, one note can cause many new voices to be started,
+     * so don't keep this number too low or otherwise sounds may not play.
+     *
+     * @param maxVoices: maximum number to pre-allocate and set the limit to
+     * @throws IllegalArgumentException if allocation failed
+     */
+    fun setMaxVoices(maxVoices: Int)
+
+    /**
+     * Start playing a note
+     * @param presetIndex preset index >= 0 and < getPresetCount()
+     * @param key note value between 0 and 127 (60 being middle C)
+     * @param velocity velocity as a float between 0.0 (equal to note off) and 1.0 (full)
+     * @throws IllegalArgumentException if allocation of a new voice failed
+     */
+    fun noteOn(presetIndex: Int, key: Int, velocity: Float)
+
+    /**
+     * Start playing a note
+     * @param bank instrument bank number (alternative to presetIndex)
+     * @param presetNumber preset number (alternative to presetIndex)
+     * @param key note value between 0 and 127 (60 being middle C)
+     * @param velocity velocity as a float between 0.0 (equal to note off) and 1.0 (full)
+     * @throws IllegalArgumentException if preset does not exist or allocation failed
+     */
+    fun bankNoteOn(bank: Int, presetNumber: Int, key: Int, velocity: Float)
+
+    /**
+     * Stop playing a note
+     * @param presetIndex preset index >= 0 and < getPresetCount()
+     * @param key note value between 0 and 127 (60 being middle C)
+     */
+    fun noteOff(presetIndex: Int, key: Int)
+
+    /**
+     * Stop playing a note
+     * @param bank instrument bank number (alternative to presetIndex)
+     * @param presetNumber preset number (alternative to presetIndex)
+     * @param key note value between 0 and 127 (60 being middle C)
+     * @throws IllegalArgumentException if preset does not exist
+     */
+    fun bankNoteOff(bank: Int, presetNumber: Int, key: Int)
+
+    /**
+     * Stop playing all notes (end with sustain and release)
+     */
+    fun noteOffAll()
+
+    /**
+     * @return the number of active voices
+     */
+    fun activeVoiceCount(): Int
+
+    /**
+     * Supported output modes by the render methods
+     */
+    enum class OutputMode {
+        /**
+         * Two channels with single left/right samples one after another
+         */
+        TSF_STEREO_INTERLEAVED,
+
+        /**
+         * Two channels with all samples for the left channel first then right
+         */
+        TSF_STEREO_UNWEAVED,
+
+        /**
+         * A single channel (stereo instruments are mixed into center)
+         */
+        TSF_MONO
+    }
+}

core/src/commonMain/kotlin/pl/lemanski/pandamidi/soundFont/SoundFontExt.kt

@@ -0,0 +1,19 @@
+package pl.lemanski.pandamidi.soundFont
+
+import pl.lemanski.pandamidi.soundFont.internal.SoundFontDelegate
+
+internal typealias Sf = Any
+
+fun SoundFont.load(path: String): SoundFont {
+    val soundFont = loadFromFile(path)
+    return object : SoundFont by SoundFontDelegate(soundFont) { }
+}
+
+fun SoundFont.load(memory: ByteArray): SoundFont {
+    val soundFont = loadFromMemory(memory)
+    return object : SoundFont by SoundFontDelegate(soundFont) { }
+}
+
+internal expect fun loadFromFile(path: String): Sf
+
+internal expect fun loadFromMemory(memory: ByteArray): Sf

core/src/commonMain/kotlin/pl/lemanski/pandamidi/soundFont/internal/SoundFontDelegate.kt

@@ -0,0 +1,39 @@
+package pl.lemanski.pandamidi.soundFont.internal
+
+import pl.lemanski.pandamidi.soundFont.Sf
+import pl.lemanski.pandamidi.soundFont.SoundFont
+
+internal open class SoundFontDelegate(val sf: Sf) : SoundFont {
+
+    override fun copy(): SoundFont = SoundFontDelegate(sf)
+
+    override fun close() = close(this)
+
+    override fun reset() = reset(this)
+
+    override fun getPresetIndex(bank: Int, presetNumber: Int): Int = getPresetIndex(this, bank, presetNumber)
+
+    override fun getPresetsCount(): Int = getPresetsCount(this)
+
+    override fun getPresetName(presetIndex: Int): String = getPresetName(this, presetIndex)
+
+    override fun bankGetPresetName(bank: Int, presetNumber: Int): String = bankGetPresetName(this, bank, presetNumber)
+
+    override fun setOutput(outputMode: SoundFont.OutputMode, sampleRate: Int, globalGainDb: Float) = setOutput(this, outputMode, sampleRate, globalGainDb)
+
+    override fun setVolume(globalGain: Float) = setVolume(this, globalGain)
+
+    override fun setMaxVoices(maxVoices: Int) = setMaxVoices(this, maxVoices)
+
+    override fun noteOn(presetIndex: Int, key: Int, velocity: Float) = noteOn(this, presetIndex, key, velocity)
+
+    override fun bankNoteOn(bank: Int, presetNumber: Int, key: Int, velocity: Float) = bankNoteOn(this, bank, presetNumber, key, velocity)
+
+    override fun noteOff(presetIndex: Int, key: Int) = noteOff(this, presetIndex, key)
+
+    override fun bankNoteOff(bank: Int, presetNumber: Int, key: Int) = bankNoteOff(this, bank, presetNumber, key)
+
+    override fun noteOffAll() = noteOffAll(this)
+
+    override fun activeVoiceCount(): Int = activeVoiceCount(this)
+}

core/src/commonMain/kotlin/pl/lemanski/pandamidi/soundFont/internal/SoundFontExtInternal.kt

@@ -0,0 +1,33 @@
+package pl.lemanski.pandamidi.soundFont.internal
+
+import pl.lemanski.pandamidi.soundFont.SoundFont
+
+internal expect fun close(delegate: SoundFontDelegate)
+
+internal expect fun reset(delegate: SoundFontDelegate)
+
+internal expect fun getPresetIndex(delegate: SoundFontDelegate, bank: Int, presetNumber: Int): Int
+
+internal expect fun getPresetsCount(delegate: SoundFontDelegate): Int
+
+internal expect fun getPresetName(delegate: SoundFontDelegate, presetIndex: Int): String
+
+internal expect fun bankGetPresetName(delegate: SoundFontDelegate, bank: Int, presetNumber: Int): String
+
+internal expect fun setOutput(delegate: SoundFontDelegate, outputMode: SoundFont.OutputMode, sampleRate: Int, globalGainDb: Float)
+
+internal expect fun setVolume(delegate: SoundFontDelegate, globalGain: Float)
+
+internal expect fun setMaxVoices(delegate: SoundFontDelegate, maxVoices: Int)
+
+internal expect fun noteOn(delegate: SoundFontDelegate, presetIndex: Int, key: Int, velocity: Float)
+
+internal expect fun bankNoteOn(delegate: SoundFontDelegate, bank: Int, presetNumber: Int, key: Int, velocity: Float)
+
+internal expect fun noteOff(delegate: SoundFontDelegate, presetIndex: Int, key: Int)
+
+internal expect fun bankNoteOff(delegate: SoundFontDelegate, bank: Int, presetNumber: Int, key: Int)
+
+internal expect fun noteOffAll(delegate: SoundFontDelegate)
+
+internal expect fun activeVoiceCount(delegate: SoundFontDelegate): Int

core/src/mingwX64Main/kotlin/pl/lemanski/pandamidi/soundFont/SoundFontExt.mingwX64.kt

@@ -0,0 +1,17 @@
+package pl.lemanski.pandamidi.soundFont
+
+import kotlinx.cinterop.ExperimentalForeignApi
+import kotlinx.cinterop.refTo
+import tinySoundFont.tsf_load_filename
+import tinySoundFont.tsf_load_memory
+
+@OptIn(ExperimentalForeignApi::class)
+internal actual fun loadFromFile(path: String): Sf {
+    return tsf_load_filename(path) ?: throw IllegalStateException("SoundFont not loaded")
+}
+
+@OptIn(ExperimentalForeignApi::class)
+internal actual fun loadFromMemory(memory: ByteArray): Sf {
+    return tsf_load_memory(memory.refTo(0), memory.size) ?: throw IllegalStateException("SoundFont not loaded")
+}
+