klang::param

A signal used as a control parameter. More...

#include <klang.h>

Inheritance diagram for klang::param:

Public Member Functions
	param (constant in)
	param (const float initial=0.f)
	param (const signal &in)
	param (signal &in)
	param (Control &in)
param &	operator+= (const increment &increment)
const signal &	operator<< (const signal &input)
	Feedback operator (prevents further processing of returned value).
signal &	operator>> (signal &destination) const
	Stream operator (feedforward; allows further processing)
signal &	operator+= (Output &in)
	Adds processed output of in to signal.
signal &	operator+= (const signal &x)
	Add (mix) another signal to the signal.
signal &	operator+= (float x)
	Add the specified amount to the signal.
signal &	operator+= (double x)
	Add the specified amount to the signal.
signal &	operator+= (int x)
	Add the specified amount to the signal.
signal &	operator-= (const signal &x)
	Subtract another signal from the signal.
signal &	operator-= (float x)
	Subtract the specified amount from the signal.
signal &	operator-= (double x)
	Subtract the specified amount from the signal.
signal &	operator-= (int x)
	Subtract the specified amount from the signal.
signal &	operator*= (const signal &x)
	Multiply (modulate) signal by another signal.
signal &	operator*= (float x)
	Multiply signal by the specified amount.
signal &	operator*= (double x)
	Multiply signal by the specified amount.
signal &	operator*= (int x)
	Multiply signal by the specified amount.
signal &	operator/= (const signal &x)
	Divide signal by another signal.
signal &	operator/= (float x)
	Divide signal by the specified amount.
signal &	operator/= (double x)
	Divide signal by the specified amount.
signal &	operator/= (int x)
	Divide signal by the specified amount.
signal	operator+ (float x) const
	Add two signals together.
signal	operator+ (double x) const
	Return a copy of the signal offset by x.
signal	operator+ (int x) const
	Return a copy of the signal offset by x.
relative	operator+ () const
	Returns a copy of the signal to treat as a relative offset (e.g. for phase modulation).
signal	operator- (float x) const
	Subtract one signal from another.
signal	operator- (double x) const
	Return a copy of the signal offset by -x.
signal	operator- (int x) const
	Return a copy of the signal offset by -x.
signal	operator* (float x) const
	Multiply (modulate) two signals.
signal	operator* (double x) const
	Return a copy of the signal scaled by x.
signal	operator* (int x) const
	Return a copy of the signal scaled by x.
signal	operator/ (float x) const
	Divide one signal by another.
signal	operator/ (double x) const
	Return a copy of the signal divided by.
signal	operator/ (int x) const
	Return a copy of the signal divided by x.
signal	operator^ (float x) const
	Return a copy of the signal raised to the power of x.
signal	operator^ (double x) const
	Return a copy of the signal raised to the power of x.
signal	operator^ (int x) const
	Return a copy of the signal raised to the power of x.
	operator const float () const
	operator float & ()
bool	isDenormal () const
	Check if the signal contains a denormal value.
int	channels () const
	Returns the number of channels (1 = mono).
relative	relative () const
	Returns a copy of the signal to treat as a relative offset (e.g. for phase modulation).

Public Attributes
float	value

Detailed Description

Definition at line 657 of file klang.h.

Constructor & Destructor Documentation

param() [1/5]

klang::param::param ( constant in )

inline

Definition at line 658 of file klang.h.

: signal(in.f) { }

References klang::signal::signal(), and klang::constant::f.

param() [2/5]

klang::param::param ( const float initial = 0.f )

inline

Definition at line 659 of file klang.h.

: signal(initial) { }

References klang::signal::signal().

Referenced by klang::Amplitude::Amplitude(), klang::dB::dB(), and klang::Frequency::Frequency().

param() [3/5]

klang::param::param ( const signal & in )

inline

Definition at line 660 of file klang.h.

: signal(in) { }

param() [4/5]

klang::param::param ( signal & in )

inline

Definition at line 661 of file klang.h.

: signal(in) { }

param() [5/5]

klang::param::param ( Control & in )

inline

Definition at line 1061 of file klang.h.

: signal(in.value) { }

References klang::Control::value.

Member Function Documentation

channels()

int klang::signal::channels ( ) const

inlineinherited

Definition at line 474 of file klang.h.

{ return 1; }

isDenormal()

