Filter.h

/*
 * This file is part of libsidplayfp, a SID player engine.
 *
 * Copyright 2011-2026 Leandro Nini <drfiemost@users.sourceforge.net>
 * Copyright 2007-2010 Antti Lankila
 * Copyright 2004 Dag Lem <resid@nimrod.no>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef FILTER_H
#define FILTER_H

#include "FilterModelConfig.h"
#include "Integrator.h"
#include "Voice.h"

#include "siddefs-fp.h"

namespace reSIDfp
{

class Filter
{
    friend class State;

private:
    uint16_t* mixer;
    uint16_t* summer;
    uint16_t* resonance;
    uint16_t* volume;

    const FilterModelConfig& m_fmc;

    const Integrator& m_hpIntegrator;

    const Integrator& m_bpIntegrator;

    uint16_t* currentMixer = nullptr;

    uint16_t* currentSummer = nullptr;

    uint16_t* currentResonance = nullptr;

    uint16_t* currentVolume = nullptr;

    int32_t Vhp = 0;

    int32_t Vbp = 0;

    int32_t Vlp = 0;

    float extin = 0;

    uint16_t fc = 0;


    bool filt1 = false;
    bool filt2 = false;
    bool filt3 = false;
    bool filtE = false;

    bool voice3off = false;


    bool hp = false;
    bool bp = false;
    bool lp = false;

private:
    uint8_t vol = 0;

    bool enabled = true;

    uint8_t filt = 0;

protected:
    virtual void updateCenterFrequency() = 0;

    void updateResonance(uint8_t res) { currentResonance = resonance + (res * (1<<16)); }

    void updateMixing();

    inline unsigned int getFC() const { return static_cast<unsigned int>(fc); }

    virtual void restartIntegrators() = 0;

    inline int32_t getNormalizedVoice(float v, uint8_t env) const
    {
        return m_fmc.getNormalizedVoice(v, env);
    }

    virtual int32_t getNormalizedMixerVoice(float v, uint8_t env) const = 0;

public:
    Filter(const FilterModelConfig& fmc,
           const Integrator& hpIntegrator,
           const Integrator& bpIntegrator);

    virtual ~Filter() = default;

    uint16_t clock(Voice& voice1, Voice& voice2, Voice& voice3);

    void enable(bool enable);

    void reset();

    void writeFC_LO(uint8_t fc_lo);

    void writeFC_HI(uint8_t fc_hi);

    void writeRES_FILT(uint8_t res_filt);

    void writeMODE_VOL(uint8_t mode_vol);

    void input(int16_t input) { extin = input/65535.f; }

    void restart() { restartIntegrators(); Vhp = 0; Vlp = 0; Vbp = 0; }
};

} // namespace reSIDfp

#if RESIDFP_INLINING || defined(FILTER_CPP)

namespace reSIDfp
{

RESIDFP_INLINE
uint16_t Filter::clock(Voice& voice1, Voice& voice2, Voice& voice3)
{
    // Waveform outputs
    const float wav1 = voice1.output();
    const float wav2 = voice2.output();
    const float wav3 = voice3.output();

    // Envelope outputs
    const uint8_t env1 = voice1.envelope()->output();
    const uint8_t env2 = voice2.envelope()->output();
    const uint8_t env3 = voice3.envelope()->output();

    // Voltage summer for filter input
    int32_t Vsum = 0;
    Vsum += filt1 ? getNormalizedVoice(wav1, env1) : 0;
    Vsum += filt2 ? getNormalizedVoice(wav2, env2) : 0;
    Vsum += filt3 ? getNormalizedVoice(wav3, env3) : 0;
    Vsum += filtE ? getNormalizedVoice(extin, 0) : 0;
    Vsum += Vlp;
    Vsum += currentResonance[Vbp];

    // Filter
    Vhp = currentSummer[Vsum];
    Vbp = m_hpIntegrator.solve(Vhp);
    Vlp = m_bpIntegrator.solve(Vbp);

    int32_t Vfilt = 0;
    if (lp) Vfilt += Vlp;
    if (bp) Vfilt += Vbp;
    if (hp) Vfilt += Vhp;

    // Voltage summer for mixer input
    int32_t Vmix = 0;
    Vmix += filt1 ? 0 : getNormalizedMixerVoice(wav1, env1);
    Vmix += filt2 ? 0 : getNormalizedMixerVoice(wav2, env2);
    // Voice 3 is silenced by voice3off if it is not routed through the filter
    Vmix += (filt3 || voice3off) ? 0 : getNormalizedMixerVoice(wav3, env3);
    Vmix += filtE ? 0 : getNormalizedMixerVoice(extin, 0);
    Vmix += Vfilt;

    return currentVolume[currentMixer[Vmix]];
}

} // namespace reSIDfp

#endif

#endif