CSL  5.2
csl::RandEnvelope Class Reference

RandEnvelope envelope class – makes random control signals using a single line segment. More...

#include <Envelope.h>

+ Inheritance diagram for csl::RandEnvelope:

List of all members.

Public Member Functions

 RandEnvelope (float frequency=1, float amplitude=1, float offset=0, float step=0)
 defaults are 1 Hz, +- 1.0 range
 ~RandEnvelope ()
void setWalk (bool walk)
 Accessors.
void setAmplitude (float amplitude)
void setFrequency (float frequency)
void setStep (float step)
void setOffset (float offset)
virtual bool isActive ()
 This answers whether I'm active (ptr < end)
void reset ()
 These are no-ops in Random envelopes.
void trigger ()
 reset internal time to restart envelope
void dump ()
 reset internal time to restart envelope
void setDuration (float d)
 print the receiver
void scaleTimes (float s)
 set/scale durations
void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
 scale durations
void addBreakpoint (float startTime, float value)
void setMode (LineMode mode)
virtual void scaleValues (float s)
 scale values so the max is s
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.
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)
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 ()
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 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 isScaled ()
 answer whether scale = 1 & offset = 0
PortgetPort (CSL_MAP_KEY name)

Protected Member Functions

void initSegment ()
 set up the line segment
void nextSegment ()
 choose the values for the next line segment
unsigned int privateNextBuffer (CPoint *breakpoint, LineSegment *segment, float *buffer, unsigned int numFrames)
 Internal helper method for computing the next buffer.
void createSegments ()
 Allocate memory for the segments.
void calculateSegments ()
 Calculate the internal data.
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

float mLastVal
 last line segment ending value (unscaled and unoffset)
float mFrequency
 frequency for picking new values
float mAmplitude
 scale (+-)
float mStep
 max step between values (+-)
float mOffset
 DC offset.
unsigned mCurrentIndex
 current index in line segment
unsigned mSegmentLength
 line segment's length in frames
bool mWalk
 whether to produce random values or a random walk
LineSegment mSegment
 single line segment
float mDuration
 Total duration, typically in seconds.
float mCurrentMark
 How far we have read.
Breakpoints mSegmentMap
 list of envelope breakpoints
LineSegment ** mSegments
 array of line segments that for the envelope
float * mValues
unsigned mSize
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
BuffermOutputCache
 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

RandEnvelope envelope class – makes random control signals using a single line segment.

Definition at line 247 of file Envelope.h.


Constructor & Destructor Documentation

RandEnvelope::RandEnvelope ( float  frequency = 1,
float  amplitude = 1,
float  offset = 0,
float  step = 0 
)

defaults are 1 Hz, +- 1.0 range

~~~~~~~~ RandEnvelope envelope class ~~~~~~~

Definition at line 548 of file Envelope.cpp.

References initSegment(), mAmplitude, csl::Envelope::mSegments, csl::Envelope::mSize, mStep, and csl::Envelope::mValues.

csl::RandEnvelope::~RandEnvelope ( )
inline

Definition at line 250 of file Envelope.h.


Member Function Documentation

void csl::RandEnvelope::setWalk ( bool  walk)
inline

Accessors.

Definition at line 252 of file Envelope.h.

References mWalk.

void csl::RandEnvelope::setAmplitude ( float  amplitude)
inline

Definition at line 253 of file Envelope.h.

References mAmplitude.

void csl::RandEnvelope::setFrequency ( float  frequency)
inline

Definition at line 254 of file Envelope.h.

References mFrequency.

void csl::RandEnvelope::setStep ( float  step)
inline

Definition at line 255 of file Envelope.h.

References mStep.

void csl::RandEnvelope::setOffset ( float  offset)
inline

Reimplemented from csl::Scalable.

Definition at line 256 of file Envelope.h.

References mOffset.

virtual bool csl::RandEnvelope::isActive ( )
inlinevirtual

This answers whether I'm active (ptr < end)

Reimplemented from csl::Envelope.

Definition at line 258 of file Envelope.h.

void csl::RandEnvelope::reset ( )
inlinevirtual

