#include <Synthesiser.h>
Represents a voice that a Synthesiser can use to play a SynthesiserSound.
A voice plays a single sound at a time, and a synthesiser holds an array of voices so that it can play polyphonically.
- See also
- Synthesiser, SynthesiserSound
◆ SynthesiserVoice()
| water::SynthesiserVoice::SynthesiserVoice |
( |
| ) |
|
◆ ~SynthesiserVoice()
| water::SynthesiserVoice::~SynthesiserVoice |
( |
| ) |
|
|
virtual |
◆ aftertouchChanged()
| void water::SynthesiserVoice::aftertouchChanged |
( |
int | newAftertouchValue | ) |
|
|
virtual |
Called to let the voice know that the aftertouch has changed. This will be called during the rendering callback, so must be fast and thread-safe.
◆ canPlaySound()
Must return true if this voice object is capable of playing the given sound.
If there are different classes of sound, and different classes of voice, a voice can choose which ones it wants to take on.
A typical implementation of this method may just return true if there's only one type of voice and sound, or it might check the type of the sound object passed-in and see if it's one that it understands.
Implemented in sfzero::Voice.
◆ channelPressureChanged()
| void water::SynthesiserVoice::channelPressureChanged |
( |
int | newChannelPressureValue | ) |
|
|
virtual |
Called to let the voice know that the channel pressure has changed. This will be called during the rendering callback, so must be fast and thread-safe.
◆ clearCurrentNote()
| void water::SynthesiserVoice::clearCurrentNote |
( |
| ) |
|
|
protected |
Resets the state of this voice after a sound has finished playing.
The subclass must call this when it finishes playing a note and becomes available to play new ones.
It must either call it in the stopNote() method, or if the voice is tailing off, then it should call it later during the renderNextBlock method, as soon as it finishes its tail-off.
It can also be called at any time during the render callback if the sound happens to have finished, e.g. if it's playing a sample and the sample finishes.
◆ controllerMoved()
| virtual void water::SynthesiserVoice::controllerMoved |
( |
int | controllerNumber, |
|
|
int | newControllerValue ) |
|
pure virtual |
Called to let the voice know that a midi controller has been moved. This will be called during the rendering callback, so must be fast and thread-safe.
Implemented in sfzero::Voice.
◆ getCurrentlyPlayingNote()
| int water::SynthesiserVoice::getCurrentlyPlayingNote |
( |
| ) |
const |
|
inlinenoexcept |
Returns the midi note that this voice is currently playing. Returns a value less than 0 if no note is playing.
◆ getCurrentlyPlayingSound()
Returns the sound that this voice is currently playing. Returns nullptr if it's not playing.
◆ getSampleRate()
| double water::SynthesiserVoice::getSampleRate |
( |
| ) |
const |
|
inlinenoexcept |
Returns the current target sample rate at which rendering is being done. Subclasses may need to know this so that they can pitch things correctly.
◆ isKeyDown()
| bool water::SynthesiserVoice::isKeyDown |
( |
| ) |
const |
|
inlinenoexcept |
Returns true if the key that triggered this voice is still held down. Note that the voice may still be playing after the key was released (e.g because the sostenuto pedal is down).
◆ isPlayingButReleased()
| bool water::SynthesiserVoice::isPlayingButReleased |
( |
| ) |
const |
|
inlinenoexcept |
Returns true if a voice is sounding in its release phase
◆ isPlayingChannel()
| bool water::SynthesiserVoice::isPlayingChannel |
( |
int | midiChannel | ) |
const |
|
virtual |
Returns true if the voice is currently playing a sound which is mapped to the given midi channel.
If it's not currently playing, this will return false.
◆ isSostenutoPedalDown()
| bool water::SynthesiserVoice::isSostenutoPedalDown |
( |
| ) |
const |
|
inlinenoexcept |
Returns true if the sostenuto pedal is currently active for this voice.
◆ isSustainPedalDown()
| bool water::SynthesiserVoice::isSustainPedalDown |
( |
| ) |
const |
|
inlinenoexcept |
Returns true if the sustain pedal is currently active for this voice.
◆ isVoiceActive()
| bool water::SynthesiserVoice::isVoiceActive |
( |
| ) |
const |
|
virtual |
Returns true if this voice is currently busy playing a sound. By default this just checks the getCurrentlyPlayingNote() value, but can be overridden for more advanced checking.
◆ pitchWheelMoved()
| virtual void water::SynthesiserVoice::pitchWheelMoved |
( |
int | newPitchWheelValue | ) |
|
|
pure virtual |
Called to let the voice know that the pitch wheel has been moved. This will be called during the rendering callback, so must be fast and thread-safe.
Implemented in sfzero::Voice.
◆ renderNextBlock()
Renders the next block of data for this voice.
The output audio data must be added to the current contents of the buffer provided. Only the region of the buffer between startSample and (startSample + numSamples) should be altered by this method.
If the voice is currently silent, it should just return without doing anything.
If the sound that the voice is playing finishes during the course of this rendered block, it must call clearCurrentNote(), to tell the synthesiser that it has finished.
The size of the blocks that are rendered can change each time it is called, and may involve rendering as little as 1 sample at a time. In between rendering callbacks, the voice's methods will be called to tell it about note and controller events.
Implemented in sfzero::Voice.
◆ setCurrentPlaybackSampleRate()
| void water::SynthesiserVoice::setCurrentPlaybackSampleRate |
( |
double | newRate | ) |
|
|
virtual |
Changes the voice's reference sample rate.
The rate is set so that subclasses know the output rate and can set their pitch accordingly.
This method is called by the synth, and subclasses can access the current rate with the currentSampleRate member.
◆ startNote()
| virtual void water::SynthesiserVoice::startNote |
( |
int | midiNoteNumber, |
|
|
float | velocity, |
|
|
SynthesiserSound * | sound, |
|
|
int | currentPitchWheelPosition ) |
|
pure virtual |
Called to start a new note. This will be called during the rendering callback, so must be fast and thread-safe.
Implemented in sfzero::Voice.
◆ stopNote()
| virtual void water::SynthesiserVoice::stopNote |
( |
float | velocity, |
|
|
bool | allowTailOff ) |
|
pure virtual |
Called to stop a note.
This will be called during the rendering callback, so must be fast and thread-safe.
The velocity indicates how quickly the note was released - 0 is slowly, 1 is quickly.
If allowTailOff is false or the voice doesn't want to tail-off, then it must stop all sound immediately, and must call clearCurrentNote() to reset the state of this voice and allow the synth to reassign it another sound.
If allowTailOff is true and the voice decides to do a tail-off, then it's allowed to begin fading out its sound, and it can stop playing until it's finished. As soon as it finishes playing (during the rendering callback), it must make sure that it calls clearCurrentNote().
Implemented in sfzero::Voice.
◆ wasStartedBefore()
Returns true if this voice started playing its current note before the other voice did.
◆ Synthesiser
◆ currentlyPlayingNote
| int water::SynthesiserVoice::currentlyPlayingNote |
|
private |
◆ currentlyPlayingSound
◆ currentPlayingMidiChannel
| int water::SynthesiserVoice::currentPlayingMidiChannel |
|
private |
◆ currentSampleRate
| double water::SynthesiserVoice::currentSampleRate |
|
private |
◆ keyIsDown
| bool water::SynthesiserVoice::keyIsDown |
|
private |
◆ noteOnTime
| uint32 water::SynthesiserVoice::noteOnTime |
|
private |
◆ sostenutoPedalDown
| bool water::SynthesiserVoice::sostenutoPedalDown |
|
private |
◆ sustainPedalDown
| bool water::SynthesiserVoice::sustainPedalDown |
|
private |
◆ tempBuffer
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/synthesisers/Synthesiser.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/synthesisers/Synthesiser.cpp
1.16.1