ADSR = 4-segment attack/decay/sustain/release envelope class. More...

#include <Envelope.h>

Inheritance diagram for csl::ADSR:

Public Member Functions
	ADSR ()
	ADSR (LineMode mode, float t, float a, float d, float s, float r)
	Minimal version - ADSR.
	ADSR (LineMode mode, float t, float i, float a, float d, float s, float r)
	with initial delay - IADSR
	ADSR (float t, float a, float d, float s, float r)
	Minimal version - ADSR.
	ADSR (float t, float i, float a, float d, float s, float r)
	with initial delay - IADSR
	~ADSR ()
void	setDuration (float d)
	Special accessors.
void	setDelay (float del)
void	setAttack (float attack)
void	setDecay (float decay)
void	setSustain (float sustain)
void	setRelease (float release)
void	release (void)
virtual bool	isActive ()
	This answers whether I'm active (ptr < end)
void	addBreakpoint (float startTime, float value)
void	setMode (LineMode mode)
virtual void	scaleTimes (float s)
	scale durations
virtual void	scaleValues (float s)
	scale values so the max is s
virtual void	reset ()
	reset internal time to restart envelope
virtual void	trigger ()
	reset internal time to restart envelope
virtual void	dump ()
	Pretty-printer.
virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	The main FrameStream work method.
virtual void	nextBuffer (Buffer &outputBuffer) throw (CException)
	get a buffer of Frames – this is the core CSL "pull" function; the given buffer can be written into, and a changed() message is sent.
unsigned	frameRate ()
void	setFrameRate (unsigned rate)
	get/set the receiver's frame rate
virtual unsigned	numChannels ()
void	setNumChannels (unsigned ch)
	get/set the receiver's number of outputs
BufferCopyPolicy	copyPolicy ()
void	setCopyPolicy (BufferCopyPolicy ch)
	get/set the receiver's buffer copy policy
virtual bool	isFixed ()
	query whether I'm fixed (StaticVariable overrides this)
void	addOutput (UnitGenerator *ugen)
	add to or return the UGen vector of outputs
void	removeOutput (UnitGenerator *ugen)
UGenVector	outputs ()
virtual unsigned	numOutputs ()
bool	checkFanOut (Buffer &outputBuffer) throw (CException)
	check for fan-out and copy previous buffer; return true if fanning out
void	handleFanOut (Buffer &outputBuffer) throw (CException)
virtual void	setValue (sample theValue)
	set/get the value (not allowed in the abstract, useful for static values)
virtual sample	value ()
void	attachObserver (Observer *)
	(possibly notify obersvers on my death)
void	detachObserver (Observer *)
void	changed (void *argument)
	this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map
virtual int	evaluate (void *argument)
void	setScale (UnitGenerator &scale)
	set the receiver's scale member to a UGen or a float
void	setScale (float scale)
void	setOffset (UnitGenerator &offset)
	set the receiver's offset member to a UGen or a float
void	setOffset (float offset)
void	isScaled ()
	answer whether scale = 1 & offset = 0
Port *	getPort (CSL_MAP_KEY name)

Protected Member Functions
unsigned int	privateNextBuffer (CPoint breakpoint, LineSegment segment, float *buffer, unsigned int numFrames)
	Internal helper method for computing the next buffer.
void	createSegments ()
	Allocate memory for the segments.
void	calculateSegments ()
	Calculate the internal data.
void	zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
	utility method to zero out an outputBuffer
void	addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
	Plug in a unit generator to the named input slot.
void	addInput (CSL_MAP_KEY name, float value)
	Plug in a float to the named input slot.
void	pullInput (Port *thePort, unsigned numFrames) throw (CException)
	method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.
void	pullInput (Port *thePort, Buffer &theBuffer) throw (CException)

Protected Attributes
float	mDuration
	Total duration, typically in seconds.
float	mCurrentMark
	How far we have read.
Breakpoints	mSegmentMap
	list of envelope breakpoints
LineSegment **	mSegments
	array of line segments that for the envelope
float *	mValues
unsigned	mSize
unsigned	mFrameRate
	trigger ignored here
unsigned	mNumChannels
	my "expected" number of output channels
BufferCopyPolicy	mCopyPolicy
	the policy I use if asked for more or fewer channels
UGenVector	mOutputs
	the vector of my output UGens
unsigned	mNumOutputs
	the number of outputs
Buffer *	mOutputCache
	my past output ring buffer (only used in case of fan-out)
unsigned	mSequence
	the highest-seen buffer seq number
PortMap	mInputs
	the map of my inputs or controls (used by the mix-in classes)

