Process signals. More...

Classes
class	DSP< SampleType >
	Base for DSP effects. More...

class	GainDb< SampleType >
	Applies gain in decibels to the signal. More...

class	GainLinear< SampleType >
	Applies linear gain (not decibels) to the signal. More...

class	HardClip< SampleType >
	Applies symmetrical hard clipping (no knee) to the signal. More...

Macros
#define	HART_DSP_DEFINE_COPY_AND_MOVE(ClassName)
	Defines hart::DSP::copy() and hart::DSP::move() methods.

#define	HART_DSP_FORBID_COPY_AND_MOVE
	Forbids hart::DSP::copy() and hart::DSP::move() methods.

Functions
template<typename SampleType >
std::ostream &	operator<< (std::ostream &stream, const DSP< SampleType > &dsp)
	Prints readable text representation of the DSP object into the I/O stream.

Detailed Description

Process signals.

Macro Definition Documentation

◆ HART_DSP_DEFINE_COPY_AND_MOVE

#define HART_DSP_DEFINE_COPY_AND_MOVE ( ClassName )

Value:

    std::unique_ptr<DSP<SampleType>> copy() const override { \
        return hart::make_unique<ClassName> (*this); \
    } \
    std::unique_ptr<DSP<SampleType>> move() override { \
        return hart::make_unique<ClassName> (std::move (*this)); \
    }

Defines hart::DSP::copy() and hart::DSP::move() methods.

Put this into your class body's public section if either is true:

Your class is trivially copyable and movable
You have your Rule Of Five methods explicitly defined in this class (see Rule Of Three/Five/Zero)

If neither of those is true, or you're unsure, use HART_DSP_FORBID_COPY_AND_MOVE instead

Despite returning a smart pointer to an abstract DSP class, those two methods must construct an object of a specific class, hence the mandatory boilerplate methods - sorry!

Parameters

ClassName Name of your class

Definition at line 334 of file hart_dsp.hpp.

◆ HART_DSP_FORBID_COPY_AND_MOVE

#define HART_DSP_FORBID_COPY_AND_MOVE

Value:

    std::unique_ptr<DSP<SampleType>> copy() const override { \
        static_assert(false, "This DSP cannot be copied"); \
        return nullptr; \
    } \
    std::unique_ptr<DSP<SampleType>> move() override { \
        static_assert(false, "This DSP cannot be moved"); \
        return nullptr; \
    }

Forbids hart::DSP::copy() and hart::DSP::move() methods.

Put this into your class body's public section if either is true:

Your class is not trivially copyable and movable
You don't want to trouble yourself with implementing move and copy semantics for your class

Otherwise, use HART_DSP_DEFINE_COPY_AND_MOVE() instead. Obviously, you won't be able to pass your class to the host by reference, copy or explicit move, but you still can pass it wrapped into a smart pointer like so:

processAudioWith (hart::make_unique<MyDspType>()).withThis().withThat().process();

But it's still better to get your move and copy semantics figured out - this is a perfect chance to stress-test your effect's resource management, among other things!

Definition at line 357 of file hart_dsp.hpp.

Function Documentation

◆ operator<<()

template<typename SampleType >

std::ostream & operator<<	(	std::ostream &	stream,
		const DSP< SampleType > &	dsp
	)

Definition at line 315 of file hart_dsp.hpp.

Classes