#include <Oscillator.h>

Inheritance diagram for csl::SumOfSines:

Public Member Functions
	SumOfSines ()

	SumOfSines (float frequency)
	Constructors. More...

	SumOfSines (unsigned numHarms, float noise)
	1/f spectrum + noise More...

	SumOfSines (float frequency, unsigned numHarms, float noise)

	SumOfSines (PartialDescriptionMode format, unsigned partialCount,...)
	given a var-args partials list More...

	SumOfSines (SHARCSpectrum &spect)

void	addPartial (Partial *pt)
	given a SHARC spectrum More...

void	addPartials (unsigned num_p, Partial **pt)

void	addPartials (int argc, void **argv)

void	addPartial (float nu, float amp)

void	addPartial (float nu, float amp, float phase)

void	clearPartials ()

void	dump ()
	print the receiver for debugging More...

void	createCache ()

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

void	setWaveform (Buffer &wave, bool freeBufs=true)
	plug in waveforms set the interpolation flag More...

void	setInterpolate (InterpolationPolicy whether)

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

virtual bool	isActive ()
	query whether I'm currently active (Envelopes can go inactive) 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 ()

virtual void	trigger ()

virtual void	trigger ()
	trigger passed on here More...

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	setFrequency (UnitGenerator &frequency)
	Setter accessors. More...

void	setFrequency (float frequency)
	set frequency More...

void	setPhase (float phase)

Port *	getPort (CSL_MAP_KEY name)

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

Public Attributes
InterpolationPolicy	mInterpolate
	whether/how I should interpolate between samples More...

Buffer	mWavetable
	the stored wave form More...

bool	mUseCache
	whether I'm to cache (vs. compute) More...

Protected Member Functions
void	nextWaveInto (SampleBuffer dest, unsigned count, bool oneHz)

virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times More...

void	fillSine ()
	fill the shared wavetable with 1 cycle of a sine wave 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
std::vector< Partial * >	mPartials

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

sample	mPhase
	set phase More...

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

Private Attributes
Buffer	outputBuffer

Detailed Description

Definition at line 207 of file Oscillator.h.

Constructor & Destructor Documentation

SumOfSines::SumOfSines ( )

Definition at line 397 of file Oscillator.cpp.

SumOfSines::SumOfSines ( float frequency )

Constructors.

empty constructor

Definition at line 399 of file Oscillator.cpp.

SumOfSines::SumOfSines	(	unsigned	numHarms,
		float	noise
	)

1/f spectrum + noise

Definition at line 450 of file Oscillator.cpp.

References addPartial(), csl::CompOrCacheOscillator::createCache(), CSL_PI, and csl::fRandV().

SumOfSines::SumOfSines	(	float	frequency,
		unsigned	numHarms,
		float	noise
	)

Definition at line 460 of file Oscillator.cpp.

References addPartial(), csl::CompOrCacheOscillator::createCache(), CSL_PI, csl::fRandM(), and csl::fRandV().

SumOfSines::SumOfSines	(	PartialDescriptionMode	format,
		unsigned	partialCount,
			...
	)

given a var-args partials list

Definition at line 402 of file Oscillator.cpp.

References csl::Partial::amplitude, kFreqAmp, kFreqAmpPhase, kFrequency, mPartials, csl::Partial::number, and csl::Partial::phase.

SumOfSines::SumOfSines ( SHARCSpectrum & spect )

Definition at line 438 of file Oscillator.cpp.

References csl::SHARCSpectrum::_num_partials, csl::SHARCSpectrum::_partials, addPartial(), csl::Partial::amplitude, csl::CompOrCacheOscillator::createCache(), csl::Partial::number, and csl::Partial::phase.

Member Function Documentation

void SumOfSines::addPartial ( Partial * pt )

given a SHARC spectrum

Definition at line 486 of file Oscillator.cpp.

References mPartials.

Referenced by csl::SquareBL::nextWaveInto(), csl::AdditiveInstrument::setParameter(), sosNote(), SumOfSines(), and testSumOfSinesSteps().

void SumOfSines::addPartials	(	unsigned	num_p,
		Partial **	pt
	)

Definition at line 490 of file Oscillator.cpp.

References mPartials.

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

void SumOfSines::addPartials	(	int	argc,
		void **	argv
	)

Definition at line 497 of file Oscillator.cpp.

References csl::Partial::amplitude, mPartials, and csl::Partial::number.

void SumOfSines::addPartial	(	float	nu,
		float	amp
	)

Definition at line 470 of file Oscillator.cpp.

References csl::Partial::amplitude, mPartials, csl::Partial::number, and csl::Partial::phase.

void SumOfSines::addPartial	(	float	nu,
		float	amp,
		float	phase
	)

Definition at line 478 of file Oscillator.cpp.

References csl::Partial::amplitude, mPartials, csl::Partial::number, and csl::Partial::phase.

void SumOfSines::clearPartials ( )

Definition at line 508 of file Oscillator.cpp.

References mPartials.

void SumOfSines::dump ( void )

virtual

print the receiver for debugging

Reimplemented from csl::Oscillator.

