sfizz/src/sfizz/Synth.cpp
2021-06-23 00:08:15 +02:00

2216 lines
71 KiB
C++

// SPDX-License-Identifier: BSD-2-Clause
// This code is part of the sfizz library and is licensed under a BSD 2-clause
// license. You should have receive a LICENSE.md file along with the code.
// If not, contact the sfizz maintainers at https://github.com/sfztools/sfizz
#include "SynthPrivate.h"
#include "Config.h"
#include "utility/Debug.h"
#include "utility/Macros.h"
#include "modulations/ModId.h"
#include "modulations/ModKey.h"
#include "modulations/ModMatrix.h"
#include "PolyphonyGroup.h"
#include "pugixml.hpp"
#include "Region.h"
#include "RegionSet.h"
#include "Resources.h"
#include "BufferPool.h"
#include "FilePool.h"
#include "Wavetables.h"
#include "Tuning.h"
#include "BeatClock.h"
#include "Metronome.h"
#include "SynthConfig.h"
#include "ScopedFTZ.h"
#include "utility/StringViewHelpers.h"
#include "utility/XmlHelpers.h"
#include "Voice.h"
#include "Interpolators.h"
#include "parser/Parser.h"
#include <absl/algorithm/container.h>
#include <absl/memory/memory.h>
#include <absl/strings/str_replace.h>
#include <absl/types/optional.h>
#include <absl/types/span.h>
#include <algorithm>
#include <chrono>
#include <iostream>
#include <random>
#include <utility>
namespace sfz {
// unless set to permissive, the loader rejects sfz files with errors
static constexpr bool loaderParsesPermissively = true;
Synth::Synth()
: impl_(new Impl) // NOLINT: (paul) I don't get why clang-tidy complains here
{
}
// Need to define the dtor after Impl has been defined
Synth::~Synth()
{
}
Synth::Impl::Impl()
{
initializeSIMDDispatchers();
initializeInterpolators();
parser_.setListener(this);
effectFactory_.registerStandardEffectTypes();
effectBuses_.reserve(5); // sufficient room for main and fx1-4
resetVoices(config::numVoices);
// modulation sources
MidiState& midiState = resources_.getMidiState();
genController_.reset(new ControllerSource(resources_, voiceManager_));
genLFO_.reset(new LFOSource(voiceManager_));
genFlexEnvelope_.reset(new FlexEnvelopeSource(voiceManager_));
genADSREnvelope_.reset(new ADSREnvelopeSource(voiceManager_, midiState));
genChannelAftertouch_.reset(new ChannelAftertouchSource(voiceManager_, midiState));
genPolyAftertouch_.reset(new PolyAftertouchSource(voiceManager_, midiState));
}
Synth::Impl::~Impl()
{
voiceManager_.reset();
resources_.getFilePool().emptyFileLoadingQueues();
}
void Synth::Impl::onParseFullBlock(const std::string& header, const std::vector<Opcode>& members)
{
const auto newRegionSet = [&](OpcodeScope level) {
auto parent = currentSet_;
while (parent && parent->getLevel() >= level)
parent = parent->getParent();
sets_.emplace_back(new RegionSet(parent, level));
currentSet_ = sets_.back().get();
};
switch (hash(header)) {
case hash("global"):
globalOpcodes_ = members;
newRegionSet(OpcodeScope::kOpcodeScopeGlobal);
groupOpcodes_.clear();
masterOpcodes_.clear();
handleGlobalOpcodes(members);
break;
case hash("control"):
defaultPath_ = ""; // Always reset on a new control header
handleControlOpcodes(members);
break;
case hash("master"):
masterOpcodes_ = members;
newRegionSet(OpcodeScope::kOpcodeScopeMaster);
groupOpcodes_.clear();
handleMasterOpcodes(members);
numMasters_++;
break;
case hash("group"):
groupOpcodes_ = members;
newRegionSet(OpcodeScope::kOpcodeScopeGroup);
handleGroupOpcodes(members, masterOpcodes_);
numGroups_++;
break;
case hash("region"):
buildRegion(members);
break;
case hash("curve"):
resources_.getCurves().addCurveFromHeader(members);
break;
case hash("effect"):
handleEffectOpcodes(members);
break;
default:
std::cerr << "Unknown header: " << header << '\n';
}
}
void Synth::Impl::onParseError(const SourceRange& range, const std::string& message)
{
const auto relativePath = range.start.filePath->lexically_relative(parser_.originalDirectory());
std::cerr << "Parse error in " << relativePath << " at line " << range.start.lineNumber + 1 << ": " << message << '\n';
}
void Synth::Impl::onParseWarning(const SourceRange& range, const std::string& message)
{
const auto relativePath = range.start.filePath->lexically_relative(parser_.originalDirectory());
std::cerr << "Parse warning in " << relativePath << " at line " << range.start.lineNumber + 1 << ": " << message << '\n';
}
void Synth::Impl::buildRegion(const std::vector<Opcode>& regionOpcodes)
{
int regionNumber = static_cast<int>(layers_.size());
MidiState& midiState = resources_.getMidiState();
Layer* lastLayer = new Layer(regionNumber, defaultPath_, midiState);
layers_.emplace_back(lastLayer);
Region* lastRegion = &lastLayer->getRegion();
//
auto parseOpcodes = [&](const std::vector<Opcode>& opcodes) {
for (auto& opcode : opcodes) {
const auto unknown = absl::c_find_if(unknownOpcodes_, [&](absl::string_view sv) { return sv.compare(opcode.name) == 0; });
if (unknown != unknownOpcodes_.end()) {
continue;
}
if (!lastRegion->parseOpcode(opcode))
unknownOpcodes_.emplace_back(opcode.name);
}
};
parseOpcodes(globalOpcodes_);
parseOpcodes(masterOpcodes_);
parseOpcodes(groupOpcodes_);
parseOpcodes(regionOpcodes);
// Create the amplitude envelope
if (!lastRegion->flexAmpEG)
lastRegion->getOrCreateConnection(
ModKey::createNXYZ(ModId::AmpEG, lastRegion->id),
ModKey::createNXYZ(ModId::MasterAmplitude, lastRegion->id)).sourceDepth = 1.0f;
else
lastRegion->getOrCreateConnection(
ModKey::createNXYZ(ModId::Envelope, lastRegion->id, *lastRegion->flexAmpEG),
ModKey::createNXYZ(ModId::MasterAmplitude, lastRegion->id)).sourceDepth = 1.0f;
if (octaveOffset_ != 0 || noteOffset_ != 0)
lastRegion->offsetAllKeys(octaveOffset_ * 12 + noteOffset_);
if (lastRegion->lastKeyswitch)
lastKeyswitchLists_[*lastRegion->lastKeyswitch].push_back(lastLayer);
if (lastRegion->lastKeyswitchRange) {
auto& range = *lastRegion->lastKeyswitchRange;
for (uint8_t note = range.getStart(), end = range.getEnd(); note <= end; note++)
lastKeyswitchLists_[note].push_back(lastLayer);
}
if (lastRegion->upKeyswitch)
upKeyswitchLists_[*lastRegion->upKeyswitch].push_back(lastLayer);
if (lastRegion->downKeyswitch)
downKeyswitchLists_[*lastRegion->downKeyswitch].push_back(lastLayer);
if (lastRegion->previousKeyswitch)
previousKeyswitchLists_.push_back(lastLayer);
if (lastRegion->defaultSwitch)
currentSwitch_ = *lastRegion->defaultSwitch;
// There was a combination of group= and polyphony= on a region, so set the group polyphony
if (lastRegion->group != Default::group && lastRegion->polyphony != config::maxVoices) {
voiceManager_.setGroupPolyphony(lastRegion->group, lastRegion->polyphony);
} else {
// Just check that there are enough polyphony groups
voiceManager_.ensureNumPolyphonyGroups(lastRegion->group);
}
if (currentSet_ != nullptr) {
lastRegion->parent = currentSet_;
currentSet_->addRegion(lastRegion);
}
// Adapt the size of the delayed releases to avoid allocating later on
if (lastRegion->trigger == Trigger::release) {
const auto keyLength = static_cast<unsigned>(lastRegion->keyRange.length());
const auto size = max(config::delayedReleaseVoices, keyLength);
lastLayer->delayedSustainReleases_.reserve(size);
lastLayer->delayedSostenutoReleases_.reserve(size);
}
// Initialize status of Key switches, CC switches, etc
lastLayer->initializeActivations();
}
void Synth::Impl::clear()
{
FilePool& filePool = resources_.getFilePool();
MidiState& midiState = resources_.getMidiState();
// Clear the background queues before removing everyone
filePool.waitForBackgroundLoading();
voiceManager_.reset();
for (auto& list : lastKeyswitchLists_)
list.clear();
for (auto& list : downKeyswitchLists_)
list.clear();
for (auto& list : upKeyswitchLists_)
list.clear();
for (auto& list : noteActivationLists_)
list.clear();
for (auto& list : ccActivationLists_)
list.clear();
previousKeyswitchLists_.clear();
currentSet_ = nullptr;
sets_.clear();
layers_.clear();
effectBuses_.clear();
effectBuses_.emplace_back(new EffectBus);
effectBuses_[0]->setGainToMain(1.0);
effectBuses_[0]->setSamplesPerBlock(samplesPerBlock_);
effectBuses_[0]->setSampleRate(sampleRate_);
effectBuses_[0]->clearInputs(samplesPerBlock_);
resources_.clear();
rootPath_.clear();
numGroups_ = 0;
numMasters_ = 0;
currentSwitch_ = absl::nullopt;
defaultPath_ = "";
image_ = "";
midiState.reset();
filePool.clear();
filePool.setRamLoading(config::loadInRam);
clearCCLabels();
currentUsedCCs_.clear();
changedCCsThisCycle_.clear();
changedCCsLastCycle_.clear();
clearKeyLabels();
keySlots_.clear();
swLastSlots_.clear();
clearKeyswitchLabels();
globalOpcodes_.clear();
masterOpcodes_.clear();
groupOpcodes_.clear();
unknownOpcodes_.clear();
modificationTime_ = absl::nullopt;
playheadMoved_ = false;
// set default controllers
// midistate is reset above
fill(absl::MakeSpan(defaultCCValues_), 0.0f);
setDefaultHdcc(7, normalizeCC(100));
setDefaultHdcc(10, 0.5f);
setDefaultHdcc(11, 1.0f);
// set default controller labels
setCCLabel(7, "Volume");
setCCLabel(10, "Pan");
setCCLabel(11, "Expression");
}
void Synth::Impl::handleMasterOpcodes(const std::vector<Opcode>& members)
{
for (auto& rawMember : members) {
const Opcode member = rawMember.cleanUp(kOpcodeScopeMaster);
switch (member.lettersOnlyHash) {
case hash("polyphony"):
ASSERT(currentSet_ != nullptr);
currentSet_->setPolyphonyLimit(member.read(Default::polyphony));
break;
case hash("sw_default"):
currentSwitch_ = member.read(Default::key);
break;
}
}
}
void Synth::Impl::handleGlobalOpcodes(const std::vector<Opcode>& members)
{
for (auto& rawMember : members) {
const Opcode member = rawMember.cleanUp(kOpcodeScopeGlobal);
switch (member.lettersOnlyHash) {
case hash("polyphony"):
ASSERT(currentSet_ != nullptr);
currentSet_->setPolyphonyLimit(member.read(Default::polyphony));
break;
case hash("sw_default"):
currentSwitch_ = member.read(Default::key);
break;
case hash("volume"):
// FIXME : Probably best not to mess with this and let the host control the volume
// setValueFromOpcode(member, volume, OldDefault::volumeRange);
break;
}
}
}
void Synth::Impl::handleGroupOpcodes(const std::vector<Opcode>& members, const std::vector<Opcode>& masterMembers)
{
absl::optional<unsigned> groupIdx;
absl::optional<unsigned> maxPolyphony;
const auto parseOpcode = [&](const Opcode& rawMember) {
const Opcode member = rawMember.cleanUp(kOpcodeScopeGroup);
switch (member.lettersOnlyHash) {
case hash("group"):
groupIdx = member.read(Default::group);
break;
case hash("polyphony"):
maxPolyphony = member.read(Default::polyphony);
break;
case hash("sw_default"):
currentSwitch_ = member.read(Default::key);
break;
}
};
for (auto& member : masterMembers)
parseOpcode(member);
for (auto& member : members)
parseOpcode(member);
if (groupIdx && maxPolyphony) {
voiceManager_.setGroupPolyphony(*groupIdx, *maxPolyphony);
} else if (maxPolyphony) {
ASSERT(currentSet_ != nullptr);
currentSet_->setPolyphonyLimit(*maxPolyphony);
} else if (groupIdx) {
voiceManager_.ensureNumPolyphonyGroups(*groupIdx);
}
}
void Synth::Impl::handleControlOpcodes(const std::vector<Opcode>& members)
{
for (auto& rawMember : members) {
const Opcode member = rawMember.cleanUp(kOpcodeScopeControl);
switch (member.lettersOnlyHash) {
case hash("set_cc&"):
if (Default::ccNumber.bounds.containsWithEnd(member.parameters.back())) {
setDefaultHdcc(member.parameters.back(), member.read(Default::loCC));
}
break;
case hash("set_hdcc&"):
if (Default::ccNumber.bounds.containsWithEnd(member.parameters.back())) {
setDefaultHdcc(member.parameters.back(), member.read(Default::loNormalized));
}
break;
case hash("label_cc&"):
if (Default::ccNumber.bounds.containsWithEnd(member.parameters.back()))
setCCLabel(member.parameters.back(), std::string(member.value));
break;
case hash("label_key&"):
if (member.parameters.back() <= Default::key.bounds.getEnd()) {
const auto noteNumber = static_cast<uint8_t>(member.parameters.back());
setKeyLabel(noteNumber, member.value);
}
break;
case hash("default_path"):
defaultPath_ = absl::StrReplaceAll(trim(member.value), { { "\\", "/" } });
DBG("Changing default sample path to " << defaultPath_);
break;
case hash("image"):
image_ = absl::StrCat(defaultPath_, absl::StrReplaceAll(trim(member.value), { { "\\", "/" } }));
break;
case hash("note_offset"):
noteOffset_ = member.read(Default::noteOffset);
break;
case hash("octave_offset"):
octaveOffset_ = member.read(Default::octaveOffset);
break;
case hash("hint_ram_based"):
{
FilePool& filePool = resources_.getFilePool();
if (member.value == "1")
filePool.setRamLoading(true);
else if (member.value == "0")
filePool.setRamLoading(false);
else
DBG("Unsupported value for hint_ram_based: " << member.value);
break;
}
case hash("hint_stealing"):
switch(hash(member.value)) {
case hash("first"):
voiceManager_.setStealingAlgorithm(StealingAlgorithm::First);
break;
case hash("oldest"):
voiceManager_.setStealingAlgorithm(StealingAlgorithm::Oldest);
break;
case hash("envelope_and_age"):
voiceManager_.setStealingAlgorithm(StealingAlgorithm::EnvelopeAndAge);
break;
default:
DBG("Unsupported value for hint_stealing: " << member.value);
}
break;
case hash("hint_sustain_cancels_release"):
{
SynthConfig& config = resources_.getSynthConfig();
config.sustainCancelsRelease = member.read(Default::sustainCancelsRelease);
}
break;
default:
// Unsupported control opcode
DBG("Unsupported control opcode: " << member.name);
}
}
}
void Synth::Impl::handleEffectOpcodes(const std::vector<Opcode>& rawMembers)
{
absl::string_view busName = "main";
auto getOrCreateBus = [this](unsigned index) -> EffectBus& {
if (index + 1 > effectBuses_.size())
effectBuses_.resize(index + 1);
EffectBusPtr& bus = effectBuses_[index];
if (!bus) {
bus.reset(new EffectBus);
bus->setSampleRate(sampleRate_);
bus->setSamplesPerBlock(samplesPerBlock_);
bus->clearInputs(samplesPerBlock_);
}
return *bus;
};
std::vector<Opcode> members;
members.reserve(rawMembers.size());
for (const Opcode& opcode : rawMembers)
members.push_back(opcode.cleanUp(kOpcodeScopeEffect));
for (const Opcode& opcode : members) {
switch (opcode.lettersOnlyHash) {
case hash("bus"):
busName = opcode.value;
break;
// note(jpc): gain opcodes are linear volumes in % units
case hash("directtomain"):
getOrCreateBus(0).setGainToMain(opcode.read(Default::effect));
break;
case hash("fx&tomain"): // fx&tomain
if (opcode.parameters.front() < 1 || opcode.parameters.front() > config::maxEffectBuses)
break;
getOrCreateBus(opcode.parameters.front()).setGainToMain(opcode.read(Default::effect));
break;
case hash("fx&tomix"): // fx&tomix
if (opcode.parameters.front() < 1 || opcode.parameters.front() > config::maxEffectBuses)
break;
getOrCreateBus(opcode.parameters.front()).setGainToMix(opcode.read(Default::effect));
break;
}
}
unsigned busIndex;
if (busName.empty() || busName == "main")
busIndex = 0;
else if (busName.size() > 2 && busName.substr(0, 2) == "fx" && absl::SimpleAtoi(busName.substr(2), &busIndex) && busIndex >= 1 && busIndex <= config::maxEffectBuses) {
// an effect bus fxN, with N usually in [1,4]
} else {
DBG("Unsupported effect bus: " << busName);
return;
}
// create the effect and add it
EffectBus& bus = getOrCreateBus(busIndex);
auto fx = effectFactory_.makeEffect(members);
fx->setSampleRate(sampleRate_);
fx->setSamplesPerBlock(samplesPerBlock_);
bus.addEffect(std::move(fx));
}
bool Synth::loadSfzFile(const fs::path& file)
{
Impl& impl = *impl_;
impl.clear();
std::error_code ec;
fs::path realFile = fs::canonical(file, ec);
bool success = true;
Parser& parser = impl.parser_;
parser.parseFile(ec ? file : realFile);
// permissive parsing for compatibility
if (!loaderParsesPermissively)
success = parser.getErrorCount() == 0;
success = success && !impl.layers_.empty();
if (!success) {
parser.clear();
return false;
}
impl.finalizeSfzLoad();
return true;
}
bool Synth::loadSfzString(const fs::path& path, absl::string_view text)
{
Impl& impl = *impl_;
impl.clear();
bool success = true;
Parser& parser = impl.parser_;
parser.parseString(path, text);
// permissive parsing for compatibility
if (!loaderParsesPermissively)
success = parser.getErrorCount() == 0;
success = success && !impl.layers_.empty();
if (!success) {
parser.clear();
return false;
}
impl.finalizeSfzLoad();
return true;
}
void Synth::Impl::finalizeSfzLoad()
{
const fs::path& rootDirectory = parser_.originalDirectory();
FilePool& filePool = resources_.getFilePool();
filePool.setRootDirectory(rootDirectory);
// a string representation used for OSC purposes
rootPath_ = rootDirectory.u8string();
size_t currentRegionIndex = 0;
size_t currentRegionCount = layers_.size();
auto removeCurrentRegion = [this, &currentRegionIndex, &currentRegionCount]() {
const Region& region = layers_[currentRegionIndex]->getRegion();
DBG("Removing the region with sample " << *region.sampleId);
layers_.erase(layers_.begin() + currentRegionIndex);
--currentRegionCount;
};
size_t maxFilters { 0 };
size_t maxEQs { 0 };
size_t maxLFOs { 0 };
size_t maxFlexEGs { 0 };
bool havePitchEG { false };
bool haveFilterEG { false };
bool haveAmplitudeLFO { false };
bool havePitchLFO { false };
bool haveFilterLFO { false };
FlexEGs::clearUnusedCurves();
while (currentRegionIndex < currentRegionCount) {
Layer& layer = *layers_[currentRegionIndex];
Region& region = layer.getRegion();
absl::optional<FileInformation> fileInformation;
FilePool& filePool = resources_.getFilePool();
WavetablePool& wavePool = resources_.getWavePool();
if (!region.isGenerator()) {
if (!filePool.checkSampleId(*region.sampleId)) {
removeCurrentRegion();
continue;
}
fileInformation = filePool.getFileInformation(*region.sampleId);
if (!fileInformation) {
removeCurrentRegion();
continue;
}
region.hasWavetableSample = fileInformation->wavetable.has_value();
if (fileInformation->end < config::wavetableMaxFrames) {
auto sample = filePool.loadFile(*region.sampleId);
bool allZeros = true;
int numChannels = sample->information.numChannels;
for (int i = 0; i < numChannels; ++i) {
allZeros &= allWithin(sample->preloadedData.getConstSpan(i),
-config::virtuallyZero, config::virtuallyZero);
}
if (allZeros) {
region.sampleId.reset(new FileId("*silence"));
region.hasWavetableSample = false;
} else {
region.hasWavetableSample |= true;
}
}
}
if (!region.isOscillator()) {
region.sampleEnd = min(region.sampleEnd, fileInformation->end);
if (fileInformation->hasLoop) {
if (region.loopRange.getStart() == Default::loopStart)
region.loopRange.setStart(fileInformation->loopStart);
if (region.loopRange.getEnd() == Default::loopEnd)
region.loopRange.setEnd(fileInformation->loopEnd);
if (!region.loopMode)
region.loopMode = LoopMode::loop_continuous;
}
if (region.isRelease() && !region.loopMode)
region.loopMode = LoopMode::one_shot;
if (region.loopRange.getEnd() == Default::loopEnd)
region.loopRange.setEnd(region.sampleEnd);
// if range is invalid, disable the loop
if (!region.loopRange.isValid())
region.loopMode = absl::nullopt;
if (fileInformation->numChannels == 2)
region.hasStereoSample = true;
if (region.pitchKeycenterFromSample)
region.pitchKeycenter = fileInformation->rootKey;
// TODO: adjust with LFO targets
const auto maxOffset = [region]() {
uint64_t sumOffsetCC = region.offset + region.offsetRandom;
for (const auto& offsets : region.offsetCC)
sumOffsetCC += offsets.data;
return Default::offsetMod.bounds.clamp(sumOffsetCC);
}();
if (!filePool.preloadFile(*region.sampleId, maxOffset)) {
removeCurrentRegion();
continue;
}
}
else if (!region.isGenerator()) {
if (!wavePool.createFileWave(filePool, std::string(region.sampleId->filename()))) {
removeCurrentRegion();
continue;
}
}
if (region.lastKeyswitch) {
if (currentSwitch_)
layer.keySwitched_ = (*currentSwitch_ == *region.lastKeyswitch);
if (region.keyswitchLabel)
setKeyswitchLabel(*region.lastKeyswitch, *region.keyswitchLabel);
}
if (region.lastKeyswitchRange) {
auto& range = *region.lastKeyswitchRange;
if (currentSwitch_)
layer.keySwitched_ = range.containsWithEnd(*currentSwitch_);
if (region.keyswitchLabel) {
for (uint8_t note = range.getStart(), end = range.getEnd(); note <= end; note++)
setKeyswitchLabel(note, *region.keyswitchLabel);
}
}
for (auto note = 0; note < 128; note++) {
if (region.keyRange.containsWithEnd(note))
noteActivationLists_[note].push_back(&layer);
}
for (int cc = 0; cc < config::numCCs; cc++) {
if (region.ccTriggers.contains(cc)
|| region.ccConditions.contains(cc)
|| (cc == region.sustainCC && region.trigger == Trigger::release)
|| (cc == region.sostenutoCC && region.trigger == Trigger::release))
ccActivationLists_[cc].push_back(&layer);
}
// Defaults
MidiState& midiState = resources_.getMidiState();
for (int cc = 0; cc < config::numCCs; cc++) {
layer.registerCC(cc, midiState.getCCValue(cc));
}
// Set the default frequencies on equalizers if needed
if (region.equalizers.size() > 0
&& region.equalizers[0].frequency == Default::eqFrequency) {
region.equalizers[0].frequency = Default::defaultEQFreq[0];
if (region.equalizers.size() > 1
&& region.equalizers[1].frequency == Default::eqFrequency) {
region.equalizers[1].frequency = Default::defaultEQFreq[1];
if (region.equalizers.size() > 2
&& region.equalizers[2].frequency == Default::eqFrequency) {
region.equalizers[2].frequency = Default::defaultEQFreq[2];
}
}
}
if (!region.velocityPoints.empty())
region.velCurve = Curve::buildFromVelcurvePoints(
region.velocityPoints, Curve::Interpolator::Linear);
layer.registerPitchWheel(0);
layer.registerAftertouch(0);
layer.registerTempo(2.0f);
maxFilters = max(maxFilters, region.filters.size());
maxEQs = max(maxEQs, region.equalizers.size());
maxLFOs = max(maxLFOs, region.lfos.size());
maxFlexEGs = max(maxFlexEGs, region.flexEGs.size());
havePitchEG = havePitchEG || region.pitchEG != absl::nullopt;
haveFilterEG = haveFilterEG || region.filterEG != absl::nullopt;
haveAmplitudeLFO = haveAmplitudeLFO || region.amplitudeLFO != absl::nullopt;
havePitchLFO = havePitchLFO || region.pitchLFO != absl::nullopt;
haveFilterLFO = haveFilterLFO || region.filterLFO != absl::nullopt;
++currentRegionIndex;
}
if (currentRegionCount < layers_.size()) {
DBG("Removing " << (layers_.size() - currentRegionCount)
<< " out of " << layers_.size() << " regions");
}
layers_.resize(currentRegionCount);
// collect all CCs used in regions, with matrix not yet connected
BitArray<config::numCCs> usedCCs;
for (const LayerPtr& layerPtr : layers_) {
const Region& region = layerPtr->getRegion();
collectUsedCCsFromRegion(usedCCs, region);
for (const Region::Connection& connection : region.connections) {
if (connection.source.id() == ModId::Controller)
usedCCs.set(connection.source.parameters().cc);
}
}
// connect default controllers, except if these CC are already used
for (const LayerPtr& layerPtr : layers_) {
Region& region = layerPtr->getRegion();
constexpr unsigned defaultSmoothness = 10;
if (!usedCCs.test(7)) {
region.getOrCreateConnection(
ModKey::createCC(7, 4, defaultSmoothness, 0),
ModKey::createNXYZ(ModId::Amplitude, region.id)).sourceDepth = 1.0f;
}
if (!usedCCs.test(10)) {
region.getOrCreateConnection(
ModKey::createCC(10, 1, defaultSmoothness, 0),
ModKey::createNXYZ(ModId::Pan, region.id)).sourceDepth = 1.0f;
}
if (!usedCCs.test(11)) {
region.getOrCreateConnection(
ModKey::createCC(11, 4, defaultSmoothness, 0),
ModKey::createNXYZ(ModId::Amplitude, region.id)).sourceDepth = 1.0f;
}
}
modificationTime_ = checkModificationTime();
settingsPerVoice_.maxFilters = maxFilters;
settingsPerVoice_.maxEQs = maxEQs;
settingsPerVoice_.maxLFOs = maxLFOs;
settingsPerVoice_.maxFlexEGs = maxFlexEGs;
settingsPerVoice_.havePitchEG = havePitchEG;
settingsPerVoice_.haveFilterEG = haveFilterEG;
settingsPerVoice_.haveAmplitudeLFO = haveAmplitudeLFO;
settingsPerVoice_.havePitchLFO = havePitchLFO;
settingsPerVoice_.haveFilterLFO = haveFilterLFO;
applySettingsPerVoice();
setupModMatrix();
// cache the set of used CCs for future access
currentUsedCCs_ = collectAllUsedCCs();
// cache the set of keys assigned
for (const LayerPtr& layerPtr : layers_) {
const Region& region = layerPtr->getRegion();
UncheckedRange<uint8_t> keyRange = region.keyRange;
unsigned loKey = keyRange.getStart();
unsigned hiKey = keyRange.getEnd();
for (unsigned key = loKey; key <= hiKey; ++key)
keySlots_.set(key);
}
// cache the set of keyswitches assigned
for (const LayerPtr& layerPtr : layers_) {
const Region& region = layerPtr->getRegion();
if (absl::optional<uint8_t> sw = region.lastKeyswitch) {
swLastSlots_.set(*sw);
}
else if (absl::optional<UncheckedRange<uint8_t>> swRange = region.lastKeyswitchRange) {
unsigned loKey = swRange->getStart();
unsigned hiKey = swRange->getEnd();
for (unsigned key = loKey; key <= hiKey; ++key)
swLastSlots_.set(key);
}
}
}
bool Synth::loadScalaFile(const fs::path& path)
{
Impl& impl = *impl_;
return impl.resources_.getTuning().loadScalaFile(path);
}
bool Synth::loadScalaString(const std::string& text)
{
Impl& impl = *impl_;
return impl.resources_.getTuning().loadScalaString(text);
}
void Synth::setScalaRootKey(int rootKey)
{
Impl& impl = *impl_;
impl.resources_.getTuning().setScalaRootKey(rootKey);
}
int Synth::getScalaRootKey() const
{
Impl& impl = *impl_;
return impl.resources_.getTuning().getScalaRootKey();
}
void Synth::setTuningFrequency(float frequency)
{
Impl& impl = *impl_;
impl.resources_.getTuning().setTuningFrequency(frequency);
}
float Synth::getTuningFrequency() const
{
Impl& impl = *impl_;
return impl.resources_.getTuning().getTuningFrequency();
}
void Synth::loadStretchTuningByRatio(float ratio)
{
Impl& impl = *impl_;
SFIZZ_CHECK(ratio >= 0.0f && ratio <= 1.0f);
ratio = clamp(ratio, 0.0f, 1.0f);
absl::optional<StretchTuning>& stretch = impl.resources_.getStretch();
if (ratio > 0.0f)
stretch = StretchTuning::createRailsbackFromRatio(ratio);
else
stretch.reset();
}
int Synth::getNumActiveVoices() const noexcept
{
Impl& impl = *impl_;
int activeVoices = static_cast<int>(impl.voiceManager_.getNumActiveVoices());
// do not count overflow voices which are over limit
return (config::overflowVoiceMultiplier > 1) ?
std::min(impl.numVoices_, activeVoices) : activeVoices;
}
void Synth::setSamplesPerBlock(int samplesPerBlock) noexcept
{
Impl& impl = *impl_;
ASSERT(samplesPerBlock <= config::maxBlockSize);
impl.samplesPerBlock_ = samplesPerBlock;
for (auto& voice : impl.voiceManager_)
voice.setSamplesPerBlock(samplesPerBlock);
impl.resources_.setSamplesPerBlock(samplesPerBlock);
for (auto& bus : impl.effectBuses_) {
if (bus)
bus->setSamplesPerBlock(samplesPerBlock);
}
}
int Synth::getSamplesPerBlock() const noexcept
{
Impl& impl = *impl_;
return impl.samplesPerBlock_;
}
void Synth::setSampleRate(float sampleRate) noexcept
{
Impl& impl = *impl_;
impl.sampleRate_ = sampleRate;
for (auto& voice : impl.voiceManager_)
voice.setSampleRate(sampleRate);
impl.resources_.setSampleRate(sampleRate);
for (auto& bus : impl.effectBuses_) {
if (bus)
bus->setSampleRate(sampleRate);
}
}
void Synth::renderBlock(AudioSpan<float> buffer) noexcept
{
Impl& impl = *impl_;
ScopedFTZ ftz;
CallbackBreakdown callbackBreakdown;
{ // Silence buffer
ScopedTiming logger { callbackBreakdown.renderMethod };
buffer.fill(0.0f);
}
const size_t numFrames = buffer.getNumFrames();
if (numFrames < 1) {
CHECKFALSE;
return;
}
const SynthConfig& synthConfig = impl.resources_.getSynthConfig();
FilePool& filePool = impl.resources_.getFilePool();
BufferPool& bufferPool = impl.resources_.getBufferPool();
if (synthConfig.freeWheeling)
filePool.waitForBackgroundLoading();
const auto now = std::chrono::high_resolution_clock::now();
const auto timeSinceLastCollection =
std::chrono::duration_cast<std::chrono::seconds>(now - impl.lastGarbageCollection_);
if (timeSinceLastCollection.count() > config::fileClearingPeriod) {
impl.lastGarbageCollection_ = now;
filePool.triggerGarbageCollection();
}
auto tempSpan = bufferPool.getStereoBuffer(numFrames);
auto tempMixSpan = bufferPool.getStereoBuffer(numFrames);
auto rampSpan = bufferPool.getBuffer(numFrames);
if (!tempSpan || !tempMixSpan || !rampSpan) {
DBG("[sfizz] Could not get a temporary buffer; exiting callback... ");
return;
}
ModMatrix& mm = impl.resources_.getModMatrix();
mm.beginCycle(numFrames);
BeatClock& bc = impl.resources_.getBeatClock();
bc.beginCycle(numFrames);
MidiState& midiState = impl.resources_.getMidiState();
if (impl.playheadMoved_ && bc.isPlaying()) {
midiState.flushEvents();
impl.genController_->resetSmoothers();
impl.playheadMoved_ = false;
}
{ // Clear effect busses
ScopedTiming logger { callbackBreakdown.effects };
for (auto& bus : impl.effectBuses_) {
if (bus)
bus->clearInputs(numFrames);
}
}
{ // Main render block
ScopedTiming logger { callbackBreakdown.renderMethod, ScopedTiming::Operation::addToDuration };
tempMixSpan->fill(0.0f);
for (auto& voice : impl.voiceManager_) {
if (voice.isFree())
continue;
mm.beginVoice(voice.getId(), voice.getRegion()->getId(), voice.getTriggerEvent().value);
const Region* region = voice.getRegion();
ASSERT(region != nullptr);
voice.renderBlock(*tempSpan);
for (size_t i = 0, n = impl.effectBuses_.size(); i < n; ++i) {
if (auto& bus = impl.effectBuses_[i]) {
float addGain = region->getGainToEffectBus(i);
bus->addToInputs(*tempSpan, addGain, numFrames);
}
}
callbackBreakdown.data += voice.getLastDataDuration();
callbackBreakdown.amplitude += voice.getLastAmplitudeDuration();
callbackBreakdown.filters += voice.getLastFilterDuration();
callbackBreakdown.panning += voice.getLastPanningDuration();
mm.endVoice();
if (voice.toBeCleanedUp())
voice.reset();
}
}
{ // Apply effect buses
// -- note(jpc) there is always a "main" bus which is initially empty.
// without any <effect>, the signal is just going to flow through it.
ScopedTiming logger { callbackBreakdown.effects, ScopedTiming::Operation::addToDuration };
for (auto& bus : impl.effectBuses_) {
if (bus) {
bus->process(numFrames);
bus->mixOutputsTo(buffer, *tempMixSpan, numFrames);
}
}
}
// Add the Mix output (fxNtomix opcodes)
// -- note(jpc) the purpose of the Mix output is not known.
// perhaps it's designed as extension point for custom processing?
// as default behavior, it adds itself to the Main signal.
buffer.add(*tempMixSpan);
// Apply the master volume
buffer.applyGain(db2mag(impl.volume_));
// Process the metronome (debugging tool for host time info)
constexpr bool metronomeEnabled = false;
if (metronomeEnabled) {
Metronome& metro = impl.resources_.getMetronome();
metro.processAdding(
bc.getRunningBeatNumber().data(), bc.getRunningBeatsPerBar().data(),
buffer.getChannel(0), buffer.getChannel(1), numFrames);
}
// Perform any remaining modulators
mm.endCycle();
// Advance the clock to the end of cycle
bc.endCycle();
// Update sets of changed CCs
impl.changedCCsLastCycle_ = impl.changedCCsThisCycle_;
impl.changedCCsThisCycle_.clear();
{ // Clear events and advance midi time
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
midiState.advanceTime(buffer.getNumFrames());
}
callbackBreakdown.dispatch = impl.dispatchDuration_;
Logger& logger = impl.resources_.getLogger();
logger.logCallbackTime(
callbackBreakdown, impl.voiceManager_.getNumActiveVoices(), numFrames);
// Reset the dispatch counter
impl.dispatchDuration_ = Duration(0);
ASSERT(!hasNanInf(buffer.getConstSpan(0)));
ASSERT(!hasNanInf(buffer.getConstSpan(1)));
SFIZZ_CHECK(isReasonableAudio(buffer.getConstSpan(0)));
SFIZZ_CHECK(isReasonableAudio(buffer.getConstSpan(1)));
}
void Synth::noteOn(int delay, int noteNumber, int velocity) noexcept
{
const float normalizedVelocity = normalizeVelocity(velocity);
hdNoteOn(delay, noteNumber, normalizedVelocity);
}
void Synth::hdNoteOn(int delay, int noteNumber, float normalizedVelocity) noexcept
{
ASSERT(noteNumber < 128);
ASSERT(noteNumber >= 0);
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
impl.resources_.getMidiState().noteOnEvent(delay, noteNumber, normalizedVelocity);
impl.noteOnDispatch(delay, noteNumber, normalizedVelocity);
}
void Synth::noteOff(int delay, int noteNumber, int velocity) noexcept
{
const float normalizedVelocity = normalizeVelocity(velocity);
hdNoteOff(delay, noteNumber, normalizedVelocity);
}
void Synth::hdNoteOff(int delay, int noteNumber, float normalizedVelocity) noexcept
{
ASSERT(noteNumber < 128);
ASSERT(noteNumber >= 0);
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
// FIXME: Some keyboards (e.g. Casio PX5S) can send a real note-off velocity. In this case, do we have a
// way in sfz to specify that a release trigger should NOT use the note-on velocity?
// auto replacedVelocity = (velocity == 0 ? getNoteVelocity(noteNumber) : velocity);
MidiState& midiState = impl.resources_.getMidiState();
midiState.noteOffEvent(delay, noteNumber, normalizedVelocity);
const auto replacedVelocity = midiState.getNoteVelocity(noteNumber);
for (auto& voice : impl.voiceManager_)
voice.registerNoteOff(delay, noteNumber, replacedVelocity);
impl.noteOffDispatch(delay, noteNumber, replacedVelocity);
}
void Synth::Impl::startVoice(Layer* layer, int delay, const TriggerEvent& triggerEvent, SisterVoiceRingBuilder& ring) noexcept
{
const Region& region = layer->getRegion();
voiceManager_.checkPolyphony(&region, delay, triggerEvent);
Voice* selectedVoice = voiceManager_.findFreeVoice();
if (selectedVoice == nullptr)
return;
ASSERT(selectedVoice->isFree());
if (selectedVoice->startVoice(layer, delay, triggerEvent))
ring.addVoiceToRing(selectedVoice);
}
void Synth::Impl::checkOffGroups(const Region* region, int delay, int number)
{
for (auto& voice : voiceManager_) {
if (voice.checkOffGroup(region, delay, number)) {
const TriggerEvent& event = voice.getTriggerEvent();
noteOffDispatch(delay, event.number, event.value);
}
}
}
void Synth::Impl::noteOffDispatch(int delay, int noteNumber, float velocity) noexcept
{
const auto randValue = randNoteDistribution_(Random::randomGenerator);
SisterVoiceRingBuilder ring;
const TriggerEvent triggerEvent { TriggerEventType::NoteOff, noteNumber, velocity };
for (Layer* layer : upKeyswitchLists_[noteNumber])
layer->keySwitched_ = true;
for (Layer* layer : downKeyswitchLists_[noteNumber])
layer->keySwitched_ = false;
for (Layer* layer : noteActivationLists_[noteNumber]) {
const Region& region = layer->getRegion();
if (layer->registerNoteOff(noteNumber, velocity, randValue)) {
if (region.trigger == Trigger::release && !region.rtDead && !voiceManager_.playingAttackVoice(&region))
continue;
checkOffGroups(&region, delay, noteNumber);
startVoice(layer, delay, triggerEvent, ring);
}
}
}
void Synth::Impl::noteOnDispatch(int delay, int noteNumber, float velocity) noexcept
{
const auto randValue = randNoteDistribution_(Random::randomGenerator);
SisterVoiceRingBuilder ring;
if (!lastKeyswitchLists_[noteNumber].empty()) {
if (currentSwitch_ && *currentSwitch_ != noteNumber) {
for (Layer* layer : lastKeyswitchLists_[*currentSwitch_])
layer->keySwitched_ = false;
}
currentSwitch_ = noteNumber;
}
for (Layer* layer : lastKeyswitchLists_[noteNumber])
layer->keySwitched_ = true;
for (Layer* layer : upKeyswitchLists_[noteNumber])
layer->keySwitched_ = false;
for (Layer* layer : downKeyswitchLists_[noteNumber])
layer->keySwitched_ = true;
for (Layer* layer : noteActivationLists_[noteNumber]) {
if (layer->registerNoteOn(noteNumber, velocity, randValue)) {
const Region& region = layer->getRegion();
checkOffGroups(&region, delay, noteNumber);
TriggerEvent triggerEvent { TriggerEventType::NoteOn, noteNumber, velocity };
startVoice(layer, delay, triggerEvent, ring);
}
}
for (Layer* layer : previousKeyswitchLists_) {
const Region& region = layer->getRegion();
layer->previousKeySwitched_ = (region.previousKeyswitch == noteNumber);
}
}
void Synth::Impl::startDelayedSustainReleases(Layer* layer, int delay, SisterVoiceRingBuilder& ring) noexcept
{
const Region& region = layer->getRegion();
if (!region.rtDead && !voiceManager_.playingAttackVoice(&region)) {
layer->delayedSustainReleases_.clear();
return;
}
for (auto& note: layer->delayedSustainReleases_) {
const TriggerEvent noteOffEvent { TriggerEventType::NoteOff, note.first, note.second };
startVoice(layer, delay, noteOffEvent, ring);
}
layer->delayedSustainReleases_.clear();
}
void Synth::Impl::startDelayedSostenutoReleases(Layer* layer, int delay, SisterVoiceRingBuilder& ring) noexcept
{
const Region& region = layer->getRegion();
if (!region.rtDead && !voiceManager_.playingAttackVoice(&region)) {
layer->delayedSostenutoReleases_.clear();
return;
}
for (auto& note: layer->delayedSostenutoReleases_) {
const TriggerEvent noteOffEvent { TriggerEventType::NoteOff, note.first, note.second };
startVoice(layer, delay, noteOffEvent, ring);
}
layer->delayedSostenutoReleases_.clear();
}
void Synth::cc(int delay, int ccNumber, int ccValue) noexcept
{
const auto normalizedCC = normalizeCC(ccValue);
hdcc(delay, ccNumber, normalizedCC);
}
void Synth::Impl::ccDispatch(int delay, int ccNumber, float value) noexcept
{
SisterVoiceRingBuilder ring;
TriggerEvent triggerEvent { TriggerEventType::CC, ccNumber, value };
for (Layer* layer : ccActivationLists_[ccNumber]) {
const Region& region = layer->getRegion();
if (region.checkSustain && ccNumber == region.sustainCC && value < region.sustainThreshold)
startDelayedSustainReleases(layer, delay, ring);
if (region.checkSostenuto && ccNumber == region.sostenutoCC && value < region.sostenutoThreshold) {
if (layer->sustainPressed_) {
for (const auto& v: layer->delayedSostenutoReleases_)
layer->delaySustainRelease(v.first, v.second);
layer->delayedSostenutoReleases_.clear();
} else {
startDelayedSostenutoReleases(layer, delay, ring);
}
}
if (layer->registerCC(ccNumber, value)) {
checkOffGroups(&region, delay, ccNumber);
startVoice(layer, delay, triggerEvent, ring);
}
}
}
void Synth::hdcc(int delay, int ccNumber, float normValue) noexcept
{
Impl& impl = *impl_;
impl.performHdcc(delay, ccNumber, normValue, true);
}
void Synth::automateHdcc(int delay, int ccNumber, float normValue) noexcept
{
Impl& impl = *impl_;
impl.performHdcc(delay, ccNumber, normValue, false);
}
void Synth::Impl::performHdcc(int delay, int ccNumber, float normValue, bool asMidi) noexcept
{
ASSERT(ccNumber < config::numCCs);
ASSERT(ccNumber >= 0);
ScopedTiming logger { dispatchDuration_, ScopedTiming::Operation::addToDuration };
changedCCsThisCycle_.set(ccNumber);
MidiState& midiState = resources_.getMidiState();
if (asMidi) {
if (ccNumber == config::resetCC) {
resetAllControllers(delay);
return;
}
if (ccNumber == config::allNotesOffCC || ccNumber == config::allSoundOffCC) {
for (auto& voice : voiceManager_)
voice.reset();
midiState.allNotesOff(delay);
return;
}
}
for (auto& voice : voiceManager_)
voice.registerCC(delay, ccNumber, normValue);
ccDispatch(delay, ccNumber, normValue);
midiState.ccEvent(delay, ccNumber, normValue);
}
void Synth::Impl::setDefaultHdcc(int ccNumber, float value)
{
ASSERT(ccNumber >= 0);
ASSERT(ccNumber < config::numCCs);
defaultCCValues_[ccNumber] = value;
resources_.getMidiState().ccEvent(0, ccNumber, value);
}
float Synth::getHdcc(int ccNumber)
{
ASSERT(ccNumber >= 0);
ASSERT(ccNumber < config::numCCs);
Impl& impl = *impl_;
return impl.resources_.getMidiState().getCCValue(ccNumber);
}
float Synth::getDefaultHdcc(int ccNumber)
{
ASSERT(ccNumber >= 0);
ASSERT(ccNumber < config::numCCs);
Impl& impl = *impl_;
return impl.defaultCCValues_[ccNumber];
}
void Synth::pitchWheel(int delay, int pitch) noexcept
{
const float normalizedPitch = normalizeBend(float(pitch));
hdPitchWheel(delay, normalizedPitch);
}
void Synth::hdPitchWheel(int delay, float normalizedPitch) noexcept
{
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
impl.resources_.getMidiState().pitchBendEvent(delay, normalizedPitch);
for (const Impl::LayerPtr& layer : impl.layers_) {
layer->registerPitchWheel(normalizedPitch);
}
for (auto& voice : impl.voiceManager_) {
voice.registerPitchWheel(delay, normalizedPitch);
}
impl.performHdcc(delay, ExtendedCCs::pitchBend, normalizedPitch, false);
}
void Synth::channelAftertouch(int delay, int aftertouch) noexcept
{
const float normalizedAftertouch = normalize7Bits(aftertouch);
hdChannelAftertouch(delay, normalizedAftertouch);
}
void Synth::hdChannelAftertouch(int delay, float normAftertouch) noexcept
{
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
impl.resources_.getMidiState().channelAftertouchEvent(delay, normAftertouch);
for (const Impl::LayerPtr& layerPtr : impl.layers_) {
layerPtr->registerAftertouch(normAftertouch);
}
for (auto& voice : impl.voiceManager_) {
voice.registerAftertouch(delay, normAftertouch);
}
impl.performHdcc(delay, ExtendedCCs::channelAftertouch, normAftertouch, false);
}
void Synth::polyAftertouch(int delay, int noteNumber, int aftertouch) noexcept
{
const float normalizedAftertouch = normalize7Bits(aftertouch);
hdPolyAftertouch(delay, noteNumber, normalizedAftertouch);
}
void Synth::hdPolyAftertouch(int delay, int noteNumber, float normAftertouch) noexcept
{
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
impl.resources_.getMidiState().polyAftertouchEvent(delay, noteNumber, normAftertouch);
for (auto& voice : impl.voiceManager_)
voice.registerPolyAftertouch(delay, noteNumber, normAftertouch);
// Note information is lost on this CC
impl.performHdcc(delay, ExtendedCCs::polyphonicAftertouch, normAftertouch, false);
}
void Synth::tempo(int delay, float secondsPerBeat) noexcept
{
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
impl.resources_.getBeatClock().setTempo(delay, secondsPerBeat);
}
void Synth::bpmTempo(int delay, float beatsPerMinute) noexcept
{
// TODO make this the main tempo function and remove the deprecated other one
return tempo(delay, 60 / beatsPerMinute);
}
void Synth::timeSignature(int delay, int beatsPerBar, int beatUnit)
{
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
impl.resources_.getBeatClock().setTimeSignature(delay, TimeSignature(beatsPerBar, beatUnit));
}
void Synth::timePosition(int delay, int bar, double barBeat)
{
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
BeatClock& beatClock = impl.resources_.getBeatClock();
const auto newPosition = BBT(bar, barBeat);
const auto newBeatPosition = newPosition.toBeats(beatClock.getTimeSignature());
const auto currentBeatPosition = beatClock.getLastBeatPosition();
const auto positionDifference = std::abs(newBeatPosition - currentBeatPosition);
const auto threshold = config::playheadMovedFrames * beatClock.getBeatsPerFrame();
if (positionDifference > threshold)
impl.playheadMoved_ = true;
beatClock.setTimePosition(delay, newPosition);
}
void Synth::playbackState(int delay, int playbackState)
{
Impl& impl = *impl_;
ScopedTiming logger { impl.dispatchDuration_, ScopedTiming::Operation::addToDuration };
impl.resources_.getBeatClock().setPlaying(delay, playbackState == 1);
}
int Synth::getNumRegions() const noexcept
{
Impl& impl = *impl_;
return static_cast<int>(impl.layers_.size());
}
int Synth::getNumGroups() const noexcept
{
Impl& impl = *impl_;
return impl.numGroups_;
}
int Synth::getNumMasters() const noexcept
{
Impl& impl = *impl_;
return impl.numMasters_;
}
int Synth::getNumCurves() const noexcept
{
Impl& impl = *impl_;
return static_cast<int>(impl.resources_.getCurves().getNumCurves());
}
std::string Synth::exportMidnam(absl::string_view model) const
{
Impl& impl = *impl_;
pugi::xml_document doc;
absl::string_view manufacturer = config::midnamManufacturer;
if (model.empty())
model = config::midnamModel;
doc.append_child(pugi::node_doctype).set_value("MIDINameDocument PUBLIC"
" \"-//MIDI Manufacturers Association//DTD MIDINameDocument 1.0//EN\""
" \"http://www.midi.org/dtds/MIDINameDocument10.dtd\"");
pugi::xml_node root = doc.append_child("MIDINameDocument");
root.append_child(pugi::node_comment)
.set_value("Generated by Sfizz for the current instrument");
root.append_child("Author");
pugi::xml_node device = root.append_child("MasterDeviceNames");
device.append_child("Manufacturer")
.append_child(pugi::node_pcdata)
.set_value(std::string(manufacturer).c_str());
device.append_child("Model")
.append_child(pugi::node_pcdata)
.set_value(std::string(model).c_str());
{
pugi::xml_node devmode = device.append_child("CustomDeviceMode");
devmode.append_attribute("Name").set_value("Default");
pugi::xml_node nsas = devmode.append_child("ChannelNameSetAssignments");
for (unsigned c = 0; c < 16; ++c) {
pugi::xml_node nsa = nsas.append_child("ChannelNameSetAssign");
nsa.append_attribute("Channel").set_value(std::to_string(c + 1).c_str());
nsa.append_attribute("NameSet").set_value("Play");
}
}
{
pugi::xml_node chns = device.append_child("ChannelNameSet");
chns.append_attribute("Name").set_value("Play");
pugi::xml_node acs = chns.append_child("AvailableForChannels");
for (unsigned c = 0; c < 16; ++c) {
pugi::xml_node ac = acs.append_child("AvailableChannel");
ac.append_attribute("Channel").set_value(std::to_string(c + 1).c_str());
ac.append_attribute("Available").set_value("true");
}
chns.append_child("UsesControlNameList")
.append_attribute("Name")
.set_value("Controls");
chns.append_child("UsesNoteNameList")
.append_attribute("Name")
.set_value("Notes");
}
{
auto anonymousCCs = getUsedCCs();
pugi::xml_node cns = device.append_child("ControlNameList");
cns.append_attribute("Name").set_value("Controls");
for (const auto& pair : impl.ccLabels_) {
anonymousCCs.set(pair.first, false);
if (pair.first < 128) {
pugi::xml_node cn = cns.append_child("Control");
cn.append_attribute("Type").set_value("7bit");
cn.append_attribute("Number").set_value(std::to_string(pair.first).c_str());
cn.append_attribute("Name").set_value(pair.second.c_str());
}
}
for (unsigned i = 0, n = std::min<unsigned>(128, anonymousCCs.bit_size()); i < n; ++i) {
if (anonymousCCs.test(i)) {
pugi::xml_node cn = cns.append_child("Control");
cn.append_attribute("Type").set_value("7bit");
cn.append_attribute("Number").set_value(std::to_string(i).c_str());
cn.append_attribute("Name").set_value(("Unnamed CC " + std::to_string(i)).c_str());
}
}
}
{
pugi::xml_node nnl = device.append_child("NoteNameList");
nnl.append_attribute("Name").set_value("Notes");
for (const auto& pair : impl.keyswitchLabels_) {
pugi::xml_node nn = nnl.append_child("Note");
nn.append_attribute("Number").set_value(std::to_string(pair.first).c_str());
nn.append_attribute("Name").set_value(pair.second.c_str());
}
for (const auto& pair : impl.keyLabels_) {
pugi::xml_node nn = nnl.append_child("Note");
nn.append_attribute("Number").set_value(std::to_string(pair.first).c_str());
nn.append_attribute("Name").set_value(pair.second.c_str());
}
}
string_xml_writer writer;
doc.save(writer);
return std::move(writer.str());
}
const Layer* Synth::getLayerView(int idx) const noexcept
{
Impl& impl = *impl_;
return (size_t)idx < impl.layers_.size() ? impl.layers_[idx].get() : nullptr;
}
const Region* Synth::getRegionView(int idx) const noexcept
{
const Layer* layer = getLayerView(idx);
return layer ? &layer->getRegion() : nullptr;
}
const EffectBus* Synth::getEffectBusView(int idx) const noexcept
{
Impl& impl = *impl_;
return (size_t)idx < impl.effectBuses_.size() ? impl.effectBuses_[idx].get() : nullptr;
}
const RegionSet* Synth::getRegionSetView(int idx) const noexcept
{
Impl& impl = *impl_;
return (size_t)idx < impl.sets_.size() ? impl.sets_[idx].get() : nullptr;
}
const PolyphonyGroup* Synth::getPolyphonyGroupView(int idx) const noexcept
{
Impl& impl = *impl_;
return impl.voiceManager_.getPolyphonyGroupView(idx);
}
Layer* Synth::getLayerById(NumericId<Region> id) noexcept
{
Impl& impl = *impl_;
const size_t size = impl.layers_.size();
if (size == 0 || !id.valid())
return nullptr;
// search a sequence of ordered identifiers with potential gaps
size_t index = static_cast<size_t>(id.number());
index = std::min(index, size - 1);
while (index > 0 && impl.layers_[index]->getRegion().getId().number() > id.number())
--index;
return (impl.layers_[index]->getRegion().getId() == id) ?
impl.layers_[index].get() : nullptr;
}
const Region* Synth::getRegionById(NumericId<Region> id) const noexcept
{
Layer* layer = const_cast<Synth*>(this)->getLayerById(id);
return layer ? &layer->getRegion() : nullptr;
}
const Voice* Synth::getVoiceView(int idx) const noexcept
{
Impl& impl = *impl_;
return idx < impl.numVoices_ ? &impl.voiceManager_[idx] : nullptr;
}
unsigned Synth::getNumPolyphonyGroups() const noexcept
{
Impl& impl = *impl_;
return impl.voiceManager_.getNumPolyphonyGroups();
}
const std::vector<std::string>& Synth::getUnknownOpcodes() const noexcept
{
Impl& impl = *impl_;
return impl.unknownOpcodes_;
}
size_t Synth::getNumPreloadedSamples() const noexcept
{
Impl& impl = *impl_;
return impl.resources_.getFilePool().getNumPreloadedSamples();
}
int Synth::getSampleQuality(ProcessMode mode)
{
Impl& impl = *impl_;
SynthConfig& synthConfig = impl.resources_.getSynthConfig();
switch (mode) {
case ProcessLive:
return synthConfig.liveSampleQuality;
case ProcessFreewheeling:
return synthConfig.freeWheelingSampleQuality;
default:
SFIZZ_CHECK(false);
return 0;
}
}
void Synth::setSampleQuality(ProcessMode mode, int quality)
{
SFIZZ_CHECK(quality >= 0 && quality <= 10);
Impl& impl = *impl_;
quality = clamp(quality, 0, 10);
SynthConfig& synthConfig = impl.resources_.getSynthConfig();
switch (mode) {
case ProcessLive:
synthConfig.liveSampleQuality = quality;
break;
case ProcessFreewheeling:
synthConfig.freeWheelingSampleQuality = quality;
break;
default:
SFIZZ_CHECK(false);
break;
}
}
int Synth::getOscillatorQuality(ProcessMode mode)
{
Impl& impl = *impl_;
SynthConfig& synthConfig = impl.resources_.getSynthConfig();
switch (mode) {
case ProcessLive:
return synthConfig.liveOscillatorQuality;
case ProcessFreewheeling:
return synthConfig.freeWheelingOscillatorQuality;
default:
SFIZZ_CHECK(false);
return 0;
}
}
void Synth::setOscillatorQuality(ProcessMode mode, int quality)
{
SFIZZ_CHECK(quality >= 0 && quality <= 3);
Impl& impl = *impl_;
quality = clamp(quality, 0, 3);
SynthConfig& synthConfig = impl.resources_.getSynthConfig();
switch (mode) {
case ProcessLive:
synthConfig.liveOscillatorQuality = quality;
break;
case ProcessFreewheeling:
synthConfig.freeWheelingOscillatorQuality = quality;
break;
default:
SFIZZ_CHECK(false);
break;
}
}
float Synth::getVolume() const noexcept
{
Impl& impl = *impl_;
return impl.volume_;
}
void Synth::setVolume(float volume) noexcept
{
Impl& impl = *impl_;
impl.volume_ = Default::volume.bounds.clamp(volume);
}
int Synth::getNumVoices() const noexcept
{
Impl& impl = *impl_;
return impl.numVoices_;
}
void Synth::setNumVoices(int numVoices) noexcept
{
ASSERT(numVoices > 0);
Impl& impl = *impl_;
// fast path
if (numVoices == impl.numVoices_)
return;
impl.resetVoices(numVoices);
}
void Synth::Impl::resetVoices(int numVoices)
{
numVoices_ = numVoices;
for (auto& set : sets_)
set->removeAllVoices();
voiceManager_.requireNumVoices(numVoices_, resources_);
for (auto& voice : voiceManager_) {
voice.setSampleRate(this->sampleRate_);
voice.setSamplesPerBlock(this->samplesPerBlock_);
}
applySettingsPerVoice();
}
void Synth::Impl::applySettingsPerVoice()
{
for (auto& voice : voiceManager_) {
voice.setMaxFiltersPerVoice(settingsPerVoice_.maxFilters);
voice.setMaxEQsPerVoice(settingsPerVoice_.maxEQs);
voice.setMaxLFOsPerVoice(settingsPerVoice_.maxLFOs);
voice.setMaxFlexEGsPerVoice(settingsPerVoice_.maxFlexEGs);
voice.setPitchEGEnabledPerVoice(settingsPerVoice_.havePitchEG);
voice.setFilterEGEnabledPerVoice(settingsPerVoice_.haveFilterEG);
voice.setAmplitudeLFOEnabledPerVoice(settingsPerVoice_.haveAmplitudeLFO);
voice.setPitchLFOEnabledPerVoice(settingsPerVoice_.havePitchLFO);
voice.setFilterLFOEnabledPerVoice(settingsPerVoice_.haveFilterLFO);
}
}
void Synth::Impl::setupModMatrix()
{
ModMatrix& mm = resources_.getModMatrix();
for (const LayerPtr& layerPtr : layers_) {
const Region& region = layerPtr->getRegion();
for (const Region::Connection& conn : region.connections) {
ModGenerator* gen = nullptr;
ModKey sourceKey = conn.source;
ModKey targetKey = conn.target;
// normalize the stepcc to 0-1
if (sourceKey.id() == ModId::Controller) {
ModKey::Parameters p = sourceKey.parameters();
p.step = (conn.sourceDepth <= 0.0f) ? 0.0f :
(p.step / conn.sourceDepth);
sourceKey = ModKey::createCC(p.cc, p.curve, p.smooth, p.step);
}
switch (sourceKey.id()) {
case ModId::Controller:
case ModId::PerVoiceController:
gen = genController_.get();
break;
case ModId::AmpLFO:
case ModId::PitchLFO:
case ModId::FilLFO:
case ModId::LFO:
gen = genLFO_.get();
break;
case ModId::Envelope:
gen = genFlexEnvelope_.get();
break;
case ModId::AmpEG:
case ModId::PitchEG:
case ModId::FilEG:
gen = genADSREnvelope_.get();
break;
case ModId::ChannelAftertouch:
gen = genChannelAftertouch_.get();
break;
case ModId::PolyAftertouch:
gen = genPolyAftertouch_.get();
break;
default:
DBG("[sfizz] Have unknown type of source generator");
break;
}
ASSERT(gen);
if (!gen)
continue;
ModMatrix::SourceId source = mm.registerSource(sourceKey, *gen);
ModMatrix::TargetId target = mm.registerTarget(targetKey);
ASSERT(source);
if (!source) {
DBG("[sfizz] Failed to register modulation source");
continue;
}
ASSERT(target);
if (!target) {
DBG("[sfizz] Failed to register modulation target");
continue;
}
if (!mm.connect(source, target, conn.sourceDepth, conn.sourceDepthMod, conn.velToDepth)) {
DBG("[sfizz] Failed to connect modulation source and target");
ASSERTFALSE;
}
}
}
mm.init();
}
void Synth::setPreloadSize(uint32_t preloadSize) noexcept
{
Impl& impl = *impl_;
FilePool& filePool = impl.resources_.getFilePool();
// fast path
if (preloadSize == filePool.getPreloadSize())
return;
filePool.setPreloadSize(preloadSize);
}
uint32_t Synth::getPreloadSize() const noexcept
{
Impl& impl = *impl_;
return impl.resources_.getFilePool().getPreloadSize();
}
void Synth::enableFreeWheeling() noexcept
{
Impl& impl = *impl_;
SynthConfig& synthConfig = impl.resources_.getSynthConfig();
if (!synthConfig.freeWheeling) {
synthConfig.freeWheeling = true;
DBG("Enabling freewheeling");
}
}
void Synth::disableFreeWheeling() noexcept
{
Impl& impl = *impl_;
SynthConfig& synthConfig = impl.resources_.getSynthConfig();
if (synthConfig.freeWheeling) {
synthConfig.freeWheeling = false;
DBG("Disabling freewheeling");
}
}
void Synth::Impl::resetAllControllers(int delay) noexcept
{
MidiState& midiState = resources_.getMidiState();
midiState.pitchBendEvent(delay, 0.0f);
for (int cc = 0; cc < config::numCCs; ++cc)
midiState.ccEvent(delay, cc, defaultCCValues_[cc]);
for (auto& voice : voiceManager_) {
voice.registerPitchWheel(delay, 0);
for (int cc = 0; cc < config::numCCs; ++cc)
voice.registerCC(delay, cc, defaultCCValues_[cc]);
}
for (const LayerPtr& layerPtr : layers_) {
Layer& layer = *layerPtr;
for (int cc = 0; cc < config::numCCs; ++cc)
layer.registerCC(cc, defaultCCValues_[cc]);
}
}
absl::optional<fs::file_time_type> Synth::Impl::checkModificationTime() const
{
absl::optional<fs::file_time_type> resultTime;
for (const auto& file : parser_.getIncludedFiles()) {
std::error_code ec;
const auto fileTime = fs::last_write_time(file, ec);
if (!ec) {
if (!resultTime || fileTime > *resultTime)
resultTime = fileTime;
}
}
return resultTime;
}
bool Synth::shouldReloadFile()
{
Impl& impl = *impl_;
absl::optional<fs::file_time_type> then = impl.modificationTime_;
if (!then) // file not loaded or failed
return false;
absl::optional<fs::file_time_type> now = impl.checkModificationTime();
if (!now) // file not currently existing
return false;
return *now > *then;
}
bool Synth::shouldReloadScala()
{
Impl& impl = *impl_;
return impl.resources_.getTuning().shouldReloadScala();
}
void Synth::enableLogging(absl::string_view prefix) noexcept
{
Impl& impl = *impl_;
impl.resources_.getLogger().enableLogging(prefix);
}
void Synth::disableLogging() noexcept
{
Impl& impl = *impl_;
impl.resources_.getLogger().disableLogging();
}
void Synth::allSoundOff() noexcept
{
Impl& impl = *impl_;
for (auto& voice : impl.voiceManager_)
voice.reset();
for (auto& effectBus : impl.effectBuses_)
effectBus->clear();
}
void Synth::addExternalDefinition(const std::string& id, const std::string& value)
{
Impl& impl = *impl_;
impl.parser_.addExternalDefinition(id, value);
}
void Synth::clearExternalDefinitions()
{
Impl& impl = *impl_;
impl.parser_.clearExternalDefinitions();
}
const BitArray<config::numCCs>& Synth::getUsedCCs() const noexcept
{
Impl& impl = *impl_;
return impl.currentUsedCCs_;
}
void sfz::Synth::setBroadcastCallback(sfizz_receive_t* broadcast, void* data)
{
Impl& impl = *impl_;
impl.broadcastReceiver = broadcast;
impl.broadcastData = data;
}
void Synth::Impl::collectUsedCCsFromRegion(BitArray<config::numCCs>& usedCCs, const Region& region)
{
collectUsedCCsFromCCMap(usedCCs, region.delayCC);
collectUsedCCsFromCCMap(usedCCs, region.offsetCC);
collectUsedCCsFromCCMap(usedCCs, region.endCC);
collectUsedCCsFromCCMap(usedCCs, region.loopStartCC);
collectUsedCCsFromCCMap(usedCCs, region.loopEndCC);
collectUsedCCsFromCCMap(usedCCs, region.amplitudeEG.ccAttack);
collectUsedCCsFromCCMap(usedCCs, region.amplitudeEG.ccRelease);
collectUsedCCsFromCCMap(usedCCs, region.amplitudeEG.ccDecay);
collectUsedCCsFromCCMap(usedCCs, region.amplitudeEG.ccDelay);
collectUsedCCsFromCCMap(usedCCs, region.amplitudeEG.ccHold);
collectUsedCCsFromCCMap(usedCCs, region.amplitudeEG.ccStart);
collectUsedCCsFromCCMap(usedCCs, region.amplitudeEG.ccSustain);
if (region.pitchEG) {
collectUsedCCsFromCCMap(usedCCs, region.pitchEG->ccAttack);
collectUsedCCsFromCCMap(usedCCs, region.pitchEG->ccRelease);
collectUsedCCsFromCCMap(usedCCs, region.pitchEG->ccDecay);
collectUsedCCsFromCCMap(usedCCs, region.pitchEG->ccDelay);
collectUsedCCsFromCCMap(usedCCs, region.pitchEG->ccHold);
collectUsedCCsFromCCMap(usedCCs, region.pitchEG->ccStart);
collectUsedCCsFromCCMap(usedCCs, region.pitchEG->ccSustain);
}
if (region.filterEG) {
collectUsedCCsFromCCMap(usedCCs, region.filterEG->ccAttack);
collectUsedCCsFromCCMap(usedCCs, region.filterEG->ccRelease);
collectUsedCCsFromCCMap(usedCCs, region.filterEG->ccDecay);
collectUsedCCsFromCCMap(usedCCs, region.filterEG->ccDelay);
collectUsedCCsFromCCMap(usedCCs, region.filterEG->ccHold);
collectUsedCCsFromCCMap(usedCCs, region.filterEG->ccStart);
collectUsedCCsFromCCMap(usedCCs, region.filterEG->ccSustain);
}
for (const LFODescription& lfo : region.lfos) {
collectUsedCCsFromCCMap(usedCCs, lfo.phaseCC);
collectUsedCCsFromCCMap(usedCCs, lfo.delayCC);
collectUsedCCsFromCCMap(usedCCs, lfo.fadeCC);
}
collectUsedCCsFromCCMap(usedCCs, region.ccConditions);
collectUsedCCsFromCCMap(usedCCs, region.ccTriggers);
collectUsedCCsFromCCMap(usedCCs, region.crossfadeCCInRange);
collectUsedCCsFromCCMap(usedCCs, region.crossfadeCCOutRange);
}
void Synth::Impl::collectUsedCCsFromModulations(BitArray<config::numCCs>& usedCCs, const ModMatrix& mm)
{
class CCSourceCollector : public ModMatrix::KeyVisitor {
public:
explicit CCSourceCollector(BitArray<config::numCCs>& used)
: used_(used)
{
}
bool visit(const ModKey& key) override
{
if (key.id() == ModId::Controller)
used_.set(key.parameters().cc);
return true;
}
BitArray<config::numCCs>& used_;
};
CCSourceCollector vtor(usedCCs);
mm.visitSources(vtor);
}
BitArray<config::numCCs> Synth::Impl::collectAllUsedCCs()
{
BitArray<config::numCCs> used;
for (const LayerPtr& layerPtr : layers_)
collectUsedCCsFromRegion(used, layerPtr->getRegion());
collectUsedCCsFromModulations(used, resources_.getModMatrix());
return used;
}
const std::string* Synth::Impl::getKeyLabel(int keyNumber) const
{
auto it = keyLabelsMap_.find(keyNumber);
return (it == keyLabelsMap_.end()) ? nullptr : &keyLabels_[it->second].second;
}
void Synth::Impl::setKeyLabel(int keyNumber, std::string name)
{
auto it = keyLabelsMap_.find(keyNumber);
if (it != keyLabelsMap_.end())
keyLabels_[it->second].second = std::move(name);
else {
size_t index = keyLabels_.size();
keyLabels_.emplace_back(keyNumber, std::move(name));
keyLabelsMap_[keyNumber] = index;
}
}
const std::string* Synth::Impl::getCCLabel(int ccNumber) const
{
auto it = ccLabelsMap_.find(ccNumber);
return (it == ccLabelsMap_.end()) ? nullptr : &ccLabels_[it->second].second;
}
void Synth::Impl::setCCLabel(int ccNumber, std::string name)
{
auto it = ccLabelsMap_.find(ccNumber);
if (it != ccLabelsMap_.end())
ccLabels_[it->second].second = std::move(name);
else {
size_t index = ccLabels_.size();
ccLabels_.emplace_back(ccNumber, std::move(name));
ccLabelsMap_[ccNumber] = index;
}
}
const std::string* Synth::Impl::getKeyswitchLabel(int swNumber) const
{
auto it = keyswitchLabelsMap_.find(swNumber);
return (it == keyswitchLabelsMap_.end()) ? nullptr : &keyswitchLabels_[it->second].second;
}
void Synth::Impl::setKeyswitchLabel(int swNumber, std::string name)
{
auto it = keyswitchLabelsMap_.find(swNumber);
if (it != keyswitchLabelsMap_.end())
keyswitchLabels_[it->second].second = std::move(name);
else {
size_t index = keyswitchLabels_.size();
keyswitchLabels_.emplace_back(swNumber, std::move(name));
keyswitchLabelsMap_[swNumber] = index;
}
}
void Synth::Impl::clearKeyLabels()
{
keyLabels_.clear();
keyLabelsMap_.clear();
}
void Synth::Impl::clearCCLabels()
{
ccLabels_.clear();
ccLabelsMap_.clear();
}
void Synth::Impl::clearKeyswitchLabels()
{
keyswitchLabels_.clear();
keyswitchLabelsMap_.clear();
}
Parser& Synth::getParser() noexcept
{
Impl& impl = *impl_;
return impl.parser_;
}
const Parser& Synth::getParser() const noexcept
{
Impl& impl = *impl_;
return impl.parser_;
}
const std::vector<NoteNamePair>& Synth::getKeyLabels() const noexcept
{
Impl& impl = *impl_;
return impl.keyLabels_;
}
const std::vector<CCNamePair>& Synth::getCCLabels() const noexcept
{
Impl& impl = *impl_;
return impl.ccLabels_;
}
Resources& Synth::getResources() noexcept
{
Impl& impl = *impl_;
return impl.resources_;
}
const Resources& Synth::getResources() const noexcept
{
Impl& impl = *impl_;
return impl.resources_;
}
} // namespace sfz