Triangle envelope class – equal attack/release times. More...

#include <Envelope.h>

Inheritance diagram for csl::Triangle:

Public Member Functions
	Triangle ()
	Various Constructors. More...

	Triangle (LineMode mode, float duration, float amplitude)
	Simple constructor. More...

	Triangle (LineMode mode, float duration, float initialDelay, float amplitude)
	Versions with initial delay segments. More...

	Triangle (float duration, float amplitude=1.0f)
	Simple constructor. More...

	Triangle (float duration, float initialDelay, float amplitude)
	Versions with initial delay segments. More...

	~Triangle ()
	Minimal version - AR. More...

virtual bool	isActive ()
	This answers whether I'm active (ptr < end) More...

void	addBreakpoint (float startTime, float value)

void	setMode (LineMode mode)

virtual void	setDuration (float d)
	set/scale durations More...

virtual void	scaleTimes (float s)
	scale durations More...

virtual void	scaleValues (float s)
	scale values so the max is s More...

virtual void	reset ()
	reset internal time to restart envelope More...

virtual void	trigger ()
	reset internal time to restart envelope More...

virtual void	dump ()
	Pretty-printer. More...

virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	The main FrameStream work method. More...

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

unsigned	frameRate ()

void	setFrameRate (unsigned rate)
	get/set the receiver's frame rate More...

virtual unsigned	numChannels ()

void	setNumChannels (unsigned ch)
	get/set the receiver's number of outputs More...

BufferCopyPolicy	copyPolicy ()

void	setCopyPolicy (BufferCopyPolicy ch)
	get/set the receiver's buffer copy policy More...

virtual bool	isFixed ()
	query whether I'm fixed (StaticVariable overrides this) More...

void	addOutput (UnitGenerator *ugen)
	add to or return the UGen vector of outputs More...

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

void	handleFanOut (Buffer &outputBuffer) throw (CException)

virtual void	setValue (sample theValue)
	set/get the value (not allowed in the abstract, useful for static values) More...

virtual sample	value ()

void	attachObserver (Observer *)
	(possibly notify obersvers on my death) More...

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

virtual int	evaluate (void *argument)

void	setScale (UnitGenerator &scale)
	set the receiver's scale member to a UGen or a float More...

void	setScale (float scale)

void	setOffset (UnitGenerator &offset)
	set the receiver's offset member to a UGen or a float More...

void	setOffset (float offset)

void	isScaled ()
	answer whether scale = 1 & offset = 0 More...

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

void	createSegments ()
	Allocate memory for the segments. More...

void	calculateSegments ()
	Calculate the internal data. More...

void	zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
	utility method to zero out an outputBuffer More...

void	addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
	Plug in a unit generator to the named input slot. More...

void	addInput (CSL_MAP_KEY name, float value)
	Plug in a float to the named input slot. More...

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

void	pullInput (Port *thePort, Buffer &theBuffer) throw (CException)

Protected Attributes
float	mDuration
	Total duration, typically in seconds. More...

float	mCurrentMark
	How far we have read. More...

Breakpoints	mSegmentMap
	list of envelope breakpoints More...

LineSegment **	mSegments
	array of line segments that for the envelope More...

float *	mValues

unsigned	mSize

unsigned	mFrameRate
	trigger ignored here More...

unsigned	mNumChannels
	my "expected" number of output channels More...

BufferCopyPolicy	mCopyPolicy
	the policy I use if asked for more or fewer channels More...

UGenVector	mOutputs
	the vector of my output UGens More...

unsigned	mNumOutputs
	the number of outputs More...

Buffer *	mOutputCache
	my past output ring buffer (only used in case of fan-out) More...

unsigned	mSequence
	the highest-seen buffer seq number More...

PortMap	mInputs
	the map of my inputs or controls (used by the mix-in classes) More...

Detailed Description

Triangle envelope class – equal attack/release times.

Definition at line 227 of file Envelope.h.

Constructor & Destructor Documentation

csl::Triangle::Triangle ( )

inline

Various Constructors.

Definition at line 230 of file Envelope.h.

Triangle::Triangle	(	LineMode	mode,
		float	duration,
		float	amplitude
	)

Simple constructor.

~~~~~ Triangle class ~~~~~

Definition at line 525 of file Envelope.cpp.

Triangle::Triangle	(	LineMode	mode,
		float	duration,
		float	initialDelay,
		float	amplitude
	)

Versions with initial delay segments.

Definition at line 530 of file Envelope.cpp.

Triangle::Triangle	(	float	duration,
		float	amplitude = `1.0f`
	)

Simple constructor.

Definition at line 535 of file Envelope.cpp.

Triangle::Triangle	(	float	duration,
		float	initialDelay,
		float	amplitude
	)

Versions with initial delay segments.

Definition at line 540 of file Envelope.cpp.

csl::Triangle::~Triangle ( )

inline

Minimal version - AR.

Definition at line 240 of file Envelope.h.

Member Function Documentation

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::setDuration ( float d )

virtualinherited

set/scale durations

Scaling operations.

Reimplemented in csl::RandEnvelope, csl::AR, and csl::ADSR.

Definition at line 220 of file Envelope.cpp.

References csl::kLogError, csl::logMsg(), csl::Envelope::mDuration, and csl::Envelope::scaleTimes().

Referenced by csl::ADSR::setDuration(), csl::AR::setDuration(), and csl::FancyFMInstrument::setParameter().

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 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::Controllable::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::BufferStream, csl::LSoundFile, 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::RingBufferTap, csl::Convolver, csl::AmbisonicPanner, csl::Convolver2, csl::FFT, csl::BlockResizer, csl::DelayLine, csl::SimplePanner, csl::SimplePanner, and csl::Microphone.

Definition at line 726 of file CSL_Core.cpp.

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

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(), csl::AR::setAttack(), csl::AR::setDelay(), and csl::AR::setRelease().

unsigned csl::UnitGenerator::frameRate ( )

inlineinherited

Definition at line 249 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by csl::CASoundFile::dump(), csl::Abst_SoundFile::dump(), and csl::SoundCue::dump().

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

inlineinherited

get/set the receiver's frame rate

Definition at line 250 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

virtual unsigned csl::UnitGenerator::numChannels ( )

inlinevirtualinherited

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

Definition at line 252 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(), csl::Mixer::nextBuffer(), csl::Convolver2::setIRFile(), csl::Convolver::setIRFile(), and csl::SpatialSource::SpatialSource().

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

inlineinherited

get/set the receiver's number of outputs

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

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

BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )

inlineinherited

Definition at line 255 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 256 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 271 of file CSL_Core.h.

void UnitGenerator::addOutput ( UnitGenerator * ugen )

inherited

add to or return the UGen vector of outputs

Definition at line 670 of file CSL_Core.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), 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 680 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 277 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

virtual unsigned csl::UnitGenerator::numOutputs ( )

inlinevirtualinherited

Definition at line 278 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 699 of file CSL_Core.cpp.

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

inherited

Definition at line 713 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 284 of file CSL_Core.h.

virtual sample csl::UnitGenerator::value ( )

inlinevirtualinherited

Reimplemented in csl::StaticVariable.

Definition at line 285 of file CSL_Core.h.

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

protectedinherited

utility method to zero out an outputBuffer

Definition at line 663 of file CSL_Core.cpp.

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

void Model::attachObserver ( Observer * o )

inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 502 of file CGestalt.cpp.

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

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

void Model::detachObserver ( Observer * o )

inherited

Definition at line 518 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 540 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 270 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 1039 of file CSL_Core.cpp.

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