CSL  6.0
csl::Convolver2 Class Reference

The Convolver2 is a CSL Effect. More...

#include <Convolver2.h>

+ Inheritance diagram for csl::Convolver2:

Public Member Functions

 Convolver2 (UnitGenerator &in, char *inFName, unsigned chan=0, unsigned len=512, bool norm=false)
 Constructors. More...
 
 Convolver2 (UnitGenerator &in, float *irData, unsigned nTaps, unsigned len=512, bool norm=false)
 
 ~Convolver2 ()
 set the IR file name; runs the analysis ffts More...
 
void setIRFile (char *inFName, unsigned chan=0)
 
void setIRData (float *irData, unsigned nTaps)
 
void nextBuffer (Buffer &outputBuffer) throw (CException)
 main nextBuffer call does the fft/ifft More...
 
virtual bool isActive ()
 am I active? More...
 
void setInput (UnitGenerator &inp)
 set the receiver's input generator More...
 
void setInline ()
 set the Effect to be inline 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 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...
 
virtual bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this) 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 dump ()
 pretty-print the receiver 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)
 
PortgetPort (CSL_MAP_KEY name)
 

Public Attributes

bool isInline
 whether to use input or buffer as source More...
 

Protected Member Functions

void checkBuffers (unsigned newNumBufs)
 alloc buffers More...
 
void free_buffers ()
 
void complex_multiply_accumulate (SampleComplexVector left, SampleComplexVector right, SampleComplexVector output)
 fast complex MAC using non-interleaved complex arrays More...
 
void pullInput (Buffer &outputBuffer) throw (CException)
 
void pullInput (unsigned numFrames) throw (CException)
 trigger passed on here 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)
 
virtual void trigger ()
 trigger passed on here get the input port More...
 
PortinPort ()
 
virtual void dump ()
 pretty-print the receiver's input/controls map 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...
 

Protected Attributes

unsigned mFFTSize
 
unsigned mFlSize
 
unsigned mNumBufs
 
unsigned mNumTaps
 
unsigned mWindowCount
 
unsigned mChan
 
bool mNormOut
 
SampleComplexMatrix mInputFFT
 A list of past input spectra. More...
 
SampleComplexMatrix mFilterFFT
 list of IR ffts More...
 
SampleComplexVector mSpectrumBuffer
 temp summing complex vector More...
 
SampleBuffer mLastOutput
 most-recent output (1/2 window) More...
 
FFT_Wrapper mFFTAnalyzer
 FFT analysis/synthesis wrappers. More...
 
FFT_Wrapper mFFTSynthesizer
 
Buffer mFFTBuffer
 buffer used for FFTs, no storage More...
 
SampleBuffer mInputPtr
 A pointer to my input's data. method to read the input value. 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...
 
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out) More...
 
unsigned mSequence
 the highest-seen buffer seq number More...
 
PortMap mInputs
 the map of my inputs or controls (used by the mix-in classes) More...
 

Detailed Description

The Convolver2 is a CSL Effect.

Definition at line 24 of file Convolver2.h.

Constructor & Destructor Documentation

Convolver2::Convolver2 ( UnitGenerator in,
char *  inFName,
unsigned  chan = 0,
unsigned  len = 512,
bool  norm = false 
)

Constructors.

Definition at line 22 of file Convolver2.cpp.

References mFFTSize, mFlSize, mNumBufs, and setIRFile().

Convolver2::Convolver2 ( UnitGenerator in,
float *  irData,
unsigned  nTaps,
unsigned  len = 512,
bool  norm = false 
)

Definition at line 34 of file Convolver2.cpp.

References mFFTSize, mFlSize, mNumBufs, and setIRData().

Convolver2::~Convolver2 ( )

set the IR file name; runs the analysis ffts

Definition at line 48 of file Convolver2.cpp.

References free_buffers().

Member Function Documentation

void Convolver2::setIRFile ( char *  inFName,
unsigned  chan = 0 
)
void Convolver2::setIRData ( float *  irData,
unsigned  nTaps 
)
void Convolver2::nextBuffer ( Buffer outputBuffer)
throw (CException
)
virtual

main nextBuffer call does the fft/ifft

Reimplemented from csl::UnitGenerator.

Definition at line 136 of file Convolver2.cpp.

References csl::kLogError, csl::logMsg(), and csl::Effect::pullInput().

void Convolver2::checkBuffers ( unsigned  newNumBufs)
protected

alloc buffers