Definition at line 563 of file Oscillator.cpp.

References csl::Controllable::dump(), csl::logMsg(), and mPartials.

Referenced by testSumOfSinesCached().

void SumOfSines::nextWaveInto	(	SampleBuffer	dest,
		unsigned	count,
		bool	oneHz
	)

protectedvirtual

Implements csl::CompOrCacheOscillator.

Definition at line 514 of file Oscillator.cpp.

References csl::Partial::amplitude, CSL_TWOPI, DECLARE_PHASED_CONTROLS, DECLARE_SCALABLE_CONTROLS, LOAD_PHASED_CONTROLS, LOAD_SCALABLE_CONTROLS, csl::UnitGenerator::mFrameRate, mPartials, csl::Partial::number, csl::Partial::phase, UPDATE_PHASED_CONTROLS, and UPDATE_SCALABLE_CONTROLS.

Referenced by csl::SquareBL::nextWaveInto().

void CompOrCacheOscillator::createCache ( void )

inherited

Definition at line 202 of file Oscillator.cpp.

References csl::Buffer::allocateBuffers(), csl::Buffer::buffer(), csl::Buffer::mNumFrames, csl::Cacheable::mUseCache, csl::WavetableOscillator::mWavetable, and csl::CompOrCacheOscillator::nextWaveInto().

Referenced by sosNote(), SumOfSines(), testComplexEnvelope(), testRandFreqEnv(), testSplitJoin1(), testSplitJoin2(), testSumOfSines1F(), and testSumOfSinesCached().

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

protectedvirtualinherited

really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times

Reimplemented from csl::WavetableOscillator.

Definition at line 210 of file Oscillator.cpp.

References csl::WavetableOscillator::nextBuffer().

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

void WavetableOscillator::setWaveform	(	Buffer &	wave,
		bool	freeBufs = `true`
	)

inherited

plug in waveforms set the interpolation flag

Definition at line 76 of file Oscillator.cpp.

References csl::Buffer::buffer(), csl::Buffer::buffers(), csl::Buffer::freeBuffers(), csl::Buffer::mAreBuffersAllocated, csl::Buffer::mAreBuffersZero, csl::Buffer::mDidIAllocateBuffers, csl::Buffer::mIsPopulated, csl::Buffer::mMonoBufferByteSize, csl::Buffer::mNumAlloc, csl::Buffer::mNumChannels, csl::UnitGenerator::mNumChannels, csl::Buffer::mNumFrames, csl::WavetableOscillator::mWavetable, csl::Buffer::setBuffer(), and csl::Buffer::setBuffers().

Referenced by csl::Abst_SoundFile::Abst_SoundFile(), and csl::WavetableOscillator::WavetableOscillator().

void csl::WavetableOscillator::setInterpolate ( InterpolationPolicy whether )

inlineinherited

Definition at line 79 of file Oscillator.h.

References csl::WavetableOscillator::mInterpolate.

void WavetableOscillator::fillSine ( )

protectedinherited

fill the shared wavetable with 1 cycle of a sine wave

Definition at line 112 of file Oscillator.cpp.

References csl::Buffer::allocateBuffers(), csl::Buffer::buffer(), CSL_TWOPI, DEFAULT_WTABLE_SIZE, csl::Buffer::mAreBuffersAllocated, csl::Buffer::mDidIAllocateBuffers, csl::WavetableOscillator::mWavetable, csl::Buffer::setBuffer(), and csl::Buffer::setSize().

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.

virtual bool csl::UnitGenerator::isActive ( )

inlinevirtualinherited

query whether I'm currently active (Envelopes can go inactive)

Reimplemented in csl::Joiner, csl::Effect, csl::RandEnvelope, csl::SoundCue, csl::Abst_SoundFile, csl::Stereoverb, csl::Envelope, csl::Instrument, csl::Mixer, and csl::KarplusString.

Definition at line 273 of file CSL_Core.h.

Referenced by csl::Instrument::isActive(), csl::Port::isActive(), csl::Mixer::nextBuffer(), csl::BinauralPanner::nextBuffer(), csl::AmbisonicMixer::nextBuffer(), and csl::VBAP::nextBuffer().

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.

virtual void csl::UnitGenerator::trigger ( void )

inlinevirtualinherited

Reimplemented in csl::Joiner, csl::Effect, csl::RandEnvelope, csl::SoundCue, csl::Abst_SoundFile, csl::Envelope, csl::LineSegment, and csl::KarplusString.

Definition at line 288 of file CSL_Core.h.

Referenced by csl::Instrument::play(), csl::Instrument::release(), and csl::Port::trigger().

void Scalable::trigger ( void )

virtualinherited

trigger passed on here

Reimplemented in csl::RandEnvelope, csl::Abst_SoundFile, csl::Envelope, and csl::KarplusString.

Definition at line 1069 of file CSL_Core.cpp.

References CSL_OFFSET, CSL_SCALE, and csl::Controllable::mInputs.

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 Phased::setFrequency ( UnitGenerator & frequency )

inherited

Setter accessors.

set frequency

Definition at line 981 of file CSL_Core.cpp.