/*
- Copyright (C) 2008-2011 Paul Davis
+ Copyright (C) 2008-2012 Paul Davis
Author: David Robillard
This program is free software; you can redistribute it and/or modify
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
*/
#include "ardour/lv2_plugin.h"
-#include "ardour/plugin_manager.h"
-#include "ardour/processor.h"
+#include "ardour/session.h"
+#include "pbd/error.h"
+#include "pbd/stacktrace.h"
-#include "ardour_ui.h"
#include "gui_thread.h"
#include "lv2_plugin_ui.h"
+#include "timers.h"
+
+#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
+
+#include <lilv/lilv.h>
+#include <suil/suil.h>
+
+#include "pbd/i18n.h"
-using namespace Gtk;
using namespace ARDOUR;
+using namespace Gtk;
using namespace PBD;
-SLV2UIHost LV2PluginUI::ui_host = NULL;
+#define NS_UI "http://lv2plug.in/ns/extensions/ui#"
+
+static SuilHost* ui_host = NULL;
void
-LV2PluginUI::lv2_ui_write(LV2UI_Controller controller,
- uint32_t port_index,
- uint32_t /*buffer_size*/,
- uint32_t /*format*/,
- const void* buffer)
+LV2PluginUI::write_from_ui(void* controller,
+ uint32_t port_index,
+ uint32_t buffer_size,
+ uint32_t format,
+ const void* buffer)
{
LV2PluginUI* me = (LV2PluginUI*)controller;
- me->_controllables[port_index]->set_value(*(float*)buffer);
+ if (format == 0) {
+ if (port_index >= me->_controllables.size()) {
+ return;
+ }
+
+ boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
+
+ me->_updates.insert (port_index);
+
+ if (ac) {
+ ac->set_value(*(const float*)buffer, Controllable::NoGroup);
+ }
+ } else if (format == URIMap::instance().urids.atom_eventTransfer) {
+
+ const int cnt = me->_pi->get_count();
+ for (int i=0; i < cnt; i++ ) {
+ boost::shared_ptr<LV2Plugin> lv2i = boost::dynamic_pointer_cast<LV2Plugin> (me->_pi->plugin(i));
+ lv2i->write_from_ui(port_index, format, buffer_size, (const uint8_t*)buffer);
+ }
+ }
}
void
-LV2PluginUI::on_external_ui_closed(LV2UI_Controller controller)
+LV2PluginUI::write_to_ui(void* controller,
+ uint32_t port_index,
+ uint32_t buffer_size,
+ uint32_t format,
+ const void* buffer)
{
LV2PluginUI* me = (LV2PluginUI*)controller;
- me->_screen_update_connection.disconnect();
- me->_external_ui_ptr = NULL;
+ if (me->_inst) {
+ suil_instance_port_event((SuilInstance*)me->_inst,
+ port_index, buffer_size, format, buffer);
+ }
+}
+
+uint32_t
+LV2PluginUI::port_index(void* controller, const char* symbol)
+{
+ return ((LV2PluginUI*)controller)->_lv2->port_index(symbol);
}
void
-LV2PluginUI::parameter_changed(uint32_t port_index, float val)
+LV2PluginUI::touch(void* controller,
+ uint32_t port_index,
+ bool grabbed)
{
- PlugUIBase::parameter_changed(port_index, val);
+ LV2PluginUI* me = (LV2PluginUI*)controller;
+ if (port_index >= me->_controllables.size()) {
+ return;
+ }
- if (val != _values[port_index]) {
- parameter_update(port_index, val);
+ ControllableRef control = me->_controllables[port_index];
+ if (grabbed) {
+ control->start_touch(control->session().transport_frame());
+ } else {
+ control->stop_touch(false, control->session().transport_frame());
}
}
void
-LV2PluginUI::parameter_update(uint32_t port_index, float val)
+LV2PluginUI::update_timeout()
{
- if (!_inst) {
- return;
- }
+ _lv2->emit_to_ui(this, &LV2PluginUI::write_to_ui);
+}
-#ifdef HAVE_NEW_SLV2
- slv2_ui_instance_port_event(_inst, port_index, 4, 0, &val);
-#else
- const LV2UI_Descriptor* ui_desc = slv2_ui_instance_get_descriptor(_inst);
- LV2UI_Handle ui_handle = slv2_ui_instance_get_handle(_inst);
- if (ui_desc->port_event) {
- ui_desc->port_event(ui_handle, port_index, 4, 0, &val);
+void
+LV2PluginUI::on_external_ui_closed(void* controller)
+{
+ //printf("LV2PluginUI::on_external_ui_closed\n");
+ LV2PluginUI* me = (LV2PluginUI*)controller;
+ me->_screen_update_connection.disconnect();
+ me->_external_ui_ptr = NULL;
+}
+
+void
+LV2PluginUI::control_changed (uint32_t port_index)
+{
+ /* Must run in GUI thread because we modify _updates with no lock */
+ if (_lv2->get_parameter (port_index) != _values_last_sent_to_ui[port_index]) {
+ /* current plugin parameter does not match last value received
+ from GUI, so queue an update to push it to the GUI during
+ our regular timeout.
+ */
+ _updates.insert (port_index);
}
-#endif
- _values[port_index] = val;
}
bool
LV2PluginUI::start_updating(GdkEventAny*)
{
- if (!_output_ports.empty()) {
- _screen_update_connection.disconnect();
- _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
- (sigc::mem_fun(*this, &LV2PluginUI::output_update));
- }
+ _screen_update_connection.disconnect();
+ _screen_update_connection = Timers::super_rapid_connect
+ (sigc::mem_fun(*this, &LV2PluginUI::output_update));
return false;
}
LV2PluginUI::stop_updating(GdkEventAny*)
{
//cout << "stop_updating" << endl;
+ _screen_update_connection.disconnect();
+ return false;
+}
- if ( //!_external_ui_ptr &&
- !_output_ports.empty()) {
- _screen_update_connection.disconnect();
+void
+LV2PluginUI::queue_port_update()
+{
+ const uint32_t num_ports = _lv2->num_ports();
+ for (uint32_t i = 0; i < num_ports; ++i) {
+ bool ok;
+ uint32_t port = _lv2->nth_parameter(i, ok);
+ if (ok) {
+ _updates.insert (port);
+ }
}
- return false;
}
void
//cout << "output_update" << endl;
if (_external_ui_ptr) {
LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
+ if (_lv2->is_external_kx() && !_external_ui_ptr) {
+ // clean up external UI if it closes itself via
+ // on_external_ui_closed() during run()
+ //printf("LV2PluginUI::output_update -- UI was closed\n");
+ //_screen_update_connection.disconnect();
+ _message_update_connection.disconnect();
+ if (_inst) {
+ suil_instance_free((SuilInstance*)_inst);
+ }
+ _inst = NULL;
+ _external_ui_ptr = NULL;
+ return;
+ }
}
- /* FIXME only works with control output ports (which is all we support now anyway) */
+ if (!_inst) {
+ return;
+ }
+
+ /* output ports (values set by DSP) need propagating to GUI */
+
uint32_t nports = _output_ports.size();
for (uint32_t i = 0; i < nports; ++i) {
uint32_t index = _output_ports[i];
- parameter_changed(index, _lv2->get_parameter(index));
+ float val = _lv2->get_parameter (index);
+
+ if (val != _values_last_sent_to_ui[index]) {
+ /* Send to GUI */
+ suil_instance_port_event ((SuilInstance*)_inst, index, 4, 0, &val);
+ /* Cache current value */
+ _values_last_sent_to_ui[index] = val;
+ }
+ }
+
+ /* Input ports marked for update because the control value changed
+ since the last redisplay.
+ */
+
+ for (Updates::iterator i = _updates.begin(); i != _updates.end(); ++i) {
+ float val = _lv2->get_parameter (*i);
+ /* push current value to the GUI */
+ suil_instance_port_event ((SuilInstance*)_inst, (*i), 4, 0, &val);
+ _values_last_sent_to_ui[(*i)] = val;
}
+ _updates.clear ();
}
LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
boost::shared_ptr<LV2Plugin> lv2p)
: PlugUIBase(pi)
+ , _pi(pi)
, _lv2(lv2p)
- , _inst(NULL)
- , _values(NULL)
+ , _gui_widget(NULL)
+ , _values_last_sent_to_ui(NULL)
, _external_ui_ptr(NULL)
+ , _inst(NULL)
{
- if (!_lv2->is_external_ui()) {
- lv2ui_instantiate("gtk2gui");
- }
+ _ardour_buttons_box.set_spacing (6);
+ _ardour_buttons_box.set_border_width (6);
+ _ardour_buttons_box.pack_end (focus_button, false, false);
+ _ardour_buttons_box.pack_end (bypass_button, false, false, 4);
+ _ardour_buttons_box.pack_end (reset_button, false, false, 4);
+ _ardour_buttons_box.pack_end (delete_button, false, false);
+ _ardour_buttons_box.pack_end (save_button, false, false);
+ _ardour_buttons_box.pack_end (add_button, false, false);
+ _ardour_buttons_box.pack_end (_preset_combo, false, false);
+ _ardour_buttons_box.pack_end (_preset_modified, false, false);
+ _ardour_buttons_box.pack_end (pin_management_button, false, false);
+
+ plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&LV2PluginUI::queue_port_update, this), gui_context ());
}
void
LV2PluginUI::lv2ui_instantiate(const std::string& title)
{
- LV2_Feature** features;
- LV2_Feature** features_src;
- LV2_Feature** features_dst;
- size_t features_count;
- bool is_external_ui;
-
- is_external_ui = _lv2->is_external_ui();
+ bool is_external_ui = _lv2->is_external_ui();
+ LV2_Feature** features_src = const_cast<LV2_Feature**>(_lv2->features());
+ LV2_Feature** features = const_cast<LV2_Feature**>(_lv2->features());
+ size_t features_count = 0;
+ while (*features++) {
+ features_count++;
+ }
+ Gtk::Alignment* container = NULL;
if (is_external_ui) {
_external_ui_host.ui_closed = LV2PluginUI::on_external_ui_closed;
_external_ui_host.plugin_human_id = strdup(title.c_str());
_external_ui_feature.URI = LV2_EXTERNAL_UI_URI;
_external_ui_feature.data = &_external_ui_host;
- features_src = features = (LV2_Feature**)_lv2->features();
- features_count = 2;
- while (*features++) {
- features_count++;
- }
- features_dst = features = (LV2_Feature**)malloc(
- sizeof(LV2_Feature*) * features_count);
- features_dst[--features_count] = NULL;
- features_dst[--features_count] = &_external_ui_feature;
- while (features_count--) {
- *features++ = *features_src++;
+ _external_kxui_feature.URI = LV2_EXTERNAL_UI_KX__Host;
+ _external_kxui_feature.data = &_external_ui_host;
+
+ ++features_count;
+ features = (LV2_Feature**)malloc(
+ sizeof(LV2_Feature*) * (features_count + 2));
+ for (size_t i = 0; i < features_count - 2; ++i) {
+ features[i] = features_src[i];
}
+ features[features_count - 2] = &_external_kxui_feature;
+ features[features_count - 1] = &_external_ui_feature;
+ features[features_count] = NULL;
} else {
- features_dst = (LV2_Feature**)_lv2->features();
+ if (_ardour_buttons_box.get_parent()) {
+ _ardour_buttons_box.get_parent()->remove(_ardour_buttons_box);
+ }
+ pack_start(_ardour_buttons_box, false, false);
+ _ardour_buttons_box.show_all();
+
+ _gui_widget = Gtk::manage((container = new Gtk::Alignment()));
+ pack_start(*_gui_widget, true, true);
+ _gui_widget->show();
+
+ _parent_feature.URI = LV2_UI__parent;
+ _parent_feature.data = _gui_widget->gobj();
+
+ ++features_count;
+ features = (LV2_Feature**)malloc(
+ sizeof(LV2_Feature*) * (features_count + 1));
+ for (size_t i = 0; i < features_count - 1; ++i) {
+ features[i] = features_src[i];
+ }
+ features[features_count - 1] = &_parent_feature;
+ features[features_count] = NULL;
}
-#ifdef HAVE_NEW_SLV2
- if (!LV2PluginUI::ui_host) {
- LV2PluginUI::ui_host = slv2_ui_host_new(
- LV2PluginUI::lv2_ui_write, NULL, NULL, NULL);
+ if (!ui_host) {
+ ui_host = suil_host_new(LV2PluginUI::write_from_ui,
+ LV2PluginUI::port_index,
+ NULL, NULL);
+ suil_host_set_touch_func(ui_host, LV2PluginUI::touch);
}
- SLV2Value gtk_ui = slv2_value_new_uri(
- ARDOUR::PluginManager::the_manager()->lv2_world()->world,
- "http://lv2plug.in/ns/extensions/ui#GtkUI");
- _inst = slv2_ui_instance_new(
- _lv2->slv2_plugin(), _lv2->slv2_ui(), gtk_ui, ui_host, this, features_dst);
- slv2_value_free(gtk_ui);
- slv2_ui_host_free(ui_host);
+ const char* container_type = (is_external_ui)
+ ? NS_UI "external"
+ : NS_UI "GtkUI";
+
+ if (_lv2->has_message_output()) {
+ _lv2->enable_ui_emission();
+ }
+
+ const LilvUI* ui = (const LilvUI*)_lv2->c_ui();
+ const LilvNode* bundle = lilv_ui_get_bundle_uri(ui);
+ const LilvNode* binary = lilv_ui_get_binary_uri(ui);
+#ifdef HAVE_LILV_0_21_3
+ char* ui_bundle_path = lilv_file_uri_parse(lilv_node_as_uri(bundle), NULL);
+ char* ui_binary_path = lilv_file_uri_parse(lilv_node_as_uri(binary), NULL);
#else
- _inst = slv2_ui_instantiate(
- _lv2->slv2_plugin(), _lv2->slv2_ui(), LV2PluginUI::lv2_ui_write, this,
- features_dst);
+ char* ui_bundle_path = strdup(lilv_uri_to_path(lilv_node_as_uri(bundle)));
+ char* ui_binary_path = strdup(lilv_uri_to_path(lilv_node_as_uri(binary)));
#endif
+ if (!ui_bundle_path || !ui_binary_path) {
+ error << _("failed to get path for UI bindle or binary") << endmsg;
+ free(ui_bundle_path);
+ free(ui_binary_path);
+ free(features);
+ return;
+ }
- if (is_external_ui) {
- free(features_dst);
+ _inst = suil_instance_new(
+ ui_host,
+ this,
+ container_type,
+ _lv2->uri(),
+ lilv_node_as_uri(lilv_ui_get_uri(ui)),
+ lilv_node_as_uri((const LilvNode*)_lv2->c_ui_type()),
+ ui_bundle_path,
+ ui_binary_path,
+ features);
+
+ free(ui_bundle_path);
+ free(ui_binary_path);
+ free(features);
+
+ if (!_inst) {
+ error << _("failed to instantiate LV2 GUI") << endmsg;
+ return;
}
- uint32_t num_ports = slv2_plugin_get_num_ports(_lv2->slv2_plugin());
+#define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
+
+ const uint32_t num_ports = _lv2->num_ports();
for (uint32_t i = 0; i < num_ports; ++i) {
if (_lv2->parameter_is_output(i)
&& _lv2->parameter_is_control(i)
}
_external_ui_ptr = NULL;
- if (_inst) {
- if (!is_external_ui) {
- GtkWidget* c_widget = (GtkWidget*)slv2_ui_instance_get_widget(_inst);
- _gui_widget = Glib::wrap(c_widget);
- _gui_widget->show_all();
- pack_start(*_gui_widget, true, true);
- } else {
- _external_ui_ptr = (struct lv2_external_ui*)slv2_ui_instance_get_widget(_inst);
+ if (!is_external_ui) {
+ GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
+ if (!c_widget) {
+ error << _("failed to get LV2 UI widget") << endmsg;
+ suil_instance_free((SuilInstance*)_inst);
+ _inst = NULL;
+ return;
+ }
+ if (!container->get_child()) {
+ // Suil didn't add the UI to the container for us, so do it now
+ container->add(*Gtk::manage(Glib::wrap(c_widget)));
}
+ container->show_all();
+ gtk_widget_set_can_focus(c_widget, true);
+ gtk_widget_grab_focus(c_widget);
+ } else {
+ _external_ui_ptr = (struct lv2_external_ui*)GET_WIDGET(_inst);
}
- _values = new float[num_ports];
+ _values_last_sent_to_ui = new float[num_ports];
_controllables.resize(num_ports);
+
for (uint32_t i = 0; i < num_ports; ++i) {
bool ok;
uint32_t port = _lv2->nth_parameter(i, ok);
if (ok) {
- _values[port] = _lv2->get_parameter(port);
+ /* Cache initial value of the parameter, regardless of
+ whether it is input or output
+ */
+
+ _values_last_sent_to_ui[port] = _lv2->get_parameter(port);
_controllables[port] = boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (
insert->control(Evoral::Parameter(PluginAutomation, 0, port)));
if (_lv2->parameter_is_control(port) && _lv2->parameter_is_input(port)) {
- parameter_update(port, _values[port]);
+ if (_controllables[port]) {
+ _controllables[port]->Changed.connect (control_connections, invalidator (*this), boost::bind (&LV2PluginUI::control_changed, this, port), gui_context());
+ }
}
+
+ /* queue for first update ("push") to GUI */
+ _updates.insert (port);
}
}
+
+ if (_lv2->has_message_output()) {
+ _message_update_connection = Timers::super_rapid_connect (
+ sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
+ }
}
-LV2PluginUI::~LV2PluginUI ()
+void
+LV2PluginUI::grab_focus()
{
- //cout << "LV2PluginUI destructor called" << endl;
-
- if (_values) {
- delete[] _values;
+ if (_inst && !_lv2->is_external_ui()) {
+ GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
+ gtk_widget_grab_focus(c_widget);
}
+}
- /* Close and delete GUI. */
-#ifdef HAVE_NEW_SLV2
- slv2_ui_instance_free(_inst);
-#else
- const LV2UI_Descriptor* ui_desc = slv2_ui_instance_get_descriptor(_inst);
- LV2UI_Handle ui_handle = slv2_ui_instance_get_handle(_inst);
+void
+LV2PluginUI::lv2ui_free()
+{
+ stop_updating (0);
- if (ui_desc) {
- ui_desc->cleanup(ui_handle);
+ if (_gui_widget) {
+ remove (*_gui_widget);
+ _gui_widget = NULL;
}
-#endif
+ if (_inst) {
+ suil_instance_free((SuilInstance*)_inst);
+ _inst = NULL;
+ }
+}
+
+LV2PluginUI::~LV2PluginUI ()
+{
+ delete [] _values_last_sent_to_ui;
+
+ _message_update_connection.disconnect();
_screen_update_connection.disconnect();
- if (_lv2->is_external_ui()) {
- /* External UI is no longer valid.
- on_window_hide() will not try to use it if is NULL.
- */
- _external_ui_ptr = NULL;
+ if (_external_ui_ptr && _lv2->is_external_kx()) {
+ LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
}
+ lv2ui_free();
+ _external_ui_ptr = NULL;
}
int
return r.width;
}
+bool
+LV2PluginUI::resizable()
+{
+ return _lv2->ui_is_resizable();
+}
+
int
LV2PluginUI::package(Gtk::Window& win)
{
if (_lv2->is_external_ui()) {
if (_external_ui_ptr) {
+ _screen_update_connection.disconnect();
+ _message_update_connection.disconnect();
LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
+ _screen_update_connection = Timers::super_rapid_connect
+ (sigc::mem_fun(*this, &LV2PluginUI::output_update));
+ if (_lv2->has_message_output()) {
+ _message_update_connection = Timers::super_rapid_connect (
+ sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
+ }
return false;
}
lv2ui_instantiate(title);
return false;
}
- LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
_screen_update_connection.disconnect();
- _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
- (sigc::mem_fun(*this, &LV2PluginUI::output_update));
+ _message_update_connection.disconnect();
+ LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
+ _screen_update_connection = Timers::super_rapid_connect
+ (sigc::mem_fun(*this, &LV2PluginUI::output_update));
+ if (_lv2->has_message_output()) {
+ _message_update_connection = Timers::super_rapid_connect (
+ sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
+ }
return false;
+ } else {
+ lv2ui_instantiate("gtk2gui");
}
- return true;
+ return _inst ? true : false;
}
void
LV2PluginUI::on_window_hide()
{
- //cout << "on_window_hide" << endl; flush(cout);
+ //printf("LV2PluginUI::on_window_hide\n");
- if (_external_ui_ptr) {
+ if (_lv2->is_external_ui()) {
+ if (!_external_ui_ptr) { return; }
LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
- //slv2_ui_instance_get_descriptor(_inst)->cleanup(_inst);
- //_external_ui_ptr = NULL;
- //_screen_update_connection.disconnect();
+ if (!_lv2->is_external_kx()) { return ; }
+ _message_update_connection.disconnect();
+ _screen_update_connection.disconnect();
+ _external_ui_ptr = NULL;
+ suil_instance_free((SuilInstance*)_inst);
+ _inst = NULL;
+ } else {
+ lv2ui_free();
}
}