#include <Oscillator.h>

Inheritance diagram for csl::SumOfSines:

Public Member Functions
	SumOfSines ()
	SumOfSines (float frequency)
	Constructors.
	SumOfSines (unsigned numHarms, float noise)
	1/f spectrum + noise
	SumOfSines (float frequency, unsigned numHarms, float noise)
	SumOfSines (PartialDescriptionMode format, unsigned partialCount,...)
	given a var-args partials list
	SumOfSines (SHARCSpectrum &spect)
void	addPartial (Partial *pt)
	given a SHARC spectrum
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
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.
void	setWaveform (Buffer &wave, bool freeBufs=true)
	plug in waveforms set the interpolation flag
void	setInterpolate (InterpolationPolicy whether)
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)
virtual bool	isActive ()
	query whether I'm currently active (Envelopes can go inactive)
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 ()
virtual void	trigger ()
virtual void	trigger ()
	trigger passed on here
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	setFrequency (UnitGenerator &frequency)
	Setter accessors.
void	setFrequency (float frequency)
	set frequency
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
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

Public Attributes
InterpolationPolicy	mInterpolate
	whether/how I should interpolate between samples
Buffer	mWavetable
	the stored wave form
bool	mUseCache
	whether I'm to cache (vs. compute)

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
void	fillSine ()
	fill the shared wavetable with 1 cycle of a sine wave
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
std::vector< Partial * >	mPartials
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
sample	mPhase
	set phase
PortMap	mInputs
	the map of my inputs or controls (used by the mix-in classes)

Private Attributes
Buffer	outputBuffer

Detailed Description

Definition at line 207 of file Oscillator.h.

Constructor & Destructor Documentation

SumOfSines::SumOfSines ( )

Definition at line 394 of file Oscillator.cpp.

SumOfSines::SumOfSines ( float frequency )

Constructors.

empty constructor

Definition at line 396 of file Oscillator.cpp.

SumOfSines::SumOfSines	(	unsigned	numHarms,
		float	noise
	)

1/f spectrum + noise

Definition at line 447 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 457 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 399 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 435 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 483 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 487 of file Oscillator.cpp.

References mPartials.

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

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

Definition at line 494 of file Oscillator.cpp.

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

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

Definition at line 467 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 475 of file Oscillator.cpp.

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

void SumOfSines::clearPartials ( )

Definition at line 505 of file Oscillator.cpp.

References mPartials.

void SumOfSines::dump ( void )

virtual

print the receiver for debugging

Reimplemented from csl::Oscillator.

Definition at line 560 of file Oscillator.cpp.

References csl::logMsg(), and mPartials.

Referenced by testSumOfSinesCached().

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

protectedvirtual

Implements csl::CompOrCacheOscillator.

Definition at line 511 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.

void CompOrCacheOscillator::createCache ( void )

inherited

Definition at line 199 of file Oscillator.cpp.

References csl::Buffer::allocateBuffers(), csl::Buffer::mNumFrames, csl::Buffer::monoBuffer(), 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 207 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::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().

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::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 109 of file Oscillator.cpp.

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

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.

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::Stereoverb, csl::Abst_SoundFile, csl::Envelope, csl::Instrument, csl::Mixer, and csl::KarplusString.

Definition at line 249 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 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.

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

inherited

Setter accessors.

set frequency

Definition at line 829 of file CSL_Core.cpp.