Detailed Description

ADSR = 4-segment attack/decay/sustain/release envelope class.

Most of this is inherited from Envelope. This design is an extended ADSR envelope with an initial constant segment and offset (default = 0@0; this can be used to make an attack delay as on ARP ADSRs), attack time and max. val (default = 1.0), decay time, sustain level, and release time and final value (default = 0.0). All times are assumed to be given in seconds. Note that there are many variations on the constructor. The 5 line segments used internally look something like the following

| / . | / \ . | / ————— . | / \ . |—/ \ .

| —– .

Note that, internally, the breakpoints are kept with cumulative times, whereas the line segments only have start/stop Y values and durations (i.e., no absolute time reference).

Definition at line 153 of file Envelope.h.

Constructor & Destructor Documentation

csl::ADSR::ADSR ( )

inline

Definition at line 156 of file Envelope.h.

ADSR::ADSR	(	LineMode	mode,
		float	t,
		float	a,
		float	d,
		float	s,
		float	r
	)

Minimal version - ADSR.

~~~~~~~ Atack / Decay / Sustain / Release Envelope ~~~~~~~~~~~

Minimal version - ADSR . . . call the Super constructor, passing the appropriate points.

Definition at line 365 of file Envelope.cpp.

ADSR::ADSR	(	LineMode	mode,
		float	t,
		float	i,
		float	a,
		float	d,
		float	s,
		float	r
	)

with initial delay - IADSR

Definition at line 370 of file Envelope.cpp.

ADSR::ADSR	(	float	t,
		float	a,
		float	d,
		float	s,
		float	r
	)

Minimal version - ADSR.

Minimal version - ADSR . . . call the Super constructor, passing the appropriate points.

Definition at line 375 of file Envelope.cpp.

ADSR::ADSR	(	float	t,
		float	i,
		float	a,
		float	d,
		float	s,
		float	r
	)

with initial delay - IADSR

Definition at line 380 of file Envelope.cpp.

csl::ADSR::~ADSR ( )

inline

Definition at line 165 of file Envelope.h.

Member Function Documentation

void ADSR::setDuration ( float d )

virtual

Special accessors.

Operations –.

set duration = scale steady-state part of env

Reimplemented from csl::Envelope.

Definition at line 385 of file Envelope.cpp.

Referenced by csl::FMInstrument::parseArgs(), csl::AdditiveInstrument::playMIDI(), csl::FMInstrument::playMIDI(), csl::FancyFMInstrument::playMIDI(), csl::AdditiveInstrument::playNote(), csl::FMInstrument::playNote(), csl::AdditiveInstrument::playOSC(), csl::AdditiveInstrument::setParameter(), csl::FMInstrument::setParameter(), and csl::FancyFMInstrument::setParameter().

void ADSR::setDelay ( float del )

Definition at line 399 of file Envelope.cpp.

References csl::Envelope::calculateSegments(), csl::LineSegment::duration(), csl::Envelope::mSegmentMap, csl::Envelope::mSegments, and csl::Envelope::mValues.

void ADSR::setAttack ( float attack )

Definition at line 409 of file Envelope.cpp.

References csl::Envelope::calculateSegments(), csl::LineSegment::duration(), csl::Envelope::mSegmentMap, csl::Envelope::mSegments, and csl::Envelope::mValues.

Referenced by csl::FMInstrument::parseArgs(), csl::FancyFMInstrument::playMIDI(), csl::AdditiveInstrument::playNote(), csl::FMInstrument::playNote(), csl::AdditiveInstrument::playOSC(), csl::FancyFMInstrument::playOSC(), csl::AdditiveInstrument::setParameter(), and csl::FMInstrument::setParameter().

void ADSR::setDecay ( float decay )

Definition at line 419 of file Envelope.cpp.

References csl::Envelope::calculateSegments(), csl::Envelope::mSegmentMap, and csl::Envelope::mValues.

Referenced by csl::FMInstrument::parseArgs(), csl::FancyFMInstrument::playMIDI(), csl::AdditiveInstrument::playNote(), csl::FMInstrument::playNote(), csl::AdditiveInstrument::playOSC(), csl::FancyFMInstrument::playOSC(), csl::AdditiveInstrument::setParameter(), and csl::FMInstrument::setParameter().

void ADSR::setSustain ( float sustain )

Definition at line 426 of file Envelope.cpp.

References csl::Envelope::calculateSegments(), csl::Envelope::mSegments, and csl::LineSegment::setEnd().