bool klang::signal::isDenormal ( ) const

inlineinherited

Definition at line 468 of file klang.h.

                            {
      const unsigned int bits = *(const unsigned int*)&value;
      return !(bits & 0x7F800000) && (bits & 0x007FFFFF);
    }

References klang::signal::value.

operator const float()

klang::signal::operator const float ( ) const

inlineinherited

Definition at line 464 of file klang.h.

{ return value; }

References klang::signal::value.

operator float &()

klang::signal::operator float & ( )

inlineinherited

Definition at line 465 of file klang.h.

{       return value; }

References klang::signal::value.

operator*() [1/3]

signal klang::signal::operator* ( double x ) const

inlineinherited

Definition at line 444 of file klang.h.

{ return value * (float)x; }

References klang::signal::value.

operator*() [2/3]

signal klang::signal::operator* ( float x ) const

inlineinherited

Definition at line 435 of file klang.h.

{ return value * x; }

References klang::signal::value.

Referenced by klang::Stereo::frame::mono(), klang::Stereo::frame::operator*(), klang::Stereo::frame::operator*(), klang::Stereo::frame::operator*(), klang::Stereo::frame::operator*(), klang::Stereo::frame::operator*(), klang::Generators::Fast::Phase::operator=(), klang::Generators::Basic::Pulse::process(), klang::Generators::Basic::Saw::process(), klang::Envelope::Follower::rms(), klang::Filters::Biquad::Filter::set(), klang::Generators::Fast::Sine::set(), klang::Generic::Oscillator< SIGNAL >::set(), klang::Generic::Oscillator< SIGNAL >::set(), klang::Wavetable::set(), klang::Wavetable::set(), klang::Wavetable::set(), klang::Generators::Fast::OSM::setDuty(), and klang::Control::smooth().

operator*() [3/3]

signal klang::signal::operator* ( int x ) const

inlineinherited

Definition at line 453 of file klang.h.

{ return value * (float)x; }

References klang::signal::value.

operator*=() [1/4]

signal & klang::signal::operator*= ( const signal & x )

inlineinherited

Definition at line 399 of file klang.h.

{ value *= x.value; return *this; }

References klang::signal::value.

Referenced by klang::buffer::operator*=(), klang::Stereo::frame::operator*=(), klang::Stereo::frame::operator*=(), and klang::Stereo::frame::operator*=().

operator*=() [2/4]

signal & klang::signal::operator*= ( double x )

inlineinherited

Definition at line 417 of file klang.h.

{ value *= (float)x; return *this; }

References klang::signal::value.

operator*=() [3/4]

signal & klang::signal::operator*= ( float x )

inlineinherited

Definition at line 408 of file klang.h.

{ value *= x; return *this; }

References klang::signal::value.

Referenced by klang::Control::operator*=(), klang::Stereo::frame::operator*=(), klang::Stereo::frame::operator*=(), and klang::Stereo::frame::operator*=().

operator*=() [4/4]

signal & klang::signal::operator*= ( int x )

inlineinherited

Definition at line 426 of file klang.h.

{ value *= (float)x; return *this; }

References klang::signal::value.

operator+() [1/4]

relative klang::signal::operator+ ( ) const

inlineinherited

Definition at line 490 of file klang.h.

{ return { value }; }

References klang::signal::value.

operator+() [2/4]

signal klang::signal::operator+ ( double x ) const

inlineinherited

Definition at line 440 of file klang.h.

{ return value + (float)x; }

References klang::signal::value.

operator+() [3/4]

signal klang::signal::operator+ ( float x ) const

inlineinherited

Definition at line 431 of file klang.h.

{ return value + x; }

References klang::signal::value.

Referenced by klang::Stereo::frame::mono(), klang::Stereo::frame::operator+(), klang::Stereo::frame::operator+(), klang::Stereo::frame::operator+(), klang::Stereo::frame::operator+(), klang::Stereo::frame::operator+(), klang::Envelope::Follower::AR::process(), klang::Filters::Butterworth::LPF::process(), klang::ADSR::set(), and klang::Control::smooth().

operator+() [4/4]

signal klang::signal::operator+ ( int x ) const

inlineinherited

Definition at line 449 of file klang.h.

{ return value + (float)x; }

References klang::signal::value.

operator+=() [1/6]

param & klang::param::operator+= ( const increment & increment )

inline

