CSL  6.0
csl::PinkNoise Class Reference

Pink noise – equal power per octave. More...

#include <Noise.h>

+ Inheritance diagram for csl::PinkNoise:

Public Member Functions

 PinkNoise ()
 Constructors. More...
 
 PinkNoise (double ampl, double offset=0.f)
 
 PinkNoise (int seed, double ampl=1.f, double offset=0.f)
 
 ~PinkNoise ()
 
void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
 Destructor. More...
 
sample nextPink ()
 returns the next pink noise sample More...
 
int generateRandomNumber ()
 returns the next pseudo-random number More...
 
float generateNormalizedRandomNumber ()
 returns next pseudo-random normalised to +/- 1.0 More...
 
void setSeed (int seed)
 set the seed integer for the pseudo-random number generators More...
 
void dump ()
 Tell me more about what is happening. 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) 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...
 
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 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...
 
PortgetPort (CSL_MAP_KEY name)
 

Protected Member Functions

void initialize (int numRows)
 set up PinkNoise for N rows of generators 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

int mPinkRows [PINK_MAX_RANDOM_ROWS]
 Pink noise generator rows. More...
 
int mPinkRunningSum
 Used to optimize summing of generators. More...
 
int mPinkIndex
 Incremented each sample. More...
 
int mPinkIndexMask
 Index wrapped by ANDing with this mask. More...
 
float mPinkScalar
 Used to scale within range of -1.0 to +1.0. More...
 
int mSeed
 Destructor. More...
 
float mDivisor
 factor to scale ints to +/- 1.0 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

Pink noise – equal power per octave.

Definition at line 66 of file Noise.h.

Constructor & Destructor Documentation

PinkNoise::PinkNoise ( )

Constructors.

Most of this code was taken from an public domain C implementation written by Phil Burk. The code and the webpage explaining it is at http://www.firstpr.com.au/dsp/pink-noise/phil_burk_19990905mPatestmPink.c and http://www.firstpr.com.au/dsp/pink-noise/.

Definition at line 78 of file Noise.cpp.

References initialize(), csl::kExpand, and csl::UnitGenerator::setCopyPolicy().

PinkNoise::PinkNoise ( double  ampl,
double  offset = 0.f 
)

Definition at line 83 of file Noise.cpp.

References initialize(), csl::kExpand, and csl::UnitGenerator::setCopyPolicy().

PinkNoise::PinkNoise ( int  seed,
double  ampl = 1.f,
double  offset = 0.f 
)

Definition at line 88 of file Noise.cpp.

References initialize(), csl::kExpand, and csl::UnitGenerator::setCopyPolicy().

csl::PinkNoise::~PinkNoise ( )
inline

Definition at line 72 of file Noise.h.

Member Function Documentation

void PinkNoise::nextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
)
throw (CException
)
virtual

Destructor.

the monoNextBuffer method is where the DSP takes place

Reimplemented from csl::UnitGenerator.

Definition at line 147 of file Noise.cpp.

References DECLARE_SCALABLE_CONTROLS, LOAD_SCALABLE_CONTROLS, csl::logMsg(), and UPDATE_SCALABLE_CONTROLS.

sample PinkNoise::nextPink ( )

returns the next pink noise sample

Definition at line 108 of file Noise.cpp.

References csl::Noise::generateRandomNumber(), mPinkIndex, mPinkIndexMask, mPinkRows, mPinkRunningSum, mPinkScalar, and PINK_RANDOM_SHIFT.

void PinkNoise::initialize ( int  numRows)
protected

set up PinkNoise for N rows of generators

Setup PinkNoise structure for N rows of generators.

Definition at line 94 of file Noise.cpp.

References mPinkIndex, mPinkIndexMask, mPinkRows, mPinkRunningSum, mPinkScalar, and PINK_RANDOM_BITS.

Referenced by PinkNoise().

int csl::Noise::generateRandomNumber ( )
inlineinherited

returns the next pseudo-random number

Definition at line 92 of file Noise.h.

References csl::Noise::mSeed.

Referenced by nextPink().

float csl::Noise::generateNormalizedRandomNumber ( )
inlineinherited

returns next pseudo-random normalised to +/- 1.0

Definition at line 99 of file Noise.h.

References csl::Noise::mSeed.

void csl::Noise::setSeed ( int  seed)
inlineinherited

set the seed integer for the pseudo-random number generators

Definition at line 27 of file Noise.h.

References csl::Noise::mSeed.

void Noise::dump ( void  )
virtualinherited

Tell me more about what is happening.

Reimplemented from csl::UnitGenerator.

Definition at line 46 of file Noise.cpp.

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

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.

virtual bool csl::UnitGenerator::isActive ( )
inlinevirtualinherited
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
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
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 Scalable::setScale ( float  scale)
inherited

Definition at line 1046 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_SCALE, and csl::logMsg().

void Scalable::setOffset ( UnitGenerator offset)
inherited

set the receiver's offset member to a UGen or a float

Definition at line 1053 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void Scalable::setOffset ( float  offset)
inherited

Definition at line 1060 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void csl::Scalable::isScaled ( )
inherited

answer whether scale = 1 & offset = 0

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.

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

Member Data Documentation

int csl::PinkNoise::mPinkRows[PINK_MAX_RANDOM_ROWS]
protected

Pink noise generator rows.

Definition at line 80 of file Noise.h.

Referenced by initialize(), and nextPink().

int csl::PinkNoise::mPinkRunningSum
protected

Used to optimize summing of generators.

Definition at line 81 of file Noise.h.

Referenced by initialize(), and nextPink().

int csl::PinkNoise::mPinkIndex
protected

Incremented each sample.

Definition at line 82 of file Noise.h.

Referenced by initialize(), and nextPink().

int csl::PinkNoise::mPinkIndexMask
protected

Index wrapped by ANDing with this mask.

Definition at line 83 of file Noise.h.

Referenced by initialize(), and nextPink().

float csl::PinkNoise::mPinkScalar
protected

Used to scale within range of -1.0 to +1.0.

Definition at line 84 of file Noise.h.

Referenced by initialize(), and nextPink().

int csl::Noise::mSeed
protectedinherited

Destructor.

seed integer for the pseudo-random number generators

Definition at line 34 of file Noise.h.

Referenced by csl::Noise::generateNormalizedRandomNumber(), csl::Noise::generateRandomNumber(), and csl::Noise::setSeed().

float csl::Noise::mDivisor
protectedinherited

factor to scale ints to +/- 1.0

Definition at line 38 of file Noise.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: