klang::ADSR

Attack-Decay-Sustain-Release Envelope. More...

#include <klang.h>

Inheritance diagram for klang::ADSR:

Public Types
enum	Mode { Time , Rate }
enum	Stage { Sustain , Release , Off }
	Envelope stage. More...

Public Member Functions
	ADSR ()
void	set (param attack, param decay, param sustain, param release) override
void	release (float time=0.f, float level=0.f) override
bool	operator== (Envelope::Stage stage) const
bool	operator!= (Stage stage) const
	operator float () const
void	set (const std::vector< Point > &points)
void	set (const Points &point)
void	set (Ramp *ramp)
void	sequence ()
void	setLoop (int startPoint, int endPoint)
signal	at (param time) const
void	resetLoop ()
void	setStage (Stage stage)
const Stage	getStage () const
float	getLength () const
bool	finished () const
void	initialise ()
void	resize (float length)
void	setTarget (const Point &point, float time=0.0)
signal &	operator++ (int)
void	process () override
const Point &	operator[] (int point) const
void	setMode (Mode mode)
Mode	mode () const
Output< signal > &	operator() (params... p)
	operator const signal & () override
	operator const signal & () const override
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)

Public Attributes
param	A
param	D
param	S
param	R
enum klang::ADSR::Mode	mode = Time
signal	out

Protected Attributes
void(Envelope::*	setTargetFunction )(const Point &point, float time) = &Envelope::setTargetTime
std::vector< Point >	points
Loop	loop
int	point
float	time
float	timeInc
Stage	stage
std::shared_ptr< Ramp >	ramp

Detailed Description

Definition at line 2988 of file klang.h.

Member Enumeration Documentation

Mode

enum klang::ADSR::Mode

Values
Time
Rate

Definition at line 2994 of file klang.h.

{ Time, Rate } mode = Time;

Stage

enum klang::Envelope::Stage

inherited

Values
Sustain
Release
Off

Definition at line 2696 of file klang.h.

{ Sustain, Release, Off };

Constructor & Destructor Documentation

ADSR()

klang::ADSR::ADSR ( )

inline

Definition at line 2996 of file klang.h.

{ set(0.5, 0.5, 1, 0.5); }

References set().

Member Function Documentation

at()

signal klang::Envelope::at ( param time ) const

inlineinherited

Definition at line 2815 of file klang.h.

                                {
      if (points.empty()) return 0;
      Point last = { 0, points[0].y };
      for (const Point& point : points) {
        if (point.x >= time) {
          const float dx = point.x - last.x;
          const float dy = point.y - last.y;
          const float x = time - last.x;
          return dx == 0 ? last.y : (last.y + x * dy / dx);
        }
        last = point;
      }
      return points.back().y;
    }

References klang::Envelope::Point::Point(), klang::signal::operator-(), klang::Envelope::points, klang::Envelope::Point::x, and klang::Envelope::Point::y.

finished()

bool klang::Envelope::finished ( ) const

inlineinherited

Definition at line 2855 of file klang.h.

                          {
      return getStage() == Stage::Off;
    }

References klang::Envelope::getStage(), and klang::Envelope::Off.

getLength()

float klang::Envelope::getLength ( ) const

inlineinherited

Definition at line 2844 of file klang.h.

{ return points.size() ? points[points.size() - 1].x : 0.f; }

References klang::Envelope::points, and klang::Envelope::Point::x.

Referenced by klang::Envelope::resize().

getStage()

const Stage klang::Envelope::getStage ( ) const

inlineinherited

Definition at line 2841 of file klang.h.

{ return stage; }

References klang::Envelope::stage.

Referenced by klang::Envelope::finished(), and operator==().

initialise()

void klang::Envelope::initialise ( )

inlineinherited

Definition at line 2860 of file klang.h.

                     {
      point = 0;
      timeInc = 1.0f / fs;
      loop.reset();
      stage = Sustain;
      if(points.size()){
        out = points[0].y;
        ramp->setValue(points[0].y);
        if(points.size() > 1)
          setTarget(points[1], points[0].x);
      }else{
        out = 1.0f;
        ramp->setValue(1.0f);
      }
    }

References klang::Envelope::loop, klang::Envelope::point, klang::Envelope::points, klang::Envelope::ramp, klang::Envelope::Loop::reset(), klang::Envelope::setTarget(), klang::Envelope::Ramp::setValue(), klang::Envelope::stage, klang::Envelope::Sustain, klang::Envelope::timeInc, klang::Envelope::Point::x, and klang::Envelope::Point::y.

Referenced by klang::Envelope::resize(), klang::Envelope::sequence(), set(), klang::Envelope::set(), klang::Envelope::set(), and klang::Envelope::set().