Definition at line 664 of file klang.h.

                                                  {
      value += increment.amount;
      if (value >= increment.size)
        value -= increment.size;
      return *this;
    }

References klang::increment::amount, klang::increment::size, and klang::signal::value.

operator+=() [2/6]

signal & klang::signal::operator+= ( const signal & x )

inlineinherited

Definition at line 395 of file klang.h.

{ value += x.value; return *this; }

References klang::signal::value.

Referenced by klang::buffer::operator+=(), klang::Stereo::frame::operator+=(), klang::Stereo::frame::operator+=(), and klang::Stereo::frame::operator+=().

operator+=() [3/6]

signal & klang::signal::operator+= ( double x )

inlineinherited

Definition at line 413 of file klang.h.

{ value += (float)x; return *this; }

References klang::signal::value.

operator+=() [4/6]

signal & klang::signal::operator+= ( float x )

inlineinherited

Definition at line 404 of file klang.h.

{ value += x; return *this; }

References klang::signal::value.

Referenced by klang::Envelope::Linear::operator++(), klang::Control::operator+=(), klang::Stereo::frame::operator+=(), klang::Stereo::frame::operator+=(), and klang::Stereo::frame::operator+=().

operator+=() [5/6]

signal & klang::signal::operator+= ( int x )

inlineinherited

Definition at line 422 of file klang.h.

{ value += (float)x; return *this; }

References klang::signal::value.

operator+=() [6/6]

signal & klang::signal::operator+= ( Output & in )

inlineinherited

Definition at line 2155 of file klang.h.

                                              { // e.g. out += osc;
    value += signal(in);
    return *this;
  }

References klang::signal::value.

operator-() [1/3]

signal klang::signal::operator- ( double x ) const

inlineinherited

Definition at line 442 of file klang.h.

{ return value - (float)x; }

References klang::signal::value.

operator-() [2/3]

signal klang::signal::operator- ( float x ) const

inlineinherited

Definition at line 433 of file klang.h.

{ return value - x; }

References klang::signal::value.

Referenced by klang::Envelope::at(), klang::Stereo::frame::operator-(), klang::Stereo::frame::operator-(), klang::Stereo::frame::operator-(), klang::Stereo::frame::operator-(), klang::Stereo::frame::operator-(), klang::Envelope::Follower::AR::process(), and klang::Generators::Basic::Saw::process().

operator-() [3/3]

signal klang::signal::operator- ( int x ) const

inlineinherited

Definition at line 451 of file klang.h.

{ return value - (float)x; }

References klang::signal::value.

operator-=() [1/4]

signal & klang::signal::operator-= ( const signal & x )

inlineinherited

Definition at line 397 of file klang.h.

{ value -= x.value; return *this; }

References klang::signal::value.

Referenced by klang::Stereo::frame::operator-=(), klang::Stereo::frame::operator-=(), and klang::Stereo::frame::operator-=().

operator-=() [2/4]

signal & klang::signal::operator-= ( double x )

inlineinherited

Definition at line 415 of file klang.h.

{ value -= (float)x; return *this; }

References klang::signal::value.

operator-=() [3/4]

signal & klang::signal::operator-= ( float x )

inlineinherited

Definition at line 406 of file klang.h.

{ value -= x; return *this; }

References klang::signal::value.

Referenced by klang::Phase::operator+(), klang::Envelope::Linear::operator++(), klang::Control::operator-=(), klang::Stereo::frame::operator-=(), klang::Stereo::frame::operator-=(), and klang::Stereo::frame::operator-=().

operator-=() [4/4]

signal & klang::signal::operator-= ( int x )

inlineinherited

Definition at line 424 of file klang.h.

{ value -= (float)x; return *this; }

References klang::signal::value.

operator/() [1/3]

signal klang::signal::operator/ ( double x ) const

inlineinherited

Definition at line 446 of file klang.h.

{ return value / (float)x; }

References klang::signal::value.

operator/() [2/3]

signal klang::signal::operator/ ( float x ) const

inlineinherited

Definition at line 437 of file klang.h.

{ return value / x; }

References klang::signal::value.

Referenced by klang::Stereo::frame::operator/(), klang::Stereo::frame::operator/(), klang::Stereo::frame::operator/(), klang::Stereo::frame::operator/(), klang::Stereo::frame::operator/(), klang::Generators::Fast::Phase::operator=(), and klang::Generic::Oscillator< SIGNAL >::set().

