Cardinal/src/CardinalPlugin.cpp
falkTX 7302208a65
Bump version to 24.09
Signed-off-by: falkTX <falktx@falktx.com>
2024-09-21 21:09:36 +02:00

1334 lines
52 KiB
C++

/*
* DISTRHO Cardinal Plugin
* Copyright (C) 2021-2024 Filipe Coelho <falktx@falktx.com>
* SPDX-License-Identifier: GPL-3.0-or-later
*/
#include <library.hpp>
#include <midi.hpp>
#include <patch.hpp>
#include <plugin.hpp>
#include <random.hpp>
#include <settings.hpp>
#include <system.hpp>
#include <app/Scene.hpp>
#include <engine/Engine.hpp>
#include <ui/common.hpp>
#include <widget/Widget.hpp>
#include <window/Window.hpp>
#ifdef NDEBUG
# undef DEBUG
#endif
#if defined(HAVE_LIBLO) && defined(HEADLESS)
# include <lo/lo.h>
# include "extra/Thread.hpp"
#endif
#include <cfloat>
#include <list>
#include "CardinalCommon.hpp"
#include "DistrhoPluginUtils.hpp"
#include "CardinalPluginContext.hpp"
#include "extra/Base64.hpp"
#include "extra/ScopedDenormalDisable.hpp"
#include "extra/ScopedSafeLocale.hpp"
#ifdef DISTRHO_OS_WASM
# include <emscripten/emscripten.h>
#else
# include "extra/SharedResourcePointer.hpp"
#endif
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
# include "extra/ScopedValueSetter.hpp"
#endif
extern const std::string CARDINAL_VERSION;
namespace rack {
#if (CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS) || defined(HEADLESS)
namespace app {
rack::widget::Widget* createMenuBar() { return new rack::widget::Widget; }
}
#endif
#ifdef DISTRHO_OS_WASM
namespace asset {
std::string patchesPath();
}
#endif
namespace engine {
void Engine_setAboutToClose(Engine*);
}
}
START_NAMESPACE_DISTRHO
template<typename T>
static inline
bool d_isDiffHigherThanLimit(const T& v1, const T& v2, const T& limit)
{
return v1 != v2 ? (v1 > v2 ? v1 - v2 : v2 - v1) > limit : false;
}
#if DISTRHO_PLUGIN_HAS_UI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
const char* UI::getBundlePath() const noexcept { return nullptr; }
void UI::setState(const char*, const char*) {}
#endif
// -----------------------------------------------------------------------------------------------------------
#ifdef DISTRHO_OS_WASM
static char* getPatchFileEncodedInURL() {
return static_cast<char*>(EM_ASM_PTR({
var searchParams = new URLSearchParams(window.location.search);
var patch = searchParams.get('patch');
if (!patch)
return null;
var length = lengthBytesUTF8(patch) + 1;
var str = _malloc(length);
stringToUTF8(patch, str, length);
return str;
}));
};
static char* getPatchRemoteURL() {
return static_cast<char*>(EM_ASM_PTR({
var searchParams = new URLSearchParams(window.location.search);
var patch = searchParams.get('patchurl');
if (!patch)
return null;
var length = lengthBytesUTF8(patch) + 1;
var str = _malloc(length);
stringToUTF8(patch, str, length);
return str;
}));
};
static char* getPatchStorageSlug() {
return static_cast<char*>(EM_ASM_PTR({
var searchParams = new URLSearchParams(window.location.search);
var patch = searchParams.get('patchstorage');
if (!patch)
return null;
var length = lengthBytesUTF8(patch) + 1;
var str = _malloc(length);
stringToUTF8(patch, str, length);
return str;
}));
};
#endif
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
float RackKnobModeToFloat(const rack::settings::KnobMode knobMode) noexcept
{
switch (knobMode)
{
case rack::settings::KNOB_MODE_LINEAR:
return 0.f;
case rack::settings::KNOB_MODE_ROTARY_ABSOLUTE:
return 1.f;
case rack::settings::KNOB_MODE_ROTARY_RELATIVE:
return 2.f;
// unused in Rack
case rack::settings::KNOB_MODE_SCALED_LINEAR:
break;
}
return 0.f;
}
#endif
// -----------------------------------------------------------------------------------------------------------
struct ScopedContext {
ScopedContext(const CardinalBasePlugin* const plugin)
{
rack::contextSet(plugin->context);
}
~ScopedContext()
{
rack::contextSet(nullptr);
}
};
// -----------------------------------------------------------------------------------------------------------
class CardinalPlugin : public CardinalBasePlugin
{
#ifdef DISTRHO_OS_WASM
ScopedPointer<Initializer> fInitializer;
#else
SharedResourcePointer<Initializer> fInitializer;
#endif
#if DISTRHO_PLUGIN_NUM_INPUTS != 0
/* If host audio ins == outs we can get issues for inplace processing.
* So allocate a float array that will serve as safe copy for those cases.
*/
float** fAudioBufferCopy;
#endif
std::string fAutosavePath;
uint64_t fNextExpectedFrame;
struct {
String comment;
String screenshot;
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
String windowSize;
#endif
} fState;
// bypass handling
bool fWasBypassed;
MidiEvent bypassMidiEvents[16];
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
// real values, not VCV interpreted ones
float fWindowParameters[kWindowParameterCount];
#endif
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
float fMiniReportValues[kCardinalParameterCountAtMini - kCardinalParameterStartMini];
#endif
#ifdef DISTRHO_PLUGIN_EXTRA_IO
uint16_t fNumActiveInputs = DISTRHO_PLUGIN_NUM_INPUTS;
uint16_t fNumActiveOutputs = DISTRHO_PLUGIN_NUM_OUTPUTS;
#else
static constexpr const uint16_t fNumActiveInputs = DISTRHO_PLUGIN_NUM_INPUTS;
static constexpr const uint16_t fNumActiveOutputs = DISTRHO_PLUGIN_NUM_OUTPUTS;
#endif
public:
CardinalPlugin()
: CardinalBasePlugin(kCardinalParameterCount, 0, kCardinalStateCount),
#ifdef DISTRHO_OS_WASM
fInitializer(new Initializer(this, static_cast<const CardinalBaseUI*>(nullptr))),
#else
fInitializer(this, static_cast<const CardinalBaseUI*>(nullptr)),
#endif
#if DISTRHO_PLUGIN_NUM_INPUTS != 0
fAudioBufferCopy(nullptr),
#endif
fNextExpectedFrame(0),
fWasBypassed(false)
{
// check if first time loading a real instance
if (!fInitializer->shouldSaveSettings && !isDummyInstance())
fInitializer->loadSettings(true);
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
fWindowParameters[kWindowParameterShowTooltips] = rack::settings::tooltips ? 1.f : 0.f;
fWindowParameters[kWindowParameterCableOpacity] = std::min(100.f, std::max(0.f, rack::settings::cableOpacity * 100));
fWindowParameters[kWindowParameterCableTension] = std::min(100.f, std::max(0.f, rack::settings::cableTension * 100));
fWindowParameters[kWindowParameterRackBrightness] = std::min(100.f, std::max(0.f, rack::settings::rackBrightness * 100));
fWindowParameters[kWindowParameterHaloBrightness] = std::min(100.f, std::max(0.f, rack::settings::haloBrightness * 100));
fWindowParameters[kWindowParameterKnobMode] = RackKnobModeToFloat(rack::settings::knobMode);
fWindowParameters[kWindowParameterWheelKnobControl] = rack::settings::knobScroll ? 1.f : 0.f;
fWindowParameters[kWindowParameterWheelSensitivity] = std::min(10.f, std::max(0.1f, rack::settings::knobScrollSensitivity * 1000));
fWindowParameters[kWindowParameterLockModulePositions] = rack::settings::lockModules ? 1.f : 0.f;
fWindowParameters[kWindowParameterBrowserSort] = std::min(rack::settings::BROWSER_SORT_RANDOM,
std::max(rack::settings::BROWSER_SORT_UPDATED,
rack::settings::browserSort));
fWindowParameters[kWindowParameterBrowserZoom] = std::min(200.f, std::max(25.f, std::pow(2.f, rack::settings::browserZoom) * 100.0f));
fWindowParameters[kWindowParameterInvertZoom] = rack::settings::invertZoom ? 1.f : 0.f;
fWindowParameters[kWindowParameterSqueezeModulePositions] = rack::settings::squeezeModules ? 1.f : 0.f;
// not saved
fWindowParameters[kWindowParameterUpdateRateLimit] = 0.0f;
#endif
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
std::memset(fMiniReportValues, 0, sizeof(fMiniReportValues));
fMiniReportValues[kCardinalParameterMiniTimeBar - kCardinalParameterStartMini] = 1;
fMiniReportValues[kCardinalParameterMiniTimeBeat - kCardinalParameterStartMini] = 1;
fMiniReportValues[kCardinalParameterMiniTimeBeatsPerBar - kCardinalParameterStartMini] = 4;
fMiniReportValues[kCardinalParameterMiniTimeBeatType - kCardinalParameterStartMini] = 4;
fMiniReportValues[kCardinalParameterMiniTimeBeatsPerMinute - kCardinalParameterStartMini] = 120;
#endif
// create unique temporary path for this instance
try {
char uidBuf[24];
const std::string tmp = rack::system::getTempDirectory();
for (int i=1;; ++i)
{
std::snprintf(uidBuf, sizeof(uidBuf), "Cardinal.%04d", i);
const std::string trypath = rack::system::join(tmp, uidBuf);
if (! rack::system::exists(trypath))
{
if (rack::system::createDirectories(trypath))
fAutosavePath = trypath;
break;
}
}
} DISTRHO_SAFE_EXCEPTION("create unique temporary path");
// initialize midi events used when entering bypassed state
std::memset(bypassMidiEvents, 0, sizeof(bypassMidiEvents));
for (uint8_t i=0; i<16; ++i)
{
bypassMidiEvents[i].size = 3;
bypassMidiEvents[i].data[0] = 0xB0 + i;
bypassMidiEvents[i].data[1] = 0x7B;
}
const float sampleRate = getSampleRate();
rack::settings::sampleRate = sampleRate;
context->bufferSize = getBufferSize();
context->sampleRate = sampleRate;
const ScopedContext sc(this);
context->engine = new rack::engine::Engine;
context->engine->setSampleRate(sampleRate);
context->history = new rack::history::State;
context->patch = new rack::patch::Manager;
context->patch->autosavePath = fAutosavePath;
context->patch->templatePath = fInitializer->templatePath;
context->patch->factoryTemplatePath = fInitializer->factoryTemplatePath;
context->event = new rack::widget::EventState;
context->scene = new rack::app::Scene;
context->event->rootWidget = context->scene;
if (! isDummyInstance())
context->window = new rack::window::Window;
#ifdef DISTRHO_OS_WASM
if ((rack::patchStorageSlug = getPatchStorageSlug()) == nullptr &&
(rack::patchRemoteURL = getPatchRemoteURL()) == nullptr &&
(rack::patchFromURL = getPatchFileEncodedInURL()) == nullptr)
#endif
{
context->patch->loadTemplate();
context->scene->rackScroll->reset();
}
#ifdef CARDINAL_INIT_OSC_THREAD
fInitializer->remotePluginInstance = this;
#endif
}
~CardinalPlugin() override
{
#ifdef HAVE_LIBLO
if (fInitializer->remotePluginInstance == this)
fInitializer->remotePluginInstance = nullptr;
#endif
{
const ScopedContext sc(this);
context->patch->clear();
// do a little dance to prevent context scene deletion from saving to temp dir
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
const ScopedValueSetter<bool> svs(rack::settings::headless, true);
#endif
Engine_setAboutToClose(context->engine);
delete context;
}
if (! fAutosavePath.empty())
rack::system::removeRecursively(fAutosavePath);
}
CardinalPluginContext* getRackContext() const noexcept
{
return context;
}
#ifdef HAVE_LIBLO
bool startRemoteServer(const char* const port) override
{
if (fInitializer->remotePluginInstance != nullptr)
return false;
if (fInitializer->startRemoteServer(port))
{
fInitializer->remotePluginInstance = this;
return true;
}
return false;
}
void stopRemoteServer() override
{
DISTRHO_SAFE_ASSERT_RETURN(fInitializer->remotePluginInstance == this,);
fInitializer->remotePluginInstance = nullptr;
fInitializer->stopRemoteServer();
}
void stepRemoteServer() override
{
DISTRHO_SAFE_ASSERT_RETURN(fInitializer->remotePluginInstance == this,);
fInitializer->stepRemoteServer();
}
#endif
protected:
/* --------------------------------------------------------------------------------------------------------
* Information */
const char* getLabel() const override
{
return DISTRHO_PLUGIN_LABEL;
}
const char* getDescription() const override
{
return ""
"Cardinal is a free and open-source virtual modular synthesizer plugin.\n"
"It is based on the popular VCV Rack but with a focus on being a fully self-contained plugin version.\n"
"It is not an official VCV project, and it is not affiliated with it in any way.\n"
"\n"
"Cardinal contains Rack, some 3rd-party modules and a few internal utilities.\n"
"It does not load external modules and does not connect to the official Rack library/store.\n";
}
const char* getMaker() const override
{
return "DISTRHO";
}
const char* getHomePage() const override
{
return "https://github.com/DISTRHO/Cardinal";
}
const char* getLicense() const override
{
return "GPLv3+";
}
uint32_t getVersion() const override
{
return d_version(0, 24, 9);
}
int64_t getUniqueId() const override
{
#if CARDINAL_VARIANT_MAIN || CARDINAL_VARIANT_NATIVE
return d_cconst('d', 'C', 'd', 'n');
#elif CARDINAL_VARIANT_MINI
return d_cconst('d', 'C', 'd', 'M');
#elif CARDINAL_VARIANT_FX
return d_cconst('d', 'C', 'n', 'F');
#elif CARDINAL_VARIANT_SYNTH
return d_cconst('d', 'C', 'n', 'S');
#else
#error cardinal variant not set
#endif
}
/* --------------------------------------------------------------------------------------------------------
* Init */
void initAudioPort(const bool input, uint32_t index, AudioPort& port) override
{
#if CARDINAL_VARIANT_MAIN || CARDINAL_VARIANT_MINI
static_assert(CARDINAL_NUM_AUDIO_INPUTS == CARDINAL_NUM_AUDIO_OUTPUTS, "inputs == outputs");
if (index < CARDINAL_NUM_AUDIO_INPUTS)
{
#if CARDINAL_VARIANT_MINI
port.groupId = kPortGroupStereo;
#else
port.groupId = index / 2;
#endif
}
else
{
port.hints = kAudioPortIsCV | kCVPortHasPositiveUnipolarRange | kCVPortHasScaledRange | kCVPortIsOptional;
index -= CARDINAL_NUM_AUDIO_INPUTS;
}
#elif CARDINAL_VARIANT_NATIVE || CARDINAL_VARIANT_FX || CARDINAL_VARIANT_SYNTH
if (index < 2)
port.groupId = kPortGroupStereo;
#endif
CardinalBasePlugin::initAudioPort(input, index, port);
}
#if CARDINAL_VARIANT_MAIN
void initPortGroup(const uint32_t index, PortGroup& portGroup) override
{
switch (index)
{
case 0:
portGroup.name = "Audio 1+2";
portGroup.symbol = "audio_1_and_2";
break;
case 1:
portGroup.name = "Audio 3+4";
portGroup.symbol = "audio_3_and_4";
break;
case 2:
portGroup.name = "Audio 5+6";
portGroup.symbol = "audio_5_and_6";
break;
case 3:
portGroup.name = "Audio 7+8";
portGroup.symbol = "audio_7_and_8";
break;
}
}
#endif
void initParameter(const uint32_t index, Parameter& parameter) override
{
if (index < kCardinalParameterCountAtModules)
{
parameter.name = "Parameter ";
parameter.name += String(index + 1);
parameter.symbol = "param_";
parameter.symbol += String(index + 1);
parameter.unit = "v";
parameter.hints = kParameterIsAutomatable;
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 10.0f;
return;
}
if (index == kCardinalParameterBypass)
{
parameter.initDesignation(kParameterDesignationBypass);
return;
}
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
if (index < kCardinalParameterCountAtWindow)
{
switch (index - kCardinalParameterStartWindow)
{
case kWindowParameterShowTooltips:
parameter.name = "Show tooltips";
parameter.symbol = "tooltips";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger|kParameterIsBoolean;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = rack::settings::tooltips ? 1.f : 0.f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 1.0f;
break;
case kWindowParameterCableOpacity:
parameter.name = "Cable opacity";
parameter.symbol = "cableOpacity";
parameter.unit = "%";
parameter.hints = kParameterIsAutomatable;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = std::min(100.f, std::max(0.f, rack::settings::cableOpacity * 100));
parameter.ranges.min = 0.0f;
parameter.ranges.max = 100.0f;
break;
case kWindowParameterCableTension:
parameter.name = "Cable tension";
parameter.symbol = "cableTension";
parameter.unit = "%";
parameter.hints = kParameterIsAutomatable;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = std::min(100.f, std::max(0.f, rack::settings::cableTension * 100));
parameter.ranges.min = 0.0f;
parameter.ranges.max = 100.0f;
break;
case kWindowParameterRackBrightness:
parameter.name = "Room brightness";
parameter.symbol = "rackBrightness";
parameter.unit = "%";
parameter.hints = kParameterIsAutomatable;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = std::min(100.f, std::max(0.f, rack::settings::rackBrightness * 100));
parameter.ranges.min = 0.0f;
parameter.ranges.max = 100.0f;
break;
case kWindowParameterHaloBrightness:
parameter.name = "Light Bloom";
parameter.symbol = "haloBrightness";
parameter.unit = "%";
parameter.hints = kParameterIsAutomatable;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = std::min(100.f, std::max(0.f, rack::settings::haloBrightness * 100));
parameter.ranges.min = 0.0f;
parameter.ranges.max = 100.0f;
break;
case kWindowParameterKnobMode:
parameter.name = "Knob mode";
parameter.symbol = "knobMode";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = RackKnobModeToFloat(rack::settings::knobMode);
parameter.ranges.min = 0.0f;
parameter.ranges.max = 2.0f;
parameter.enumValues.count = 3;
parameter.enumValues.restrictedMode = true;
parameter.enumValues.values = new ParameterEnumerationValue[3];
parameter.enumValues.values[0].label = "Linear";
parameter.enumValues.values[0].value = 0.0f;
parameter.enumValues.values[1].label = "Absolute rotary";
parameter.enumValues.values[1].value = 1.0f;
parameter.enumValues.values[2].label = "Relative rotary";
parameter.enumValues.values[2].value = 2.0f;
break;
case kWindowParameterWheelKnobControl:
parameter.name = "Scroll wheel knob control";
parameter.symbol = "knobScroll";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger|kParameterIsBoolean;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = rack::settings::knobScroll ? 1.f : 0.f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 1.0f;
break;
case kWindowParameterWheelSensitivity:
parameter.name = "Scroll wheel knob sensitivity";
parameter.symbol = "knobScrollSensitivity";
parameter.hints = kParameterIsAutomatable|kParameterIsLogarithmic;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = std::min(10.f, std::max(0.1f, rack::settings::knobScrollSensitivity * 1000));
parameter.ranges.min = 0.1f;
parameter.ranges.max = 10.0f;
break;
case kWindowParameterLockModulePositions:
parameter.name = "Lock module positions";
parameter.symbol = "lockModules";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger|kParameterIsBoolean;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = rack::settings::lockModules ? 1.f : 0.f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 1.0f;
break;
case kWindowParameterUpdateRateLimit:
parameter.name = "Update rate limit";
parameter.symbol = "rateLimit";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 2.0f;
parameter.enumValues.count = 3;
parameter.enumValues.restrictedMode = true;
parameter.enumValues.values = new ParameterEnumerationValue[3];
parameter.enumValues.values[0].label = "None";
parameter.enumValues.values[0].value = 0.0f;
parameter.enumValues.values[1].label = "2x";
parameter.enumValues.values[1].value = 1.0f;
parameter.enumValues.values[2].label = "4x";
parameter.enumValues.values[2].value = 2.0f;
break;
case kWindowParameterBrowserSort:
parameter.name = "Browser sort";
parameter.symbol = "browserSort";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = std::min(rack::settings::BROWSER_SORT_RANDOM,
std::max(rack::settings::BROWSER_SORT_UPDATED,
rack::settings::browserSort));
parameter.ranges.min = rack::settings::BROWSER_SORT_UPDATED;
parameter.ranges.max = rack::settings::BROWSER_SORT_RANDOM;
parameter.enumValues.count = 6;
parameter.enumValues.restrictedMode = true;
parameter.enumValues.values = new ParameterEnumerationValue[6];
parameter.enumValues.values[0].label = "Updated";
parameter.enumValues.values[0].value = rack::settings::BROWSER_SORT_UPDATED;
parameter.enumValues.values[1].label = "Last used";
parameter.enumValues.values[1].value = rack::settings::BROWSER_SORT_LAST_USED;
parameter.enumValues.values[2].label = "Most used";
parameter.enumValues.values[2].value = rack::settings::BROWSER_SORT_MOST_USED;
parameter.enumValues.values[3].label = "Brand";
parameter.enumValues.values[3].value = rack::settings::BROWSER_SORT_BRAND;
parameter.enumValues.values[4].label = "Name";
parameter.enumValues.values[4].value = rack::settings::BROWSER_SORT_NAME;
parameter.enumValues.values[5].label = "Random";
parameter.enumValues.values[5].value = rack::settings::BROWSER_SORT_RANDOM;
break;
case kWindowParameterBrowserZoom:
parameter.name = "Browser zoom";
parameter.symbol = "browserZoom";
parameter.hints = kParameterIsAutomatable;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.unit = "%";
parameter.ranges.def = std::min(200.f, std::max(25.f, std::pow(2.f, rack::settings::browserZoom) * 100.0f));
parameter.ranges.min = 25.0f;
parameter.ranges.max = 200.0f;
parameter.enumValues.count = 7;
parameter.enumValues.restrictedMode = true;
parameter.enumValues.values = new ParameterEnumerationValue[7];
parameter.enumValues.values[0].label = "25";
parameter.enumValues.values[0].value = 25.0f;
parameter.enumValues.values[1].label = "35";
parameter.enumValues.values[1].value = 35.0f;
parameter.enumValues.values[2].label = "50";
parameter.enumValues.values[2].value = 50.0f;
parameter.enumValues.values[3].label = "71";
parameter.enumValues.values[3].value = 71.0f;
parameter.enumValues.values[4].label = "100";
parameter.enumValues.values[4].value = 100.0f;
parameter.enumValues.values[5].label = "141";
parameter.enumValues.values[5].value = 141.0f;
parameter.enumValues.values[6].label = "200";
parameter.enumValues.values[6].value = 200.0f;
break;
case kWindowParameterInvertZoom:
parameter.name = "Invert zoom";
parameter.symbol = "invertZoom";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger|kParameterIsBoolean;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = rack::settings::invertZoom ? 1.f : 0.f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 1.0f;
break;
case kWindowParameterSqueezeModulePositions:
parameter.name = "Auto-squeeze module positions";
parameter.symbol = "squeezeModules";
parameter.hints = kParameterIsAutomatable|kParameterIsInteger|kParameterIsBoolean;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
parameter.hints |= kParameterIsHidden;
#endif
parameter.ranges.def = rack::settings::squeezeModules ? 1.f : 0.f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 1.0f;
break;
}
}
#endif
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
switch (index)
{
case kCardinalParameterMiniAudioIn1:
parameter.name = "Report Audio Input 1";
parameter.symbol = "r_audio_in_1";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 1.0f;
break;
case kCardinalParameterMiniAudioIn2:
parameter.name = "Report Audio Input 2";
parameter.symbol = "r_audio_in_2";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 1.0f;
break;
case kCardinalParameterMiniCVIn1:
parameter.name = "Report CV Input 1";
parameter.symbol = "r_cv_in_1";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = -10.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 10.0f;
break;
case kCardinalParameterMiniCVIn2:
parameter.name = "Report CV Input 2";
parameter.symbol = "r_cv_in_2";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = -10.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 10.0f;
break;
case kCardinalParameterMiniCVIn3:
parameter.name = "Report CV Input 3";
parameter.symbol = "r_cv_in_3";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = -10.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 10.0f;
break;
case kCardinalParameterMiniCVIn4:
parameter.name = "Report CV Input 4";
parameter.symbol = "r_cv_in_4";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = -10.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 10.0f;
break;
case kCardinalParameterMiniCVIn5:
parameter.name = "Report CV Input 5";
parameter.symbol = "r_cv_in_5";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = -10.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 10.0f;
break;
case kCardinalParameterMiniTimeFlags:
parameter.name = "Report Time Flags";
parameter.symbol = "r_time_flags";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 0x0;
parameter.ranges.min = 0x0;
parameter.ranges.max = 0x7;
break;
case kCardinalParameterMiniTimeBar:
parameter.name = "Report Time Bar";
parameter.symbol = "r_time_bar";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 1.0f;
parameter.ranges.min = 1.0f;
parameter.ranges.max = FLT_MAX;
break;
case kCardinalParameterMiniTimeBeat:
parameter.name = "Report Time Beat";
parameter.symbol = "r_time_beat";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 1.0f;
parameter.ranges.min = 1.0f;
parameter.ranges.max = 128.0f;
break;
case kCardinalParameterMiniTimeBeatsPerBar:
parameter.name = "Report Time Beats Per Bar";
parameter.symbol = "r_time_beatsPerBar";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 4.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 128.0f;
break;
case kCardinalParameterMiniTimeBeatType:
parameter.name = "Report Time Beat Type";
parameter.symbol = "r_time_beatType";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 4.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 128.0f;
break;
case kCardinalParameterMiniTimeFrame:
parameter.name = "Report Time Frame";
parameter.symbol = "r_time_frame";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = FLT_MAX;
break;
case kCardinalParameterMiniTimeBarStartTick:
parameter.name = "Report Time BarStartTick";
parameter.symbol = "r_time_barStartTick";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = FLT_MAX;
break;
case kCardinalParameterMiniTimeBeatsPerMinute:
parameter.name = "Report Time Beats Per Minute";
parameter.symbol = "r_time_bpm";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 20.0f;
parameter.ranges.min = 120.0f;
parameter.ranges.max = 999.0f;
break;
case kCardinalParameterMiniTimeTick:
parameter.name = "Report Time Tick";
parameter.symbol = "r_time_tick";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 8192.0f;
break;
case kCardinalParameterMiniTimeTicksPerBeat:
parameter.name = "Report Time Ticks Per Beat";
parameter.symbol = "r_time_ticksPerBeat";
parameter.hints = kParameterIsAutomatable|kParameterIsOutput;
parameter.ranges.def = 0.0f;
parameter.ranges.min = 0.0f;
parameter.ranges.max = 8192.0f;
break;
}
#endif
}
void initState(const uint32_t index, State& state) override
{
switch (index)
{
case kCardinalStatePatch:
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
state.hints = kStateIsHostReadable;
#else
state.hints = kStateIsOnlyForDSP | kStateIsBase64Blob;
#endif
if (FILE* const f = std::fopen(context->patch->factoryTemplatePath.c_str(), "r"))
{
std::fseek(f, 0, SEEK_END);
if (const long fileSize = std::ftell(f))
{
std::fseek(f, 0, SEEK_SET);
char* const fileContent = new char[fileSize+1];
if (std::fread(fileContent, fileSize, 1, f) == 1)
{
fileContent[fileSize] = '\0';
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
state.defaultValue = fileContent;
#else
state.defaultValue = String::asBase64(fileContent, fileSize);
#endif
}
delete[] fileContent;
}
std::fclose(f);
}
state.key = "patch";
state.label = "Patch";
break;
case kCardinalStateScreenshot:
state.hints = kStateIsHostReadable | kStateIsBase64Blob;
state.key = "screenshot";
state.label = "Screenshot";
break;
case kCardinalStateComment:
state.hints = kStateIsHostWritable;
state.key = "comment";
state.label = "Comment";
break;
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
case kCardinalStateWindowSize:
state.hints = kStateIsOnlyForUI;
// state.defaultValue = String("%d:%d", DISTRHO_UI_DEFAULT_WIDTH, DISTRHO_UI_DEFAULT_HEIGHT);
state.key = "windowSize";
state.label = "Window size";
break;
#endif
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
case kCardinalStateParamChange:
state.hints = kStateIsHostReadable | kStateIsOnlyForDSP;
state.key = "param";
state.label = "ParamChange";
break;
#endif
}
}
/* --------------------------------------------------------------------------------------------------------
* Internal data */
float getParameterValue(uint32_t index) const override
{
// host mapped parameters
if (index < kCardinalParameterCountAtModules)
return context->parameters[index];
// bypass
if (index == kCardinalParameterBypass)
return context->bypassed ? 1.0f : 0.0f;
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
if (index < kCardinalParameterCountAtWindow)
return fWindowParameters[index - kCardinalParameterStartWindow];
#endif
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
if (index < kCardinalParameterCountAtMini)
return fMiniReportValues[index - kCardinalParameterStartMini];
#endif
return 0.0f;
}
void setParameterValue(uint32_t index, float value) override
{
// host mapped parameters
if (index < kCardinalParameterCountAtModules)
{
context->parameters[index] = value;
return;
}
// bypass
if (index == kCardinalParameterBypass)
{
context->bypassed = value > 0.5f;
return;
}
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
if (index < kCardinalParameterCountAtWindow)
{
fWindowParameters[index - kCardinalParameterStartWindow] = value;
return;
}
#endif
}
String getState(const char* const key) const override
{
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
if (std::strcmp(key, "windowSize") == 0)
return fState.windowSize;
#endif
if (std::strcmp(key, "comment") == 0)
return fState.comment;
if (std::strcmp(key, "screenshot") == 0)
return fState.screenshot;
if (std::strcmp(key, "patch") != 0)
return String();
if (fAutosavePath.empty())
return String();
std::vector<uint8_t> data;
{
const ScopedContext sc(this);
context->engine->prepareSave();
context->patch->saveAutosave();
context->patch->cleanAutosave();
// context->history->setSaved();
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
FILE* const f = std::fopen(rack::system::join(context->patch->autosavePath, "patch.json").c_str(), "r");
DISTRHO_SAFE_ASSERT_RETURN(f != nullptr, String());
DEFER({
std::fclose(f);
});
std::fseek(f, 0, SEEK_END);
const long fileSize = std::ftell(f);
DISTRHO_SAFE_ASSERT_RETURN(fileSize > 0, String());
std::fseek(f, 0, SEEK_SET);
char* const fileContent = static_cast<char*>(std::malloc(fileSize+1));
DISTRHO_SAFE_ASSERT_RETURN(std::fread(fileContent, fileSize, 1, f) == 1, String());
fileContent[fileSize] = '\0';
return String(fileContent, false);
#else
try {
data = rack::system::archiveDirectory(fAutosavePath, 1);
} DISTRHO_SAFE_EXCEPTION_RETURN("getState archiveDirectory", String());
#endif
}
return String::asBase64(data.data(), data.size());
}
void setState(const char* const key, const char* const value) override
{
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
if (std::strcmp(key, "param") == 0)
{
long long moduleId = 0;
int paramId = 0;
float paramValue = 0.f;
{
const ScopedSafeLocale cssl;
std::sscanf(value, "%lld:%d:%f", &moduleId, &paramId, &paramValue);
}
rack::engine::Module* const module = context->engine->getModule(moduleId);
DISTRHO_SAFE_ASSERT_RETURN(module != nullptr,);
context->engine->setParamValue(module, paramId, paramValue);
return;
}
#endif
#if CARDINAL_VARIANT_MINI || !defined(HEADLESS)
if (std::strcmp(key, "windowSize") == 0)
{
fState.windowSize = value;
return;
}
#endif
if (std::strcmp(key, "comment") == 0)
{
fState.comment = value;
return;
}
if (std::strcmp(key, "screenshot") == 0)
{
fState.screenshot = value;
return;
}
if (std::strcmp(key, "patch") != 0)
return;
if (fAutosavePath.empty())
return;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
rack::system::removeRecursively(fAutosavePath);
rack::system::createDirectories(fAutosavePath);
FILE* const f = std::fopen(rack::system::join(fAutosavePath, "patch.json").c_str(), "w");
DISTRHO_SAFE_ASSERT_RETURN(f != nullptr,);
std::fwrite(value, std::strlen(value), 1, f);
std::fclose(f);
#else
const std::vector<uint8_t> data(d_getChunkFromBase64String(value));
DISTRHO_SAFE_ASSERT_RETURN(data.size() >= 4,);
rack::system::removeRecursively(fAutosavePath);
rack::system::createDirectories(fAutosavePath);
static constexpr const char zstdMagic[] = "\x28\xb5\x2f\xfd";
if (std::memcmp(data.data(), zstdMagic, sizeof(zstdMagic)) != 0)
{
FILE* const f = std::fopen(rack::system::join(fAutosavePath, "patch.json").c_str(), "w");
DISTRHO_SAFE_ASSERT_RETURN(f != nullptr,);
std::fwrite(data.data(), data.size(), 1, f);
std::fclose(f);
}
else
{
try {
rack::system::unarchiveToDirectory(data, fAutosavePath);
} DISTRHO_SAFE_EXCEPTION_RETURN("setState unarchiveToDirectory",);
}
#endif
const ScopedContext sc(this);
try {
context->patch->loadAutosave();
} catch(const rack::Exception& e) {
d_stderr(e.what());
} DISTRHO_SAFE_EXCEPTION_RETURN("setState loadAutosave",);
// context->history->setSaved();
}
/* --------------------------------------------------------------------------------------------------------
* Process */
void activate() override
{
context->bufferSize = getBufferSize();
#if DISTRHO_PLUGIN_NUM_INPUTS != 0
fAudioBufferCopy = new float*[DISTRHO_PLUGIN_NUM_INPUTS];
for (int i=0; i<DISTRHO_PLUGIN_NUM_INPUTS; ++i)
{
fAudioBufferCopy[i] = new float[context->bufferSize];
std::memset(fAudioBufferCopy[i], 0, sizeof(float) * context->bufferSize);
}
#endif
fNextExpectedFrame = 0;
}
void deactivate() override
{
#if DISTRHO_PLUGIN_NUM_INPUTS != 0
if (fAudioBufferCopy != nullptr)
{
for (int i=0; i<DISTRHO_PLUGIN_NUM_INPUTS; ++i)
delete[] fAudioBufferCopy[i];
delete[] fAudioBufferCopy;
fAudioBufferCopy = nullptr;
}
#endif
}
void run(const float** const inputs, float** const outputs, const uint32_t frames,
const MidiEvent* const midiEvents, const uint32_t midiEventCount) override
{
const ScopedDenormalDisable sdd;
rack::contextSet(context);
const bool bypassed = context->bypassed;
{
const TimePosition& timePos(getTimePosition());
bool reset = timePos.playing && (timePos.frame == 0 || d_isDiffHigherThanLimit(fNextExpectedFrame, timePos.frame, (uint64_t)2));
// ignore hosts which cannot supply time frame position
if (context->playing == timePos.playing && timePos.frame == 0 && context->frame == 0)
reset = false;
context->playing = timePos.playing;
context->bbtValid = timePos.bbt.valid;
context->frame = timePos.frame;
if (timePos.bbt.valid)
{
const double samplesPerTick = 60.0 * getSampleRate()
/ timePos.bbt.beatsPerMinute
/ timePos.bbt.ticksPerBeat;
context->bar = timePos.bbt.bar;
context->beat = timePos.bbt.beat;
context->beatsPerBar = timePos.bbt.beatsPerBar;
context->beatType = timePos.bbt.beatType;
context->barStartTick = timePos.bbt.barStartTick;
context->beatsPerMinute = timePos.bbt.beatsPerMinute;
context->tick = timePos.bbt.tick;
context->ticksPerBeat = timePos.bbt.ticksPerBeat;
context->ticksPerClock = timePos.bbt.ticksPerBeat / timePos.bbt.beatType;
context->ticksPerFrame = 1.0 / samplesPerTick;
context->tickClock = std::fmod(timePos.bbt.tick, context->ticksPerClock);
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
fMiniReportValues[kCardinalParameterMiniTimeBar - kCardinalParameterStartMini] = timePos.bbt.bar;
fMiniReportValues[kCardinalParameterMiniTimeBeat - kCardinalParameterStartMini] = timePos.bbt.beat;
fMiniReportValues[kCardinalParameterMiniTimeBeatsPerBar - kCardinalParameterStartMini] = timePos.bbt.beatsPerBar;
fMiniReportValues[kCardinalParameterMiniTimeBeatType - kCardinalParameterStartMini] = timePos.bbt.beatType;
fMiniReportValues[kCardinalParameterMiniTimeBarStartTick - kCardinalParameterStartMini] = timePos.bbt.barStartTick;
fMiniReportValues[kCardinalParameterMiniTimeBeatsPerMinute - kCardinalParameterStartMini] = timePos.bbt.beatsPerMinute;
fMiniReportValues[kCardinalParameterMiniTimeTick - kCardinalParameterStartMini] = timePos.bbt.tick;
fMiniReportValues[kCardinalParameterMiniTimeTicksPerBeat - kCardinalParameterStartMini] = timePos.bbt.ticksPerBeat;
#endif
}
context->reset = reset;
fNextExpectedFrame = timePos.playing ? timePos.frame + frames : 0;
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
const int flags = (timePos.playing ? 0x1 : 0x0)
| (timePos.bbt.valid ? 0x2 : 0x0)
| (reset ? 0x4 : 0x0);
fMiniReportValues[kCardinalParameterMiniTimeFlags - kCardinalParameterStartMini] = flags;
fMiniReportValues[kCardinalParameterMiniTimeFrame - kCardinalParameterStartMini] = timePos.frame / getSampleRate();
#endif
}
// separate buffers, use them
if (inputs != outputs && (inputs == nullptr || inputs[0] != outputs[0]))
{
context->dataIns = inputs;
context->dataOuts = outputs;
}
// inline processing, use a safe copy
else
{
#if DISTRHO_PLUGIN_NUM_INPUTS != 0
for (int i=0; i<fNumActiveInputs; ++i)
{
#if CARDINAL_VARIANT_MAIN || CARDINAL_VARIANT_MINI
// can be null on main and mini variants
if (inputs[i] != nullptr)
#endif
std::memcpy(fAudioBufferCopy[i], inputs[i], sizeof(float)*frames);
}
context->dataIns = fAudioBufferCopy;
#else
context->dataIns = nullptr;
#endif
context->dataOuts = outputs;
}
for (int i=0; i<fNumActiveOutputs; ++i)
{
#if CARDINAL_VARIANT_MAIN || CARDINAL_VARIANT_MINI
// can be null on main and mini variants
if (outputs[i] != nullptr)
#endif
std::memset(outputs[i], 0, sizeof(float)*frames);
}
#if CARDINAL_VARIANT_MINI && ! DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
for (int i=0; i<DISTRHO_PLUGIN_NUM_INPUTS; ++i)
fMiniReportValues[i] = context->dataIns[i][0];
#endif
if (bypassed)
{
if (fWasBypassed != bypassed)
{
context->midiEvents = bypassMidiEvents;
context->midiEventCount = 16;
}
else
{
context->midiEvents = nullptr;
context->midiEventCount = 0;
}
}
else
{
context->midiEvents = midiEvents;
context->midiEventCount = midiEventCount;
}
++context->processCounter;
context->engine->stepBlock(frames);
fWasBypassed = bypassed;
}
void sampleRateChanged(const double newSampleRate) override
{
rack::contextSet(context);
rack::settings::sampleRate = newSampleRate;
context->sampleRate = newSampleRate;
context->engine->setSampleRate(newSampleRate);
}
#ifdef DISTRHO_PLUGIN_EXTRA_IO
void ioChanged(const uint16_t numInputs, const uint16_t numOutputs) override
{
fNumActiveInputs = numInputs;
fNumActiveOutputs = numOutputs;
}
#endif
// -------------------------------------------------------------------------------------------------------
private:
/**
Set our plugin class as non-copyable and add a leak detector just in case.
*/
DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CardinalPlugin)
};
CardinalPluginContext* getRackContextFromPlugin(void* const ptr)
{
return static_cast<CardinalPlugin*>(ptr)->getRackContext();
}
/* ------------------------------------------------------------------------------------------------------------
* Plugin entry point, called by DPF to create a new plugin instance. */
Plugin* createPlugin()
{
return new CardinalPlugin();
}
// --------------------------------------------------------------------------------------------------------------------
END_NAMESPACE_DISTRHO