csl::BlackmanWindow Class Reference

BlackmanWindow. More...

#include <Window.h>

Inheritance diagram for csl::BlackmanWindow:

Public Member Functions
	BlackmanWindow ()
	BlackmanWindow (unsigned windowSize)
	BlackmanWindow (unsigned windowSize, float gain)
	~BlackmanWindow ()
void	setSize (unsigned windowSize)
	Set the number of samples the window spans. More...
void	setGain (float gain)
	Set the gain to which the window should be normalized. More...
SampleBuffer	window ()
void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	Returns a pointer to the window data. 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...
void	dump ()
	Print some info about the window. 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...
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 ()
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)

Protected Member Functions
void	fillWindow ()
	subclasses override this to fill the buffer with corresponding function. More...
void	zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
	utility method to zero out an outputBuffer More...

Protected Attributes
Buffer	mWindowBuffer
	used to store the window More...
unsigned	mWindowBufferPos
	where am I in the window buffer More...
unsigned	mWindowSize
	length in samples of the window More...
float	mGain
	gain for the window More...
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...

Detailed Description

BlackmanWindow.

Definition at line 108 of file Window.h.

Constructor & Destructor Documentation

csl::BlackmanWindow::BlackmanWindow ( )

inline

Definition at line 110 of file Window.h.

csl::BlackmanWindow::BlackmanWindow ( unsigned  windowSize )

inline

Definition at line 111 of file Window.h.

csl::BlackmanWindow::BlackmanWindow ( unsigned  windowSize, float  gain  )

inline

Definition at line 112 of file Window.h.

csl::BlackmanWindow::~BlackmanWindow ( )

inline

Definition at line 113 of file Window.h.

Member Function Documentation

void BlackmanWindow::fillWindow ( )

protectedvirtual

subclasses override this to fill the buffer with corresponding function.

Reimplemented from csl::Window.

Definition at line 101 of file Window.cpp.

References csl::Buffer::buffer(), CSL_TWOPI, csl::Window::mGain, csl::Window::mWindowBuffer, and csl::Window::mWindowSize.

void Window::setSize ( unsigned  windowSize )

inherited

Set the number of samples the window spans.

Definition at line 30 of file Window.cpp.

References csl::Buffer::allocateBuffers(), csl::Window::fillWindow(), csl::Buffer::freeBuffers(), csl::Window::mWindowBuffer, csl::Window::mWindowBufferPos, csl::Window::mWindowSize, and csl::Buffer::setSize().

Referenced by csl::Window::Window().

void Window::setGain ( float  gain )

inherited

Set the gain to which the window should be normalized.

Definition at line 25 of file Window.cpp.

References csl::Window::fillWindow(), and csl::Window::mGain.

SampleBuffer csl::Window::window ( )

inlineinherited

Definition at line 39 of file Window.h.

References csl::Buffer::buffer(), and csl::Window::mWindowBuffer.

Referenced by csl::FFT::FFT().

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

virtualinherited

Returns a pointer to the window data.

get everything into registers

Reimplemented from csl::UnitGenerator.

Definition at line 40 of file Window.cpp.

References csl::logMsg().

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

virtualinherited

Print some info about the window.

Reimplemented from csl::UnitGenerator.

Definition at line 130 of file Window.cpp.

References csl::logMsg(), and csl::Window::mWindowSize.

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

Member Data Documentation

Buffer csl::Window::mWindowBuffer

protectedinherited

used to store the window

Definition at line 45 of file Window.h.

Referenced by csl::Window::fillWindow(), csl::RectangularWindow::fillWindow(), csl::TriangularWindow::fillWindow(), csl::HammingWindow::fillWindow(), csl::HannWindow::fillWindow(), fillWindow(), csl::BlackmanHarrisWindow::fillWindow(), csl::WelchWindow::fillWindow(), csl::Window::setSize(), csl::Window::window(), and csl::Window::~Window().

unsigned csl::Window::mWindowBufferPos

protectedinherited

where am I in the window buffer

Definition at line 46 of file Window.h.

Referenced by csl::Window::setSize().

unsigned csl::Window::mWindowSize

protectedinherited

length in samples of the window

Definition at line 47 of file Window.h.

