2 Copyright (C) 2008-2012 Paul Davis
3 Author: David Robillard
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "ardour/lv2_plugin.h"
21 #include "ardour/plugin_manager.h"
22 #include "ardour/processor.h"
24 #include "ardour_ui.h"
25 #include "gui_thread.h"
26 #include "lv2_plugin_ui.h"
30 #include <lilv/lilv.h>
31 #include <suil/suil.h>
33 using namespace ARDOUR;
37 #define NS_UI "http://lv2plug.in/ns/extensions/ui#"
39 static SuilHost* ui_host = NULL;
42 LV2PluginUI::write_from_ui(void* controller,
48 LV2PluginUI* me = (LV2PluginUI*)controller;
50 if (port_index >= me->_controllables.size()) {
54 boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
56 ac->set_value(*(float*)buffer);
58 } else if (format == me->_lv2->atom_eventTransfer()) {
59 me->_lv2->write_from_ui(port_index, format, buffer_size, (uint8_t*)buffer);
64 LV2PluginUI::write_to_ui(void* controller,
70 LV2PluginUI* me = (LV2PluginUI*)controller;
71 fprintf(stderr, "MESSAGE FROM PLUGIN %u BYTES\n", buffer_size);
72 suil_instance_port_event((SuilInstance*)me->_inst,
73 port_index, buffer_size, format, buffer);
77 LV2PluginUI::update_timeout()
79 _lv2->emit_to_ui(this, &LV2PluginUI::write_to_ui);
83 LV2PluginUI::on_external_ui_closed(void* controller)
85 LV2PluginUI* me = (LV2PluginUI*)controller;
86 me->_screen_update_connection.disconnect();
87 me->_external_ui_ptr = NULL;
91 LV2PluginUI::parameter_changed(uint32_t port_index, float val)
93 PlugUIBase::parameter_changed(port_index, val);
95 if (val != _values[port_index]) {
96 parameter_update(port_index, val);
101 LV2PluginUI::parameter_update(uint32_t port_index, float val)
107 suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
108 _values[port_index] = val;
112 LV2PluginUI::start_updating(GdkEventAny*)
114 if (!_output_ports.empty()) {
115 _screen_update_connection.disconnect();
116 _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
117 (sigc::mem_fun(*this, &LV2PluginUI::output_update));
123 LV2PluginUI::stop_updating(GdkEventAny*)
125 //cout << "stop_updating" << endl;
127 if (!_output_ports.empty()) {
128 _screen_update_connection.disconnect();
134 LV2PluginUI::output_update()
136 //cout << "output_update" << endl;
137 if (_external_ui_ptr) {
138 LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
141 /* FIXME only works with control output ports (which is all we support now anyway) */
142 uint32_t nports = _output_ports.size();
143 for (uint32_t i = 0; i < nports; ++i) {
144 uint32_t index = _output_ports[i];
145 parameter_changed(index, _lv2->get_parameter(index));
150 LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
151 boost::shared_ptr<LV2Plugin> lv2p)
156 , _external_ui_ptr(NULL)
162 LV2PluginUI::lv2ui_instantiate(const std::string& title)
164 LV2_Feature** features;
165 LV2_Feature** features_src;
166 LV2_Feature** features_dst;
167 size_t features_count;
170 is_external_ui = _lv2->is_external_ui();
172 if (is_external_ui) {
173 _external_ui_host.ui_closed = LV2PluginUI::on_external_ui_closed;
174 _external_ui_host.plugin_human_id = strdup(title.c_str());
176 _external_ui_feature.URI = LV2_EXTERNAL_UI_URI;
177 _external_ui_feature.data = &_external_ui_host;
179 features_src = features = (LV2_Feature**)_lv2->features();
181 while (*features++) {
184 features_dst = features = (LV2_Feature**)malloc(
185 sizeof(LV2_Feature*) * features_count);
186 features_dst[--features_count] = NULL;
187 features_dst[--features_count] = &_external_ui_feature;
188 while (features_count--) {
189 *features++ = *features_src++;
192 features_dst = (LV2_Feature**)_lv2->features();
196 ui_host = suil_host_new(LV2PluginUI::write_from_ui, NULL, NULL, NULL);
198 const char* container_type = (is_external_ui)
202 LilvUI* ui = (LilvUI*)_lv2->c_ui();
203 _inst = suil_instance_new(
208 lilv_node_as_uri(lilv_ui_get_uri(ui)),
209 lilv_node_as_uri((const LilvNode*)_lv2->c_ui_type()),
210 lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_bundle_uri(ui))),
211 lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_binary_uri(ui))),
214 if (is_external_ui) {
218 #define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
220 const uint32_t num_ports = _lv2->num_ports();
221 for (uint32_t i = 0; i < num_ports; ++i) {
222 if (_lv2->parameter_is_output(i)
223 && _lv2->parameter_is_control(i)
224 && is_update_wanted(i)) {
225 _output_ports.push_back(i);
229 _external_ui_ptr = NULL;
231 if (!is_external_ui) {
232 Gtk::HBox* box = manage (new Gtk::HBox);
233 box->set_spacing (6);
234 box->set_border_width (6);
235 box->pack_end (focus_button, false, false);
236 box->pack_end (bypass_button, false, false, 10);
237 box->pack_end (delete_button, false, false);
238 box->pack_end (save_button, false, false);
239 box->pack_end (add_button, false, false);
240 box->pack_end (_preset_combo, false, false);
242 pack_start(*box, false, false);
244 GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
245 _gui_widget = Glib::wrap(c_widget);
246 _gui_widget->show_all();
247 pack_start(*_gui_widget, true, true);
249 _external_ui_ptr = (struct lv2_external_ui*)GET_WIDGET(_inst);
253 _values = new float[num_ports];
254 _controllables.resize(num_ports);
255 for (uint32_t i = 0; i < num_ports; ++i) {
257 uint32_t port = _lv2->nth_parameter(i, ok);
259 _values[port] = _lv2->get_parameter(port);
260 _controllables[port] = boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (
261 insert->control(Evoral::Parameter(PluginAutomation, 0, port)));
263 if (_lv2->parameter_is_control(port) && _lv2->parameter_is_input(port)) {
264 parameter_update(port, _values[port]);
269 if (_lv2->has_message_output()) {
270 ARDOUR_UI::instance()->RapidScreenUpdate.connect(
271 sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
276 LV2PluginUI::lv2ui_free()
281 remove (*_gui_widget);
284 suil_instance_free((SuilInstance*)_inst);
290 LV2PluginUI::~LV2PluginUI ()
296 /* Close and delete GUI. */
299 _screen_update_connection.disconnect();
301 if (_lv2->is_external_ui()) {
302 /* External UI is no longer valid.
303 on_window_hide() will not try to use it if is NULL.
305 _external_ui_ptr = NULL;
310 LV2PluginUI::get_preferred_height()
312 Gtk::Requisition r = size_request();
317 LV2PluginUI::get_preferred_width()
319 Gtk::Requisition r = size_request();
324 LV2PluginUI::package(Gtk::Window& win)
326 if (_external_ui_ptr) {
329 /* forward configure events to plugin window */
330 win.signal_configure_event().connect(
331 sigc::mem_fun(*this, &LV2PluginUI::configure_handler));
332 win.signal_map_event().connect(
333 sigc::mem_fun(*this, &LV2PluginUI::start_updating));
334 win.signal_unmap_event().connect(
335 sigc::mem_fun(*this, &LV2PluginUI::stop_updating));
341 LV2PluginUI::configure_handler(GdkEventConfigure*)
343 std::cout << "CONFIGURE" << std::endl;
348 LV2PluginUI::is_update_wanted(uint32_t /*index*/)
350 /* FIXME: use port notification properties
351 and/or new UI extension subscription methods
357 LV2PluginUI::on_window_show(const std::string& title)
359 //cout << "on_window_show - " << title << endl; flush(cout);
361 if (_lv2->is_external_ui()) {
362 if (_external_ui_ptr) {
363 LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
366 lv2ui_instantiate(title);
367 if (!_external_ui_ptr) {
371 LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
372 _screen_update_connection.disconnect();
373 _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
374 (sigc::mem_fun(*this, &LV2PluginUI::output_update));
377 lv2ui_instantiate("gtk2gui");
384 LV2PluginUI::on_window_hide()
386 //cout << "on_window_hide" << endl; flush(cout);
388 if (_external_ui_ptr) {
389 LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
390 //slv2_ui_instance_get_descriptor(_inst)->cleanup(_inst);
391 //_external_ui_ptr = NULL;
392 //_screen_update_connection.disconnect();