sam/sfizz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documented the envelope generator description

Browse source
This commit is contained in:
Paul Ferrand 2019-11-30 00:52:44 +01:00
parent 8ce3af6f85
commit 4a4790d6ba
1 changed files with 57 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
src/sfizz/EGDescription.h
View file

@ -31,7 +31,14 @@
namespace sfz
{
/**
* @brief A description for an SFZ envelope generator, with its envelope parameters
* and possible CC modulation. This is a structure to be integrated directly in a
* region and accessed, so not too many getters and setters in there.
*
* TODO: should be updated for SFZ v2
*
*/
struct EGDescription
{
EGDescription() = default;
@ -63,30 +70,79 @@ struct EGDescription
absl::optional<CCValuePair> ccStart;
absl::optional<CCValuePair> ccSustain;
/**
* @brief Get the attack with possibly a CC modifier and a velocity modifier
*
* @param ccValues
* @param velocity
* @return float
*/
float getAttack(const CCValueArray &ccValues, uint8_t velocity) const noexcept
{
return ccSwitchedValue(ccValues, ccAttack, attack) + normalizeCC(velocity)*vel2attack;
}
/**
* @brief Get the decay with possibly a CC modifier and a velocity modifier
*
* @param ccValues
* @param velocity
* @return float
*/
float getDecay(const CCValueArray &ccValues, uint8_t velocity) const noexcept
{
return ccSwitchedValue(ccValues, ccDecay, decay) + normalizeCC(velocity)*vel2decay;
}
/**
* @brief Get the delay with possibly a CC modifier and a velocity modifier
*
* @param ccValues
* @param velocity
* @return float
*/
float getDelay(const CCValueArray &ccValues, uint8_t velocity) const noexcept
{
return ccSwitchedValue(ccValues, ccDelay, delay) + normalizeCC(velocity)*vel2delay;
}
/**
* @brief Get the holding duration with possibly a CC modifier and a velocity modifier
*
* @param ccValues
* @param velocity
* @return float
*/
float getHold(const CCValueArray &ccValues, uint8_t velocity) const noexcept
{
return ccSwitchedValue(ccValues, ccHold, hold) + normalizeCC(velocity)*vel2hold;
}
/**
* @brief Get the release duration with possibly a CC modifier and a velocity modifier
*
* @param ccValues
* @param velocity
* @return float
*/
float getRelease(const CCValueArray &ccValues, uint8_t velocity) const noexcept
{
return ccSwitchedValue(ccValues, ccRelease, release) + normalizeCC(velocity)*vel2release;
}
/**
* @brief Get the starting level with possibly a CC modifier and a velocity modifier
*
* @param ccValues
* @param velocity
* @return float
*/
float getStart(const CCValueArray &ccValues, uint8_t velocity [[maybe_unused]]) const noexcept
{
return ccSwitchedValue(ccValues, ccStart, start);
}
/**
* @brief Get the sustain level with possibly a CC modifier and a velocity modifier
*
* @param ccValues
* @param velocity
* @return float
*/
float getSustain(const CCValueArray &ccValues, uint8_t velocity) const noexcept
{
return ccSwitchedValue(ccValues, ccSustain, sustain) + normalizeCC(velocity)*vel2sustain;