OpenWareLaboratory
OscillatorTemplate< T, BaseOscillator, Sample > Class Template Reference
Inheritance diagram for OscillatorTemplate< T, BaseOscillator, Sample >:
Collaboration diagram for OscillatorTemplate< T, BaseOscillator, Sample >:

Public Member Functions

Sample generate ()
 Produce the next consecutive sample. More...
 
Sample generate (float fm)
 Produce a sample with frequency modulation. More...
 
virtual void generate (FloatArray output)
 Produce a block of samples. More...
 
virtual void generate (FloatArray output, FloatArray fm)
 Produce a block of samples with frequency modulation. More...
 
float getFrequency ()
 Get oscillator frequency in Hertz. More...
 
float getNextSample ()
 
float getNextSample (float fm)
 
float getPhase ()
 Get current oscillator phase in radians. More...
 
float getSampleRate ()
 
void getSamples (FloatArray output)
 
void getSamples (FloatArray output, FloatArray fm)
 
void reset ()
 Reset oscillator (typically resets phase) More...
 
void setFrequency (float freq)
 Set oscillator frequency in Hertz. More...
 
void setPhase (float ph)
 Set current oscillator phase in radians. More...
 
void setSampleRate (float sr)
 Set oscillator sample rate. More...
 

Static Public Member Functions

static T * create (float sr)
 
static void destroy (T *osc)
 

Static Protected Member Functions

static float polyblep (float t, float dt)
 Calculate poly blep antialiasing compensation on normalised (to range [0, 1]) phase and phase increment (angular rate) values. More...
 

Protected Attributes

float incr = 0
 
float mul = 1
 
float phase = 0
 

Detailed Description

template<class T, class BaseOscillator = Oscillator, typename Sample = float>
class OscillatorTemplate< T, BaseOscillator, Sample >

Definition at line 69 of file Oscillator.h.

Member Function Documentation

◆ create()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
static T* OscillatorTemplate< T, BaseOscillator, Sample >::create ( float  sr)
inlinestatic

Definition at line 115 of file Oscillator.h.

◆ destroy()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
static void OscillatorTemplate< T, BaseOscillator, Sample >::destroy ( T *  osc)
inlinestatic

Definition at line 120 of file Oscillator.h.

◆ generate() [1/4]

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
Sample OscillatorTemplate< T, BaseOscillator, Sample >::generate ( )
inlinevirtual

Produce the next consecutive sample.

Reimplemented from SignalGenerator.

Definition at line 99 of file Oscillator.h.

References OscillatorTemplate< T, BaseOscillator, Sample >::incr, and OscillatorTemplate< T, BaseOscillator, Sample >::phase.

◆ generate() [2/4]

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
Sample OscillatorTemplate< T, BaseOscillator, Sample >::generate ( float  fm)
inlinevirtual

Produce a sample with frequency modulation.

Implements Oscillator.

Definition at line 106 of file Oscillator.h.

References OscillatorTemplate< T, BaseOscillator, Sample >::incr, and OscillatorTemplate< T, BaseOscillator, Sample >::phase.

◆ generate() [3/4]

◆ generate() [4/4]

virtual void Oscillator::generate ( FloatArray  output,
FloatArray  fm 
)
inlinevirtualinherited

Produce a block of samples with frequency modulation.

Reimplemented in VosimOscillator, SineOscillator, SampleOscillator< im >, PolyBlepOscillator, and MorphingOscillator.

Definition at line 50 of file Oscillator.h.

References Oscillator::generate(), and SimpleArray< T >::getSize().

◆ getFrequency()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
float OscillatorTemplate< T, BaseOscillator, Sample >::getFrequency ( )
inlinevirtual

◆ getNextSample() [1/2]

float Oscillator::getNextSample ( )
inlineinherited

Definition at line 55 of file Oscillator.h.

References Oscillator::generate().

◆ getNextSample() [2/2]

float Oscillator::getNextSample ( float  fm)
inlineinherited

Definition at line 57 of file Oscillator.h.

References Oscillator::generate().

◆ getPhase()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
float OscillatorTemplate< T, BaseOscillator, Sample >::getPhase ( )
inlinevirtual

Get current oscillator phase in radians.

Returns
a value between 0 and 2*pi

Implements Oscillator.

Definition at line 92 of file Oscillator.h.

References M_PI, and OscillatorTemplate< T, BaseOscillator, Sample >::phase.

◆ getSampleRate()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
float OscillatorTemplate< T, BaseOscillator, Sample >::getSampleRate ( )
inline

Definition at line 80 of file Oscillator.h.

References OscillatorTemplate< T, BaseOscillator, Sample >::mul.

◆ getSamples() [1/2]

void Oscillator::getSamples ( FloatArray  output)
inlineinherited

Definition at line 59 of file Oscillator.h.

References Oscillator::generate().

◆ getSamples() [2/2]

void Oscillator::getSamples ( FloatArray  output,
FloatArray  fm 
)
inlineinherited

Definition at line 63 of file Oscillator.h.

References Oscillator::generate().

◆ polyblep()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
static float OscillatorTemplate< T, BaseOscillator, Sample >::polyblep ( float  t,
float  dt 
)
inlinestaticprotected

Calculate poly blep antialiasing compensation on normalised (to range [0, 1]) phase and phase increment (angular rate) values.

Definition at line 128 of file Oscillator.h.

◆ reset()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
void OscillatorTemplate< T, BaseOscillator, Sample >::reset ( )
inlinevirtual

Reset oscillator (typically resets phase)

Implements Oscillator.

Definition at line 96 of file Oscillator.h.

References OscillatorTemplate< T, BaseOscillator, Sample >::phase.

Referenced by VosimOscillator::generate(), and AntialiasedRampOscillator::reset().

◆ setFrequency()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
void OscillatorTemplate< T, BaseOscillator, Sample >::setFrequency ( float  value)
inlinevirtual

◆ setPhase()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
void OscillatorTemplate< T, BaseOscillator, Sample >::setPhase ( float  phase)
inlinevirtual

Set current oscillator phase in radians.

Parameters
phasea value between 0 and 2*pi

Implements Oscillator.

Definition at line 89 of file Oscillator.h.

References M_PI, and OscillatorTemplate< T, BaseOscillator, Sample >::phase.

Referenced by VosimOscillator::generate(), and AntialiasedRampOscillator::setPhase().

◆ setSampleRate()

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
void OscillatorTemplate< T, BaseOscillator, Sample >::setSampleRate ( float  value)
inlinevirtual

Field Documentation

◆ incr

◆ mul

template<class T , class BaseOscillator = Oscillator, typename Sample = float>
float OscillatorTemplate< T, BaseOscillator, Sample >::mul = 1
protected

◆ phase


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