CSL port of the public domain Freeverb reverberator. More...

#include <Freeverb.h>

Inheritance diagram for csl::Freeverb:

Public Member Functions
	Freeverb (UnitGenerator &input)
	~Freeverb ()
float	roomSize ()
void	setRoomSize (float size)
	Setting the room size makes longer tails. The value has a range from 0 to 1.
float	dampening ()
void	setDampening (float damp)
	Specified in percentage (from 0 to 100%).
float	wetLevel ()
void	setWetLevel (float level)
	Amount of wet (reverberation) in the mixed output.
float	dryLevel ()
void	setDryLevel (float level)
	Amount of the original "dry" signal in the output.
float	width ()
void	setWidth (float width)
	Currently not used, as this reverb became mono in/out.
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
virtual bool	isActive ()
	am I active?
void	setInput (UnitGenerator &inp)
	set the receiver's input generator
void	setInline ()
	set the Effect to be inline
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 ()
virtual void	dump ()
	pretty-print the receiver
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)
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)
virtual void	trigger ()
	trigger passed on here
void	isScaled ()
	answer whether scale = 1 & offset = 0

Public Attributes
bool	isInline
	whether to use input or buffer as source

Protected Member Functions
void	constructReverbGraph ()
void	updateParameters ()
void	pullInput (Buffer &outputBuffer) throw (CException)
void	pullInput (unsigned numFrames) throw (CException)
	trigger passed on here
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)
virtual void	trigger ()
	trigger passed on here get the input port
Port *	inPort ()
virtual void	dump ()
	pretty-print the receiver's input/controls map
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.

Protected Attributes
float	mRoomSize
float	mDampening
float	mWetLevel
float	mDryLevel
float	mWidth
float	mGain
std::vector< Comb * >	mCombFilters
std::vector< FAllpass * >	mAllpassFilters
SampleBufferVector	mCombBuffers
SampleBufferVector	mAllpassBuffers
SampleBuffer	mInputPtr
	A pointer to my input's data. method to read the input value.
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

CSL port of the public domain Freeverb reverberator.

Definition at line 23 of file Freeverb.h.

Constructor & Destructor Documentation

Freeverb::Freeverb ( UnitGenerator & input )

Definition at line 71 of file Freeverb.cpp.

References constructReverbGraph().

Freeverb::~Freeverb ( )

Definition at line 75 of file Freeverb.cpp.

References mAllpassBuffers, mAllpassFilters, mCombBuffers, and mCombFilters.

Member Function Documentation

float Freeverb::roomSize ( )

Definition at line 141 of file Freeverb.cpp.

References mRoomSize.

void Freeverb::setRoomSize ( float size )

Setting the room size makes longer tails. The value has a range from 0 to 1.

Definition at line 143 of file Freeverb.cpp.

References kOffsetRoom, kScaleRoom, mRoomSize, and updateParameters().

Referenced by constructReverbGraph(), csl::Stereoverb::setRoomSize(), csl::Stereoverb::Stereoverb(), test_SHARC2(), testFancy_FM(), and testReverb().

float Freeverb::dampening ( )

Definition at line 148 of file Freeverb.cpp.

References kScaleDamp, and mDampening.

void Freeverb::setDampening ( float damp )

Specified in percentage (from 0 to 100%).

The "damp" parameter can be thought as setting the material of the room walls.

Definition at line 152 of file Freeverb.cpp.

References kScaleDamp, mDampening, and updateParameters().

Referenced by constructReverbGraph(), and csl::Stereoverb::setDampening().

float Freeverb::wetLevel ( )

Definition at line 157 of file Freeverb.cpp.

References mWetLevel.

void Freeverb::setWetLevel ( float level )

Amount of wet (reverberation) in the mixed output.

Definition at line 159 of file Freeverb.cpp.

References mWetLevel, and updateParameters().

Referenced by constructReverbGraph(), csl::Stereoverb::setWetLevel(), and csl::Stereoverb::Stereoverb().

float Freeverb::dryLevel ( )

Definition at line 164 of file Freeverb.cpp.

References mDryLevel.

void Freeverb::setDryLevel ( float level )

Amount of the original "dry" signal in the output.

Definition at line 168 of file Freeverb.cpp.

References mDryLevel.

Referenced by constructReverbGraph(), csl::Stereoverb::setDryLevel(), and csl::Stereoverb::Stereoverb().

float Freeverb::width ( )

Definition at line 170 of file Freeverb.cpp.

References mWidth.

void Freeverb::setWidth ( float width )

Currently not used, as this reverb became mono in/out.

Definition at line 172 of file Freeverb.cpp.

References mWidth, and updateParameters().

Referenced by constructReverbGraph(), and csl::Stereoverb::setWidth().

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

virtual

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

Reimplemented from csl::UnitGenerator.

Definition at line 179 of file Freeverb.cpp.

References csl::logMsg().

void Freeverb::constructReverbGraph ( )

protected

Definition at line 91 of file Freeverb.cpp.

