juce::dsp::Oscillator< SampleType > Class Template Reference

#include <juce_Oscillator.h>

Public Types
using	NumericType = typename SampleTypeHelpers::ElementType<SampleType>::Type

Public Member Functions
	Oscillator ()=default
	Oscillator (const std::function< NumericType(NumericType)> &function, size_t lookupTableNumPoints=0)
bool	isInitialised () const noexcept
void	initialise (const std::function< NumericType(NumericType)> &function, size_t lookupTableNumPoints=0)
void	setFrequency (NumericType newFrequency, bool force=false) noexcept
NumericType	getFrequency () const noexcept
void	prepare (const ProcessSpec &spec) noexcept
void	reset () noexcept
SampleType JUCE_VECTOR_CALLTYPE	processSample (SampleType input) noexcept
template<typename ProcessContext>
void	process (const ProcessContext &context) noexcept

Private Attributes
std::function< NumericType(NumericType)>	generator
std::unique_ptr< LookupTableTransform< NumericType > >	lookupTable
Array< NumericType >	rampBuffer
SmoothedValue< NumericType >	frequency { static_cast<NumericType> (440.0) }
NumericType	sampleRate = 48000.0
Phase< NumericType >	phase

Detailed Description

template<typename SampleType>
class juce::dsp::Oscillator< SampleType >

Generates a signal based on a user-supplied function.

@tags{DSP}

Member Typedef Documentation

NumericType

template<typename SampleType>

using juce::dsp::Oscillator< SampleType >::NumericType = typename SampleTypeHelpers::ElementType<SampleType>::Type

The NumericType is the underlying primitive type used by the SampleType (which could be either a primitive or vector)

Constructor & Destructor Documentation

Oscillator() [1/2]

template<typename SampleType>

juce::dsp::Oscillator< SampleType >::Oscillator ( )

default

Creates an uninitialised oscillator. Call initialise before first use.

Oscillator() [2/2]

template<typename SampleType>

juce::dsp::Oscillator< SampleType >::Oscillator ( const std::function< NumericType(NumericType)> & function, size_t lookupTableNumPoints = 0 )

inline

Creates an oscillator with a periodic input function (-pi..pi).

If lookup table is not zero, then the function will be approximated with a lookup table.

Member Function Documentation

getFrequency()

template<typename SampleType>

NumericType juce::dsp::Oscillator< SampleType >::getFrequency ( ) const

inlinenoexcept

Returns the current frequency of the oscillator.

initialise()

template<typename SampleType>

void juce::dsp::Oscillator< SampleType >::initialise ( const std::function< NumericType(NumericType)> & function, size_t lookupTableNumPoints = 0 )

inline

Initialises the oscillator with a waveform.

isInitialised()

template<typename SampleType>

bool juce::dsp::Oscillator< SampleType >::isInitialised ( ) const

inlinenoexcept

Returns true if the Oscillator has been initialised.

prepare()

template<typename SampleType>

void juce::dsp::Oscillator< SampleType >::prepare ( const ProcessSpec & spec )

inlinenoexcept

Called before processing starts.

process()

template<typename SampleType>

template<typename ProcessContext>

void juce::dsp::Oscillator< SampleType >::process ( const ProcessContext & context )

inlinenoexcept

Processes the input and output buffers supplied in the processing context.

processSample()

template<typename SampleType>

SampleType JUCE_VECTOR_CALLTYPE juce::dsp::Oscillator< SampleType >::processSample ( SampleType input )

inlinenoexcept

Returns the result of processing a single sample.

reset()

template<typename SampleType>

void juce::dsp::Oscillator< SampleType >::reset ( )

inlinenoexcept

Resets the internal state of the oscillator

setFrequency()

template<typename SampleType>

void juce::dsp::Oscillator< SampleType >::setFrequency ( NumericType newFrequency, bool force = false )

inlinenoexcept

Sets the frequency of the oscillator.

Member Data Documentation

frequency

template<typename SampleType>

SmoothedValue<NumericType> juce::dsp::Oscillator< SampleType >::frequency { static_cast<NumericType> (440.0) }

private

generator

template<typename SampleType>

std::function<NumericType (NumericType)> juce::dsp::Oscillator< SampleType >::generator

private

lookupTable

template<typename SampleType>

std::unique_ptr<LookupTableTransform<NumericType> > juce::dsp::Oscillator< SampleType >::lookupTable

private

phase

template<typename SampleType>

Phase<NumericType> juce::dsp::Oscillator< SampleType >::phase

private

rampBuffer

template<typename SampleType>

Array<NumericType> juce::dsp::Oscillator< SampleType >::rampBuffer

private

sampleRate

template<typename SampleType>

NumericType juce::dsp::Oscillator< SampleType >::sampleRate = 48000.0

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_dsp/widgets/juce_Oscillator.h