dspark::detail::SaturationAlgorithm< T > Class Template Reference

#include <Saturation.h>

Inheritance diagram for dspark::detail::SaturationAlgorithm< T >:

Public Member Functions
virtual	~SaturationAlgorithm ()=default
virtual void	prepare (const AudioSpec &spec) noexcept=0
	Prepares the algorithm with the current audio specification.
virtual void	reset () noexcept=0
	Resets internal states (filters, phase, memory).
virtual void	update (T, T, const AudioSpec &) noexcept
	Updates internal coefficients dependent on block-rate parameters.
virtual Saturation< T >::Algorithm	getType () const noexcept=0
	Identifies the exact algorithm type for CRTP static dispatch.
void	setAntialias (bool on) noexcept
	Enables 1st-order antiderivative anti-aliasing (ADAA) on the memoryless curves (Tanh/Tube/HardClip). Combined with oversampling this is the cleanest known approach (Parker/Zavalishin DAFx-16, Bilbao et al. 2017). No-op for algorithms that do not implement it. Default off (transparent).

Static Public Attributes
static constexpr int	kAaCh = 16

Protected Attributes
std::atomic< bool >	antialias_ { false }

Detailed Description

template<typename T>
class dspark::detail::SaturationAlgorithm< T >

Definition at line 78 of file Saturation.h.

Constructor & Destructor Documentation

~SaturationAlgorithm()

template<typename T >

virtual dspark::detail::SaturationAlgorithm< T >::~SaturationAlgorithm ( )

virtualdefault

Member Function Documentation

getType()

template<typename T >

virtual Saturation< T >::Algorithm dspark::detail::SaturationAlgorithm< T >::getType ( ) const

pure virtualnoexcept

Identifies the exact algorithm type for CRTP static dispatch.

Implemented in dspark::detail::TanhAlgorithm< T >, dspark::detail::TubeAlgorithm< T >, dspark::detail::HardClipAlgorithm< T >, dspark::detail::ExciterAlgorithm< T >, dspark::detail::WavefolderAlgorithm< T >, dspark::detail::BitcrusherAlgorithm< T >, dspark::detail::TapeAlgorithm< T >, dspark::detail::TransformerAlgorithm< T >, dspark::detail::DownsampleAlgorithm< T >, and dspark::detail::MultiStageAlgorithm< T >.

prepare()

template<typename T >

virtual void dspark::detail::SaturationAlgorithm< T >::prepare ( const AudioSpec &  spec )

pure virtualnoexcept

Prepares the algorithm with the current audio specification.

Implemented in dspark::detail::TanhAlgorithm< T >, dspark::detail::TubeAlgorithm< T >, dspark::detail::HardClipAlgorithm< T >, dspark::detail::ExciterAlgorithm< T >, dspark::detail::WavefolderAlgorithm< T >, dspark::detail::BitcrusherAlgorithm< T >, dspark::detail::TapeAlgorithm< T >, dspark::detail::TransformerAlgorithm< T >, dspark::detail::DownsampleAlgorithm< T >, and dspark::detail::MultiStageAlgorithm< T >.

reset()

template<typename T >

virtual void dspark::detail::SaturationAlgorithm< T >::reset ( )

pure virtualnoexcept

Resets internal states (filters, phase, memory).

Implemented in dspark::detail::TanhAlgorithm< T >, dspark::detail::TubeAlgorithm< T >, dspark::detail::HardClipAlgorithm< T >, dspark::detail::ExciterAlgorithm< T >, dspark::detail::WavefolderAlgorithm< T >, dspark::detail::BitcrusherAlgorithm< T >, dspark::detail::TapeAlgorithm< T >, dspark::detail::TransformerAlgorithm< T >, dspark::detail::DownsampleAlgorithm< T >, and dspark::detail::MultiStageAlgorithm< T >.

setAntialias()

template<typename T >

void dspark::detail::SaturationAlgorithm< T >::setAntialias ( bool  on )

inlinenoexcept

Enables 1st-order antiderivative anti-aliasing (ADAA) on the memoryless curves (Tanh/Tube/HardClip). Combined with oversampling this is the cleanest known approach (Parker/Zavalishin DAFx-16, Bilbao et al. 2017). No-op for algorithms that do not implement it. Default off (transparent).

Definition at line 103 of file Saturation.h.

update()

template<typename T >

virtual void dspark::detail::SaturationAlgorithm< T >::update ( T  , T  , const AudioSpec &    )

inlinevirtualnoexcept

Updates internal coefficients dependent on block-rate parameters.

Reimplemented in dspark::detail::MultiStageAlgorithm< T >, dspark::detail::BitcrusherAlgorithm< T >, dspark::detail::TapeAlgorithm< T >, dspark::detail::DownsampleAlgorithm< T >, and dspark::detail::TransformerAlgorithm< T >.

Definition at line 92 of file Saturation.h.

Member Data Documentation

antialias_

template<typename T >

std::atomic<bool> dspark::detail::SaturationAlgorithm< T >::antialias_ { false }

protected

Definition at line 106 of file Saturation.h.

kAaCh

template<typename T >

constexpr int dspark::detail::SaturationAlgorithm< T >::kAaCh = 16

staticconstexpr

Definition at line 81 of file Saturation.h.

---

The documentation for this class was generated from the following file:

• Effects/Saturation.h