spessasynth_core 3.26.10 → 3.26.12

package/README.md

@@ -63,6 +63,7 @@ npm install --save spessasynth_core
   - **Sound Controllers:** Real-time filter and envelope control!
   - **MIDI Tuning Standard Support:** [more info here](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#midi-tuning-standard)
   - [Full **RPN** and limited **NRPN** support](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#supported-registered-parameters)
+  - [**AWE32** NRPN Compatibility Layer](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#awe32-nrpn-compatibility-layer)
   - Supports some [**Roland GS** and **Yamaha XG** system exclusives](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#supported-system-exclusives)
 
 ### Powerful and Fast MIDI Sequencer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_core",
-  "version": "3.26.10",
+  "version": "3.26.12",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "main": "index.js",
   "type": "module",

package/src/midi/midi_tools/midi_writer.js

@@ -36,12 +36,18 @@ export function writeMIDI()
                 // this is a meta-message
                 // syntax is FF<type><length><data>
                 messageData = [0xff, event.messageStatusByte, ...writeVariableLengthQuantity(event.messageData.length), ...event.messageData];
+                // RP-001:
+                // Sysex events and meta-events cancel any running status which was in effect.
+                runningByte = undefined;
             }
             else if (event.messageStatusByte === messageTypes.systemExclusive)
             {
                 // this is a system exclusive message
                 // syntax is F0<length><data>
                 messageData = [0xf0, ...writeVariableLengthQuantity(event.messageData.length), ...event.messageData];
+                // RP-001:
+                // Sysex events and meta-events cancel any running status which was in effect.
+                runningByte = undefined;
             }
             else
             {

package/src/synthetizer/audio_engine/engine_components/dynamic_modulator_system.js

@@ -18,14 +18,6 @@ export class DynamicModulatorSystem
         this.modulatorList = [];
     }
     
-    /**
-     * @returns {Modulator[]}
-     */
-    getModulators()
-    {
-        return this.modulatorList.map(m => m.mod);
-    }
-    
     /**
      * @param source {number}
      * @param destination {generatorTypes}

package/src/synthetizer/audio_engine/engine_components/midi_audio_channel.js

@@ -29,9 +29,11 @@ import { pitchWheel } from "../engine_methods/tuning_control/pitch_wheel.js";
 import { setOctaveTuning } from "../engine_methods/tuning_control/set_octave_tuning.js";
 import { programChange } from "../engine_methods/program_change.js";
 import { chooseBank, isSystemXG, parseBankSelect } from "../../../utils/xg_hacks.js";
-import { DEFAULT_PERCUSSION } from "../../synth_constants.js";
+import { DEFAULT_PERCUSSION, GENERATOR_OVERRIDE_NO_CHANGE_VALUE } from "../../synth_constants.js";
 import { modulatorSources } from "../../../soundfont/basic_soundfont/modulator.js";
 import { DynamicModulatorSystem } from "./dynamic_modulator_system.js";
+import { GENERATORS_AMOUNT } from "../../../soundfont/basic_soundfont/generator.js";
+import { computeModulators } from "./compute_modulator.js";
 
 /**
  * This class represents a single MIDI Channel within the synthesizer.
@@ -83,11 +85,24 @@ class MidiAudioChannel
     channelTuningCents = 0;
     
     /**
-     * A system for dynamic modulator assignment for system exclusives
+     * A system for dynamic modulator assignment for advanced system exclusives.
      * @type {DynamicModulatorSystem}
      */
     sysExModulators = new DynamicModulatorSystem();
     
+    /**
+     * An array of override generators for AWE32 support.
+     * A value of 32,767 means unchanged, as it is not allowed anywhere.
+     * @type {Int16Array}
+     */
+    generatorOverrides = new Int16Array(GENERATORS_AMOUNT);
+    
+    /**
+     * A small optimization that disables applying overrides until at least one is set.
+     * @type {boolean}
+     */
+    generatorOverridesEnabled = false;
+    
     /**
      * Indicates whether the sustain (hold) pedal is active.
      * @type {boolean}
@@ -210,6 +225,7 @@ class MidiAudioChannel
         this.synth = synth;
         this.preset = preset;
         this.channelNumber = channelNumber;
+        this.resetGeneratorOverrides();
     }
     
     get isXGChannel()
@@ -438,6 +454,31 @@ class MidiAudioChannel
         };
         this.synth?.onChannelPropertyChange?.(data, this.channelNumber);
     }
+    
+    resetGeneratorOverrides()
+    {
+        this.generatorOverrides.fill(GENERATOR_OVERRIDE_NO_CHANGE_VALUE);
+        this.generatorOverridesEnabled = false;
+    }
+    
+    /**
+     * @param gen {generatorTypes}
+     * @param value {number}
+     * @param realtime {boolean}
+     */
+    setGeneratorOverride(gen, value, realtime = false)
+    {
+        this.generatorOverrides[gen] = value;
+        this.generatorOverridesEnabled = true;
+        if (realtime)
+        {
+            this.voices.forEach(v =>
+            {
+                v.generators[gen] = value;
+                computeModulators(v, this.midiControllers);
+            });
+        }
+    }
 }
 
 // voice

package/src/synthetizer/audio_engine/engine_methods/controller_control/reset_controllers.js

@@ -219,6 +219,7 @@ export function resetControllersRP15Compliant()
             }
         }
     }