Referenced by csl::Window::dump(), csl::Window::fillWindow(), csl::RectangularWindow::fillWindow(), csl::TriangularWindow::fillWindow(), csl::HammingWindow::fillWindow(), csl::HannWindow::fillWindow(), fillWindow(), csl::BlackmanHarrisWindow::fillWindow(), csl::WelchWindow::fillWindow(), and csl::Window::setSize().

float csl::Window::mGain

protectedinherited

gain for the window

Definition at line 48 of file Window.h.

Referenced by csl::RectangularWindow::fillWindow(), csl::HannWindow::fillWindow(), fillWindow(), csl::BlackmanHarrisWindow::fillWindow(), csl::WelchWindow::fillWindow(), and csl::Window::setGain().

unsigned csl::UnitGenerator::mFrameRate

protectedinherited

trigger ignored here

the frame rate – initialized to be the default by the constructor

Definition at line 288 of file CSL_Core.h.

Referenced by csl::Abst_SoundFile::convertRate(), csl::Lorenz::dump(), csl::Abst_SoundFile::durationInSecs(), csl::UnitGenerator::frameRate(), csl::Filter::init(), csl::CASoundFile::initFromSndfile(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::RandEnvelope::nextSegment(), csl::SquareBL::nextWaveInto(), csl::SumOfSines::nextWaveInto(), csl::DelayLine::setDelayTime(), csl::UnitGenerator::setFrameRate(), csl::Abst_SoundFile::setStartSec(), csl::Abst_SoundFile::setStopSec(), csl::Butter::setupCoeffs(), csl::Formant::setupCoeffs(), csl::Notch::setupCoeffs(), and csl::Moog::setupCoeffs().

unsigned csl::UnitGenerator::mNumChannels

protectedinherited

my "expected" number of output channels

Definition at line 292 of file CSL_Core.h.

Referenced by csl::AmbisonicMixer::addInput(), csl::Mixer::allocateOpBuffer(), csl::AmbisonicDecoder::asProjection(), csl::AmbisonicDecoder::asPseudoInverse(), csl::BlockResizer::BlockResizer(), csl::Abst_SoundFile::channels(), csl::Abst_SoundFile::checkBuffer(), csl::FMInstrument::FMInstrument(), csl::GrainPlayer::GrainPlayer(), csl::AdditiveInstrument::init(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::AmbisonicMixer::initialize(), csl::SndFileInstrument::initialize(), csl::AmbisonicRotator::initialize(), csl::AmbisonicEncoder::initialize(), csl::AmbisonicDecoder::initialize(), csl::AmbisonicUnitGenerator::initOrder(), csl::RemoteStream::initPacket(), csl::Joiner::isActive(), csl::Joiner::Joiner(), csl::AmbisonicDecoder::makeInPhase(), csl::AmbisonicDecoder::makeMaxRE(), csl::Abst_SoundFile::mergeToMono(), csl::Mixer::Mixer(), csl::UnitGenerator::numChannels(), csl::Panner::Panner(), csl::CASoundFile::readBufferFromFile(), csl::JSoundFile::readBufferFromFile(), csl::LSoundFile::readBufferFromFile(), csl::RemoteStream::RemoteStream(), csl::UnitGenerator::setNumChannels(), csl::WavetableOscillator::setWaveform(), csl::Joiner::trigger(), and csl::AmbisonicRotator::~AmbisonicRotator().

BufferCopyPolicy csl::UnitGenerator::mCopyPolicy

protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 293 of file CSL_Core.h.

Referenced by csl::UnitGenerator::copyPolicy(), and csl::UnitGenerator::setCopyPolicy().

UGenVector csl::UnitGenerator::mOutputs

protectedinherited

the vector of my output UGens

Definition at line 294 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput(), csl::UnitGenerator::dump(), csl::UnitGenerator::outputs(), and csl::UnitGenerator::removeOutput().

unsigned csl::UnitGenerator::mNumOutputs

protectedinherited

the number of outputs

Definition at line 295 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput(), csl::UnitGenerator::numOutputs(), and csl::UnitGenerator::removeOutput().

Buffer* csl::UnitGenerator::mOutputCache

protectedinherited

my past output ring buffer (only used in case of fan-out)

Definition at line 296 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput().

unsigned csl::UnitGenerator::mSequence

protectedinherited

the highest-seen buffer seq number

Definition at line 297 of file CSL_Core.h.

---

The documentation for this class was generated from the following files:

• /Content/Code/CSL6/Src/Sources/Window.h
• /Content/Code/CSL6/Src/Sources/Window.cpp