Definition at line 70 of file Convolver2.cpp.

References free_buffers(), mFFTSize, mFilterFFT, mInputFFT, mLastOutput, mNumBufs, mSpectrumBuffer, and SAFE_MALLOC.

Referenced by setIRData().

void Convolver2::free_buffers ( )
protected

Definition at line 54 of file Convolver2.cpp.

References mFilterFFT, mInputFFT, mLastOutput, mNumBufs, mSpectrumBuffer, and SAFE_FREE.

Referenced by checkBuffers(), and ~Convolver2().

void Convolver2::complex_multiply_accumulate ( SampleComplexVector  left,
SampleComplexVector  right,
SampleComplexVector  output 
)
protected

fast complex MAC using non-interleaved complex arrays

Definition at line 211 of file Convolver2.cpp.

References mFFTSize.

bool Effect::isActive ( )
virtualinherited

am I active?

Reimplemented from csl::UnitGenerator.

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

Definition at line 1105 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 1112 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 476 of file CSL_Core.h.

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

trigger passed on here

Definition at line 1137 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 847 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 879 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 1148 of file CSL_Core.cpp.

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

Port* csl::Effect::inPort ( )
inlineprotectedinherited

Definition at line 485 of file CSL_Core.h.

References CSL_INPUT.

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

unsigned csl::UnitGenerator::frameRate ( )
inlineinherited
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.

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

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.

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

Port * Controllable::getPort ( CSL_MAP_KEY  name)
inherited
void Controllable::addInput ( CSL_MAP_KEY  name,
float  value 
)
protectedinherited

Plug in a float to the named input slot.

Definition at line 906 of file CSL_Core.cpp.

References csl::logMsg(), csl::Controllable::mInputs, and csl::Port::mValue.

Member Data Documentation

unsigned csl::Convolver2::mFFTSize
protected

Definition at line 35 of file Convolver2.h.

Referenced by checkBuffers(), complex_multiply_accumulate(), Convolver2(), and setIRData().

unsigned csl::Convolver2::mFlSize
protected

Definition at line 35 of file Convolver2.h.

Referenced by Convolver2().

unsigned csl::Convolver2::mNumBufs
protected

Definition at line 35 of file Convolver2.h.

Referenced by checkBuffers(), Convolver2(), free_buffers(), and setIRData().

unsigned csl::Convolver2::mNumTaps
protected

Definition at line 35 of file Convolver2.h.

Referenced by setIRData().

unsigned csl::Convolver2::mWindowCount
protected

Definition at line 35 of file Convolver2.h.

Referenced by setIRData().

unsigned csl::Convolver2::mChan
protected

Definition at line 35 of file Convolver2.h.

bool csl::Convolver2::mNormOut
protected

Definition at line 36 of file Convolver2.h.

SampleComplexMatrix csl::Convolver2::mInputFFT
protected

A list of past input spectra.

Definition at line 38 of file Convolver2.h.

Referenced by checkBuffers(), and free_buffers().

SampleComplexMatrix csl::Convolver2::mFilterFFT
protected

list of IR ffts

Definition at line 39 of file Convolver2.h.

Referenced by checkBuffers(), free_buffers(), and setIRData().

SampleComplexVector csl::Convolver2::mSpectrumBuffer
protected

temp summing complex vector

Definition at line 40 of file Convolver2.h.

Referenced by checkBuffers(), and free_buffers().

SampleBuffer csl::Convolver2::mLastOutput
protected

most-recent output (1/2 window)

Definition at line 41 of file Convolver2.h.

Referenced by checkBuffers(), and free_buffers().

FFT_Wrapper csl::Convolver2::mFFTAnalyzer
protected

FFT analysis/synthesis wrappers.

Definition at line 43 of file Convolver2.h.

Referenced by setIRData().

FFT_Wrapper csl::Convolver2::mFFTSynthesizer
protected

Definition at line 44 of file Convolver2.h.

Buffer csl::Convolver2::mFFTBuffer
protected

buffer used for FFTs, no storage

Definition at line 45 of file Convolver2.h.

Referenced by setIRData().

bool csl::Effect::isInline
inherited

whether to use input or buffer as source

Definition at line 475 of file CSL_Core.h.

Referenced by csl::Effect::Effect(), and csl::Effect::setInput().

SampleBuffer csl::Effect::mInputPtr
protectedinherited

A pointer to my input's data. method to read the input value.

Definition at line 479 of file CSL_Core.h.

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