Klang C++ 0.7.15
Language Reference (draft)
Loading...
Searching...
No Matches
klang::Effect

Language Guide / Plugin Architecture

Effect

klang::Effect

Base class for mono audio effects.

An effect receives the current sample in in and writes the processed sample to out. Override the per-sample process() for ordinary DSP. The buffer overload lets you work directly with a block when the algorithm needs it.

Effect derives from Plugin. Use controls to expose settings such as gain or cutoff in Studio, and presets to give users starting points for common settings.

Example ยท Apply gain

struct Gain : Effect {
    void process() {
        in * 0.5 >> out;
    }
};

See also Stereo::Effect.

Effect mini-plugin (mono) More...

#include <klang.h>

+ Inheritance diagram for klang::Effect:

Public Member Functions

virtual ~Effect ()
 
virtual void prepare ()
 
virtual void process ()
 
virtual void process (buffer buffer)
 
virtual void onControl (int index, float value)
 
virtual void onPreset (int index)
 
virtual void onMIDI (int status, int byte1, int byte2)
 
 operator const signal & () override
 
 operator const signal & () const override
 
Modifier< signal > & operator() (params &&... p)
 
virtual const signal & input () const
 
virtual void input (const signal &source)
 
virtual void operator<< (const signal &source)
 
virtual const signal & output () const
 
TYPE & operator>> (TYPE &destination)
 
signal operator+ (TYPE &other)
 
signal operator* (TYPE &other)
 
signal operator- (TYPE &other)
 
signal operator/ (TYPE &other)
 
void reset ()
 

Static Public Member Functions

template<typename DERIVED , typename... ARGS>
static DERIVED * Create (ARGS &&... args)
 

Public Attributes

Controls controls
 
Presets presets
 
signal in
 
signal out
 

Detailed Description

Definition at line 5535 of file klang.h.

Constructor & Destructor Documentation

◆ ~Effect()

virtual klang::Effect::~Effect ( )
inlinevirtual

Definition at line 5536 of file klang.h.

5536{}

Member Function Documentation

◆ control()

virtual event klang::Controller::control ( int index,
float value )
inlineprotectedvirtualinherited

Definition at line 5509 of file klang.h.

5509{};

◆ Create()

template<typename DERIVED , typename... ARGS>
static DERIVED * klang::Plugin::Create ( ARGS &&... args)
inlinestaticinherited

Definition at line 5523 of file klang.h.

5523 {
5524 static_assert(std::is_base_of_v<Plugin, DERIVED>);
5525 DERIVED* p = new DERIVED();
5526 p->controls.set(std::forward<ARGS>(args)...);
5527 return p;
5528 }

◆ input() [1/3]

virtual void klang::Generic::Input< signal >::input ( )
inlineprotectedvirtualinherited

◆ input() [2/3]

virtual const signal & klang::Generic::Input< signal >::input ( ) const
inlinevirtualinherited

Reimplemented in klang::Generic::Graph< SIZE >::Series.

Definition at line 2947 of file klang.h.

2947{ return in; }

◆ input() [3/3]

virtual void klang::Generic::Input< signal >::input ( const signal & source)
inlinevirtualinherited

Reimplemented in klang::Debug.

Definition at line 2951 of file klang.h.

2951{ in = source; this->input(); }
virtual const signal & input() const
Definition klang.h:2947

◆ midi()

virtual event klang::Controller::midi ( int status,
int byte1,
int byte2 )
inlineprotectedvirtualinherited

Definition at line 5511 of file klang.h.

5511{};

◆ onControl()

virtual void klang::Controller::onControl ( int index,
float value )
inlinevirtualinherited

Reimplemented in klang::Stereo::Synth, and klang::Synth.

Definition at line 5513 of file klang.h.

5513{ this->control(index, value); };
virtual event control(int index, float value)
Definition klang.h:5509

◆ onMIDI()

virtual void klang::Controller::onMIDI ( int status,
int byte1,
int byte2 )
inlinevirtualinherited

Reimplemented in klang::Stereo::Synth, and klang::Synth.

Definition at line 5515 of file klang.h.

5515{ this->midi(status, byte1, byte2); }
virtual event midi(int status, int byte1, int byte2)
Definition klang.h:5511

◆ onPreset()

virtual void klang::Controller::onPreset ( int index)
inlinevirtualinherited

Reimplemented in klang::Stereo::Synth, and klang::Synth.

