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

Language Guide / Plugin Architecture

Stereo::Sound

klang::Stereo::Sound

Base class for stereo sound sources.

Derive from Stereo::Sound for procedural audio such as game sound effects. Implement process() to generate one frame at a time. Keep oscillators and other stateful processors as members so their state carries from frame to frame.

Write the left and right samples to out.l and out.r. Store a generated sample before sending it to both channels so the generator advances once per frame.

Stereo::Sound inherits the Plugin interface through Stereo::Effect. Use controls to expose settings such as engine speed or surface type, and presets to supply named sets of values.

Example ยท Route a mono source to both channels

struct StereoTone : Stereo::Sound {
    Sine sine;

    void process() {
        const signal sample = sine(220) * 0.1;
        sample >> out.l;
        sample >> out.r;
    }
};

See also Sound.

#include <klang.h>

+ Inheritance diagram for klang::Stereo::Sound:

Public Member Functions

void process () override
 
virtual void process (Stereo::buffer buffer)
 
virtual void process (interleaved::buffer buffer)
 Process interleaved host frames; inherited by the current Stereo::Sound.
 
virtual void prepare ()
 
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

Sound mini-plugin (stereo). Input is available through in, but is silent unless a model explicitly routes it to out or debug.

Definition at line 6096 of file klang.h.

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::Stereo::Effect::prepare ( )
inlinevirtualinherited

Definition at line 6066 of file klang.h.

6066{};

◆ preset()

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

Definition at line 5510 of file klang.h.

5510{};

◆ process() [1/3]

void klang::Stereo::Sound::process ( )
inlineoverridevirtual

Reimplemented from klang::Stereo::Effect.

Definition at line 6098 of file klang.h.

6098{ out = 0; }

◆ process() [2/3]

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

Reimplemented from klang::Stereo::Effect.

Definition at line 6080 of file klang.h.

6080 {
6081 this->prepare();
6082 while (!buffer.finished()) {
6083 input(buffer);
6084 this->process();
6085 buffer++ = out;
6086#if HAS_KLANG_DEBUG
6087 debug.buffer++;
6088#endif
6089 }
6090 }
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:6066
void process() override
Definition klang.h:6098

◆ process() [3/3]

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

Reimplemented from klang::Stereo::Effect.

Definition at line 6068 of file klang.h.

6068 {
6069 this->prepare();
6070 while (!buffer.finished()) {
6071 input(buffer);
6072 this->process();
6073 buffer++ = out;
6074#if HAS_KLANG_DEBUG
6075 debug.buffer++;
6076#endif
6077 }
6078 }

◆ 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.