diff options
Diffstat (limited to 'libs/distrho/src/DistrhoUILV2.cpp')
| -rw-r--r-- | libs/distrho/src/DistrhoUILV2.cpp | 536 |
1 files changed, 0 insertions, 536 deletions
diff --git a/libs/distrho/src/DistrhoUILV2.cpp b/libs/distrho/src/DistrhoUILV2.cpp deleted file mode 100644 index 2aa6565..0000000 --- a/libs/distrho/src/DistrhoUILV2.cpp +++ /dev/null @@ -1,536 +0,0 @@ -/* - * DISTRHO Plugin Framework (DPF) - * Copyright (C) 2012-2014 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 "DistrhoUIInternal.hpp" - -#include "../extra/d_string.hpp" - -#include "lv2/atom.h" -#include "lv2/atom-util.h" -#include "lv2/data-access.h" -#include "lv2/instance-access.h" -#include "lv2/options.h" -#include "lv2/ui.h" -#include "lv2/urid.h" -#include "lv2/lv2_kxstudio_properties.h" -#include "lv2/lv2_programs.h" - -START_NAMESPACE_DISTRHO - -// ----------------------------------------------------------------------- - -class UiLv2 -{ -public: - UiLv2(const intptr_t winId, - const LV2_Options_Option* options, const LV2_URID_Map* const uridMap, const LV2UI_Resize* const uiResz, const LV2UI_Touch* uiTouch, - const LV2UI_Controller controller, const LV2UI_Write_Function writeFunc, - LV2UI_Widget* const widget, void* const dspPtr) - : fUI(this, winId, editParameterCallback, setParameterCallback, setStateCallback, sendNoteCallback, setSizeCallback, dspPtr), - fUridMap(uridMap), - fUiResize(uiResz), - fUiTouch(uiTouch), - fController(controller), - fWriteFunction(writeFunc), - fEventTransferURID(uridMap->map(uridMap->handle, LV2_ATOM__eventTransfer)), - fKeyValueURID(uridMap->map(uridMap->handle, "urn:distrho:keyValueState")), - fWinIdWasNull(winId == 0) - { - if (fUiResize != nullptr && winId != 0) - fUiResize->ui_resize(fUiResize->handle, fUI.getWidth(), fUI.getHeight()); - - if (widget != nullptr) - *widget = (LV2UI_Widget*)fUI.getWindowId(); - -#if DISTRHO_PLUGIN_WANT_STATE - // tell the DSP we're ready to receive msgs - setState("__dpf_ui_data__", ""); -#endif - - if (winId != 0) - return; - - // if winId == 0 then options must not be null - DISTRHO_SAFE_ASSERT_RETURN(options != nullptr,); - - const LV2_URID uridWindowTitle(uridMap->map(uridMap->handle, LV2_UI__windowTitle)); - const LV2_URID uridTransientWinId(uridMap->map(uridMap->handle, LV2_KXSTUDIO_PROPERTIES__TransientWindowId)); - - bool hasTitle = false; - - for (int i=0; options[i].key != 0; ++i) - { - if (options[i].key == uridTransientWinId) - { - if (options[i].type == uridMap->map(uridMap->handle, LV2_ATOM__Long)) - { - if (const int64_t transientWinId = *(const int64_t*)options[i].value) - fUI.setWindowTransientWinId(static_cast<intptr_t>(transientWinId)); - } - else - d_stderr("Host provides transientWinId but has wrong value type"); - } - else if (options[i].key == uridWindowTitle) - { - if (options[i].type == uridMap->map(uridMap->handle, LV2_ATOM__String)) - { - if (const char* const windowTitle = (const char*)options[i].value) - { - hasTitle = true; - fUI.setWindowTitle(windowTitle); - } - } - else - d_stderr("Host provides windowTitle but has wrong value type"); - } - } - - if (! hasTitle) - fUI.setWindowTitle(DISTRHO_PLUGIN_NAME); - } - - // ------------------------------------------------------------------- - - void lv2ui_port_event(const uint32_t rindex, const uint32_t bufferSize, const uint32_t format, const void* const buffer) - { - if (format == 0) - { - const uint32_t parameterOffset(fUI.getParameterOffset()); - - DISTRHO_SAFE_ASSERT_RETURN(rindex >= parameterOffset,) - DISTRHO_SAFE_ASSERT_RETURN(bufferSize == sizeof(float),) - - const float value(*(const float*)buffer); - fUI.parameterChanged(rindex-parameterOffset, value); - } -#if DISTRHO_PLUGIN_WANT_STATE - else if (format == fEventTransferURID) - { - const LV2_Atom* const atom((const LV2_Atom*)buffer); - - DISTRHO_SAFE_ASSERT_RETURN(atom->type == fKeyValueURID,); - - const char* const key = (const char*)LV2_ATOM_BODY_CONST(atom); - const char* const value = key+(std::strlen(key)+1); - - fUI.stateChanged(key, value); - } -#endif - } - - // ------------------------------------------------------------------- - - int lv2ui_idle() - { - if (fWinIdWasNull) - return (fUI.idle() && fUI.isVisible()) ? 0 : 1; - - return fUI.idle() ? 0 : 1; - } - - int lv2ui_show() - { - return fUI.setWindowVisible(true) ? 0 : 1; - } - - int lv2ui_hide() - { - return fUI.setWindowVisible(false) ? 0 : 1; - } - - int lv2ui_resize(uint width, uint height) - { - fUI.setWindowSize(width, height, true); - return 0; - } - - // ------------------------------------------------------------------- - - uint32_t lv2_get_options(LV2_Options_Option* const /*options*/) - { - // currently unused - return LV2_OPTIONS_ERR_UNKNOWN; - } - - uint32_t lv2_set_options(const LV2_Options_Option* const options) - { - for (int i=0; options[i].key != 0; ++i) - { - if (options[i].key == fUridMap->map(fUridMap->handle, LV2_CORE__sampleRate)) - { - if (options[i].type == fUridMap->map(fUridMap->handle, LV2_ATOM__Double)) - { - const double sampleRate(*(const double*)options[i].value); - fUI.setSampleRate(sampleRate); - continue; - } - else - { - d_stderr("Host changed sampleRate but with wrong value type"); - continue; - } - } - } - - return LV2_OPTIONS_SUCCESS; - } - - // ------------------------------------------------------------------- - -#if DISTRHO_PLUGIN_WANT_PROGRAMS - void lv2ui_select_program(const uint32_t bank, const uint32_t program) - { - const uint32_t realProgram(bank * 128 + program); - - fUI.programChanged(realProgram); - } -#endif - - // ------------------------------------------------------------------- - -protected: - void editParameterValue(const uint32_t rindex, const bool started) - { - if (fUiTouch != nullptr && fUiTouch->touch != nullptr) - fUiTouch->touch(fUiTouch->handle, rindex, started); - } - - void setParameterValue(const uint32_t rindex, const float value) - { - DISTRHO_SAFE_ASSERT_RETURN(fWriteFunction != nullptr,); - - fWriteFunction(fController, rindex, sizeof(float), 0, &value); - } - - void setState(const char* const key, const char* const value) - { - DISTRHO_SAFE_ASSERT_RETURN(fWriteFunction != nullptr,); - - const uint32_t eventInPortIndex(DISTRHO_PLUGIN_NUM_INPUTS + DISTRHO_PLUGIN_NUM_OUTPUTS); - - // join key and value - d_string tmpStr; - tmpStr += key; - tmpStr += "\xff"; - tmpStr += value; - - tmpStr[std::strlen(key)] = '\0'; - - // set msg size (key + separator + value + null terminator) - const size_t msgSize(tmpStr.length()+1); - - // reserve atom space - const size_t atomSize(lv2_atom_pad_size(sizeof(LV2_Atom) + msgSize)); - char atomBuf[atomSize]; - std::memset(atomBuf, 0, atomSize); - - // set atom info - LV2_Atom* const atom((LV2_Atom*)atomBuf); - atom->size = msgSize; - atom->type = fKeyValueURID; - - // set atom data - std::memcpy(atomBuf + sizeof(LV2_Atom), tmpStr.buffer(), msgSize); - - // send to DSP side - fWriteFunction(fController, eventInPortIndex, atomSize, fEventTransferURID, atom); - } - - void sendNote(const uint8_t /*channel*/, const uint8_t /*note*/, const uint8_t /*velocity*/) - { - } - - void setSize(const uint width, const uint height) - { - fUI.setWindowSize(width, height); - - if (fUiResize != nullptr && ! fWinIdWasNull) - fUiResize->ui_resize(fUiResize->handle, width, height); - } - -private: - UIExporter fUI; - - // LV2 features - const LV2_URID_Map* const fUridMap; - const LV2UI_Resize* const fUiResize; - const LV2UI_Touch* const fUiTouch; - - // LV2 UI stuff - const LV2UI_Controller fController; - const LV2UI_Write_Function fWriteFunction; - - // Need to save this - const LV2_URID fEventTransferURID; - const LV2_URID fKeyValueURID; - - // using ui:showInterface if true - bool fWinIdWasNull; - - // ------------------------------------------------------------------- - // Callbacks - - #define uiPtr ((UiLv2*)ptr) - - static void editParameterCallback(void* ptr, uint32_t rindex, bool started) - { - uiPtr->editParameterValue(rindex, started); - } - - static void setParameterCallback(void* ptr, uint32_t rindex, float value) - { - uiPtr->setParameterValue(rindex, value); - } - - static void setStateCallback(void* ptr, const char* key, const char* value) - { - uiPtr->setState(key, value); - } - - static void sendNoteCallback(void* ptr, uint8_t channel, uint8_t note, uint8_t velocity) - { - uiPtr->sendNote(channel, note, velocity); - } - - static void setSizeCallback(void* ptr, uint width, uint height) - { - uiPtr->setSize(width, height); - } - - #undef uiPtr -}; - -// ----------------------------------------------------------------------- - -static LV2UI_Handle lv2ui_instantiate(const LV2UI_Descriptor*, const char* uri, const char*, LV2UI_Write_Function writeFunction, LV2UI_Controller controller, LV2UI_Widget* widget, const LV2_Feature* const* features) -{ - if (uri == nullptr || std::strcmp(uri, DISTRHO_PLUGIN_URI) != 0) - { - d_stderr("Invalid plugin URI"); - return nullptr; - } - - const LV2_Options_Option* options = nullptr; - const LV2_URID_Map* uridMap = nullptr; - const LV2UI_Resize* uiResize = nullptr; - const LV2UI_Touch* uiTouch = nullptr; - void* parentId = nullptr; - void* instance = nullptr; - -#if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS -# define DISTRHO_DIRECT_ACCESS_URI "urn:distrho:direct-access" - - struct LV2_DirectAccess_Interface { - void* (*get_instance_pointer)(LV2_Handle handle); - }; - const LV2_Extension_Data_Feature* extData = nullptr; -#endif - - for (int i=0; features[i] != nullptr; ++i) - { - if (std::strcmp(features[i]->URI, LV2_OPTIONS__options) == 0) - options = (const LV2_Options_Option*)features[i]->data; - else if (std::strcmp(features[i]->URI, LV2_URID__map) == 0) - uridMap = (const LV2_URID_Map*)features[i]->data; - else if (std::strcmp(features[i]->URI, LV2_UI__resize) == 0) - uiResize = (const LV2UI_Resize*)features[i]->data; - else if (std::strcmp(features[i]->URI, LV2_UI__parent) == 0) - parentId = features[i]->data; -#if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS - else if (std::strcmp(features[i]->URI, LV2_DATA_ACCESS_URI) == 0) - extData = (const LV2_Extension_Data_Feature*)features[i]->data; - else if (std::strcmp(features[i]->URI, LV2_INSTANCE_ACCESS_URI) == 0) - instance = features[i]->data; -#endif - } - - if (options == nullptr && parentId == nullptr) - { - d_stderr("Options feature missing (needed for show-interface), cannot continue!"); - return nullptr; - } - - if (uridMap == nullptr) - { - d_stderr("URID Map feature missing, cannot continue!"); - return nullptr; - } - - if (parentId == nullptr) - { - d_stdout("Parent Window Id missing, host should be using ui:showInterface..."); - } - -#if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS - if (extData == nullptr || instance == nullptr) - { - d_stderr("Data or instance access missing, cannot continue!"); - return nullptr; - } - - if (const LV2_DirectAccess_Interface* const directAccess = (const LV2_DirectAccess_Interface*)extData->data_access(DISTRHO_DIRECT_ACCESS_URI)) - instance = directAccess->get_instance_pointer(instance); - else - instance = nullptr; - - if (instance == nullptr) - { - d_stderr("Failed to get direct access, cannot continue!"); - return nullptr; - } -#endif - - const intptr_t winId((intptr_t)parentId); - - if (options != nullptr) - { - const LV2_URID uridSampleRate(uridMap->map(uridMap->handle, LV2_CORE__sampleRate)); - - for (int i=0; options[i].key != 0; ++i) - { - if (options[i].key == uridSampleRate) - { - if (options[i].type == uridMap->map(uridMap->handle, LV2_ATOM__Double)) - d_lastUiSampleRate = *(const double*)options[i].value; - else - d_stderr("Host provides sampleRate but has wrong value type"); - - break; - } - } - } - - if (d_lastUiSampleRate == 0.0) - { - d_stdout("WARNING: this host does not send sample-rate information for LV2 UIs, using 44100 as fallback (this could be wrong)"); - d_lastUiSampleRate = 44100.0; - } - - return new UiLv2(winId, options, uridMap, uiResize, uiTouch, controller, writeFunction, widget, instance); -} - -#define uiPtr ((UiLv2*)ui) - -static void lv2ui_cleanup(LV2UI_Handle ui) -{ - delete uiPtr; -} - -static void lv2ui_port_event(LV2UI_Handle ui, uint32_t portIndex, uint32_t bufferSize, uint32_t format, const void* buffer) -{ - uiPtr->lv2ui_port_event(portIndex, bufferSize, format, buffer); -} - -// ----------------------------------------------------------------------- - -static int lv2ui_idle(LV2UI_Handle ui) -{ - return uiPtr->lv2ui_idle(); -} - -static int lv2ui_show(LV2UI_Handle ui) -{ - return uiPtr->lv2ui_show(); -} - -static int lv2ui_hide(LV2UI_Handle ui) -{ - return uiPtr->lv2ui_hide(); -} - -static int lv2ui_resize(LV2UI_Handle ui, int width, int height) -{ - DISTRHO_SAFE_ASSERT_RETURN(ui != nullptr, 1); - DISTRHO_SAFE_ASSERT_RETURN(width > 0, 1); - DISTRHO_SAFE_ASSERT_RETURN(height > 0, 1); - - return 1; // This needs more testing - //return uiPtr->lv2ui_resize(width, height); -} - -// ----------------------------------------------------------------------- - -static uint32_t lv2_get_options(LV2UI_Handle ui, LV2_Options_Option* options) -{ - return uiPtr->lv2_get_options(options); -} - -static uint32_t lv2_set_options(LV2UI_Handle ui, const LV2_Options_Option* options) -{ - return uiPtr->lv2_set_options(options); -} - -// ----------------------------------------------------------------------- - -#if DISTRHO_PLUGIN_WANT_PROGRAMS -static void lv2ui_select_program(LV2UI_Handle ui, uint32_t bank, uint32_t program) -{ - uiPtr->lv2ui_select_program(bank, program); -} -#endif - -// ----------------------------------------------------------------------- - -static const void* lv2ui_extension_data(const char* uri) -{ - static const LV2_Options_Interface options = { lv2_get_options, lv2_set_options }; - static const LV2UI_Idle_Interface uiIdle = { lv2ui_idle }; - static const LV2UI_Show_Interface uiShow = { lv2ui_show, lv2ui_hide }; - static const LV2UI_Resize uiResz = { nullptr, lv2ui_resize }; - - if (std::strcmp(uri, LV2_OPTIONS__interface) == 0) - return &options; - if (std::strcmp(uri, LV2_UI__idleInterface) == 0) - return &uiIdle; - if (std::strcmp(uri, LV2_UI__showInterface) == 0) - return &uiShow; - if (std::strcmp(uri, LV2_UI__resize) == 0) - return &uiResz; - -#if DISTRHO_PLUGIN_WANT_PROGRAMS - static const LV2_Programs_UI_Interface uiPrograms = { lv2ui_select_program }; - - if (std::strcmp(uri, LV2_PROGRAMS__UIInterface) == 0) - return &uiPrograms; -#endif - - return nullptr; -} - -#undef instancePtr - -// ----------------------------------------------------------------------- - -static const LV2UI_Descriptor sLv2UiDescriptor = { - DISTRHO_UI_URI, - lv2ui_instantiate, - lv2ui_cleanup, - lv2ui_port_event, - lv2ui_extension_data -}; - -// ----------------------------------------------------------------------- - -END_NAMESPACE_DISTRHO - -DISTRHO_PLUGIN_EXPORT -const LV2UI_Descriptor* lv2ui_descriptor(uint32_t index) -{ - USE_NAMESPACE_DISTRHO - return (index == 0) ? &sLv2UiDescriptor : nullptr; -} - -// ----------------------------------------------------------------------- |