mode()

Mode klang::Envelope::mode ( ) const

inlineinherited

Definition at line 2955 of file klang.h.

{ return setTargetFunction == &Envelope::setTargetTime ? Time : Rate; }

References klang::Envelope::Rate, klang::Envelope::setTargetFunction, klang::Envelope::setTargetTime(), and klang::Envelope::Time.

Referenced by klang::Envelope::operator++().

operator const signal &() [1/2]

klang::Generic::Generator< signal >::operator const signal & ( ) const

inlineoverridevirtualinherited

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

Definition at line 1416 of file klang.h.

{ return out; } // return last output   

operator const signal &() [2/2]

klang::Generic::Generator< signal >::operator const signal & ( )

inlineoverridevirtualinherited

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

Definition at line 1415 of file klang.h.

{ process(); return out; } // return processed output   

operator float()

klang::Envelope::operator float ( ) const

inlineinherited

Definition at line 2770 of file klang.h.

{ return out; }

operator!=()

bool klang::Envelope::operator!= ( Stage stage ) const

inlineinherited

Definition at line 2768 of file klang.h.

{ return Envelope::stage != stage; }

References klang::Envelope::stage.

operator()()

Output< signal > & klang::Generic::Generator< signal >::operator() ( params... p )

inlineinherited

Definition at line 1409 of file klang.h.

                                              {
        set(p...); return *this;
      }

operator*()

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

inlineinherited

Definition at line 1372 of file klang.h.

{ process(); return out * (other); }

operator+()

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

inlineinherited

Definition at line 1371 of file klang.h.

{ process(); return out + (other); }

operator++()

signal & klang::Envelope::operator++ ( int )

inlineinherited

Definition at line 2898 of file klang.h.

                           { 
      out = (*ramp)++;
            
      switch(stage){
      case Sustain:
        time += timeInc;
        if (!ramp->isActive()) { // envelop segment end reached
          if (loop.isActive() && (point + 1) >= loop.end) {
            point = loop.start;
            ramp->setValue(points[point].y);
            if (loop.start != loop.end)
              setTarget(points[point + 1], points[point].x);
          } else if ((point + 1) < points.size()) {
            if (mode() == Rate || time >= points[point + 1].x) { // reached target point
              point++;
              ramp->setValue(points[point].y); // make sure exact value is set
 
              if ((point + 1) < points.size()) // new target point?
                setTarget(points[point + 1], points[point].x);
            }
          } else {
            stage = Off;
          }
        } break;
      case Release:
        if (!ramp->isActive()) //if(out == 0.0)
          stage = Off;
        break;
      case Off:
        break;
      }
            
      return out;
    }

References klang::Envelope::Loop::end, klang::Envelope::Loop::isActive(), klang::Envelope::Ramp::isActive(), klang::Envelope::loop, klang::Envelope::mode(), klang::Envelope::Off, klang::Envelope::Ramp::operator++(), klang::Envelope::point, klang::Envelope::points, klang::Envelope::ramp, klang::Envelope::Rate, klang::Envelope::Release, klang::Envelope::setTarget(), klang::Envelope::Ramp::setValue(), klang::Envelope::stage, klang::Envelope::Loop::start, klang::Envelope::Sustain, klang::Envelope::time, klang::Envelope::timeInc, klang::Envelope::Point::x, and klang::Envelope::Point::y.

operator-()

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

inlineinherited

Definition at line 1373 of file klang.h.

{ process(); return out - (other); }

operator/()

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

inlineinherited

Definition at line 1374 of file klang.h.

{ process(); return out / (other); }

operator==()

bool klang::ADSR::operator== ( Envelope::Stage stage ) const

inline

Definition at line 3017 of file klang.h.

                                               {
      return getStage() == stage;
    }

References klang::Envelope::getStage().

operator>>()

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

inlineinherited

Definition at line 1364 of file klang.h.

{ process(); return destination = out; }

operator[]()

const Point & klang::Envelope::operator[] ( int point ) const

inlineinherited

Definition at line 2938 of file klang.h.

                                             {
      return points[point];
    }

References klang::Envelope::points.

output()

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

inlinevirtualinherited

Definition at line 1360 of file klang.h.

{ return out; }

process()

void klang::Envelope::process ( )

inlineoverridevirtualinherited

Implements klang::Generic::Output< signal >.

Definition at line 2933 of file klang.h.

                            { /* do nothing -> only process on ++ */
      out = *ramp;
    }

References klang::Envelope::ramp.

release()

void klang::ADSR::release ( float time = 0.f, float level = 0.f )

inlineoverridevirtual

Reimplemented from klang::Envelope.

Definition at line 3013 of file klang.h.

                                                               {
      Envelope::release(time ? time : float(R), level);
    }

