Generates a signal based on a user-supplied function. More...

#include <juce_Oscillator.h>

Collaboration diagram for juce::dsp::Oscillator< SampleType >:

[legend]

Public Types
using	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) More...

Public Member Functions
	Oscillator ()
	Creates an uninitialised oscillator. More...

	Oscillator (const std::function< NumericType(NumericType)> &function, size_t lookupTableNumPoints=0)
	Creates an oscillator with a periodic input function (-pi..pi). More...

NumericType	getFrequency () const noexcept
	Returns the current frequency of the oscillator. More...

void	initialise (const std::function< NumericType(NumericType)> &function, size_t lookupTableNumPoints=0)
	Initialises the oscillator with a waveform. More...

bool	isInitialised () const noexcept
	Returns true if the Oscillator has been initialised. More...

void	prepare (const ProcessSpec &spec) noexcept
	Called before processing starts. More...

template<typename ProcessContext >
void	process (const ProcessContext &context) noexcept
	Processes the input and output buffers supplied in the processing context. More...

SampleType JUCE_VECTOR_CALLTYPE	processSample (SampleType input) noexcept
	Returns the result of processing a single sample. More...

void	reset () noexcept
	Resets the internal state of the oscillator. More...

void	setFrequency (NumericType newFrequency, bool force=false) noexcept
	Sets the frequency of the oscillator. More...

Private Attributes
LinearSmoothedValue< NumericType >	frequency { static_cast<NumericType> (440.0) }

std::function< NumericType(NumericType)>	generator

std::unique_ptr< LookupTableTransform< NumericType > >	lookupTable

Phase< NumericType >	phase

Array< NumericType >	rampBuffer

NumericType	sampleRate = 48000.0

Detailed Description

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

Generates a signal based on a user-supplied function.

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

inline

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.

References juce::dsp::Oscillator< SampleType >::initialise().

Member Function Documentation

◆ getFrequency()

template<typename SampleType >

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

inlinenoexcept

Returns the current frequency of the oscillator.

References juce::dsp::Oscillator< SampleType >::frequency, and juce::LinearSmoothedValue< FloatType >::getTargetValue().

◆ 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.

References juce::dsp::Oscillator< SampleType >::generator, and juce::dsp::Oscillator< SampleType >::lookupTable.

Referenced by juce::dsp::Oscillator< SampleType >::Oscillator().

◆ isInitialised()

template<typename SampleType >

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

inlinenoexcept

Returns true if the Oscillator has been initialised.

References juce::dsp::Oscillator< SampleType >::generator.

Referenced by juce::dsp::Oscillator< SampleType >::process(), and juce::dsp::Oscillator< SampleType >::processSample().

◆ prepare()

template<typename SampleType >

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

inlinenoexcept

Called before processing starts.

References juce::dsp::Oscillator< SampleType >::rampBuffer, juce::dsp::Oscillator< SampleType >::reset(), juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::resize(), and juce::dsp::Oscillator< SampleType >::sampleRate.

◆ 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.

References juce::dsp::Phase< Type >::advance(), juce::dsp::Oscillator< SampleType >::frequency, juce::dsp::Oscillator< SampleType >::generator, juce::LinearSmoothedValue< FloatType >::getNextValue(), juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getRawDataPointer(), juce::dsp::Oscillator< SampleType >::isInitialised(), juce::LinearSmoothedValue< FloatType >::isSmoothing(), jassert, juce::jmin(), juce::dsp::Oscillator< SampleType >::phase, juce::dsp::Oscillator< SampleType >::rampBuffer, juce::dsp::Oscillator< SampleType >::sampleRate, juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size(), and juce::LinearSmoothedValue< FloatType >::skip().

◆ processSample()

template<typename SampleType >

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

inlinenoexcept

Returns the result of processing a single sample.

References juce::dsp::Phase< Type >::advance(), juce::dsp::Oscillator< SampleType >::frequency, juce::dsp::Oscillator< SampleType >::generator, juce::LinearSmoothedValue< FloatType >::getNextValue(), juce::dsp::Oscillator< SampleType >::isInitialised(), jassert, juce::dsp::Oscillator< SampleType >::phase, and juce::dsp::Oscillator< SampleType >::sampleRate.

◆ reset()

template<typename SampleType >

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

inlinenoexcept

Resets the internal state of the oscillator.

References juce::dsp::Oscillator< SampleType >::frequency, juce::dsp::Oscillator< SampleType >::phase, juce::dsp::Phase< Type >::reset(), juce::LinearSmoothedValue< FloatType >::reset(), and juce::dsp::Oscillator< SampleType >::sampleRate.

Referenced by juce::dsp::Oscillator< SampleType >::prepare().

◆ setFrequency()

template<typename SampleType >

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

inlinenoexcept

Sets the frequency of the oscillator.

References juce::dsp::Oscillator< SampleType >::frequency, and juce::LinearSmoothedValue< FloatType >::setValue().

Member Data Documentation

◆ frequency

template<typename SampleType >

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

private

Referenced by juce::dsp::Oscillator< SampleType >::getFrequency(), juce::dsp::Oscillator< SampleType >::process(), juce::dsp::Oscillator< SampleType >::processSample(), juce::dsp::Oscillator< SampleType >::reset(), and juce::dsp::Oscillator< SampleType >::setFrequency().

◆ generator

template<typename SampleType >

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

private

Referenced by juce::dsp::Oscillator< SampleType >::initialise(), juce::dsp::Oscillator< SampleType >::isInitialised(), juce::dsp::Oscillator< SampleType >::process(), and juce::dsp::Oscillator< SampleType >::processSample().

◆ lookupTable

template<typename SampleType >

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

private

Referenced by juce::dsp::Oscillator< SampleType >::initialise().

◆ phase

template<typename SampleType >

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

private

Referenced by juce::dsp::Oscillator< SampleType >::process(), juce::dsp::Oscillator< SampleType >::processSample(), and juce::dsp::Oscillator< SampleType >::reset().

◆ rampBuffer

template<typename SampleType >

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

private

Referenced by juce::dsp::Oscillator< SampleType >::prepare(), and juce::dsp::Oscillator< SampleType >::process().

◆ sampleRate

template<typename SampleType >

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

private

Referenced by juce::dsp::Oscillator< SampleType >::prepare(), juce::dsp::Oscillator< SampleType >::process(), juce::dsp::Oscillator< SampleType >::processSample(), and juce::dsp::Oscillator< SampleType >::reset().

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

juce_Oscillator.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ NumericType

Constructor & Destructor Documentation

◆ Oscillator() [1/2]

◆ Oscillator() [2/2]

Member Function Documentation

◆ getFrequency()

◆ initialise()

◆ isInitialised()

◆ prepare()

◆ process()

◆ processSample()

◆ reset()

◆ setFrequency()

Member Data Documentation

◆ frequency

◆ generator

◆ lookupTable

◆ phase

◆ rampBuffer

◆ sampleRate

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