Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
+#include <gtkmm/stock.h>
+
#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 "gtkmm2ext/utils.h"
-#include "lv2_ui.h"
+#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
#include <lilv/lilv.h>
#include <suil/suil.h>
+#include "pbd/i18n.h"
+
using namespace ARDOUR;
using namespace Gtk;
using namespace PBD;
}
boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
+
+ me->_updates.insert (port_index);
+
if (ac) {
- ac->set_value(*(float*)buffer);
+ 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);
}
- } else if (format == me->_lv2->atom_eventTransfer()) {
- me->_lv2->write_from_ui(port_index, format, buffer_size, (uint8_t*)buffer);
}
}
const void* buffer)
{
LV2PluginUI* me = (LV2PluginUI*)controller;
- suil_instance_port_event((SuilInstance*)me->_inst,
- port_index, buffer_size, format, buffer);
+ if (me->_inst) {
+ suil_instance_port_event((SuilInstance*)me->_inst,
+ port_index, buffer_size, format, buffer);
+ }
}
-void
-LV2PluginUI::update_timeout()
+uint32_t
+LV2PluginUI::port_index(void* controller, const char* symbol)
{
- _lv2->emit_to_ui(this, &LV2PluginUI::write_to_ui);
+ return ((LV2PluginUI*)controller)->_lv2->port_index(symbol);
}
void
-LV2PluginUI::on_external_ui_closed(void* controller)
+LV2PluginUI::touch(void* controller,
+ uint32_t port_index,
+ bool grabbed)
{
LV2PluginUI* me = (LV2PluginUI*)controller;
- me->_screen_update_connection.disconnect();
- me->_external_ui_ptr = NULL;
+ 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_sample());
+ } else {
+ control->stop_touch(control->session().transport_sample());
+ }
}
void
-LV2PluginUI::parameter_changed(uint32_t port_index, float val)
+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)
{
- PlugUIBase::parameter_changed(port_index, val);
+ LV2PluginUI* me = (LV2PluginUI*)handle;
- if (val != _values[port_index]) {
- parameter_update(port_index, val);
+ /* 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 0 // MODAL, blocking
+
+ Gtk::FileChooserDialog* lv2ui_file_dialog (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);
+ if (_file_dialog.run()= Gtk::RESPONSE_ACCEPT) {
+ me->plugin->set_property (desc.key, Variant(Variant::PATH, lv2ui_file_dialog.get_filename()));
+ }
+ return 0;
+
+#else
+
+ 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;
+
+#endif
+}
+
+void
+LV2PluginUI::update_timeout()
+{
+ _lv2->emit_to_ui(this, &LV2PluginUI::write_to_ui);
}
void
-LV2PluginUI::parameter_update(uint32_t port_index, float val)
+LV2PluginUI::on_external_ui_closed(void* controller)
{
- if (!_inst) {
- return;
- }
+ //printf("LV2PluginUI::on_external_ui_closed\n");
+ LV2PluginUI* me = (LV2PluginUI*)controller;
+ me->_screen_update_connection.disconnect();
+ me->_external_ui_ptr = NULL;
+}
- suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
- _values[port_index] = val;
+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);
+ }
}
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 (!_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;
+ }
+ }
+
+ if (!_inst) {
+ return;
}
- /* FIXME only works with control output ports (which is all we support now anyway) */
+ /* 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)
, _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, 4);
+ if (pi->controls().size() > 0) {
+ _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;
+ 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;
+ }
+
+ 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;
- is_external_ui = _lv2->is_external_ui();
+ features[fi++] = &_lv2ui_request_feature;
+ 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[fi++] = &_external_kxui_feature;
+ features[fi++] = &_external_ui_feature;
} 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[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, NULL, NULL, NULL);
+ ui_host = suil_host_new(LV2PluginUI::write_from_ui,
+ LV2PluginUI::port_index,
+ NULL, NULL);
+ suil_host_set_touch_func(ui_host, LV2PluginUI::touch);
}
const char* container_type = (is_external_ui)
? NS_UI "external"
: NS_UI "GtkUI";
- LilvUI* ui = (LilvUI*)_lv2->c_ui();
+ 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
+ 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;
+ }
+
_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))),
- features_dst);
+ ui_bundle_path,
+ ui_binary_path,
+ features);
- if (is_external_ui) {
- free(features_dst);
+ 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);
}
_external_ui_ptr = NULL;
- if (_inst) {
- if (!is_external_ui) {
- Gtk::HBox* box = manage (new Gtk::HBox);
- box->set_spacing (6);
- box->set_border_width (6);
- box->pack_end (focus_button, false, false);
- box->pack_end (bypass_button, false, false, 10);
- box->pack_end (delete_button, false, false);
- box->pack_end (save_button, false, false);
- box->pack_end (add_button, false, false);
- box->pack_end (_preset_combo, false, false);
- box->show_all();
- pack_start(*box, false, false);
-
- GtkWidget* c_widget = (GtkWidget*)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*)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()) {
- _lv2->enable_ui_emmission();
- ARDOUR_UI::instance()->RapidScreenUpdate.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()
{
if (_gui_widget) {
remove (*_gui_widget);
+ _gui_widget = NULL;
}
- suil_instance_free((SuilInstance*)_inst);
-
- _inst = NULL;
- _gui_widget = NULL;
+ if (_inst) {
+ suil_instance_free((SuilInstance*)_inst);
+ _inst = NULL;
+ }
}
LV2PluginUI::~LV2PluginUI ()
{
- if (_values) {
- delete[] _values;
- }
-
- /* Close and delete GUI. */
- lv2ui_free();
+ 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();
}
projects / ardour.git / blobdiff