References R, and klang::Envelope::release().

resetLoop()

void klang::Envelope::resetLoop ( )

inlineinherited

Definition at line 2831 of file klang.h.

                    {
      loop.reset();
      if(stage == Sustain && (point+1) < points.size())
        setTarget(points[point+1], points[point].x);
    }

References klang::Envelope::loop, klang::Envelope::point, klang::Envelope::points, klang::Envelope::Loop::reset(), klang::Envelope::setTarget(), klang::Envelope::stage, klang::Envelope::Sustain, and klang::Envelope::Point::x.

resize()

void klang::Envelope::resize ( float length )

inlineinherited

Definition at line 2877 of file klang.h.

                             {
      const float old_length = getLength();
      if(old_length == 0.0)
        return;
            
      const float multiplier = length / (fs * old_length);
      std::vector<Point>::iterator point = points.begin();
      while(point != points.end()){
        point->x *= multiplier;
        point++;
      }
            
      initialise();
    }

References klang::Envelope::getLength(), klang::Envelope::initialise(), klang::Envelope::points, and klang::Envelope::Point::x.

sequence()

void klang::Envelope::sequence ( )

inlineinherited

Definition at line 2798 of file klang.h.

                    {
      float time = 0.f;
      for(Point& point : points) {
        const float delta = point.x;
        time += delta + 0.00001f;
        point.x = time;
      }
      initialise();
    }

References klang::Envelope::initialise(), klang::Envelope::points, and klang::Envelope::Point::x.

set() [1/4]

void klang::ADSR::set ( param attack, param decay, param sustain, param release )

inlineoverride

Definition at line 2998 of file klang.h.

                                                                               {
      A = attack + 0.005f;
      D = decay + 0.005f;
      S = sustain;
      R = release + 0.005f;
 
      points.resize(3);
      points[0] = { 0, 0 };
      points[1] = { A, 1 };
      points[2] = { A + D, S };
      
      initialise();
      setLoop(2, 2);
    }

References klang::Envelope::Point::Point(), A, D, klang::Envelope::initialise(), klang::signal::operator+(), klang::Envelope::points, R, S, and klang::Envelope::setLoop().

Referenced by ADSR().

set() [2/4]

void klang::Envelope::set ( const Points & point )

inlineinherited

Definition at line 2785 of file klang.h.

                                 {
      points.clear();
            
      const Points* pPoint = &point;
      while(pPoint){
        points.push_back(*pPoint);
        pPoint = pPoint->next;
      }
            
      initialise();
    }

References klang::Envelope::initialise(), and klang::Envelope::points.

Referenced by klang::Envelope::Envelope(), and klang::Envelope::Envelope().

set() [3/4]

void klang::Envelope::set ( const std::vector< Point > & points )

inlineinherited

Definition at line 2779 of file klang.h.

                                             {
      Envelope::points = points;
      initialise();
    }

References klang::Envelope::initialise(), and klang::Envelope::points.

Referenced by klang::Envelope::Envelope(), klang::Envelope::Envelope(), and klang::Envelope::operator=().

set() [4/4]

void klang::Envelope::set ( Ramp * ramp )

inlineinherited

Definition at line 2943 of file klang.h.

                         {
      Envelope::ramp = std::shared_ptr<Ramp>(ramp);
      initialise();
    }

References klang::Envelope::initialise(), and klang::Envelope::ramp.

setLoop()

void klang::Envelope::setLoop ( int startPoint, int endPoint )

inlineinherited

Definition at line 2809 of file klang.h.

                                              {
      if(startPoint >= 0 && endPoint < points.size())
        loop.set(startPoint, endPoint);
    }

References klang::Envelope::loop, klang::Envelope::points, and klang::Envelope::Loop::set().

Referenced by set().

setMode()

void klang::Envelope::setMode ( Mode mode )

inlineinherited

Definition at line 2948 of file klang.h.

                            {
      if (mode == Time)
        setTargetFunction = &Envelope::setTargetTime;
      else
        setTargetFunction = &Envelope::setTargetRate;
    }

References klang::Envelope::setTargetFunction, klang::Envelope::setTargetRate(), klang::Envelope::setTargetTime(), and klang::Envelope::Time.

setStage()

void klang::Envelope::setStage ( Stage stage )

inlineinherited

Definition at line 2838 of file klang.h.

{ this->stage = stage; }

References klang::Envelope::stage.

setTarget()

void klang::Envelope::setTarget ( const Point & point, float time = 0.0 )

inlineinherited

Definition at line 2893 of file klang.h.

                                                        {
      (this->*setTargetFunction)(point, time);
    }

References klang::Envelope::setTargetFunction.

