commit 30a467159f331352a3ea5e1f9cb71a5d21a4a89e
parent 054f35db47a783108e61088a628427dd6e213f9f
Author: falkTX <falktx@falktx.com>
Date: Sun, 22 Aug 2021 21:25:18 +0100
Start embed external ui example
Diffstat:
5 files changed, 342 insertions(+), 0 deletions(-)
diff --git a/examples/EmbedExternalUI/DistrhoPluginInfo.h b/examples/EmbedExternalUI/DistrhoPluginInfo.h
@@ -0,0 +1,36 @@
+/*
+ * DISTRHO Plugin Framework (DPF)
+ * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any purpose with
+ * or without fee is hereby granted, provided that the above copyright notice and this
+ * permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+ * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+ * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+ * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#ifndef DISTRHO_PLUGIN_INFO_H_INCLUDED
+#define DISTRHO_PLUGIN_INFO_H_INCLUDED
+
+#define DISTRHO_PLUGIN_BRAND "DISTRHO"
+#define DISTRHO_PLUGIN_NAME "EmbedExternalUI"
+#define DISTRHO_PLUGIN_URI "http://distrho.sf.net/examples/EmbedExternalUI"
+
+#define DISTRHO_PLUGIN_HAS_UI 1
+#define DISTRHO_PLUGIN_HAS_EMBED_UI 1
+#define DISTRHO_PLUGIN_HAS_EXTERNAL_UI 1
+#define DISTRHO_PLUGIN_IS_RT_SAFE 1
+#define DISTRHO_PLUGIN_NUM_INPUTS 2
+#define DISTRHO_PLUGIN_NUM_OUTPUTS 2
+
+enum Parameters {
+ kParameterLevel = 0,
+ kParameterCount
+};
+
+#endif // DISTRHO_PLUGIN_INFO_H_INCLUDED
diff --git a/examples/EmbedExternalUI/EmbedExternalExamplePlugin.cpp b/examples/EmbedExternalUI/EmbedExternalExamplePlugin.cpp
@@ -0,0 +1,190 @@
+/*
+ * DISTRHO Plugin Framework (DPF)
+ * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any purpose with
+ * or without fee is hereby granted, provided that the above copyright notice and this
+ * permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+ * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+ * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+ * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include "DistrhoPlugin.hpp"
+
+START_NAMESPACE_DISTRHO
+
+// -----------------------------------------------------------------------------------------------------------
+
+/**
+ Plugin to show how to get some basic information sent to the UI.
+ */
+class EmbedExternalExamplePlugin : public Plugin
+{
+public:
+ EmbedExternalExamplePlugin()
+ : Plugin(kParameterCount, 0, 0),
+ fValue(0.0f)
+ {
+ }
+
+protected:
+ /* --------------------------------------------------------------------------------------------------------
+ * Information */
+
+ /**
+ Get the plugin label.
+ This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters.
+ */
+ const char* getLabel() const override
+ {
+ return "EmbedExternalUI";
+ }
+
+ /**
+ Get an extensive comment/description about the plugin.
+ */
+ const char* getDescription() const override
+ {
+ return "Plugin to show how to use an embedable dpf-external UI.";
+ }
+
+ /**
+ Get the plugin author/maker.
+ */
+ const char* getMaker() const override
+ {
+ return "DISTRHO";
+ }
+
+ /**
+ Get the plugin homepage.
+ */
+ const char* getHomePage() const override
+ {
+ return "https://github.com/DISTRHO/DPF";
+ }
+
+ /**
+ Get the plugin license name (a single line of text).
+ For commercial plugins this should return some short copyright information.
+ */
+ const char* getLicense() const override
+ {
+ return "ISC";
+ }
+
+ /**
+ Get the plugin version, in hexadecimal.
+ */
+ uint32_t getVersion() const override
+ {
+ return d_version(1, 0, 0);
+ }
+
+ /**
+ Get the plugin unique Id.
+ This value is used by LADSPA, DSSI and VST plugin formats.
+ */
+ int64_t getUniqueId() const override
+ {
+ return d_cconst('d', 'b', 'x', 't');
+ }
+
+ /* --------------------------------------------------------------------------------------------------------
+ * Init */
+
+ /**
+ Initialize the parameter @a index.
+ This function will be called once, shortly after the plugin is created.
+ */
+ void initParameter(uint32_t index, Parameter& parameter) override
+ {
+ if (index != 0)
+ return;
+
+ parameter.hints = kParameterIsAutomable|kParameterIsInteger;
+ parameter.ranges.def = 0.0f;
+ parameter.ranges.min = 0.0f;
+ parameter.ranges.max = 100.0f;
+ parameter.name = "Value";
+ parameter.symbol = "value";
+ }
+
+ /* --------------------------------------------------------------------------------------------------------
+ * Internal data */
+
+ /**
+ Get the current value of a parameter.
+ The host may call this function from any context, including realtime processing.
+ */
+ float getParameterValue(uint32_t index) const override
+ {
+ if (index != 0)
+ return 0.0f;
+
+ return fValue;
+
+ }
+
+ /**
+ Change a parameter value.
+ The host may call this function from any context, including realtime processing.
+ When a parameter is marked as automable, you must ensure no non-realtime operations are performed.
+ @note This function will only be called for parameter inputs.
+ */
+ void setParameterValue(uint32_t index, float value) override
+ {
+ if (index != 0)
+ return;
+
+ fValue = value;
+ }
+
+ /* --------------------------------------------------------------------------------------------------------
+ * Audio/MIDI Processing */
+
+ /**
+ Run/process function for plugins without MIDI input.
+ @note Some parameters might be null if there are no audio inputs or outputs.
+ */
+ void run(const float** inputs, float** outputs, uint32_t frames) override
+ {
+ /**
+ This plugin does nothing, it just demonstrates information usage.
+ So here we directly copy inputs over outputs, leaving the audio untouched.
+ We need to be careful in case the host re-uses the same buffer for both inputs and outputs.
+ */
+ if (outputs[0] != inputs[0])
+ std::memcpy(outputs[0], inputs[0], sizeof(float)*frames);
+ if (outputs[1] != inputs[1])
+ std::memcpy(outputs[1], inputs[1], sizeof(float)*frames);
+ }
+
+ // -------------------------------------------------------------------------------------------------------
+
+private:
+ // Parameters
+ float fValue;
+
+ /**
+ Set our plugin class as non-copyable and add a leak detector just in case.
+ */
+ DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(EmbedExternalExamplePlugin)
+};
+
+/* ------------------------------------------------------------------------------------------------------------
+ * Plugin entry point, called by DPF to create a new plugin instance. */
+
+Plugin* createPlugin()
+{
+ return new EmbedExternalExamplePlugin();
+}
+
+// -----------------------------------------------------------------------------------------------------------
+
+END_NAMESPACE_DISTRHO
diff --git a/examples/EmbedExternalUI/EmbedExternalExampleUI.cpp b/examples/EmbedExternalUI/EmbedExternalExampleUI.cpp
@@ -0,0 +1,73 @@
+/*
+ * DISTRHO Plugin Framework (DPF)
+ * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any purpose with
+ * or without fee is hereby granted, provided that the above copyright notice and this
+ * permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+ * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+ * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+ * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include "DistrhoUI.hpp"
+
+START_NAMESPACE_DISTRHO
+
+// -----------------------------------------------------------------------------------------------------------
+
+class EmbedExternalExampleUI : public UI
+{
+public:
+ EmbedExternalExampleUI()
+ : UI(405, 256),
+ fValue(0.0f)
+ {
+ }
+
+protected:
+ /* --------------------------------------------------------------------------------------------------------
+ * DSP/Plugin Callbacks */
+
+ /**
+ A parameter has changed on the plugin side.
+ This is called by the host to inform the UI about parameter changes.
+ */
+ void parameterChanged(uint32_t index, float value) override
+ {
+ if (index != 0)
+ return;
+
+ fValue = value;
+ }
+
+ /* --------------------------------------------------------------------------------------------------------
+ * External Window overrides */
+
+ // -------------------------------------------------------------------------------------------------------
+
+private:
+ // Current value, cached for when UI becomes visible
+ float fValue;
+
+ /**
+ Set our UI class as non-copyable and add a leak detector just in case.
+ */
+ DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(EmbedExternalExampleUI)
+};
+
+/* ------------------------------------------------------------------------------------------------------------
+ * UI entry point, called by DPF to create a new UI instance. */
+
+UI* createUI()
+{
+ return new EmbedExternalExampleUI();
+}
+
+// -----------------------------------------------------------------------------------------------------------
+
+END_NAMESPACE_DISTRHO
diff --git a/examples/EmbedExternalUI/Makefile b/examples/EmbedExternalUI/Makefile
@@ -0,0 +1,37 @@
+#!/usr/bin/make -f
+# Makefile for DISTRHO Plugins #
+# ---------------------------- #
+# Created by falkTX
+#
+
+# --------------------------------------------------------------
+# Project name, used for binaries
+
+NAME = d_embedextui
+
+# --------------------------------------------------------------
+# Files to build
+
+FILES_DSP = \
+ EmbedExternalExamplePlugin.cpp
+
+FILES_UI = \
+ EmbedExternalExampleUI.cpp
+
+# --------------------------------------------------------------
+# Do some magic
+
+UI_TYPE = external
+include ../../Makefile.plugins.mk
+
+# --------------------------------------------------------------
+# Enable all possible plugin types
+
+TARGETS += jack
+TARGETS += dssi
+TARGETS += lv2_sep
+TARGETS += vst2
+
+all: $(TARGETS)
+
+# --------------------------------------------------------------
diff --git a/examples/EmbedExternalUI/README.md b/examples/EmbedExternalUI/README.md
@@ -0,0 +1,6 @@
+# Embed External UI example
+
+This example will show how to use something external to DPF that is still embed within the host window.
+
+The DSP side does nothing but provide a dummy parameter, just to test the interaction.
+The UI side implements a OS-native UI, in order to test interacting with external elements.
