OpenWareLaboratory
RampOscillator Class Reference

Ramp oscillator generates rising output values from -1 to 1. More...

Inheritance diagram for RampOscillator:
Collaboration diagram for RampOscillator:

Public Member Functions

float generate ()
 Produce the next consecutive sample. More...
 
float 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 getSample ()
 
float getSampleRate ()
 
void getSamples (FloatArray output)
 
void getSamples (FloatArray output, FloatArray fm)
 
 RampOscillator ()
 
 RampOscillator (float sr)
 
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 RampOscillatorcreate (float sr)
 
static void destroy (RampOscillator *osc)
 

Static Public Attributes

static constexpr float begin_phase = -1
 
static constexpr float end_phase = 1
 

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
 
float mul
 
float phase
 

Detailed Description

Ramp oscillator generates rising output values from -1 to 1.

Definition at line 9 of file RampOscillator.h.

Constructor & Destructor Documentation

◆ RampOscillator() [1/2]

RampOscillator::RampOscillator ( )
inline

Definition at line 13 of file RampOscillator.h.

◆ RampOscillator() [2/2]

RampOscillator::RampOscillator ( float  sr)
inline

Member Function Documentation

◆ create()

static RampOscillator * OscillatorTemplate< RampOscillator , Oscillator , float >::create ( float  sr)
inlinestaticinherited

Definition at line 115 of file Oscillator.h.

◆ destroy()

static void OscillatorTemplate< RampOscillator , Oscillator , float >::destroy ( RampOscillator osc)
inlinestaticinherited

Definition at line 120 of file Oscillator.h.

◆ generate() [1/4]

float OscillatorTemplate< RampOscillator , Oscillator , float >::generate ( )
inlinevirtualinherited

Produce the next consecutive sample.

Reimplemented from Oscillator.

Definition at line 99 of file Oscillator.h.

◆ generate() [2/4]

float OscillatorTemplate< RampOscillator , Oscillator , float >::generate ( float  fm)
inlinevirtualinherited

Produce a sample with frequency modulation.

Implements Oscillator.

Definition at line 106 of file Oscillator.h.

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

float OscillatorTemplate< RampOscillator , Oscillator , float >::getFrequency ( )
inlinevirtualinherited

Get oscillator frequency in Hertz.

Implements Oscillator.

Definition at line 86 of file Oscillator.h.

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

float OscillatorTemplate< RampOscillator , Oscillator , float >::getPhase ( )
inlinevirtualinherited

Get current oscillator phase in radians.

Returns
a value between 0 and 2*pi

Implements Oscillator.

Definition at line 92 of file Oscillator.h.

◆ getSample()

float RampOscillator::getSample ( )
inline

Definition at line 17 of file RampOscillator.h.

References OscillatorTemplate< RampOscillator >::phase.

◆ getSampleRate()

float OscillatorTemplate< RampOscillator , Oscillator , float >::getSampleRate ( )
inlineinherited

Definition at line 80 of file Oscillator.h.

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

static float OscillatorTemplate< RampOscillator , Oscillator , float >::polyblep ( float  t,
float  dt 
)
inlinestaticprotectedinherited

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

void OscillatorTemplate< RampOscillator , Oscillator , float >::reset ( )
inlinevirtualinherited

Reset oscillator (typically resets phase)

Implements Oscillator.

Definition at line 96 of file Oscillator.h.

◆ setFrequency()

void OscillatorTemplate< RampOscillator , Oscillator , float >::setFrequency ( float  freq)
inlinevirtualinherited

Set oscillator frequency in Hertz.

Implements Oscillator.

Definition at line 83 of file Oscillator.h.

◆ setPhase()

void OscillatorTemplate< RampOscillator , Oscillator , float >::setPhase ( float  ph)
inlinevirtualinherited

Set current oscillator phase in radians.

Parameters
phasea value between 0 and 2*pi

Implements Oscillator.

Definition at line 89 of file Oscillator.h.

◆ setSampleRate()

void OscillatorTemplate< RampOscillator , Oscillator , float >::setSampleRate ( float  sr)
inlinevirtualinherited

Set oscillator sample rate.

Reimplemented from Oscillator.

Definition at line 75 of file Oscillator.h.

Field Documentation

◆ begin_phase

constexpr float RampOscillator::begin_phase = -1
staticconstexpr

Definition at line 11 of file RampOscillator.h.

◆ end_phase

constexpr float RampOscillator::end_phase = 1
staticconstexpr

Definition at line 12 of file RampOscillator.h.

◆ incr

float OscillatorTemplate< RampOscillator , Oscillator , float >::incr
protectedinherited

Definition at line 73 of file Oscillator.h.

◆ mul

float OscillatorTemplate< RampOscillator , Oscillator , float >::mul
protectedinherited

Definition at line 71 of file Oscillator.h.

◆ phase

float OscillatorTemplate< RampOscillator , Oscillator , float >::phase
protectedinherited

Definition at line 72 of file Oscillator.h.


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