/*
- Copyright (C) 2008-2012 Paul Davis
- Author: David Robillard
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- 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.
-*/
+ * Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2008-2018 David Robillard <d@drobilla.net>
+ * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2012-2018 Robin Gareus <robin@gareus.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <gtkmm/stock.h>
#include "ardour/lv2_plugin.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 "gtkmm2ext/utils.h"
#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
#include <lilv/lilv.h>
#include <suil/suil.h>
-#include "i18n.h"
+#include "pbd/i18n.h"
using namespace ARDOUR;
using namespace Gtk;
}
boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
+
+ me->_updates.insert (port_index);
+
if (ac) {
- ac->set_value(*(const float*)buffer);
+ ac->set_value(*(const float*)buffer, Controllable::NoGroup);
}
- } else if (format == me->_lv2->urids.atom_eventTransfer) {
+ } else if (format == URIMap::instance().urids.atom_eventTransfer) {
const int cnt = me->_pi->get_count();
for (int i=0; i < cnt; i++ ) {
if (port_index >= me->_controllables.size()) {
return;
}
+ if (!me->_lv2->parameter_is_control(port_index) || !me->_lv2->parameter_is_input(port_index)) {
+ return;
+ }
ControllableRef control = me->_controllables[port_index];
if (grabbed) {
- control->start_touch(control->session().transport_frame());
+ control->start_touch(control->session().transport_sample());
} else {
- control->stop_touch(false, control->session().transport_frame());
+ control->stop_touch(control->session().transport_sample());
}
}
+void
+LV2PluginUI::set_path_property (int response,
+ const ParameterDescriptor& desc,
+ Gtk::FileChooserDialog* widget)
+{
+ if (response == Gtk::RESPONSE_ACCEPT) {
+ plugin->set_property (desc.key, Variant (Variant::PATH, widget->get_filename()));
+ }
+#if 0
+ widget->hide ();
+ delete_when_idle (widget);
+#else
+ delete widget;
+#endif
+ active_parameter_requests.erase (desc.key);
+}
+
+uint32_t
+LV2PluginUI::request_parameter (void* handle, LV2_URID key)
+{
+ LV2PluginUI* me = (LV2PluginUI*)handle;
+
+ /* This will return `PropertyDescriptors nothing` when not found */
+ const ParameterDescriptor& desc (me->_lv2->get_property_descriptor(key));
+ if (desc.datatype != Variant::PATH) {
+ return 0;
+ }
+
+ if (me->active_parameter_requests.find (key) != me->active_parameter_requests.end()) {
+ return 0; /* already showing dialog */
+ }
+ me->active_parameter_requests.insert (key);
+
+ Gtk::FileChooserDialog* lv2ui_file_dialog = new Gtk::FileChooserDialog(desc.label, FILE_CHOOSER_ACTION_OPEN);
+ Gtkmm2ext::add_volume_shortcuts (*lv2ui_file_dialog);
+ lv2ui_file_dialog->add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
+ lv2ui_file_dialog->add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
+ lv2ui_file_dialog->set_default_response(Gtk::RESPONSE_ACCEPT);
+
+ /* this assumes announce_property_values() was called, or
+ * the plugin has previously sent a patch:Set */
+ const Variant& value = me->_lv2->get_property_value (desc.key);
+ if (value.type() == Variant::PATH) {
+ lv2ui_file_dialog->set_filename (value.get_path());
+ }
+
+#if 0 // TODO mime-type, file-extension filter, get from LV2 Parameter Property
+ FileFilter file_ext_filter;
+ file_ext_filter.add_pattern ("*.foo");
+ file_ext_filter.set_name ("Foo File");
+ lv2ui_file_dialog.add_filter (file_ext_filter);
+#endif
+
+ lv2ui_file_dialog->signal_response().connect (sigc::bind (sigc::mem_fun (*me, &LV2PluginUI::set_path_property), desc, lv2ui_file_dialog));
+ lv2ui_file_dialog->present();
+ return 0;
+}
+
void
LV2PluginUI::update_timeout()
{
//printf("LV2PluginUI::on_external_ui_closed\n");
LV2PluginUI* me = (LV2PluginUI*)controller;
me->_screen_update_connection.disconnect();
- if (me->_lv2->is_external_kx() /* called from plugin's UI_RUN() */) {
- // plugin is free()d in parent function - LV2PluginUI::output_update()
- me->_external_ui_ptr = NULL;
- }
-}
-
-void
-LV2PluginUI::parameter_changed(uint32_t port_index, float val)
-{
- PlugUIBase::parameter_changed(port_index, val);
-
- if (val != _values[port_index]) {
- parameter_update(port_index, val);
- }
+ me->_external_ui_ptr = NULL;
}
void
-LV2PluginUI::parameter_update(uint32_t port_index, float val)
+LV2PluginUI::control_changed (uint32_t port_index)
{
- if (!_inst) {
- return;
+ /* 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);
}
-
- suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
- _values[port_index] = val;
}
bool
LV2PluginUI::start_updating(GdkEventAny*)
{
- if (!_output_ports.empty()) {
- _screen_update_connection.disconnect();
- _screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.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 (!_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
// 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();
+ //_screen_update_connection.disconnect();
_message_update_connection.disconnect();
if (_inst) {
suil_instance_free((SuilInstance*)_inst);
}
}
- /* 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,
, _pi(pi)
, _lv2(lv2p)
, _gui_widget(NULL)
- , _values(NULL)
+ , _values_last_sent_to_ui(NULL)
, _external_ui_ptr(NULL)
, _inst(NULL)
{
_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, 10);
+ _ardour_buttons_box.pack_end (bypass_button, false, false, 4);
+ if (pi->controls().size() > 0) {
+ _ardour_buttons_box.pack_end (reset_button, false, false, 4);
+ }
+ if (has_descriptive_presets ()) {
+ _ardour_buttons_box.pack_end (preset_browser_button, false, false);
+ }
_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
LV2_Feature** features = const_cast<LV2_Feature**>(_lv2->features());
size_t features_count = 0;
while (*features++) {
- features_count++;
+ ++features_count;
}
+ if (is_external_ui) {
+ features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * (features_count + 4));
+ } else {
+ features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * (features_count + 3));
+ }
+
+ size_t fi = 0;
+ for (; fi < features_count; ++fi) {
+ features[fi] = features_src[fi];
+ }
+
+ _lv2ui_request_paramater.handle = this;
+ _lv2ui_request_paramater.request = LV2PluginUI::request_parameter;
+ _lv2ui_request_feature.URI = LV2_UI_PREFIX "requestParameter";
+ _lv2ui_request_feature.data = &_lv2ui_request_paramater;
+
+ features[fi++] = &_lv2ui_request_feature;
+
Gtk::Alignment* container = NULL;
if (is_external_ui) {
_external_ui_host.ui_closed = LV2PluginUI::on_external_ui_closed;
_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;
+ features[fi++] = &_external_kxui_feature;
+ features[fi++] = &_external_ui_feature;
} else {
if (_ardour_buttons_box.get_parent()) {
_ardour_buttons_box.get_parent()->remove(_ardour_buttons_box);
_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;
+ features[fi++] = &_parent_feature;
}
+ features[fi] = NULL;
+ assert (fi == features_count + (is_external_ui ? 3 : 2));
+
if (!ui_host) {
ui_host = suil_host_new(LV2PluginUI::write_from_ui,
LV2PluginUI::port_index,
: NS_UI "GtkUI";
if (_lv2->has_message_output()) {
- _lv2->enable_ui_emmission();
+ _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);
+ 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);
+ 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;
}
- const LilvUI* ui = (const LilvUI*)_lv2->c_ui();
_inst = suil_instance_new(
ui_host,
this,
_lv2->uri(),
lilv_node_as_uri(lilv_ui_get_uri(ui)),
lilv_node_as_uri((const LilvNode*)_lv2->c_ui_type()),
- lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_bundle_uri(ui))),
- lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_binary_uri(ui))),
+ 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;
+ }
+
#define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
const uint32_t num_ports = _lv2->num_ports();
}
_external_ui_ptr = NULL;
- if (_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();
- } else {
- _external_ui_ptr = (struct lv2_external_ui*)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 = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect(
+ _message_update_connection = Timers::super_rapid_connect (
sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
}
}
+void
+LV2PluginUI::grab_focus()
+{
+ if (_inst && !_lv2->is_external_ui()) {
+ GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
+ gtk_widget_grab_focus(c_widget);
+ }
+}
+
void
LV2PluginUI::lv2ui_free()
{
LV2PluginUI::~LV2PluginUI ()
{
- if (_values) {
- delete[] _values;
- }
+ delete [] _values_last_sent_to_ui;
+
+ _message_update_connection.disconnect();
+ _screen_update_connection.disconnect();
- on_window_hide();
+ if (_external_ui_ptr && _lv2->is_external_kx()) {
+ LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
+ }
+ lv2ui_free();
+ _external_ui_ptr = NULL;
}
int
int
LV2PluginUI::package(Gtk::Window& win)
{
- if (_external_ui_ptr) {
- _win_ptr = &win;
- } else {
+ if (!_external_ui_ptr) {
/* forward configure events to plugin window */
win.signal_configure_event().connect(
sigc::mem_fun(*this, &LV2PluginUI::configure_handler));
_screen_update_connection.disconnect();
_message_update_connection.disconnect();
LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
- _screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
+ _screen_update_connection = Timers::super_rapid_connect
(sigc::mem_fun(*this, &LV2PluginUI::output_update));
if (_lv2->has_message_output()) {
- _message_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect(
+ _message_update_connection = Timers::super_rapid_connect (
sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
}
return false;
_screen_update_connection.disconnect();
_message_update_connection.disconnect();
LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
- _screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
+ _screen_update_connection = Timers::super_rapid_connect
(sigc::mem_fun(*this, &LV2PluginUI::output_update));
if (_lv2->has_message_output()) {
- _message_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect(
+ _message_update_connection = Timers::super_rapid_connect (
sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
}
return false;
lv2ui_instantiate("gtk2gui");
}
- return true;
+ return _inst ? true : false;
}
void
LV2PluginUI::on_window_hide()
{
//printf("LV2PluginUI::on_window_hide\n");
- _message_update_connection.disconnect();
if (_lv2->is_external_ui()) {
if (!_external_ui_ptr) { return; }
- _screen_update_connection.disconnect();
LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
+ 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;