MetaOscil is a wrapper for several Oscil. More...

#include <MetaOscil.h>

Detailed Description

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>
class MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >

MetaOscil is a wrapper for several Oscil.

Once constructed it will behave exactly as an Oscil except that it will automatically switch between Oscil depending on the asked frequency. This allows to produce non-aliased sounds by switching between tables with less and less harmonics as the frequency increases.

Definition at line 32 of file MetaOscil.h.

Public Member Functions
template<class... T>
	MetaOscil (Oscil< NUM_TABLE_CELLS, UPDATE_RATE > first, T ... elements)
	Constructor Declare a MetaOscil containing any number of Oscil pointers. More...

template<typename ... T>
void	setOscils (Oscil< NUM_TABLE_CELLS, UPDATE_RATE > *first, T... elements)
	Set all Oscil of a MetaOscil. More...

void	setOscils ()

template<typename ... T>
void	setCutoffFreqs (int first, T... elements)
	Set all the cutoff frequencies for changing between Oscil. More...

void	setCutoffFreqs ()

void	setCutoffFreq (int freq, byte rank)
	Set or change the cutoff frequency of one Oscil. More...

int8_t	next ()
	Updates the phase according to the current frequency and returns the sample at the new phase position. More...

void	setTable (const int8_t *TABLE_NAME, byte rank)
	Change the sound table which will be played by the Oscil of rank. More...

void	setPhase (unsigned int phase)
	Set the phase of the currently playing Oscil. More...

void	setPhaseFractional (unsigned long phase)
	Set the phase of the currently playing Oscil in fractional format. More...

unsigned long	getPhaseFractional ()
	Get the phase of the currently playin Oscil in fractional format. More...

int8_t	phMod (Q15n16 phmod_proportion)
	Returns the next sample given a phase modulation value. More...

void	setFreq (int frequency, bool apply=true)
	Set the MetaOsc frequency with an unsigned int. More...

void	setFreq (float frequency)
	Set the MetaOsc frequency with a float. More...

template<int8_t NI, int8_t NF, uint64_t RANGE>
void	setFreq (UFix< NI, NF, RANGE > frequency)
	Set the MetaOsc frequency with a UFix<NI,NF> fixed-point number format. More...

void	setFreq_Q24n8 (Q24n8 frequency)
	Set the MetaOsc frequency with a Q24n8 fixed-point number format. More...

void	setFreq_Q16n16 (Q16n16 frequency)
	Set the MetaOsc frequency with a Q16n16 fixed-point number format. More...

int8_t	atIndex (unsigned int index)
	Returns the sample at the given table index of the current Oscil. More...

unsigned long	phaseIncFromFreq (int frequency)
	phaseIncFromFreq() and setPhaseInc() are for saving processor time when sliding between frequencies. More...

void	setPhaseInc (unsigned long phaseinc_fractional)
	Set a specific phase increment. More...

Constructor & Destructor Documentation

◆ MetaOscil()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

template<class... T>

MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::MetaOscil	(	Oscil< NUM_TABLE_CELLS, UPDATE_RATE > *	first,
		T *...	elements
	)

inline

Constructor Declare a MetaOscil containing any number of Oscil pointers.

Every Oscil should have the same TABLE_NUM_CELLS and UPDATE_RATE which are also passed in the MetaOscil constructor.

Parameters

N_OSCIL is the number of Oscil contained in the MetaOscil. This cannot be changed after construction.

Definition at line 39 of file MetaOscil.h.

Member Function Documentation

◆ atIndex()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

int8_t MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::atIndex ( unsigned int index )

inline

Returns the sample at the given table index of the current Oscil.

Parameters

index between 0 and the table size.The index rolls back around to 0 if it's larger than the table size.

Returns: the sample at the given table index.

Definition at line 218 of file MetaOscil.h.

◆ getPhaseFractional()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

unsigned long MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::getPhaseFractional ( )

inline

Get the phase of the currently playin Oscil in fractional format.

Returns: position in the wavetable, shifted left by OSCIL_F_BITS (which is 16 when this was written).

Definition at line 115 of file MetaOscil.h.

◆ next()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

int8_t MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::next ( )

inline

Updates the phase according to the current frequency and returns the sample at the new phase position.

Returns: the next sample.

Definition at line 94 of file MetaOscil.h.

◆ phaseIncFromFreq()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

unsigned long MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::phaseIncFromFreq ( int frequency )

inline

phaseIncFromFreq() and setPhaseInc() are for saving processor time when sliding between frequencies.

Parameters

frequency for which you want to calculate a phase increment value.

Returns: the phase increment value which will produce a given frequency.

Definition at line 225 of file MetaOscil.h.

◆ phMod()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

int8_t MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::phMod ( Q15n16 phmod_proportion )

inline

Returns the next sample given a phase modulation value.