Referenced by klang::Envelope::initialise(), klang::Envelope::operator++(), klang::Envelope::release(), and klang::Envelope::resetLoop().

setTargetRate()

void klang::Envelope::setTargetRate ( const Point & point, float rate = 0.0 )

inlineprotectedinherited

Definition at line 2967 of file klang.h.

                                                             {
      this->time = 0;
      if (point.x == 0) {
        ramp->setValue(point.y);
      } else {
        ramp->setTarget(point.y);
        ramp->setRate(point.x);
      }
    }

References klang::Envelope::ramp, klang::Envelope::Ramp::setRate(), klang::Envelope::Ramp::setTarget(), klang::Envelope::Ramp::setValue(), klang::Envelope::time, klang::Envelope::Point::x, and klang::Envelope::Point::y.

Referenced by klang::Envelope::setMode().

setTargetTime()

void klang::Envelope::setTargetTime ( const Point & point, float time = 0.0 )

inlineprotectedinherited

Definition at line 2961 of file klang.h.

                                                             {
      this->time = time;
      ramp->setTarget(point.y);
      ramp->setRate(abs(point.y - ramp->out) / ((point.x - time) * fs));
    }

References klang::Generic::operator/(), klang::Envelope::ramp, klang::Envelope::Ramp::setRate(), klang::Envelope::Ramp::setTarget(), klang::Envelope::time, klang::Envelope::Point::x, and klang::Envelope::Point::y.

Referenced by klang::Envelope::mode(), and klang::Envelope::setMode().

Member Data Documentation

A

param klang::ADSR::A

Definition at line 2992 of file klang.h.

Referenced by set().

D

param klang::ADSR::D

Definition at line 2992 of file klang.h.

Referenced by set().

loop

Loop klang::Envelope::loop

protectedinherited

Definition at line 2978 of file klang.h.

Referenced by klang::Envelope::initialise(), klang::Envelope::operator++(), klang::Envelope::resetLoop(), and klang::Envelope::setLoop().

mode

enum klang::ADSR::Mode klang::ADSR::mode = Time

out

signal klang::Generic::Output< signal >::out

inherited

Definition at line 1357 of file klang.h.

{ 0.f };

point

int klang::Envelope::point

protectedinherited

Definition at line 2980 of file klang.h.

Referenced by klang::Envelope::initialise(), klang::Envelope::operator++(), and klang::Envelope::resetLoop().

points

std::vector<Point> klang::Envelope::points

protectedinherited

Definition at line 2977 of file klang.h.

Referenced by klang::Envelope::Envelope(), klang::Envelope::at(), klang::Envelope::getLength(), klang::Envelope::initialise(), klang::Envelope::operator++(), klang::Envelope::operator[](), klang::Envelope::resetLoop(), klang::Envelope::resize(), klang::Envelope::sequence(), set(), klang::Envelope::set(), klang::Envelope::set(), and klang::Envelope::setLoop().

R

param klang::ADSR::R

Definition at line 2992 of file klang.h.

Referenced by release(), and set().

ramp

std::shared_ptr<Ramp> klang::Envelope::ramp

protectedinherited

Definition at line 2984 of file klang.h.

Referenced by klang::Envelope::Envelope(), klang::Envelope::Envelope(), klang::Envelope::Envelope(), klang::Envelope::Envelope(), klang::Envelope::initialise(), klang::Envelope::operator++(), klang::Envelope::process(), klang::Envelope::set(), klang::Envelope::setTargetRate(), and klang::Envelope::setTargetTime().

S

param klang::ADSR::S

Definition at line 2992 of file klang.h.

Referenced by set().

setTargetFunction

void(Envelope::* klang::Envelope::setTargetFunction) (const Point &point, float time) = &Envelope::setTargetTime

protectedinherited

Definition at line 2959 of file klang.h.

Referenced by klang::Envelope::mode(), klang::Envelope::setMode(), and klang::Envelope::setTarget().

stage

Stage klang::Envelope::stage

protectedinherited

Definition at line 2982 of file klang.h.

Referenced by klang::Envelope::getStage(), klang::Envelope::initialise(), klang::Envelope::operator!=(), klang::Envelope::operator++(), klang::Envelope::operator==(), klang::Envelope::release(), klang::Envelope::resetLoop(), and klang::Envelope::setStage().

time

float klang::Envelope::time

protectedinherited

Definition at line 2981 of file klang.h.

Referenced by klang::Envelope::operator++(), klang::Envelope::setTargetRate(), and klang::Envelope::setTargetTime().

timeInc

float klang::Envelope::timeInc

protectedinherited

Definition at line 2981 of file klang.h.

Referenced by klang::Envelope::initialise(), and klang::Envelope::operator++().