Referenced by csl::FMInstrument::parseArgs(), csl::AdditiveInstrument::playNote(), csl::FMInstrument::playNote(), csl::AdditiveInstrument::playOSC(), csl::AdditiveInstrument::setParameter(), and csl::FMInstrument::setParameter().

void ADSR::setRelease ( float release )

Definition at line 432 of file Envelope.cpp.

References csl::Envelope::calculateSegments(), csl::Envelope::mDuration, csl::Envelope::mSegmentMap, and csl::Envelope::mValues.

Referenced by csl::FMInstrument::parseArgs(), csl::AdditiveInstrument::playNote(), csl::FMInstrument::playNote(), csl::AdditiveInstrument::playOSC(), csl::AdditiveInstrument::setParameter(), and csl::FMInstrument::setParameter().

void ADSR::release ( void )

Definition at line 441 of file Envelope.cpp.

References csl::Envelope::mCurrentMark, and csl::Envelope::mValues.

bool Envelope::isActive ( )

virtualinherited

This answers whether I'm active (ptr < end)

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 211 of file Envelope.cpp.

References csl::Envelope::mCurrentMark, and csl::Envelope::mDuration.

void Envelope::addBreakpoint	(	float	startTime,
		float	value
	)

inherited

Definition at line 192 of file Envelope.cpp.

References csl::Envelope::createSegments(), csl::Envelope::mDuration, csl::Envelope::mSegmentMap, csl::Envelope::mSegments, and csl::Envelope::mValues.

Referenced by sosNote(), and testComplexEnvelope().

void Envelope::setMode ( LineMode mode )

inherited

Definition at line 206 of file Envelope.cpp.

References csl::Envelope::mSegments, and csl::Envelope::mSize.

void Envelope::scaleTimes ( float s )

virtualinherited

scale durations

Reimplemented in csl::RandEnvelope.

Definition at line 229 of file Envelope.cpp.

References csl::Envelope::calculateSegments(), csl::Envelope::mDuration, csl::Envelope::mSegmentMap, csl::Envelope::mSegments, csl::Envelope::mSize, csl::Envelope::mValues, and csl::LineSegment::reset().

Referenced by csl::Envelope::setDuration().

void Envelope::scaleValues ( float s )

virtualinherited

scale values so the max is s

Definition at line 246 of file Envelope.cpp.

References csl::LineSegment::end(), csl::Envelope::mSegments, csl::Envelope::mSize, csl::LineSegment::setEnd(), csl::LineSegment::setStart(), and csl::LineSegment::start().

Referenced by csl::FMInstrument::FMInstrument(), csl::FMInstrument::parseArgs(), csl::AdditiveInstrument::playMIDI(), csl::FMInstrument::playMIDI(), csl::FancyFMInstrument::playMIDI(), csl::AdditiveInstrument::playNote(), csl::FMInstrument::playNote(), csl::AdditiveInstrument::playOSC(), and csl::FMInstrument::setParameter().

void Envelope::reset ( )

virtualinherited

reset internal time to restart envelope

Reset time to 0.0 to restart envelope.

Reimplemented in csl::RandEnvelope.

Definition at line 276 of file Envelope.cpp.

References csl::Envelope::mCurrentMark, csl::Envelope::mSegments, and csl::Envelope::mSize.

Referenced by csl::Envelope::trigger().

void Envelope::trigger ( void )

virtualinherited

reset internal time to restart envelope

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 284 of file Envelope.cpp.

References csl::Envelope::reset().

Referenced by fm_bells(), main(), csl::SndFileInstrument::play(), csl::SndFileInstrument::playNote(), csl::SndFileInstrument::playOSC(), sosNote(), test_SHARC(), test_SHARC2(), testADSR2(), testADSR_FM(), testAMFMEnvs(), testARSin(), testARSin2(), testBlockDownsizer(), testBlockUpsizer(), testComplexEnvelope(), testEnvScale(), testFancy_FM(), testFanMix1(), testFanMix2(), testFrequencyEnv(), testMultiTap(), testRandFreqEnv(), testReverb(), testSplitJoin1(), testSplitJoin2(), testStereoverb(), and testWaveShaper().

void Envelope::dump ( void )

virtualinherited

Pretty-printer.

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 263 of file Envelope.cpp.

References csl::LineSegment::dump(), csl::logMsg(), csl::Envelope::mDuration, csl::Envelope::mSegments, csl::Envelope::mSize, and csl::Envelope::mValues.

Referenced by testComplexEnvelope(), and testFrequencyEnv().

void Envelope::nextBuffer	(	Buffer &	outputBuffer,
		unsigned	outBufNum
	)		throw (CException)

virtualinherited

The main FrameStream work method.

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 292 of file Envelope.cpp.

