warm_saturator.hpp

Go to the documentation of this file.

// sbl/dsp/comp/warm_saturator.hpp — Warm saturation composition
//
// Asymmetric saturation that adds even-order harmonics for tube/transformer
// coloration. Composes gain + AsymmetricShaper + SoftLimiter.
//
// Signal flow: input * drive → asymmetric shaping → soft limiting → output
//
// Drive and asymmetry are both configurable. The old warm_saturate() free
// function hardcoded asymmetry at 0.1 — this composition makes it explicit.
//
// Usage:
//   sbl::dsp::comp::WarmSaturator sat;
//   sat.set_asymmetry(0.1f);      // character: how much even-harmonic warmth
//   float out = sat.process(x, drive);  // drive applied per-sample
 
#ifndef SBL_DSP_COMP_WARM_SATURATOR_HPP_
#define SBL_DSP_COMP_WARM_SATURATOR_HPP_
 
#include <cstdint>
 
#include <sbl/dsp/primitives/asymmetric_shaper.hpp>
#include <sbl/dsp/primitives/soft_limiter.hpp>
 
namespace sbl::dsp::comp {
 
class WarmSaturator {
public:
    /// Set asymmetry depth (structural character parameter)
    void set_asymmetry(float k) { shaper_.set_asymmetry(k); }
 
    /// Current asymmetry depth
    float asymmetry() const { return shaper_.asymmetry(); }
 
    /// Process a single sample with per-sample drive
    float process(float x, float drive) {
        float d = x * drive;
        return limiter_.process(shaper_.process(d));
    }
 
    /// Process a block in-place with constant drive
    void process(float* buf, uint16_t frames, float drive) {
        for (uint16_t i = 0; i < frames; ++i) {
            buf[i] = process(buf[i], drive);
        }
    }
 
private:
    primitives::AsymmetricShaper shaper_;
    primitives::SoftLimiter limiter_;
};
 
} // namespace sbl::dsp::comp
 
#endif // SBL_DSP_COMP_WARM_SATURATOR_HPP_