hart_hardclip.hpp

Go to the documentation of this file.

#pragma once
 
#include <algorithm>  // min(), max()
#include <iomanip>
 
#include "hart_cliconfig.hpp"
#include "hart_dsp.hpp"
 
namespace hart
{
 
/// @brief Applies symmetrical hard clipping (no knee) to the signal.
/// @details Signal will never go above the threshold. Signal that doesn't peak above
///         the threshold is guaranteed to be identical to the input signal.
/// @ingroup DSP
template <typename SampleType>
class HardClip:
    public hart::DSP<SampleType, HardClip<SampleType>>
{
public:
    enum Params
    {
        thresholdDb  ///< Threshold in decibels
    };
 
    /// @brief Contructor
    /// @param thresholdDb Fixed threshold in decibels, above which the signal will be symmetrically hard-clipped
    HardClip (double thresholdDb = 0.0):
        m_initialThresholdDb (thresholdDb),
        m_thresholdLinear (decibelsToRatio (thresholdDb))
        {
        }
 
    void prepare (double /*sampleRateHz*/, size_t /*numInputChannels*/, size_t /*numOutputChannels*/, size_t /*maxBlockSizeFrames*/) override {}
 
    void process (const AudioBuffer<SampleType>& input, AudioBuffer<SampleType>& output, const EnvelopeBuffers& /* envelopeBuffers */, ChannelFlags channelsToProcess) override
    {
        hassert (output.getNumFrames() == input.getNumFrames());
        const size_t numChannels = input.getNumChannels();
        const size_t numFrames = input.getNumFrames();
 
        if (input.getNumChannels() != output.getNumChannels())
            HART_THROW_OR_RETURN_VOID (hart::ChannelLayoutError, "Unsupported channel configuration");
 
        for (size_t channel = 0; channel < numChannels; ++channel)
        {
            if (channelsToProcess[channel] == true)
            {
                for (size_t frame = 0; frame < numFrames; ++frame)
                    output[channel][frame] = std::min (std::max (input[channel][frame], (SampleType) -m_thresholdLinear), (SampleType) m_thresholdLinear);
            }
            else
            {
                for (size_t frame = 0; frame < numFrames; ++frame)
                    output[channel][frame] = input[channel][frame];
            }
        }
    }
 
    void reset() override {}
 
    /// @param id Only @ref HardClip::thresholdDb is accepted
    /// @param value Threshold in decibels
    void setValue(int id, double value) override
    {
        if (id == Params::thresholdDb)
            m_thresholdLinear = decibelsToRatio (value);
    }
 
    /// @param id Only @ref HardClip::thresholdDb is accepted
    /// @return Threshold in decibels
    double getValue (int id) const override
    {
        if (id == Params::thresholdDb)
            return ratioToDecibels (m_thresholdLinear);
 
        return 0.0;
    }
 
    /// @details Supports only n-to-n channel configurations 
    bool supportsChannelLayout (size_t numInputChannels, size_t numOutputChannels) const override
    {
        return numInputChannels == numOutputChannels;
    }
 
    void represent (std::ostream& stream) const override
    {
        stream << dbPrecision << "HardClip (" << m_initialThresholdDb << "_dB)";
    }
 
    bool supportsEnvelopeFor (int /* id */) const override
    {
        return false;
    }
 
private:
    double m_initialThresholdDb;
    double m_thresholdLinear;
};
 
HART_DSP_DECLARE_ALIASES_FOR (HardClip)
 
}  // namespace hart