References DECLARE_SCALABLE_CONTROLS, csl::kLogError, LOAD_SCALABLE_CONTROLS, csl::logMsg(), mFrameRate, and UPDATE_SCALABLE_CONTROLS.

void UnitGenerator::nextBuffer ( Buffer & outputBuffer ) throw (CException)

virtualinherited

get a buffer of Frames – this is the core CSL "pull" function; the given buffer can be written into, and a changed() message is sent.

Reimplemented in csl::Joiner, csl::Splitter, csl::FanOut, csl::SoundCue, csl::Stereoverb, csl::StereoWidth, csl::Abst_SoundFile, csl::NtoMPanner, csl::RemoteStream, csl::LSoundFile, csl::BufferStream, csl::GrainPlayer, csl::Panner, csl::RingBuffer, csl::Instrument, csl::VBAP, csl::IFFT, csl::SpatialSource, csl::BinauralPanner, csl::InOut, csl::Spatializer, csl::Mixer, csl::SpatialPanner, csl::DecodedFile, csl::RingBufferTap, csl::AmbisonicPanner, csl::BlockResizer, csl::FFT, csl::DelayLine, csl::SimplePanner, csl::SimplePanner, and csl::Microphone.

Definition at line 576 of file CSL_Core.cpp.

References csl::kCopy, csl::kExpand, csl::kIgnore, csl::logMsg(), and memcpy().

Referenced by csl::DistanceSimulator::nextBuffer(), csl::RingBufferTap::nextBuffer(), csl::Mixer::nextBuffer(), csl::AmbisonicMixer::nextBuffer(), csl::SpatialSource::nextBuffer(), csl::BufferStream::nextBuffer(), csl::Controllable::pullInput(), csl::PAIO::test(), and csl::FileIO::writeNextBuffer().

unsigned int csl::Envelope::privateNextBuffer	(	CPoint *	breakpoint,
		LineSegment *	segment,
		float *	buffer,
		unsigned int	numFrames
	)

protectedinherited

Internal helper method for computing the next buffer.

void Envelope::createSegments ( )

protectedinherited

Allocate memory for the segments.

Definition at line 164 of file Envelope.cpp.

References csl::Envelope::calculateSegments(), csl::Envelope::mSegmentMap, csl::Envelope::mSegments, and csl::Envelope::mValues.

Referenced by csl::Envelope::addBreakpoint(), and csl::Envelope::Envelope().

void Envelope::calculateSegments ( )

protectedinherited

Calculate the internal data.

Definition at line 170 of file Envelope.cpp.

References csl::Envelope::mCurrentMark, csl::Envelope::mDuration, csl::Envelope::mSegmentMap, csl::Envelope::mSegments, csl::Envelope::mSize, csl::Envelope::mValues, csl::LineSegment::setDuration(), and csl::LineSegment::setStart().

Referenced by csl::Envelope::createSegments(), csl::Envelope::scaleTimes(), csl::AR::setAll(), setAttack(), csl::AR::setAttack(), setDecay(), setDelay(), csl::AR::setDelay(), setRelease(), csl::AR::setRelease(), and setSustain().

unsigned csl::UnitGenerator::frameRate ( )

inlineinherited

Definition at line 225 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by csl::CASoundFile::dump(), csl::Abst_SoundFile::dump(), csl::SoundCue::dump(), csl::Filter::init(), csl::SndFileInstrument::playNote(), and csl::SndFileInstrument::playOSC().

void csl::UnitGenerator::setFrameRate ( unsigned rate )

inlineinherited

get/set the receiver's frame rate

Definition at line 226 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by m3_header().

virtual unsigned csl::UnitGenerator::numChannels ( )

inlinevirtualinherited

Reimplemented in csl::Splitter, and csl::Stereoverb.

Definition at line 228 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

Referenced by csl::AmbisonicMixer::addInput(), csl::BlockResizer::BlockResizer(), csl::Port::checkBuffer(), csl::Effect::Effect(), csl::AmbisonicRotator::initialize(), csl::AmbisonicDecoder::initialize(), m3_output(), csl::Mixer::nextBuffer(), and csl::SpatialSource::SpatialSource().

void csl::UnitGenerator::setNumChannels ( unsigned ch )

inlineinherited

get/set the receiver's number of outputs

Definition at line 229 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

Referenced by csl::BinauralPanner::BinauralPanner(), m3_output(), csl::Spatializer::Spatializer(), csl::VBAP::speakerLayoutChanged(), and csl::VBAP::VBAP().

BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )

inlineinherited

Definition at line 231 of file CSL_Core.h.