References kAllpassBufferSizes, kCombBufferSizes, kFixedGain, kInitialDamp, kInitialDry, kInitialRoom, kInitialWet, kInitialWidth, kNumAllpasses, kNumCombs, mAllpassBuffers, mAllpassFilters, mCombBuffers, mCombFilters, mGain, csl::Comb::setBuffer(), csl::FAllpass::setBuffer(), setDampening(), setDryLevel(), csl::FAllpass::setFeedback(), setRoomSize(), setWetLevel(), setWidth(), and updateParameters().

Referenced by Freeverb().

void Freeverb::updateParameters ( )

protected

Definition at line 133 of file Freeverb.cpp.

References mCombFilters, mDampening, and mRoomSize.

Referenced by constructReverbGraph(), setDampening(), setRoomSize(), setWetLevel(), and setWidth().

bool Effect::isActive ( )

virtualinherited

am I active?

Reimplemented from csl::UnitGenerator.

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

Definition at line 951 of file CSL_Core.cpp.

References CSL_INPUT, csl::Port::isActive(), and csl::Controllable::mInputs.

Referenced by csl::Stereoverb::isActive().

void Effect::setInput ( UnitGenerator & inp )

inherited

set the receiver's input generator

Definition at line 958 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_INPUT, csl::Effect::isInline, and csl::logMsg().

void csl::Effect::setInline ( )

inlineinherited

set the Effect to be inline

Definition at line 446 of file CSL_Core.h.

References csl::Effect::isInline.

void Effect::pullInput ( Buffer & outputBuffer ) throw (CException)

protectedinherited

Definition at line 968 of file CSL_Core.cpp.

References CSL_INPUT, csl::logMsg(), and csl::Controllable::pullInput().

Referenced by csl::InOut::nextBuffer(), csl::RingBuffer::nextBuffer(), csl::Panner::nextBuffer(), csl::FIR::nextBuffer(), csl::Filter::nextBuffer(), csl::DynamicVariable::nextBuffer(), csl::NtoMPanner::nextBuffer(), csl::StereoWidth::nextBuffer(), and SAFliter::nextBuffer().

void Effect::pullInput ( unsigned numFrames ) throw (CException)

protectedinherited

trigger passed on here

Definition at line 983 of file CSL_Core.cpp.

References csl::Buffer::buffer(), CSL_INPUT, csl::logMsg(), csl::Port::mBuffer, and csl::Controllable::pullInput().

void Controllable::pullInput	(	Port *	thePort,
		unsigned	numFrames
	)		throw (CException)

protectedinherited

method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.

Definition at line 695 of file CSL_Core.cpp.

References csl::kSamples, csl::logMsg(), csl::Buffer::mIsPopulated, csl::Buffer::mNumFrames, csl::Buffer::mType, csl::UnitGenerator::nextBuffer(), and csl::Buffer::zeroBuffers().

Referenced by csl::Panner::nextBuffer(), csl::NtoMPanner::nextBuffer(), and csl::Effect::pullInput().

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

protectedinherited

Definition at line 727 of file CSL_Core.cpp.

References csl::UnitGenerator::nextBuffer().

void Effect::trigger ( void )

protectedvirtualinherited

trigger passed on here get the input port

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::Joiner.

Definition at line 994 of file CSL_Core.cpp.

References CSL_INPUT, and csl::Controllable::mInputs.

Port* csl::Effect::inPort ( )

inlineprotectedinherited

Definition at line 455 of file CSL_Core.h.

References CSL_INPUT, and csl::Controllable::mInputs.

Referenced by csl::BinaryOp::dump(), and csl::BinaryOp::inputIsFixed().

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::dump ( void )

virtualinherited

pretty-print the receiver

Reimplemented in csl::RandEnvelope, csl::SumOfSines, csl::SoundCue, csl::Abst_SoundFile, csl::Envelope, csl::Filter, csl::VBAP, csl::SineAsScaled, csl::LineSegment, csl::SpatialSource, csl::SineAsPhased, csl::Mixer, csl::Window, csl::KarplusString, csl::Oscillator, csl::AmbisonicPanner, csl::BinaryOp, csl::Lorenz, csl::Clipper, csl::CASoundFile, and csl::Noise.

Definition at line 543 of file CSL_Core.cpp.

References csl::logMsg(), and csl::UnitGenerator::mOutputs.

Referenced by csl::Port::dump(), dumpTest(), and testSimpleSines().

void Controllable::dump ( void )

protectedvirtualinherited

pretty-print the receiver's input/controls map

Reimplemented in csl::RandEnvelope, csl::SumOfSines, csl::Abst_SoundFile, csl::Envelope, csl::Filter, csl::SineAsScaled, csl::SpatialSource, csl::SineAsPhased, csl::Mixer, csl::KarplusString, csl::Oscillator, csl::BinaryOp, csl::Clipper, csl::CASoundFile, and csl::Noise.

Definition at line 774 of file CSL_Core.cpp.

References CSL_FREQUENCY, CSL_INPUT, CSL_OFFSET, CSL_SCALE, csl::logMsg(), 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.

Port * Controllable::getPort ( CSL_MAP_KEY name )

inherited

Definition at line 768 of file CSL_Core.cpp.

References csl::Controllable::mInputs.

Referenced by csl::FrequencyAmount::getFrequency(), and csl::VSTIO::getParameter().