klang::Envelope

Envelope object. More...

#include <klang.h>

Inheritance diagram for klang::Envelope:

Classes
struct	Follower
	Envelope follower (Peak / RMS) More...
struct	Linear
	Linear envelope ramp (default) More...
struct	Loop
	Envelope loop. More...
struct	Point
	Envelope point (x,y) More...
struct	Ramp
	Abstract envelope ramp type. More...

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

Public Member Functions
	Envelope ()
	Envelope (const Points &points)
	Envelope (std::initializer_list< Point > points)
	Envelope (const Envelope &in)
virtual	~Envelope ()
bool	operator== (Stage stage) const
bool	operator!= (Stage stage) const
	operator float () const
Envelope &	operator= (std::initializer_list< Point > points)
void	set (const std::vector< Point > &points)
void	set (const Points &point)
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
virtual void	release (float time, float level=0.f)
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	set (Ramp *ramp)
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
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 2609 of file klang.h.

Member Enumeration Documentation

Mode

enum klang::Envelope::Mode

Values
Time
Rate

Definition at line 2698 of file klang.h.

{ Time, Rate };

Stage

enum klang::Envelope::Stage

Values
Sustain
Release
Off

Definition at line 2696 of file klang.h.

{ Sustain, Release, Off };

Constructor & Destructor Documentation

Envelope() [1/4]

klang::Envelope::Envelope ( )

inline

Definition at line 2753 of file klang.h.

: ramp(new Linear()) {                    set(Points(0.f, 1.f));  }

References ramp, and set().

Envelope() [2/4]

klang::Envelope::Envelope ( const Points & points )

inline

Definition at line 2756 of file klang.h.

: ramp(new Linear()) {          set(points);      }

References ramp, and set().

Envelope() [3/4]

klang::Envelope::Envelope ( std::initializer_list< Point > points )

inline

Definition at line 2759 of file klang.h.

: ramp(new Linear()) {  set(points);      }

References ramp, and set().

Envelope() [4/4]

klang::Envelope::Envelope ( const Envelope & in )

inline

Definition at line 2762 of file klang.h.

: ramp(new Linear()) {            set(in.points);     }

References points, ramp, and set().

~Envelope()

virtual klang::Envelope::~Envelope ( )

inlinevirtual

Definition at line 2764 of file klang.h.

{ }

Member Function Documentation

at()

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

inline

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-(), points, klang::Envelope::Point::x, and klang::Envelope::Point::y.

finished()

bool klang::Envelope::finished ( ) const

inline

Definition at line 2855 of file klang.h.

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

References getStage(), and Off.

getLength()

float klang::Envelope::getLength ( ) const

inline

Definition at line 2844 of file klang.h.

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

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

Referenced by resize().

getStage()

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

inline

Definition at line 2841 of file klang.h.

{ return stage; }

References stage.

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

initialise()

void klang::Envelope::initialise ( )

inline

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 loop, point, points, ramp, klang::Envelope::Loop::reset(), setTarget(), klang::Envelope::Ramp::setValue(), stage, Sustain, timeInc, klang::Envelope::Point::x, and klang::Envelope::Point::y.

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

mode()

Mode klang::Envelope::mode ( ) const

inline

Definition at line 2955 of file klang.h.

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

References Rate, setTargetFunction, setTargetTime(), and Time.

Referenced by 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

inline

Definition at line 2770 of file klang.h.

{ return out; }

operator!=()

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

inline

Definition at line 2768 of file klang.h.

{ return Envelope::stage != stage; }

References 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 )

inline

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(), loop, mode(), Off, klang::Envelope::Ramp::operator++(), point, points, ramp, Rate, Release, setTarget(), klang::Envelope::Ramp::setValue(), stage, klang::Envelope::Loop::start, Sustain, time, 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=()

Envelope & klang::Envelope::operator= ( std::initializer_list< Point > points )

inline

Definition at line 2773 of file klang.h.

                                                           {
      set(points);
      return *this;
    }

References set().

operator==()

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

inline

Definition at line 2767 of file klang.h.

{ return Envelope::stage == stage; }

References stage.

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

inline

Definition at line 2938 of file klang.h.

                                             {
      return points[point];
    }

References 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 ( )

inlineoverridevirtual

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

Definition at line 2933 of file klang.h.

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

References ramp.

release()

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

inlinevirtual

Reimplemented in klang::ADSR.

Definition at line 2847 of file klang.h.

                                                       {
      stage = Release;
      setTarget({ time, level }, 0);
      //ramp->setTime(time);
      //ramp->setTarget(0.f);
    }

References klang::Envelope::Point::Point(), Release, setTarget(), and stage.

Referenced by klang::ADSR::release().

resetLoop()

void klang::Envelope::resetLoop ( )

inline

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 loop, point, points, klang::Envelope::Loop::reset(), setTarget(), stage, Sustain, and klang::Envelope::Point::x.

resize()

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

inline

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 getLength(), initialise(), points, and klang::Envelope::Point::x.

sequence()

void klang::Envelope::sequence ( )

inline

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 initialise(), points, and klang::Envelope::Point::x.

set() [1/3]

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

inline

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 initialise(), and points.

Referenced by Envelope(), and Envelope().

set() [2/3]

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

inline

Definition at line 2779 of file klang.h.

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

References initialise(), and points.

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

set() [3/3]

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

inline

Definition at line 2943 of file klang.h.

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

References initialise(), and ramp.

setLoop()

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

inline

Definition at line 2809 of file klang.h.

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

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

Referenced by klang::ADSR::set().

setMode()

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

inline

Definition at line 2948 of file klang.h.

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

References setTargetFunction, setTargetRate(), setTargetTime(), and Time.

setStage()

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

inline

Definition at line 2838 of file klang.h.

{ this->stage = stage; }

References stage.

setTarget()

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

inline

Definition at line 2893 of file klang.h.

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

References setTargetFunction.

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

setTargetRate()

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

inlineprotected

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 ramp, klang::Envelope::Ramp::setRate(), klang::Envelope::Ramp::setTarget(), klang::Envelope::Ramp::setValue(), time, klang::Envelope::Point::x, and klang::Envelope::Point::y.

Referenced by setMode().

setTargetTime()

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

inlineprotected

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/(), ramp, klang::Envelope::Ramp::setRate(), klang::Envelope::Ramp::setTarget(), time, klang::Envelope::Point::x, and klang::Envelope::Point::y.

Referenced by mode(), and setMode().

Member Data Documentation

loop

Loop klang::Envelope::loop

protected

Definition at line 2978 of file klang.h.

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

out

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

inherited

Definition at line 1357 of file klang.h.

{ 0.f };

point

int klang::Envelope::point

protected

Definition at line 2980 of file klang.h.

Referenced by initialise(), operator++(), and resetLoop().

points

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

protected

Definition at line 2977 of file klang.h.

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

ramp

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

protected

Definition at line 2984 of file klang.h.

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

setTargetFunction

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

protected

Definition at line 2959 of file klang.h.

Referenced by mode(), setMode(), and setTarget().

stage

Stage klang::Envelope::stage

protected

Definition at line 2982 of file klang.h.

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

time

float klang::Envelope::time

protected

Definition at line 2981 of file klang.h.

Referenced by operator++(), setTargetRate(), and setTargetTime().

timeInc

float klang::Envelope::timeInc

protected

Definition at line 2981 of file klang.h.

Referenced by initialise(), and operator++().