13
0
livetrax/gtk2_ardour/lv2_plugin_ui.cc
David Robillard d367b210f4 Create and destroy (non-external) LV2 plugin UIs as window is shown/hidden.
Fixes ticket #4067 (not to mention avoids having every UI that has ever been shown loaded in memory until exit time...)


git-svn-id: svn://localhost/ardour2/branches/3.0@9638 d708f5d6-7413-0410-9779-e7cbd77b26cf
2011-05-31 02:00:16 +00:00

399 lines
9.5 KiB
C++

/*
Copyright (C) 2008-2011 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.
*/
#include "ardour/lv2_plugin.h"
#include "ardour/plugin_manager.h"
#include "ardour/processor.h"
#include "ardour_ui.h"
#include "gui_thread.h"
#include "lv2_plugin_ui.h"
#include "lv2_ui.h"
/* Note this file is not compiled without either Suil or SLV2 present,
and if Suil is present then Lilv is also present.
*/
#ifdef HAVE_SUIL
#include <lilv/lilv.h>
#include <suil/suil.h>
#else
#include <slv2/slv2.h>
#endif
using namespace Gtk;
using namespace ARDOUR;
using namespace PBD;
#define NS_UI "http://lv2plug.in/ns/extensions/ui#"
#ifdef HAVE_SUIL
static SuilHost* ui_host = NULL;
#endif
void
LV2PluginUI::lv2_ui_write(void* controller,
uint32_t port_index,
uint32_t /*buffer_size*/,
uint32_t /*format*/,
const void* buffer)
{
LV2PluginUI* me = (LV2PluginUI*)controller;
boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
if (ac) {
ac->set_value(*(float*)buffer);
}
}
void
LV2PluginUI::on_external_ui_closed(void* controller)
{
LV2PluginUI* me = (LV2PluginUI*)controller;
me->_screen_update_connection.disconnect();
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);
}
}
void
LV2PluginUI::parameter_update(uint32_t port_index, float val)
{
if (!_inst) {
return;
}
#ifdef HAVE_SUIL
suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
#else
SLV2UIInstance inst = (SLV2UIInstance)_inst;
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);
}
#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));
}
return false;
}
bool
LV2PluginUI::stop_updating(GdkEventAny*)
{
//cout << "stop_updating" << endl;
if (!_output_ports.empty()) {
_screen_update_connection.disconnect();
}
return false;
}
void
LV2PluginUI::output_update()
{
//cout << "output_update" << endl;
if (_external_ui_ptr) {
LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
}
/* FIXME only works with control output ports (which is all we support now anyway) */
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));
}
}
LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
boost::shared_ptr<LV2Plugin> lv2p)
: PlugUIBase(pi)
, _lv2(lv2p)
, _gui_widget(NULL)
, _values(NULL)
, _external_ui_ptr(NULL)
, _inst(NULL)
{
}
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();
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++;
}
} else {
features_dst = (LV2_Feature**)_lv2->features();
}
#ifdef HAVE_SUIL
if (!ui_host) {
ui_host = suil_host_new(LV2PluginUI::lv2_ui_write, NULL, NULL, NULL);
}
const char* container_type = (is_external_ui)
? NS_UI "external"
: NS_UI "GtkUI";
LilvUI* ui = (LilvUI*)_lv2->c_ui();
_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()),
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);
#else
_inst = slv2_ui_instantiate((SLV2Plugin)_lv2->c_plugin(),
(SLV2UI)_lv2->c_ui(),
LV2PluginUI::lv2_ui_write,
this,
features_dst);
#endif
if (is_external_ui) {
free(features_dst);
}
#ifdef HAVE_SUIL
#define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
#else
#define GET_WIDGET(inst) slv2_ui_instance_get_widget((SLV2UIInstance)inst);
#endif
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)
&& is_update_wanted(i)) {
_output_ports.push_back(i);
}
}
_external_ui_ptr = NULL;
if (_inst) {
if (!is_external_ui) {
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);
}
}
_values = 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);
_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]);
}
}
}
}
void
LV2PluginUI::lv2ui_free()
{
if (_lv2->is_external_ui() || !_gui_widget) {
return;
}
stop_updating(NULL);
remove(*_gui_widget);
#ifdef HAVE_SUIL
suil_instance_free((SuilInstance*)_inst);
#else
SLV2UIInstance inst = (SLV2UIInstance)_inst;
const LV2UI_Descriptor* ui_desc = slv2_ui_instance_get_descriptor(inst);
LV2UI_Handle ui_handle = slv2_ui_instance_get_handle(inst);
if (ui_desc) {
ui_desc->cleanup(ui_handle);
}
#endif
_inst = NULL;
_gui_widget = NULL;
}
LV2PluginUI::~LV2PluginUI ()
{
//cout << "LV2PluginUI destructor called" << endl;
if (_values) {
delete[] _values;
}
/* Close and delete GUI. */
lv2ui_free();
_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;
}
}
int
LV2PluginUI::get_preferred_height()
{
Gtk::Requisition r = size_request();
return r.height;
}
int
LV2PluginUI::get_preferred_width()
{
Gtk::Requisition r = size_request();
return r.width;
}
int
LV2PluginUI::package(Gtk::Window& win)
{
if (_external_ui_ptr) {
_win_ptr = &win;
} else {
/* forward configure events to plugin window */
win.signal_configure_event().connect(
sigc::mem_fun(*this, &LV2PluginUI::configure_handler));
win.signal_map_event().connect(
sigc::mem_fun(*this, &LV2PluginUI::start_updating));
win.signal_unmap_event().connect(
sigc::mem_fun(*this, &LV2PluginUI::stop_updating));
}
return 0;
}
bool
LV2PluginUI::configure_handler(GdkEventConfigure*)
{
std::cout << "CONFIGURE" << std::endl;
return false;
}
bool
LV2PluginUI::is_update_wanted(uint32_t /*index*/)
{
/* FIXME: use port notification properties
and/or new UI extension subscription methods
*/
return true;
}
bool
LV2PluginUI::on_window_show(const std::string& title)
{
//cout << "on_window_show - " << title << endl; flush(cout);
if (_lv2->is_external_ui()) {
if (_external_ui_ptr) {
LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
return false;
}
lv2ui_instantiate(title);
if (!_external_ui_ptr) {
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));
return false;
} else {
lv2ui_instantiate("gtk2gui");
}
return true;
}
void
LV2PluginUI::on_window_hide()
{
//cout << "on_window_hide" << endl; flush(cout);
if (_external_ui_ptr) {
LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
//slv2_ui_instance_get_descriptor(_inst)->cleanup(_inst);
//_external_ui_ptr = NULL;
//_screen_update_connection.disconnect();
} else {
lv2ui_free();
}
}