References csl::UnitGenerator::mCopyPolicy.

void csl::UnitGenerator::setCopyPolicy ( BufferCopyPolicy ch )

inlineinherited

get/set the receiver's buffer copy policy

Definition at line 232 of file CSL_Core.h.

References csl::UnitGenerator::mCopyPolicy.

Referenced by csl::AmbisonicPanner::AmbisonicPanner(), csl::BinauralPanner::BinauralPanner(), csl::AmbisonicUnitGenerator::initOrder(), csl::Noise::Noise(), csl::PinkNoise::PinkNoise(), csl::Spatializer::Spatializer(), and csl::VBAP::VBAP().

virtual bool csl::UnitGenerator::isFixed ( )

inlinevirtualinherited

query whether I'm fixed (StaticVariable overrides this)

Reimplemented in csl::StaticVariable, and csl::BinaryOp.

Definition at line 247 of file CSL_Core.h.

void UnitGenerator::addOutput ( UnitGenerator * ugen )

inherited

add to or return the UGen vector of outputs

Definition at line 520 of file CSL_Core.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::maxBufferFrames(), csl::UnitGenerator::mNumOutputs, csl::UnitGenerator::mOutputCache, and csl::UnitGenerator::mOutputs.

Referenced by csl::Mixer::addInput(), csl::Controllable::addInput(), csl::AmbisonicRotator::initialize(), csl::AmbisonicDecoder::initialize(), csl::AmbisonicEncoder::setInput(), and csl::IO::setRoot().

void UnitGenerator::removeOutput ( UnitGenerator * ugen )

inherited

Definition at line 530 of file CSL_Core.cpp.

References csl::UnitGenerator::mNumOutputs, and csl::UnitGenerator::mOutputs.

Referenced by csl::IO::clearRoot(), csl::AmbisonicEncoder::setInput(), csl::AmbisonicDecoder::~AmbisonicDecoder(), and csl::AmbisonicRotator::~AmbisonicRotator().

UGenVector csl::UnitGenerator::outputs ( )

inlineinherited

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

virtual unsigned csl::UnitGenerator::numOutputs ( )

inlinevirtualinherited

Definition at line 254 of file CSL_Core.h.

References csl::UnitGenerator::mNumOutputs.

bool UnitGenerator::checkFanOut ( Buffer & outputBuffer ) throw (CException)

inherited

check for fan-out and copy previous buffer; return true if fanning out

Definition at line 549 of file CSL_Core.cpp.

void UnitGenerator::handleFanOut ( Buffer & outputBuffer ) throw (CException)

inherited

Definition at line 563 of file CSL_Core.cpp.

References csl_max.

virtual void csl::UnitGenerator::setValue ( sample theValue )

inlinevirtualinherited

set/get the value (not allowed in the abstract, useful for static values)

Reimplemented in csl::DynamicVariable, and csl::StaticVariable.

Definition at line 260 of file CSL_Core.h.

virtual sample csl::UnitGenerator::value ( )

inlinevirtualinherited

Reimplemented in csl::StaticVariable.

Definition at line 261 of file CSL_Core.h.

void UnitGenerator::zeroBuffer	(	Buffer &	outputBuffer,
		unsigned	outBufNum
	)

protectedinherited

utility method to zero out an outputBuffer

Definition at line 513 of file CSL_Core.cpp.

References csl::Buffer::mMonoBufferByteSize, and csl::Buffer::monoBuffer().

void Model::attachObserver ( Observer * o )

inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 491 of file CGestalt.cpp.

References csl::logMsg(), csl::Observer::mKey, and csl::Observer::mPeriod.

Referenced by csl::SpatialPanner::setSpeakerLayout().

void Model::detachObserver ( Observer * o )

inherited

Definition at line 507 of file CGestalt.cpp.

References csl::logMsg().

Referenced by csl::SpatialPanner::setSpeakerLayout(), and csl::SpatialPanner::~SpatialPanner().

void Model::changed ( void * argument )

inherited

this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map

Definition at line 529 of file CGestalt.cpp.

References csl::logMsg().

Referenced by csl::SpeakerLayout::addSpeaker(), csl::MIDIIn::handleIncomingMidiMessage(), and csl::SpeakerLayout::setDefaultSpeakerLayout().

virtual int csl::Model::evaluate ( void * argument )

inlinevirtualinherited

Reimplemented in csl::MIDIIn.

Definition at line 259 of file CGestalt.h.

void Scalable::setScale ( UnitGenerator & scale )

inherited

set the receiver's scale member to a UGen or a float

Definition at line 887 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_SCALE, and csl::logMsg().