Parameters

phmod_proportion a phase modulation value given as a proportion of the wave. The phmod_proportion parameter is a Q15n16 fixed-point number where the fractional n16 part represents almost -1 to almost 1, modulating the phase by one whole table length in each direction.

Returns: a sample from the table.

Definition at line 126 of file MetaOscil.h.

◆ setCutoffFreq()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setCutoffFreq	(	int	freq,
		byte	rank
	)

inline

Set or change the cutoff frequency of one Oscil.

Parameters

rank	is the rank of the Oscil.
freq	is the cutoff frequency.

Definition at line 85 of file MetaOscil.h.

◆ setCutoffFreqs()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

template<typename ... T>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setCutoffFreqs	(	int	first,
		T...	elements
	)

inline

Set all the cutoff frequencies for changing between Oscil.

They have to be sorted in increasing values and contain at least N_OSCIL-1 values. Note that the last Oscil will be used by default for frequencies higher than the higher cutoff, hence the last value can be discarded.

Parameters

first,elements... a set of int cutoff frequencies.

Definition at line 72 of file MetaOscil.h.

◆ setFreq() [1/3]

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setFreq ( float frequency )

inline

Set the MetaOsc frequency with a float.

Parameters

frequency to play the wave table.

Definition at line 171 of file MetaOscil.h.

◆ setFreq() [2/3]

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setFreq	(	int	frequency,
		bool	apply = `true`
	)

inline

Set the MetaOsc frequency with an unsigned int.

Parameters

frequency to play the wave table.

Definition at line 132 of file MetaOscil.h.

◆ setFreq() [3/3]

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

template<int8_t NI, int8_t NF, uint64_t RANGE>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setFreq ( UFix< NI, NF, RANGE > frequency )

inline

Set the MetaOsc frequency with a UFix<NI,NF> fixed-point number format.

This falls back to using UFix<16,16> internally and is provided as a fallout for other UFix types..

Parameters

frequency to play the wave table.

Definition at line 183 of file MetaOscil.h.

◆ setFreq_Q16n16()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setFreq_Q16n16 ( Q16n16 frequency )

inline

Set the MetaOsc frequency with a Q16n16 fixed-point number format.

Parameters

frequency to play the wave table.

Definition at line 205 of file MetaOscil.h.

◆ setFreq_Q24n8()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setFreq_Q24n8 ( Q24n8 frequency )

inline

Set the MetaOsc frequency with a Q24n8 fixed-point number format.

Parameters

frequency to play the wave table.

Definition at line 194 of file MetaOscil.h.

◆ setOscils()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

template<typename ... T>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setOscils	(	Oscil< NUM_TABLE_CELLS, UPDATE_RATE > *	first,
		T...	elements
	)

inline

Set all Oscil of a MetaOscil.

Parameters

first... is a list of pointers towards several Oscil

Definition at line 58 of file MetaOscil.h.

◆ setPhase()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setPhase ( unsigned int phase )

inline

Set the phase of the currently playing Oscil.

Parameters

phase a position in the wavetable.

Definition at line 104 of file MetaOscil.h.

◆ setPhaseFractional()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setPhaseFractional ( unsigned long phase )

inline

Set the phase of the currently playing Oscil in fractional format.

Parameters

phase a position in the wavetable.

Definition at line 109 of file MetaOscil.h.

◆ setPhaseInc()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setPhaseInc ( unsigned long phaseinc_fractional )

inline

Set a specific phase increment.

Parameters

phaseinc_fractional a phase increment value as calculated by phaseIncFromFreq().

Definition at line 231 of file MetaOscil.h.

◆ setTable()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>

void MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >::setTable	(	const int8_t *	TABLE_NAME,
		byte	rank
	)

inline

Change the sound table which will be played by the Oscil of rank.

Parameters

TABLE_NAME	is the name of the array in the table ".h" file you're using.
rank	is the Oscil.

Definition at line 99 of file MetaOscil.h.

Detailed Description

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL> class MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >

Public Member Functions

Constructor & Destructor Documentation

◆ MetaOscil()

Member Function Documentation

◆ atIndex()

◆ getPhaseFractional()

◆ next()

◆ phaseIncFromFreq()

◆ phMod()

◆ setCutoffFreq()

◆ setCutoffFreqs()

◆ setFreq() [1/3]

◆ setFreq() [2/3]

◆ setFreq() [3/3]

◆ setFreq_Q16n16()

◆ setFreq_Q24n8()

◆ setOscils()

◆ setPhase()

◆ setPhaseFractional()

◆ setPhaseInc()

◆ setTable()

template<uint16_t NUM_TABLE_CELLS, uint16_t UPDATE_RATE, byte N_OSCIL>
class MetaOscil< NUM_TABLE_CELLS, UPDATE_RATE, N_OSCIL >