Definition at line 5514 of file klang.h.

5514{ this->preset(index); };
virtual event preset(int index)
Definition klang.h:5510

◆ operator const signal &() [1/2]

klang::Generic::Modifier< signal >::operator const signal & ( ) const
inlineoverridevirtualinherited

Reimplemented from klang::Generic::Output< signal >.

Definition at line 3091 of file klang.h.

3091{ return out; } // return last output

◆ operator const signal &() [2/2]

klang::Generic::Modifier< signal >::operator const signal & ( )
inlineoverridevirtualinherited

Reimplemented from klang::Generic::Output< signal >.

Definition at line 3090 of file klang.h.

3090{ this->process(); return out; } // return processed output
virtual void process() override
Definition klang.h:3094

◆ operator()()

Modifier< signal > & klang::Generic::Modifier< signal >::operator() ( params &&... p)
inlineinherited

Definition at line 3098 of file klang.h.

3098 {
3099 set(std::forward<params>(p)...); return *this;
3100 }

◆ operator*()

signal klang::Generic::Output< signal >::operator* ( TYPE & other)
inlineinherited

Definition at line 2977 of file klang.h.

2977{ this->process(); return out * SIGNAL(other); }

◆ operator+()

signal klang::Generic::Output< signal >::operator+ ( TYPE & other)
inlineinherited

Definition at line 2976 of file klang.h.

2976{ this->process(); return out + SIGNAL(other); }

◆ operator-()

signal klang::Generic::Output< signal >::operator- ( TYPE & other)
inlineinherited

Definition at line 2978 of file klang.h.

2978{ this->process(); return out - SIGNAL(other); }

◆ operator/()

signal klang::Generic::Output< signal >::operator/ ( TYPE & other)
inlineinherited

Definition at line 2979 of file klang.h.

2979{ this->process(); return out / SIGNAL(other); }

◆ operator<<()

virtual void klang::Generic::Input< signal >::operator<< ( const signal & source)
inlinevirtualinherited

Reimplemented in klang::Debug.

Definition at line 2950 of file klang.h.

2950{ in = source; this->input(); }

◆ operator>>()

TYPE & klang::Generic::Output< signal >::operator>> ( TYPE & destination)
inlineinherited

Definition at line 2969 of file klang.h.

2969{ this->process(); return destination = out; }

◆ output()

virtual const signal & klang::Generic::Output< signal >::output ( ) const
inlinevirtualinherited

Definition at line 2964 of file klang.h.

2964{ return out; }

◆ prepare()

virtual void klang::Effect::prepare ( )
inlinevirtual

Definition at line 5538 of file klang.h.

5538{};

◆ preset()

virtual event klang::Controller::preset ( int index)
inlineprotectedvirtualinherited

Definition at line 5510 of file klang.h.

5510{};

◆ process() [1/2]

virtual void klang::Effect::process ( )
inlinevirtual

Reimplemented from klang::Generic::Modifier< signal >.

Reimplemented in klang::Sound, and klang::Synth.

Definition at line 5539 of file klang.h.

5539{ out = in; }

◆ process() [2/2]

virtual void klang::Effect::process ( buffer buffer)
inlinevirtual

Reimplemented in klang::Sound, and klang::Synth.

Definition at line 5540 of file klang.h.

5540 {
5541 this->prepare();
5542 while (!buffer.finished()) {
5543 input(buffer);
5544 this->process();
5545 buffer++ = out;
5546#if HAS_KLANG_DEBUG
5547 debug.buffer++;
5548#endif
5549 }
5550 }
klang::interleaved::buffer< 2 > buffer
Definition klang.h:5999
static Debug debug
Definition klang.h:4518
static THREAD_LOCAL Buffer buffer
Definition klang.h:4361
virtual void prepare()
Definition klang.h:5538
virtual void process()
Definition klang.h:5539

References klang::Debug::buffer, klang::debug, and klang::buffer::finished().

◆ reset()

void klang::Generic::Output< signal >::reset ( )
inlineinherited

Definition at line 2981 of file klang.h.

2981{ out = 0; }

Member Data Documentation

◆ controls

Controls klang::Plugin::controls
inherited

Definition at line 5530 of file klang.h.

◆ in

◆ out

Definition at line 2961 of file klang.h.

2961{ 0.f };

◆ presets

Presets klang::Plugin::presets
inherited

Definition at line 5531 of file klang.h.