+    this.resetGeneratorOverrides();
 }
 
 /**
@@ -228,9 +229,13 @@ export function resetParameters()
 {
     /**
      * reset the state machine to idle
-     * @type {string}
      */
     this.dataEntryState = dataEntryStates.Idle;
+    this.midiControllers[midiControllers.NRPNLsb] = 127 << 7;
+    this.midiControllers[midiControllers.NRPNMsb] = 127 << 7;
+    this.midiControllers[midiControllers.RPNLsb] = 127 << 7;
+    this.midiControllers[midiControllers.RPNMsb] = 127 << 7;
+    this.resetGeneratorOverrides();
     SpessaSynthInfo(
         "%cResetting Registered and Non-Registered Parameters!",
         consoleColors.info

package/src/synthetizer/audio_engine/engine_methods/data_entry/awe32.js

@@ -0,0 +1,198 @@
+import { generatorTypes } from "../../../../soundfont/basic_soundfont/generator.js";
+import { SpessaSynthWarn } from "../../../../utils/loggin.js";
+import { consoleColors } from "../../../../utils/other.js";
+
+/**
+ * http://archive.gamedev.net/archive/reference/articles/article445.html
+ * https://github.com/user-attachments/files/15757220/adip301.pdf
+ * @type {generatorTypes[]}
+ */
+const AWE_NRPN_GENERATOR_MAPPINGS = [
+    generatorTypes.delayModLFO,
+    generatorTypes.freqModLFO,
+    
+    generatorTypes.delayVibLFO,
+    generatorTypes.freqVibLFO,
+    
+    generatorTypes.delayModEnv,
+    generatorTypes.attackModEnv,
+    generatorTypes.holdModEnv,
+    generatorTypes.decayModEnv,
+    generatorTypes.sustainModEnv,
+    generatorTypes.releaseModEnv,
+    
+    generatorTypes.delayVolEnv,
+    generatorTypes.attackVolEnv,
+    generatorTypes.holdVolEnv,
+    generatorTypes.decayVolEnv,
+    generatorTypes.sustainVolEnv,
+    generatorTypes.releaseVolEnv,
+    
+    generatorTypes.fineTune,
+    
+    generatorTypes.modLfoToPitch,
+    generatorTypes.vibLfoToPitch,
+    generatorTypes.modEnvToPitch,
+    generatorTypes.modLfoToVolume,
+    
+    generatorTypes.initialFilterFc,
+    generatorTypes.initialFilterQ,
+    
+    generatorTypes.modLfoToFilterFc,
+    generatorTypes.modEnvToFilterFc,
+    
+    generatorTypes.chorusEffectsSend,
+    generatorTypes.reverbEffectsSend
+];
+
+/**
+ * Function that emulates AWE32 similarly to fluidsynth
+ * https://github.com/FluidSynth/fluidsynth/wiki/FluidFeatures
+ *
+ * Note: This makes use of findings by mrbumpy409:
+ * https://github.com/fluidSynth/fluidsynth/issues/1473
+ *
+ * The excellent test files are available here, also collected and converted by mrbumpy409:
+ * https://github.com/mrbumpy409/AWE32-midi-conversions
+ * @this {MidiAudioChannel}
+ * @param aweGen {number}
+ * @param dataLSB {number}
+ * @param dataMSB {number}
+ */
+export function handleAWE32NRPN(aweGen, dataLSB, dataMSB)
+{
+    const clip = (v, min, max) => Math.max(min, Math.min(max, v));
+    const msecToTimecents = ms => Math.max(-32768, 1200 * Math.log2(ms / 1000));
+    const hzToCents = hz => 6900 + 1200 * Math.log2(hz / 440);
+    
+    
+    let dataValue = (dataMSB << 7) | dataLSB;
+    // center the value
+    // though ranges reported as 0 to 127 only use LSB
+    dataValue -= 8192;
+    const generator = AWE_NRPN_GENERATOR_MAPPINGS[aweGen];
+    if (!generator)
+    {
+        SpessaSynthWarn(
+            `Invalid AWE32 LSB: %c${aweGen}`,
+            consoleColors.unrecognized
+        );
+    }
+    let milliseconds, hertz, centibels, cents;
+    switch (generator)
+    {
+        default:
+            // this should not happen
+            break;
+        
+        // delays
+        case generatorTypes.delayModLFO:
+        case generatorTypes.delayVibLFO:
+        case generatorTypes.delayVolEnv:
+        case generatorTypes.delayModEnv:
+            milliseconds = 4 * clip(dataValue, 0, 5900);
+            // convert to timecents
+            this.setGeneratorOverride(generator, msecToTimecents(milliseconds));
+            break;
+        
+        // attacks
+        case generatorTypes.attackVolEnv:
+        case generatorTypes.attackModEnv:
+            milliseconds = clip(dataValue, 0, 5940);
+            // convert to timecents
+            this.setGeneratorOverride(generator, msecToTimecents(milliseconds));
+            break;
+        
+        // holds
+        case generatorTypes.holdVolEnv:
+        case generatorTypes.holdModEnv:
+            milliseconds = clip(dataValue, 0, 8191);
+            // convert to timecents
+            this.setGeneratorOverride(generator, msecToTimecents(milliseconds));
+            break;
+        
+        // decays and releases (share clips and units)
+        case generatorTypes.decayModEnv:
+        case generatorTypes.decayVolEnv:
+        case generatorTypes.releaseVolEnv:
+        case generatorTypes.releaseModEnv:
+            milliseconds = 4 * clip(dataValue, 0, 5940);
+            // convert to timecents
+            this.setGeneratorOverride(generator, msecToTimecents(milliseconds));
+            break;
+        
+        // lfo frequencies
+        case generatorTypes.freqVibLFO:
+        case generatorTypes.freqModLFO:
+            hertz = 0.084 * dataLSB;
+            // convert to abs cents
+            this.setGeneratorOverride(generator, hzToCents(hertz), true);
+            break;
+        
+        // sustains
+        case generatorTypes.sustainVolEnv:
+        case generatorTypes.sustainModEnv:
+            // 0.75 dB is 7.5 cB
+            centibels = dataLSB * 7.5;
+            this.setGeneratorOverride(generator, centibels);
+            break;
+        
+        // pitch
+        case generatorTypes.fineTune:
+            // data is already centered
+            this.setGeneratorOverride(generator, dataValue, true);
+            break;
+        
+        // lfo to pitch
+        case generatorTypes.modLfoToPitch:
+        case generatorTypes.vibLfoToPitch:
+            cents = clip(dataValue, -127, 127) * 9.375;
+            this.setGeneratorOverride(generator, cents, true);
+            break;
+        
+        // env to pitch
+        case generatorTypes.modEnvToPitch:
+            cents = clip(dataValue, -127, 127) * 9.375;
+            this.setGeneratorOverride(generator, cents);
+            break;
+        
+        // mod lfo to vol
+        case generatorTypes.modLfoToVolume:
+            // 0.1875 dB is 1.875 cB
+            centibels = 1.875 * dataLSB;
+            this.setGeneratorOverride(generator, centibels, true);
+            break;
+        
+        // filter fc
+        case generatorTypes.initialFilterFc:
+            // minimum: 100 Hz -> 4335 cents
+            const fcCents = 4335 + 59 * dataLSB;
+            this.setGeneratorOverride(generator, fcCents, true);
+            break;
+        
+        // filter Q
+        case generatorTypes.initialFilterQ:
+            // note: this uses the "modulator-ish" approach proposed by mrbumpy409
+            // here https://github.com/FluidSynth/fluidsynth/issues/1473
+            centibels = 215 * (dataLSB / 127);
+            this.setGeneratorOverride(generator, centibels, true);
+            break;
+        
+        // to filterFc
+        case generatorTypes.modLfoToFilterFc:
+            cents = clip(dataValue, -64, 63) * 56.25;
+            this.setGeneratorOverride(generator, cents, true);
+            break;
+        
+        case generatorTypes.modEnvToFilterFc:
+            cents = clip(dataValue, -64, 63) * 56.25;
+            this.setGeneratorOverride(generator, cents);
+            break;
+        
+        // effects
+        case generatorTypes.chorusEffectsSend:
+        case generatorTypes.reverbEffectsSend:
+            this.setGeneratorOverride(generator, clip(dataValue, 0, 255) * (1000 / 255));
+            break;
+    }
+}

package/src/synthetizer/audio_engine/engine_methods/data_entry/data_entry_coarse.js

@@ -8,7 +8,7 @@ import { modulatorSources } from "../../../../soundfont/basic_soundfont/modulato
 /**
  * @enum {number}
  */
-const registeredParameterTypes = {
+export const registeredParameterTypes = {
     pitchBendRange: 0x0000,
     fineTuning: 0x0001,
     coarseTuning: 0x0002,
@@ -19,8 +19,9 @@ const registeredParameterTypes = {
 /**
  * @enum {number}
  */
-const nonRegisteredGSMSB = {
-    partParameter: 0x01
+export const nonRegisteredMSB = {
+    partParameter: 0x01,
+    awe32: 0x7F
 };
 
 /**
@@ -50,6 +51,8 @@ const nonRegisteredGSLSB = {
  */
 export function dataEntryCoarse(dataValue)
 {
+    // store in cc table
+    this.midiControllers[midiControllers.dataEntryMsb] = dataValue << 7;
     const addDefaultVibrato = () =>
     {
         if (this.channelVibrato.delay === 0 && this.channelVibrato.rate === 0 && this.channelVibrato.depth === 0)
@@ -117,7 +120,7 @@ export function dataEntryCoarse(dataValue)
                     break;
                 
                 // part parameters: vibrato, cutoff
-                case nonRegisteredGSMSB.partParameter:
+                case nonRegisteredMSB.partParameter:
                     switch (NRPNFine)
                     {
                         default:
@@ -193,6 +196,9 @@ export function dataEntryCoarse(dataValue)
                             break;
                     }
                     break;
+                
+                case nonRegisteredMSB.awe32:
+                    break;
             }
             break;
         

package/src/synthetizer/audio_engine/engine_methods/data_entry/data_entry_fine.js

@@ -1,8 +1,10 @@
 import { consoleColors } from "../../../../utils/other.js";
-import { SpessaSynthInfo } from "../../../../utils/loggin.js";
+import { SpessaSynthInfo, SpessaSynthWarn } from "../../../../utils/loggin.js";
 import { modulatorSources } from "../../../../soundfont/basic_soundfont/modulator.js";
 import { customControllers, dataEntryStates, NON_CC_INDEX_OFFSET } from "../../engine_components/controller_tables.js";
 import { midiControllers } from "../../../../midi/midi_message.js";
+import { nonRegisteredMSB, registeredParameterTypes } from "./data_entry_coarse.js";
+import { handleAWE32NRPN } from "./awe32.js";
 
 /**
  * Executes a data entry for an RPN tuning
@@ -12,6 +14,8 @@ import { midiControllers } from "../../../../midi/midi_message.js";
  */
 export function dataEntryFine(dataValue)
 {
+    // store in cc table
+    this.midiControllers[midiControllers.lsbForControl6DataEntry] = dataValue << 7;
     switch (this.dataEntryState)
     {
         default:
@@ -26,7 +30,7 @@ export function dataEntryFine(dataValue)
                     break;
                 
                 // pitch bend range fine tune
-                case 0x0000:
+                case registeredParameterTypes.pitchBendRange:
                     if (dataValue === 0)
                     {
                         break;
@@ -42,7 +46,7 @@ export function dataEntryFine(dataValue)
                     break;
                 
                 // fine-tuning
-                case 0x0001:
+                case registeredParameterTypes.fineTuning:
                     // grab the data and shift
                     const coarse = this.customControllers[customControllers.channelTuning];
                     const finalTuning = (coarse << 7) | dataValue;
@@ -50,7 +54,7 @@ export function dataEntryFine(dataValue)
                     break;
                 
                 // modulation depth
-                case 0x0005:
+                case registeredParameterTypes.modulationDepth:
                     const currentModulationDepthCents = this.customControllers[customControllers.modulationMultiplier] * 50;
                     let cents = currentModulationDepthCents + (dataValue / 128) * 100;
                     this.setModulationDepth(cents);
@@ -61,6 +65,41 @@ export function dataEntryFine(dataValue)
                     break;
                 
             }
+            break;
         
+        case dataEntryStates.NRPFine:
+            /**
+             * @type {number}
+             */
+            const NRPNCoarse = this.midiControllers[midiControllers.NRPNMsb] >> 7;
+            /**
+             * @type {number}
+             */
+            const NRPNFine = this.midiControllers[midiControllers.NRPNLsb] >> 7;
+            switch (NRPNCoarse)
+            {
+                default:
+                    SpessaSynthWarn(
+                        `%cUnrecognized NRPN LSB for %c${this.channelNumber}%c: %c(0x${NRPNFine.toString(16)
+                            .toUpperCase()} 0x${NRPNFine.toString(
+                            16).toUpperCase()})%c data value: %c${dataValue}`,
+                        consoleColors.warn,
+                        consoleColors.recognized,
+                        consoleColors.warn,
+                        consoleColors.unrecognized,
+                        consoleColors.warn,
+                        consoleColors.value
+                    );
+                    break;
+                
+                case nonRegisteredMSB.awe32:
+                    handleAWE32NRPN.call(
+                        this,
+                        NRPNFine,
+                        dataValue,
+                        this.midiControllers[midiControllers.dataEntryMsb] >> 7
+                    );
+                    break;
+            }
     }
 }

package/src/synthetizer/audio_engine/engine_methods/note_on.js

@@ -4,6 +4,7 @@ import { midiControllers } from "../../../midi/midi_message.js";
 import { portamentoTimeToSeconds } from "./portamento_time.js";
 import { customControllers } from "../engine_components/controller_tables.js";
 import { Modulator } from "../../../soundfont/basic_soundfont/modulator.js";
+import { GENERATOR_OVERRIDE_NO_CHANGE_VALUE } from "../../synth_constants.js";
 
 /**
  * sends a "MIDI Note on message"
@@ -99,9 +100,6 @@ export function noteOn(midiNote, velocity)
         panOverride = Math.round(Math.random() * 1000 - 500);
     }
     
-    // dynamic modulators (sysEx)
-    const dynamicModulators = this.sysExModulators.getModulators();
-    
     // add voices
     const channelVoices = this.voices;
     voices.forEach(voice =>
@@ -116,8 +114,10 @@ export function noteOn(midiNote, velocity)
         // apply gain override
         voice.gain = voiceGain;
         
-        dynamicModulators.forEach(mod =>
+        // dynamic modulators (if none, this won't iterate over anything)
+        this.sysExModulators.modulatorList.forEach(m =>
         {
+            const mod = m.mod;
             const existingModIndex = voice.modulators.findIndex(voiceMod => Modulator.isIdentical(voiceMod, mod));
             
             // replace or add
@@ -131,6 +131,19 @@ export function noteOn(midiNote, velocity)
             }
         });
         
+        // apply generator override
+        if (this.generatorOverridesEnabled)
+        {
+            this.generatorOverrides.forEach((overrideValue, generatorType) =>
+            {
+                if (overrideValue === GENERATOR_OVERRIDE_NO_CHANGE_VALUE)
+                {
+                    return;
+                }
+                voice.generators[generatorType] = overrideValue;
+            });
+        }
+        
         
         // apply exclusive class
         const exclusive = voice.exclusiveClass;

package/src/synthetizer/synth_constants.js

@@ -21,4 +21,6 @@ export const DEFAULT_SYNTH_MODE = "gs";
 
 export const ALL_CHANNELS_OR_DIFFERENT_ACTION = -1;
 
-export const EMBEDDED_SOUND_BANK_ID = `SPESSASYNTH_EMBEDDED_BANK_${Math.random()}`;
+export const EMBEDDED_SOUND_BANK_ID = `SPESSASYNTH_EMBEDDED_BANK_${Math.random()}`;
+
+export const GENERATOR_OVERRIDE_NO_CHANGE_VALUE = 32767;