Synthesizer Class Reference

A simple Synthesizer which can generate sound having multiple keys pressed. The main purpose of this class is managing the synthezizer channels. More...

#include <Synthesizer.h>

Inheritance diagram for Synthesizer:

Classes
struct	KeyParameter

Public Member Functions
	Synthesizer ()
	Synthesizer (AbstractSynthesizerChannel *ch)
	Synthesizer (Synthesizer const &)=delete
virtual	~Synthesizer ()
virtual AudioInfo	audioInfo ()
	Provides the AudioInfo.
virtual bool	begin ()
	Starts the processing.
bool	begin (AudioInfo config)
	Starts the processing with the provided AudioInfo.
virtual AudioInfo	defaultConfig ()
	Provides the default configuration.
virtual void	end ()
	Ends the processing.
virtual bool	isActive ()
	Checks if the begin method has been called - after end() isActive is false.
void	keyOff (int note)
void	keyOn (int note, float tgt=0)
Synthesizer &	operator= (Synthesizer const &)=delete
virtual size_t	readBytes (uint8_t *data, size_t len)
	Provides the data as byte array with the requested number of channels.
int16_t	readSample () override
	Provides mixed samples of all channels.
virtual void	setAudioInfo (AudioInfo info)
	Defines/updates the AudioInfo.
virtual void	setFrequency (float frequency)
	Abstract method: not implemented! Just provides an error message...
void	setKeys (AudioActions &actions, SynthesizerKey *p_keys, AudioActions::ActiveLogic activeValue)
	Assigns pins to notes - the last SynthesizerKey is marked with an entry containing the note <= 0.
void	setMidiName (const char *name)
	Defines the midi name.
void	setPlayTime (uint32_t playMs, uint8_t upPercent=20, uint8_t downPercent=30)
	Defines the play time in ms and the ramp up and ramp down time in percent.

Protected Member Functions
int16_t	applyRamp (int16_t sample)
AbstractSynthesizerChannel *	getFreeChannel ()
AbstractSynthesizerChannel *	getNoteChannel (int note)
size_t	readBytesFrames (uint8_t *buffer, size_t lengthBytes, int frames, int channels)
size_t	readBytesFromBuffer (uint8_t *buffer, size_t lengthBytes, int frame_size, int channels)
void	recalculatePlayTime ()

Static Protected Member Functions
static void	callbackKeyOff (bool active, int pin, void *ref)
static void	callbackKeyOn (bool active, int pin, void *ref)

Protected Attributes
bool	active
bool	activeWarningIssued
AudioInfo	cfg
Vector< AbstractSynthesizerChannel * >	channels
uint32_t	currentSample
AbstractSynthesizerChannel *	defaultChannel
uint8_t	downPercent
float	factor
AudioInfo	info
const char *	midi_name = "Synthesizer"
uint32_t	playMs
uint32_t	playSamples
float	rampDownDec
uint32_t	rampDownSamples
float	rampUpInc
RingBuffer< uint8_t >	ring_buffer
uint8_t	upPercent
uint32_t	upSamples

Detailed Description

A simple Synthesizer which can generate sound having multiple keys pressed. The main purpose of this class is managing the synthezizer channels.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

Synthesizer() [1/3]

Synthesizer ( )

inline

Synthesizer() [2/3]

Synthesizer ( AbstractSynthesizerChannel *  ch )

inline

Synthesizer() [3/3]

Synthesizer ( Synthesizer const &  )

delete

~Synthesizer()

virtual ~Synthesizer ( )

inlinevirtual

Member Function Documentation

applyRamp()

int16_t applyRamp ( int16_t  sample )

inlineprotectedinherited

audioInfo()

virtual AudioInfo audioInfo ( )

inlinevirtualinherited

Provides the AudioInfo.

begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Starts the processing.

begin() [2/2]

bool begin ( AudioInfo  info )

inlinevirtual

Starts the processing with the provided AudioInfo.

Reimplemented from SoundGenerator< int16_t >.

callbackKeyOff()

static void callbackKeyOff ( bool  active, int  pin, void *  ref  )

inlinestaticprotected

callbackKeyOn()

static void callbackKeyOn ( bool  active, int  pin, void *  ref  )

inlinestaticprotected

defaultConfig()

virtual AudioInfo defaultConfig ( )

inlinevirtualinherited

Provides the default configuration.

end()

virtual void end ( )

inlinevirtualinherited

Ends the processing.

getFreeChannel()

AbstractSynthesizerChannel * getFreeChannel ( )

inlineprotected

getNoteChannel()

AbstractSynthesizerChannel * getNoteChannel ( int  note )

inlineprotected

isActive()

virtual bool isActive ( )

inlinevirtualinherited

Checks if the begin method has been called - after end() isActive is false.

keyOff()

void keyOff ( int  note )

inline

keyOn()

void keyOn ( int  note, float  tgt = 0  )

inline

operator=()

Synthesizer & operator= ( Synthesizer const &  )

delete

readBytes()

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlinevirtualinherited

Provides the data as byte array with the requested number of channels.

readBytesFrames()

size_t readBytesFrames ( uint8_t *  buffer, size_t  lengthBytes, int  frames, int  channels  )

inlineprotectedinherited

readBytesFromBuffer()

size_t readBytesFromBuffer ( uint8_t *  buffer, size_t  lengthBytes, int  frame_size, int  channels  )

inlineprotectedinherited

readSample()

int16_t readSample ( )

inlineoverridevirtual

Provides mixed samples of all channels.

Implements SoundGenerator< int16_t >.

recalculatePlayTime()

void recalculatePlayTime ( )

inlineprotectedinherited

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtualinherited

Defines/updates the AudioInfo.

setFrequency()

virtual void setFrequency ( float  frequency )

inlinevirtualinherited

Abstract method: not implemented! Just provides an error message...

setKeys()

void setKeys ( AudioActions &  actions, SynthesizerKey *  p_keys, AudioActions::ActiveLogic  activeValue  )

inline

Assigns pins to notes - the last SynthesizerKey is marked with an entry containing the note <= 0.

setMidiName()

void setMidiName ( const char *  name )

inline

Defines the midi name.

setPlayTime()

void setPlayTime ( uint32_t  playMs, uint8_t  upPercent = 20, uint8_t  downPercent = 30  )

inlineinherited

Defines the play time in ms and the ramp up and ramp down time in percent.

Member Data Documentation

active

bool active

protectedinherited

activeWarningIssued

bool activeWarningIssued

protectedinherited

cfg

AudioInfo cfg

protected

channels

Vector<AbstractSynthesizerChannel*> channels

protected

currentSample

uint32_t currentSample

protectedinherited

defaultChannel

AbstractSynthesizerChannel* defaultChannel

protected

downPercent

uint8_t downPercent

protectedinherited

factor

float factor

protectedinherited

info

AudioInfo info

protectedinherited

midi_name

const char* midi_name = "Synthesizer"

protected

playMs

uint32_t playMs

protectedinherited

playSamples

uint32_t playSamples

protectedinherited

rampDownDec

float rampDownDec

protectedinherited

rampDownSamples

uint32_t rampDownSamples

protectedinherited

rampUpInc

float rampUpInc

protectedinherited

ring_buffer

RingBuffer<uint8_t> ring_buffer

protectedinherited

upPercent

uint8_t upPercent

protectedinherited

upSamples

uint32_t upSamples

protectedinherited

---

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

• src/AudioTools/CoreAudio/AudioEffects/Synthesizer.h