spessasynth_core 3.27.8 → 4.0.0

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

@@ -1,282 +0,0 @@
-import { absCentsToHz, decibelAttenuationToGain } from "./unit_converter.js";
-import { generatorTypes } from "../../../soundfont/basic_soundfont/generator_types.js";
-
-/**
- * lowpass_filter.js
- * purpose: applies a low pass filter to a voice
- * note to self: a lot of tricks and come from fluidsynth.
- * They are the real smart guys.
- * Shoutout to them!
- * Give their repo a star over at:
- * https://github.com/FluidSynth/fluidsynth
- */
-
-export const FILTER_SMOOTHING_FACTOR = 0.1;
-
-/**
- * @typedef {Object} CachedCoefficient
- * @property {number} a0 - Filter coefficient 1
- * @property {number} a1 - Filter coefficient 2
- * @property {number} a2 - Filter coefficient 3
- * @property {number} a3 - Filter coefficient 4
- * @property {number} a4 - Filter coefficient 5
- */
-
-export class LowpassFilter
-{
-    /**
-     * Cached coefficient calculations
-     * stored as cachedCoefficients[resonanceCb][currentInitialFc]
-     * @type {CachedCoefficient[][]}
-     * @private
-     */
-    static cachedCoefficients = [];
-    /**
-     * Filter coefficient 1
-     * @type {number}
-     */
-    a0 = 0;
-    
-    /**
-     * Filter coefficient 2
-     * @type {number}
-     */
-    a1 = 0;
-    
-    /**
-     * Filter coefficient 3
-     * @type {number}
-     */
-    a2 = 0;
-    
-    /**
-     * Filter coefficient 4
-     * @type {number}
-     */
-    a3 = 0;
-    
-    /**
-     * Filter coefficient 5
-     * @type {number}
-     */
-    a4 = 0;
-    
-    /**
-     * Input history 1
-     * @type {number}
-     */
-    x1 = 0;
-    
-    /**
-     * Input history 2
-     * @type {number}
-     */
-    x2 = 0;
-    
-    /**
-     * Output history 1
-     * @type {number}
-     */
-    y1 = 0;
-    
-    /**
-     * Output history 2
-     * @type {number}
-     */
-    y2 = 0;
-    
-    /**
-     * Resonance in centibels
-     * @type {number}
-     */
-    resonanceCb = 0;
-    
-    /**
-     * Cutoff frequency in absolute cents
-     * @type {number}
-     */
-    currentInitialFc = 13500;
-    
-    /**
-     * For tracking the last cutoff frequency in the apply method, absolute cents
-     * Set to infinity to force recalculation
-     * @type {number}
-     */
-    lastTargetCutoff = Infinity;
-    
-    /**
-     * used for tracking if the filter has been initialized
-     * @type {boolean}
-     */
-    initialized = false;
-    /**
-     * Hertz
-     * @type {number}
-     */
-    sampleRate;
-    
-    /**
-     * @param sampleRate {number}
-     */
-    constructor(sampleRate)
-    {
-        this.sampleRate = sampleRate;
-        /**
-         * @type {number}
-         */
-        this.maxCutoff = sampleRate * 0.45;
-    }
-    
-    /**
-     * Applies a low-pass filter to the given buffer
-     * @param voice {Voice} the voice we are working on
-     * @param outputBuffer {Float32Array} the buffer to apply the filter to
-     * @param fcExcursion {number} the addition of modenv and mod lfo in cents to the filter
-     * @param smoothingFactor {number} filter's cutoff frequency smoothing factor
-     */
-    static apply(voice, outputBuffer, fcExcursion, smoothingFactor)
-    {
-        const initialFc = voice.modulatedGenerators[generatorTypes.initialFilterFc];
-        const filter = voice.filter;
-        
-        
-        if (!filter.initialized)
-        {
-            // filter initialization, set the current fc to target
-            filter.initialized = true;
-            filter.currentInitialFc = initialFc;
-        }
-        else
-        {
-            /* Note:
-             * We only smooth out the initialFc part,
-             * the modulation envelope and LFO excursions are not smoothed.
-             */
-            filter.currentInitialFc += (initialFc - filter.currentInitialFc) * smoothingFactor;
-        }
-        
-        // the final cutoff for this calculation
-        const targetCutoff = filter.currentInitialFc + fcExcursion;
-        const modulatedResonance = voice.modulatedGenerators[generatorTypes.initialFilterQ];
-        /* note:
-         * the check for initialFC is because of the filter optimization
-         * (if cents are the maximum then the filter is open)
-         * filter cannot use this optimization if it's dynamic (see #53), and
-         * the filter can only be dynamic if the initial filter is not open
-         */
-        if (filter.currentInitialFc > 13499 && targetCutoff > 13499 && modulatedResonance === 0)
-        {
-            filter.currentInitialFc = 13500;
-            return; // filter is open
-        }
-        
-        // check if the frequency has changed. if so, calculate new coefficients
-        if (Math.abs(filter.lastTargetCutoff - targetCutoff) > 1 || filter.resonanceCb !== modulatedResonance)
-        {
-            filter.lastTargetCutoff = targetCutoff;
-            filter.resonanceCb = modulatedResonance;
-            LowpassFilter.calculateCoefficients(filter, targetCutoff);
-        }
-        
-        // filter the input
-        // initial filtering code was ported from meltysynth created by sinshu.
-        for (let i = 0; i < outputBuffer.length; i++)
-        {
-            let input = outputBuffer[i];
-            let filtered = filter.a0 * input
-                + filter.a1 * filter.x1
-                + filter.a2 * filter.x2
-                - filter.a3 * filter.y1
-                - filter.a4 * filter.y2;
-            
-            // set buffer
-            filter.x2 = filter.x1;
-            filter.x1 = input;
-            filter.y2 = filter.y1;
-            filter.y1 = filtered;
-            
-            outputBuffer[i] = filtered;
-        }
-    }
-    
-    /**
-     * @param filter {LowpassFilter}
-     * @param cutoffCents {number}
-     */
-    static calculateCoefficients(filter, cutoffCents)
-    {
-        cutoffCents = ~~cutoffCents; // Math.floor
-        const qCb = filter.resonanceCb;
-        // check if these coefficients were already cached
-        const cached = LowpassFilter.cachedCoefficients?.[qCb]?.[cutoffCents];
-        if (cached !== undefined)
-        {
-            filter.a0 = cached.a0;
-            filter.a1 = cached.a1;
-            filter.a2 = cached.a2;
-            filter.a3 = cached.a3;
-            filter.a4 = cached.a4;
-            return;
-        }
-        let cutoffHz = absCentsToHz(cutoffCents);
-        
-        // fix cutoff on low sample rates
-        cutoffHz = Math.min(cutoffHz, filter.maxCutoff);
-        
-        // the coefficient calculation code was originally ported from meltysynth by sinshu.
-        // turn resonance to gain, -3.01 so it gives a non-resonant peak
-        const qDb = qCb / 10;
-        // -1 because it's attenuation, and we don't want attenuation
-        const resonanceGain = decibelAttenuationToGain(-(qDb - 3.01));
-        
-        // the sfspec asks for a reduction in gain based on the Q value.
-        // note that we calculate it again,
-        // without the 3.01-peak offset as it only applies to the coefficients, not the gain.
-        const qGain = 1 / Math.sqrt(decibelAttenuationToGain(-qDb));
-        
-        
-        // note: no sin or cos tables here as the coefficients are cached
-        let w = 2 * Math.PI * cutoffHz / filter.sampleRate;
-        let cosw = Math.cos(w);
-        let alpha = Math.sin(w) / (2 * resonanceGain);
-        
-        let b1 = (1 - cosw) * qGain;
-        let b0 = b1 / 2;
-        let b2 = b0;
-        let a0 = 1 + alpha;
-        let a1 = -2 * cosw;
-        let a2 = 1 - alpha;
-        
-        /**
-         * set coefficients
-         * @type {CachedCoefficient}
-         */
-        const toCache = {};
-        toCache.a0 = b0 / a0;
-        toCache.a1 = b1 / a0;
-        toCache.a2 = b2 / a0;
-        toCache.a3 = a1 / a0;
-        toCache.a4 = a2 / a0;
-        filter.a0 = toCache.a0;
-        filter.a1 = toCache.a1;
-        filter.a2 = toCache.a2;
-        filter.a3 = toCache.a3;
-        filter.a4 = toCache.a4;
-        
-        if (LowpassFilter.cachedCoefficients[qCb] === undefined)
-        {
-            LowpassFilter.cachedCoefficients[qCb] = [];
-        }
-        LowpassFilter.cachedCoefficients[qCb][cutoffCents] = toCache;
-    }
-}
-
-// precompute all the cutoffs for 0q (most common)
-const dummy = new LowpassFilter(44100);
-dummy.resonanceCb = 0;
-// sfspec section 8.1.3: initialFilterFc ranges from 1500 to 13,500 cents
-for (let i = 1500; i < 13500; i++)
-{
-    dummy.currentInitialFc = i;
-    LowpassFilter.calculateCoefficients(dummy, i);
-}