Envelope: a collection of LineSegments; may have an input (scale) and act like a processor, or have no input and act like a control UGen. I inherit Scalable setScale, setOffset for inputs. More...

#include <Envelope.h>

Inheritance diagram for csl::Envelope:

List of all members.

Public Member Functions
	Envelope ()
	Envelope (LineMode mode, float t, float x1, float y1, float x2=0, float y2=1.0, float x3=0, float y3=1.0, float x4=0, float y4=1.0, float x5=0, float y5=1.0, float x6=0, float y6=1.0)
	Envelope class.
	Envelope (LineMode mode, float t, unsigned int size, float x[], float y[])
	Envelope (float t, float x1, float y1, float x2=0, float y2=1.0, float x3=0, float y3=1.0, float x4=0, float y4=1.0, float x5=0, float y5=1.0, float x6=0, float y6=1.0)
	Envelope (float t, unsigned int size, float x[], float y[])
virtual	~Envelope ()
virtual bool	isActive ()
	This answers whether I'm active (ptr < end)
void	addBreakpoint (float startTime, float value)
void	setMode (LineMode mode)
virtual void	setDuration (float d)
	set/scale durations
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.
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 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.
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

Envelope: a collection of LineSegments; may have an input (scale) and act like a processor, or have no input and act like a control UGen. I inherit Scalable setScale, setOffset for inputs.

Definition at line 89 of file Envelope.h.

Constructor & Destructor Documentation

csl::Envelope::Envelope ( )

inline

Definition at line 91 of file Envelope.h.

Envelope::Envelope	(	LineMode	mode,
		float	t,
		float	x1,
		float	y1,
		float	x2 = `0`,
		float	y2 = `1.0`,
		float	x3 = `0`,
		float	y3 = `1.0`,
		float	x4 = `0`,
		float	y4 = `1.0`,
		float	x5 = `0`,
		float	y5 = `1.0`,
		float	x6 = `0`,
		float	y6 = `1.0`
	)

Envelope class.

Lots of useful constructors

Definition at line 117 of file Envelope.cpp.

References createSegments(), and mSegmentMap.

Envelope::Envelope	(	LineMode	mode,
		float	t,
		unsigned int	size,
		float	x[],
		float	y[]
	)

Definition at line 129 of file Envelope.cpp.

References createSegments(), and mSegmentMap.

Envelope::Envelope	(	float	t,
		float	x1,
		float	y1,
		float	x2 = `0`,
		float	y2 = `1.0`,
		float	x3 = `0`,
		float	y3 = `1.0`,
		float	x4 = `0`,
		float	y4 = `1.0`,
		float	x5 = `0`,
		float	y5 = `1.0`,
		float	x6 = `0`,
		float	y6 = `1.0`
	)

Definition at line 136 of file Envelope.cpp.

References createSegments(), and mSegmentMap.

Envelope::Envelope	(	float	t,
		unsigned int	size,
		float	x[],
		float	y[]
	)

Definition at line 148 of file Envelope.cpp.

References createSegments(), and mSegmentMap.

Envelope::~Envelope ( )

virtual

Definition at line 155 of file Envelope.cpp.

References mSegmentMap, mSegments, and mValues.

Member Function Documentation

bool Envelope::isActive ( )

virtual

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 mCurrentMark, and mDuration.

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

Definition at line 192 of file Envelope.cpp.

References createSegments(), mDuration, mSegmentMap, mSegments, and mValues.

Referenced by sosNote(), and testComplexEnvelope().

void Envelope::setMode ( LineMode mode )

Definition at line 206 of file Envelope.cpp.

References mSegments, and mSize.

void Envelope::setDuration ( float d )

virtual

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(), mDuration, and scaleTimes().

Referenced by csl::FancyFMInstrument::setParameter().

void Envelope::scaleTimes ( float s )

virtual

scale durations

Reimplemented in csl::RandEnvelope.

Definition at line 229 of file Envelope.cpp.

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

Referenced by setDuration().

void Envelope::scaleValues ( float s )

virtual

scale values so the max is s

Definition at line 246 of file Envelope.cpp.

References csl::LineSegment::end(), mSegments, 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 ( )

virtual

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 mCurrentMark, mSegments, and mSize.

Referenced by trigger().

void Envelope::trigger ( void )

virtual

reset internal time to restart envelope

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 284 of file Envelope.cpp.

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

virtual

Pretty-printer.

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 263 of file Envelope.cpp.

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

Referenced by testComplexEnvelope(), and testFrequencyEnv().

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

virtual

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.

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

protected

Internal helper method for computing the next buffer.

void Envelope::createSegments ( )

protected

Allocate memory for the segments.

Definition at line 164 of file Envelope.cpp.

References calculateSegments(), mSegmentMap, mSegments, and mValues.

Referenced by addBreakpoint(), and Envelope().

void Envelope::calculateSegments ( )

protected

Calculate the internal data.

Definition at line 170 of file Envelope.cpp.

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

Referenced by createSegments(), scaleTimes(), csl::AR::setAll(), csl::ADSR::setAttack(), csl::AR::setAttack(), csl::ADSR::setDecay(), csl::ADSR::setDelay(), csl::AR::setDelay(), csl::ADSR::setRelease(), csl::AR::setRelease(), and csl::ADSR::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().

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

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