These are no-ops in Random envelopes.

Reimplemented from csl::Envelope.

Definition at line 260 of file Envelope.h.

void csl::RandEnvelope::trigger ( void  )
inlinevirtual

reset internal time to restart envelope

Reimplemented from csl::Envelope.

Definition at line 261 of file Envelope.h.

void csl::RandEnvelope::dump ( void  )
inlinevirtual

reset internal time to restart envelope

Reimplemented from csl::Envelope.

Definition at line 262 of file Envelope.h.

void csl::RandEnvelope::setDuration ( float  d)
inlinevirtual

print the receiver

Reimplemented from csl::Envelope.

Definition at line 263 of file Envelope.h.

void csl::RandEnvelope::scaleTimes ( float  s)
inlinevirtual

set/scale durations

Reimplemented from csl::Envelope.

Definition at line 264 of file Envelope.h.

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

scale durations

The main UGen work method

Reimplemented from csl::Envelope.

Definition at line 594 of file Envelope.cpp.

References DECLARE_SCALABLE_CONTROLS.

void RandEnvelope::initSegment ( )
protected

set up the line segment

Definition at line 561 of file Envelope.cpp.

References csl::fRandZ(), mAmplitude, mLastVal, mOffset, mSegment, nextSegment(), and csl::LineSegment::setEnd().

Referenced by RandEnvelope().

void Envelope::addBreakpoint ( float  startTime,
float  value 
)
inherited
void Envelope::setMode ( LineMode  mode)
inherited

Definition at line 206 of file Envelope.cpp.

References csl::Envelope::mSegments, and csl::Envelope::mSize.

unsigned int csl::Envelope::privateNextBuffer ( CPoint breakpoint,
LineSegment segment,
float *  buffer,
unsigned int  numFrames 
)
protectedinherited

Internal helper method for computing the next buffer.

void Envelope::createSegments ( )
protectedinherited
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().

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

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::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
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 Scalable::setScale ( float  scale)
inherited

Definition at line 894 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 901 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 754 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 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().


Member Data Documentation

float csl::RandEnvelope::mLastVal
protected

last line segment ending value (unscaled and unoffset)

Definition at line 270 of file Envelope.h.

Referenced by initSegment(), and nextSegment().

float csl::RandEnvelope::mFrequency
protected

frequency for picking new values

Definition at line 271 of file Envelope.h.

Referenced by nextSegment(), and setFrequency().

float csl::RandEnvelope::mAmplitude
protected

scale (+-)

Definition at line 272 of file Envelope.h.

Referenced by initSegment(), nextSegment(), RandEnvelope(), and setAmplitude().

float csl::RandEnvelope::mStep
protected

max step between values (+-)

Definition at line 273 of file Envelope.h.

Referenced by nextSegment(), RandEnvelope(), and setStep().

float csl::RandEnvelope::mOffset
protected

DC offset.

Definition at line 274 of file Envelope.h.

Referenced by initSegment(), nextSegment(), and setOffset().

unsigned csl::RandEnvelope::mCurrentIndex
protected

current index in line segment

Definition at line 275 of file Envelope.h.

Referenced by nextSegment().

unsigned csl::RandEnvelope::mSegmentLength
protected

line segment's length in frames

Definition at line 276 of file Envelope.h.

Referenced by nextSegment().

bool csl::RandEnvelope::mWalk
protected

whether to produce random values or a random walk

Definition at line 277 of file Envelope.h.

Referenced by nextSegment(), and setWalk().

LineSegment csl::RandEnvelope::mSegment
protected

single line segment

Definition at line 278 of file Envelope.h.

Referenced by initSegment(), and nextSegment().

float csl::Envelope::mCurrentMark
protectedinherited
unsigned csl::UnitGenerator::mNumChannels
protectedinherited
BufferCopyPolicy csl::UnitGenerator::mCopyPolicy
protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 269 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 271 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 272 of file CSL_Core.h.

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

unsigned csl::UnitGenerator::mSequence
protectedinherited

the highest-seen buffer seq number

Definition at line 273 of file CSL_Core.h.


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