operator/() [3/3]

signal klang::signal::operator/ ( int x ) const

inlineinherited

Definition at line 455 of file klang.h.

{ return value / (float)x; }

References klang::signal::value.

operator/=() [1/4]

signal & klang::signal::operator/= ( const signal & x )

inlineinherited

Definition at line 401 of file klang.h.

{ value /= x.value; return *this; }

References klang::signal::value.

Referenced by klang::Stereo::frame::operator/=(), klang::Stereo::frame::operator/=(), and klang::Stereo::frame::operator/=().

operator/=() [2/4]

signal & klang::signal::operator/= ( double x )

inlineinherited

Definition at line 419 of file klang.h.

{ value /= (float)x; return *this; }

References klang::signal::value.

operator/=() [3/4]

signal & klang::signal::operator/= ( float x )

inlineinherited

Definition at line 410 of file klang.h.

{ value /= x; return *this; }

References klang::signal::value.

Referenced by klang::Control::operator/=(), klang::Stereo::frame::operator/=(), klang::Stereo::frame::operator/=(), and klang::Stereo::frame::operator/=().

operator/=() [4/4]

signal & klang::signal::operator/= ( int x )

inlineinherited

Definition at line 428 of file klang.h.

{ value /= (float)x; return *this; }

References klang::signal::value.

operator<<()

const signal & klang::signal::operator<< ( const signal & input )

inlineinherited

Definition at line 378 of file klang.h.

                                                  {
      value = input;
      return *this;
    }

References klang::signal::value.

operator>>()

signal & klang::signal::operator>> ( signal & destination ) const

inlineinherited

Definition at line 384 of file klang.h.

                                                  {
      destination.value = value;
      return destination;
    }

References klang::signal::value.

Referenced by klang::Envelope::Follower::AR::process().

operator^() [1/3]

signal klang::signal::operator^ ( double x ) const

inlineinherited

Definition at line 460 of file klang.h.

{ return power(value, x); }

References klang::power(), and klang::signal::value.

operator^() [2/3]

signal klang::signal::operator^ ( float x ) const

inlineinherited

Definition at line 458 of file klang.h.

{ return power(value, x); }

References klang::power(), and klang::signal::value.

operator^() [3/3]

signal klang::signal::operator^ ( int x ) const

inlineinherited

Definition at line 462 of file klang.h.

{ return power(value, x); }

References klang::power(), and klang::signal::value.

relative()

relative klang::signal::relative ( ) const

inlineinherited

Definition at line 492 of file klang.h.

{ return { value }; }

References klang::signal::value.

Member Data Documentation

value

float klang::signal::value

inherited

Definition at line 363 of file klang.h.

Referenced by klang::Amplitude::Amplitude(), klang::signal::signal(), klang::signal::signal(), klang::signal::signal(), klang::signal::signal(), klang::signal::isDenormal(), klang::signal::operator const float(), klang::Control::operator float(), klang::signal::operator float &(), klang::Phase::operator%(), klang::signal::operator*(), klang::signal::operator*(), klang::signal::operator*(), klang::signal::operator*=(), klang::signal::operator*=(), klang::signal::operator*=(), klang::signal::operator*=(), klang::Phase::operator+(), klang::signal::operator+(), klang::signal::operator+(), klang::signal::operator+(), klang::signal::operator+(), operator+=(), klang::Phase::operator+=(), klang::Phase::operator+=(), klang::signal::operator+=(), klang::signal::operator+=(), klang::signal::operator+=(), klang::signal::operator+=(), klang::signal::operator+=(), klang::signal::operator-(), klang::signal::operator-(), klang::signal::operator-(), klang::signal::operator-=(), klang::signal::operator-=(), klang::signal::operator-=(), klang::signal::operator-=(), klang::Amplitude::operator->(), klang::dB::operator->(), klang::Pitch::operator->(), klang::signal::operator/(), klang::signal::operator/(), klang::signal::operator/(), klang::signal::operator/=(), klang::signal::operator/=(), klang::signal::operator/=(), klang::signal::operator/=(), klang::signal::operator<<(), klang::signal::operator>>(), klang::signal::operator^(), klang::signal::operator^(), klang::signal::operator^(), klang::signal::relative(), and klang::Pitch::text().