ardour/gtk2_ardour/plugin_ui.cc

/*
 * Copyright (C) 2005-2006 Nick Mainsbridge <mainsbridge@gmail.com>
 * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2006-2009 Sampo Savolainen <v2@iki.fi>
 * Copyright (C) 2006-2015 David Robillard <d@drobilla.net>
 * Copyright (C) 2009-2011 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2012-2019 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2013-2018 John Emmas <john@creativepost.co.uk>
 *
 * 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.
 */

#ifdef WAF_BUILD
#include "gtk2ardour-config.h"
#endif

#include <cerrno>
#include <climits>
#include <cmath>
#include <string>

#include "pbd/failed_constructor.h"
#include "pbd/stl_delete.h"
#include "pbd/xml++.h"

#include "gtkmm/box.h"
#include "gtkmm/widget.h"

#include "gtkmm2ext/application.h"
#include "gtkmm2ext/doi.h"
#include "gtkmm2ext/utils.h"

#include "widgets/fastmeter.h"
#include "widgets/tooltips.h"

#include "ardour/auditioner.h"
#include "ardour/ladspa_plugin.h"
#include "ardour/lv2_plugin.h"
#include "ardour/plugin.h"
#include "ardour/plugin_insert.h"
#include "ardour/session.h"
#include "lv2_plugin_ui.h"

#ifdef WINDOWS_VST_SUPPORT
#include "ardour/windows_vst_plugin.h"
#include "windows_vst_plugin_ui.h"
#endif

#ifdef LXVST_SUPPORT
#include "ardour/lxvst_plugin.h"
#include "lxvst_plugin_ui.h"
#endif

#ifdef MACVST_SUPPORT
#include "ardour/mac_vst_plugin.h"
#include "vst_plugin_ui.h"
#endif

#ifdef VST3_SUPPORT
#include "ardour/vst3_plugin.h"
# ifdef PLATFORM_WINDOWS
#  include "vst3_hwnd_plugin_ui.h"
# elif defined(__APPLE__)
#  include "vst3_plugin_ui.h"
extern VST3PluginUI* create_mac_vst3_gui (std::shared_ptr<ARDOUR::PlugInsertBase>, Gtk::VBox**);
# else
#  include "vst3_x11_plugin_ui.h"
# endif
#endif

#include "ardour_ui.h"
#include "ardour_window.h"
#include "gui_thread.h"
#include "keyboard.h"
#include "latency_gui.h"
#include "new_plugin_preset_dialog.h"
#include "plugin_dspload_ui.h"
#include "plugin_eq_gui.h"
#include "plugin_presets_ui.h"
#include "plugin_ui.h"
#include "processor_box.h"
#include "public_editor.h"
#include "timers.h"
#include "ui_config.h"
#include "utils.h"

#include "pbd/i18n.h"

using namespace std;
using namespace ARDOUR;
using namespace ARDOUR_UI_UTILS;
using namespace ArdourWidgets;
using namespace PBD;
using namespace Gtkmm2ext;
using namespace Gtk;

PluginUIWindow* PluginUIWindow::the_plugin_window = 0;

PluginUIWindow::PluginUIWindow (std::shared_ptr<PlugInsertBase> pib,
                                bool                            scrollable,
                                bool                            editor)
	: ArdourWindow (string ())
	, was_visible (false)
	, _keyboard_focused (false)
#ifdef AUDIOUNIT_SUPPORT
	, pre_deactivate_x (-1)
	, pre_deactivate_y (-1)
#endif

{
	bool   have_gui = false;
	Label* label    = manage (new Label ());
	label->set_markup ("<b>THIS IS THE PLUGIN UI</b>");

	if (editor && pib->plugin ()->has_editor ()) {
		switch (pib->type ()) {
			case ARDOUR::Windows_VST:
				have_gui = create_windows_vst_editor (pib);
				break;

			case ARDOUR::LXVST:
				have_gui = create_lxvst_editor (pib);
				break;

			case ARDOUR::MacVST:
				have_gui = create_mac_vst_editor (pib);
				break;

			case ARDOUR::AudioUnit:
				have_gui = create_audiounit_editor (pib);
				break;

			case ARDOUR::LADSPA:
				error << _("Eh? LADSPA plugins don't have editors!") << endmsg;
				break;

			case ARDOUR::LV2:
				have_gui = create_lv2_editor (pib);
				break;

			case ARDOUR::VST3:
				have_gui = create_vst3_editor (pib);
				break;

			default:
#ifndef WINDOWS_VST_SUPPORT
				error << string_compose (_("unknown type of editor-supplying plugin (note: no VST support in this version of %1)"), PROGRAM_NAME)
				      << endmsg;
#else
				error << _("unknown type of editor-supplying plugin") << endmsg;
#endif
				throw failed_constructor ();
		}
	}

	if (!have_gui) {
		GenericPluginUI* pu = new GenericPluginUI (pib, scrollable);

		_pluginui = pu;
		_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
		add (*pu);
		set_wmclass (X_("ardour_plugin_editor"), PROGRAM_NAME);

		signal_map_event ().connect (sigc::mem_fun (*pu, &GenericPluginUI::start_updating));
		signal_unmap_event ().connect (sigc::mem_fun (*pu, &GenericPluginUI::stop_updating));
	}

	set_name ("PluginEditor");
	add_events (Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK | Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);

	pib->DropReferences.connect (death_connection, invalidator (*this), boost::bind (&PluginUIWindow::plugin_going_away, this), gui_context ());

	gint h = _pluginui->get_preferred_height ();
	gint w = _pluginui->get_preferred_width ();

	if (scrollable) {
		if (h > 600) {
			h = 600;
		}
	}

	set_border_width (0);
	set_default_size (w, h);
	set_resizable (_pluginui->resizable ());
	unset_transient_for ();
}

PluginUIWindow::~PluginUIWindow ()
{
#ifndef NDEBUG
	cerr << "PluginWindow deleted for " << this << endl;
#endif
	delete _pluginui;

	if (the_plugin_window == this) {
		the_plugin_window = 0;
	}
}

void
PluginUIWindow::on_show ()
{
	if (UIConfiguration::instance ().get_one_plugin_window_only ()) {
		if (the_plugin_window) {
			the_plugin_window->hide ();
		}
		the_plugin_window = this;
	}

	set_role ("plugin_ui");

	if (_pluginui) {
		_pluginui->update_preset_list ();
		_pluginui->update_preset ();
	}

	if (_pluginui) {
#if defined(HAVE_AUDIOUNITS) && defined(__APPLE__)
		if (pre_deactivate_x >= 0) {
			move (pre_deactivate_x, pre_deactivate_y);
		}
#endif

		if (_pluginui->on_window_show (_title)) {
			Window::on_show ();
		}
	}
}

void
PluginUIWindow::on_hide ()
{
#if defined(HAVE_AUDIOUNITS) && defined(__APPLE__)
	get_position (pre_deactivate_x, pre_deactivate_y);
#endif

	Window::on_hide ();

	if (_pluginui) {
		_pluginui->on_window_hide ();
	}
}

void
PluginUIWindow::set_title (const std::string& title)
{
	Gtk::Window::set_title (title);
	_title = title;
}

bool
#ifdef WINDOWS_VST_SUPPORT
PluginUIWindow::create_windows_vst_editor (std::shared_ptr<PlugInsertBase> pib)
#else
PluginUIWindow::create_windows_vst_editor (std::shared_ptr<PlugInsertBase>)
#endif
{
#ifndef WINDOWS_VST_SUPPORT
	return false;
#else

	std::shared_ptr<WindowsVSTPlugin> vp;

	if ((vp = std::dynamic_pointer_cast<WindowsVSTPlugin> (pib->plugin ())) == 0) {
		error << string_compose (_("unknown type of editor-supplying plugin (note: no VST support in this version of %1)"), PROGRAM_NAME)
		      << endmsg;
		throw failed_constructor ();
	} else {
		WindowsVSTPluginUI* vpu = new WindowsVSTPluginUI (pib, vp, GTK_WIDGET (this->gobj ()));

		_pluginui = vpu;
		_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
		add (*vpu);
		vpu->package (*this);
	}

	return true;
#endif
}

bool
#ifdef LXVST_SUPPORT
PluginUIWindow::create_lxvst_editor (std::shared_ptr<PlugInsertBase> pib)
#else
PluginUIWindow::create_lxvst_editor (std::shared_ptr<PlugInsertBase>)
#endif
{
#ifndef LXVST_SUPPORT
	return false;
#else

	std::shared_ptr<LXVSTPlugin> lxvp;

	if ((lxvp = std::dynamic_pointer_cast<LXVSTPlugin> (pib->plugin ())) == 0) {
		error << string_compose (_("unknown type of editor-supplying plugin (note: no linuxVST support in this version of %1)"), PROGRAM_NAME)
		      << endmsg;
		throw failed_constructor ();
	} else {
		LXVSTPluginUI* lxvpu = new LXVSTPluginUI (pib, lxvp);

		_pluginui = lxvpu;
		_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
		add (*lxvpu);
		lxvpu->package (*this);
	}

	return true;
#endif
}

bool
#ifdef MACVST_SUPPORT
PluginUIWindow::create_mac_vst_editor (std::shared_ptr<PlugInsertBase> pib)
#else
PluginUIWindow::create_mac_vst_editor (std::shared_ptr<PlugInsertBase>)
#endif
{
#ifndef MACVST_SUPPORT
	return false;
#else
	std::shared_ptr<MacVSTPlugin> mvst;
	if ((mvst = std::dynamic_pointer_cast<MacVSTPlugin> (pib->plugin ())) == 0) {
		error << string_compose (_("unknown type of editor-supplying plugin (note: no MacVST support in this version of %1)"), PROGRAM_NAME)
		      << endmsg;
		throw failed_constructor ();
	}
	VSTPluginUI* vpu = create_mac_vst_gui (pib);
	_pluginui = vpu;
	_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
	add (*vpu);
	vpu->package (*this);

	Application::instance ()->ActivationChanged.connect (mem_fun (*this, &PluginUIWindow::app_activated));

	return true;
#endif
}

bool
#ifdef VST3_SUPPORT
PluginUIWindow::create_vst3_editor (std::shared_ptr<PlugInsertBase> pib)
#else
PluginUIWindow::create_vst3_editor (std::shared_ptr<PlugInsertBase>)
#endif
{
#ifndef VST3_SUPPORT
	return false;
#else
	std::shared_ptr<VST3Plugin> vst3;
	if ((vst3 = std::dynamic_pointer_cast<VST3Plugin> (pib->plugin ())) == 0) {
		error << _("create_vst3_editor called on non-VST3 plugin") << endmsg;
		throw failed_constructor ();
	} else {
#ifdef PLATFORM_WINDOWS
		VST3HWNDPluginUI* pui = new VST3HWNDPluginUI (pib, vst3);
		add (*pui);
#elif defined(__APPLE__)
		VBox*         box;
		VST3PluginUI* pui = create_mac_vst3_gui (pib, &box);
		add (*box);
		Application::instance ()->ActivationChanged.connect (mem_fun (*this, &PluginUIWindow::app_activated));
#else
		VST3X11PluginUI* pui = new VST3X11PluginUI (pib, vst3);
		add (*pui);
#endif
		_pluginui = pui;
		pui->package (*this);
		_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
	}
	return true;
#endif
}

bool
#ifdef AUDIOUNIT_SUPPORT
PluginUIWindow::create_audiounit_editor (std::shared_ptr<PlugInsertBase> pib)
#else
PluginUIWindow::create_audiounit_editor (std::shared_ptr<PlugInsertBase>)
#endif
{
#ifndef AUDIOUNIT_SUPPORT
	return false;
#else
	VBox* box;
	_pluginui = create_au_gui (pib, &box);
	_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
	add (*box);

	Application::instance ()->ActivationChanged.connect (mem_fun (*this, &PluginUIWindow::app_activated));

	return true;
#endif
}

void
#ifdef __APPLE__
PluginUIWindow::app_activated (bool yn)
#else
PluginUIWindow::app_activated (bool)
#endif
{
#ifdef AUDIOUNIT_SUPPORT
	if (_pluginui) {
		if (yn) {
			if (was_visible) {
				_pluginui->activate ();
				if (pre_deactivate_x >= 0) {
					move (pre_deactivate_x, pre_deactivate_y);
				}
				present ();
				was_visible = true;
			}
		} else {
			was_visible = get_visible ();
			get_position (pre_deactivate_x, pre_deactivate_y);
			hide ();
			_pluginui->deactivate ();
		}
	}
#endif
}

bool
PluginUIWindow::create_lv2_editor (std::shared_ptr<PlugInsertBase> pib)
{
#ifdef HAVE_SUIL
	std::shared_ptr<LV2Plugin> vp;

	if ((vp = std::dynamic_pointer_cast<LV2Plugin> (pib->plugin ())) == 0) {
		error << _("create_lv2_editor called on non-LV2 plugin") << endmsg;
		throw failed_constructor ();
	} else {
		LV2PluginUI* lpu = new LV2PluginUI (pib, vp);
		_pluginui        = lpu;
		add (*lpu);
		lpu->package (*this);
		_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
	}

	return true;
#else
	return false;
#endif
}

void
PluginUIWindow::keyboard_focused (bool yn)
{
	_keyboard_focused = yn;
}

bool
PluginUIWindow::on_key_press_event (GdkEventKey* event)
{
	if (_keyboard_focused) {
		if (_pluginui) {
			_pluginui->grab_focus ();
			if (_pluginui->non_gtk_gui ()) {
				_pluginui->forward_key_event (event);
			} else {
				return relay_key_press (event, this);
			}
		}
		return true;
	}
	/* for us to be getting key press events, there really
	   MUST be a _pluginui, but just to be safe, check ...
	*/

	if (_pluginui) {
		_pluginui->grab_focus ();
		if (_pluginui->non_gtk_gui ()) {
			/* pass main window as the window for the event
			   to be handled in, not this one, because there are
			   no widgets in this window that we want to have
			   key focus.
			*/
			return relay_key_press (event, &ARDOUR_UI::instance ()->main_window ());
		} else {
			return relay_key_press (event, this);
		}
	}

	return false;
}

bool
PluginUIWindow::on_key_release_event (GdkEventKey* event)
{
	if (_keyboard_focused) {
		if (_pluginui) {
			if (_pluginui->non_gtk_gui ()) {
				_pluginui->forward_key_event (event);
				return true;
			}
		}
	} else {
		gtk_window_propagate_key_event (GTK_WINDOW (gobj ()), event);
	}
	return relay_key_press (event, this);
}

void
PluginUIWindow::plugin_going_away ()
{
	ENSURE_GUI_THREAD (*this, &PluginUIWindow::plugin_going_away)

	if (_pluginui) {
		_pluginui->stop_updating (0);
	}

	death_connection.disconnect ();
}

PlugUIBase::PlugUIBase (std::shared_ptr<PlugInsertBase> pib)
	: _pib (pib)
	, plugin (pib->plugin ())
	, _add_button (_("Add"))
	, _save_button (_("Save"))
	, _delete_button (_("Delete"))
	, _preset_browser_button (_("Preset Browser"))
	, _reset_button (_("Reset"))
	, _bypass_button (ArdourButton::led_default_elements)
	, _pin_management_button (_("Pinout"))
	, description_expander (_("Description"))
	, plugin_analysis_expander (_("Plugin analysis"))
	, cpuload_expander (_("CPU Profile"))
	, latency_gui (0)
	, latency_dialog (0)
	, eqgui (0)
	, stats_gui (0)
	, preset_gui (0)
	, preset_dialog (0)
{
	_pi = std::dynamic_pointer_cast<ARDOUR::PluginInsert> (_pib); /* may be NULL */

	_preset_modified.set_size_request (16, -1);
	_preset_combo.set_text ("(default)");
	set_tooltip (_preset_combo, _("Presets (if any) for this plugin\n(Both factory and user-created)"));
	set_tooltip (_add_button, _("Save a new preset"));
	set_tooltip (_save_button, _("Save the current preset"));
	set_tooltip (_delete_button, _("Delete the current preset"));
	set_tooltip (_preset_browser_button, _("Show Preset Browser Dialog"));
	set_tooltip (_reset_button, _("Reset parameters to default (if no parameters are in automation play mode)"));
	set_tooltip (_pin_management_button, _("Show Plugin Pin Management Dialog"));
	set_tooltip (_bypass_button, _("Disable signal processing by the plugin"));
	set_tooltip (_latency_button, _("Edit Plugin Delay/Latency Compensation"));
	_no_load_preset = 0;

	update_preset_list ();
	update_preset ();

	_latency_button.set_icon (ArdourIcon::LatencyClock);
	_latency_button.add_elements (ArdourButton::Text);
	_latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
	set_latency_label ();

	_add_button.set_name ("generic button");
	_add_button.set_icon (ArdourIcon::PsetAdd);
	_add_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::add_plugin_setting));

	_save_button.set_name ("generic button");
	_save_button.set_icon (ArdourIcon::PsetSave);
	_save_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::save_plugin_setting));

	_delete_button.set_name ("generic button");
	_delete_button.set_icon (ArdourIcon::PsetDelete);
	_delete_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::delete_plugin_setting));

	_preset_browser_button.set_name ("generic button");
	_preset_browser_button.set_icon (ArdourIcon::PsetBrowse);
	_preset_browser_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::browse_presets));

	_reset_button.set_name ("generic button");
	_reset_button.set_icon (ArdourIcon::PluginReset);
	_reset_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::reset_plugin_parameters));

	_pin_management_button.set_name ("generic button");
	_pin_management_button.set_icon (ArdourIcon::PluginPinout);
	_pin_management_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::manage_pins));

	_bypass_button.set_name ("plugin bypass button");
	_bypass_button.set_text (_("Bypass"));
	_bypass_button.set_icon (ArdourIcon::PluginBypass);
	_bypass_button.signal_button_release_event ().connect (sigc::mem_fun (*this, &PlugUIBase::bypass_button_release), false);

	if (_pi) {
		_pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&PlugUIBase::processor_active_changed, this, std::weak_ptr<Processor> (_pi)), gui_context ());
		_bypass_button.set_active (!_pi->enabled ());
	} else {
		_bypass_button.set_sensitive (false);
	}

	_focus_button.signal_button_release_event ().connect (sigc::mem_fun (*this, &PlugUIBase::focus_toggled));
	_focus_button.add_events (Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK);

	/* these images are not managed, so that we can remove them at will */

	_focus_out_image = new Image (get_icon (X_("computer_keyboard")));
	_focus_in_image  = new Image (get_icon (X_("computer_keyboard_active")));

	_focus_button.add (*_focus_out_image);

	set_tooltip (_focus_button, string_compose (_("Click to allow the plugin to receive keyboard events that %1 would normally use as a shortcut"), PROGRAM_NAME));
	set_tooltip (_bypass_button, _("Click to enable/disable this plugin"));

	description_expander.property_expanded ().signal_changed ().connect (sigc::mem_fun (*this, &PlugUIBase::toggle_description));
	description_expander.set_expanded (false);

	plugin_analysis_expander.property_expanded ().signal_changed ().connect (sigc::mem_fun (*this, &PlugUIBase::toggle_plugin_analysis));
	plugin_analysis_expander.set_expanded (false);

	cpuload_expander.property_expanded ().signal_changed ().connect (sigc::mem_fun (*this, &PlugUIBase::toggle_cpuload_display));
	cpuload_expander.set_expanded (false);

	_pib->DropReferences.connect (death_connection, invalidator (*this), boost::bind (&PlugUIBase::plugin_going_away, this), gui_context ());

	if (_pib->ui_elements () & PlugInsertBase::PluginPreset) {
		plugin->PresetAdded.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::preset_added_or_removed, this), gui_context ());
		plugin->PresetRemoved.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::preset_added_or_removed, this), gui_context ());
		plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::update_preset, this), gui_context ());
		plugin->PresetDirty.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::update_preset_modified, this), gui_context ());
	}
	if (_pi && _pi->ui_elements () != PlugInsertBase::NoGUIToolbar) {
		_pi->AutomationStateChanged.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::automation_state_changed, this), gui_context ());
		_pi->LatencyChanged.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::set_latency_label, this), gui_context ());
		automation_state_changed ();
	}
}

PlugUIBase::~PlugUIBase ()
{
	delete eqgui;
	delete stats_gui;
	delete preset_gui;
	delete latency_gui;
	delete latency_dialog;
	delete preset_dialog;

	delete _focus_out_image;
	delete _focus_in_image;
}

void
PlugUIBase::plugin_going_away ()
{
	drop_connections ();
	/* drop references to the plugin/insert */
	_pib.reset ();
	_pi.reset ();
	plugin.reset ();
}

void
PlugUIBase::add_common_widgets (Gtk::HBox* b, bool with_focus)
{
	PlugInsertBase::UIElements const ui_elements = _pib->ui_elements ();

	if (ui_elements == PlugInsertBase::NoGUIToolbar) {
		return;
	}
	if (with_focus) {
		b->pack_end (_focus_button, false, false);
	}

	if (ui_elements & PlugInsertBase::BypassEnable) {
		b->pack_end (_bypass_button, false, false, with_focus ? 4 : 0);
	}

	if (_pib->controls ().size () > 0) {
		b->pack_end (_reset_button, false, false, 4);
	}
	if (has_descriptive_presets ()) {
		b->pack_end (_preset_browser_button, false, false);
	}

	if (ui_elements & PlugInsertBase::PluginPreset) {
		b->pack_end (_delete_button, false, false);
		b->pack_end (_save_button, false, false);
		b->pack_end (_add_button, false, false);
		b->pack_end (_preset_combo, false, false);
		b->pack_end (_preset_modified, false, false);
	}

	if (_pi) {
		b->pack_end (_pin_management_button, false, false);
		b->pack_start (_latency_button, false, false, 4);
	}
}

void
PlugUIBase::set_latency_label ()
{
	if (!_pi) {
		return;
	}
	samplecnt_t const l  = _pi->effective_latency ();
	float const       sr = _pi->session ().sample_rate ();

	_latency_button.set_text (samples_as_time_string (l, sr, true));
}

void
PlugUIBase::latency_button_clicked ()
{
	assert (_pi);
	if (!latency_gui) {
		latency_gui    = new LatencyGUI (*(_pi.get ()), _pi->session ().sample_rate (), _pi->session ().get_block_size ());
		latency_dialog = new ArdourWindow (_("Edit Latency"));
		/* use both keep-above and transient for to try cover as many
		   different WM's as possible.
		*/
		latency_dialog->set_keep_above (true);
		Window* win = dynamic_cast<Window*> (_bypass_button.get_toplevel ());
		if (win) {
			latency_dialog->set_transient_for (*win);
		}
		latency_dialog->add (*latency_gui);
	}

	latency_gui->refresh ();
	latency_dialog->show_all ();
}

void
PlugUIBase::processor_active_changed (std::weak_ptr<Processor> weak_p)
{
	ENSURE_GUI_THREAD (*this, &PlugUIBase::processor_active_changed, weak_p);
	std::shared_ptr<Processor> p (weak_p.lock ());

	if (p) {
		_bypass_button.set_active (!p->enabled ());
	}
}

void
PlugUIBase::preset_selected (Plugin::PresetRecord preset)
{
	if (_no_load_preset) {
		return;
	}
	if (!preset.label.empty ()) {
		_pib->load_preset (preset);
	} else {
		// blank selected = no preset
		plugin->clear_preset ();
	}
}

void
PlugUIBase::add_plugin_setting ()
{
	NewPluginPresetDialog d (plugin, _("New Preset"));

	Window* win = dynamic_cast<Window*> (_bypass_button.get_toplevel ());
	d.set_keep_above (true);
	if (win) {
		d.set_transient_for (*win);
	}

	switch (d.run ()) {
		case Gtk::RESPONSE_ACCEPT:
			if (d.name ().empty ()) {
				break;
			}

			Plugin::PresetRecord const r = plugin->save_preset (d.name ());
			if (!r.uri.empty ()) {
				plugin->Plugin::load_preset (r);
			}
			break;
	}
}

void
PlugUIBase::save_plugin_setting ()
{
	string const               name = _preset_combo.get_text ();
	Plugin::PresetRecord const r    = plugin->save_preset (name);
	if (!r.uri.empty ()) {
		plugin->Plugin::load_preset (r);
	}
}

void
PlugUIBase::delete_plugin_setting ()
{
	plugin->remove_preset (_preset_combo.get_text ());
}

void
PlugUIBase::automation_state_changed ()
{
	_reset_button.set_sensitive (_pib->can_reset_all_parameters ());
}

void
PlugUIBase::reset_plugin_parameters ()
{
	_pib->reset_parameters_to_default ();
}

bool
PlugUIBase::has_descriptive_presets () const
{
	std::vector<Plugin::PresetRecord> presets = _pib->plugin ()->get_presets ();
	for (std::vector<Plugin::PresetRecord>::const_iterator i = presets.begin (); i != presets.end (); ++i) {
		if (i->valid && !i->description.empty ()) {
			return true;
		}
	}
	return false;
}

void
PlugUIBase::browse_presets ()
{
	if (!_pi) {
		return;
	}
	if (!preset_dialog) {
		if (preset_gui) {
			/* Do not allow custom window, if preset_gui is used.
			 * e.g. generic-plugin UI.
			 */
			return;
		}
		preset_dialog = new ArdourWindow (_("Select Preset"));
		preset_dialog->set_keep_above (true);
		Window* win = dynamic_cast<Window*> (_preset_browser_button.get_toplevel ());
		if (win) {
			preset_dialog->set_transient_for (*win);
		}
		preset_gui = new PluginPresetsUI (_pi);
		preset_dialog->add (*preset_gui);
	}
	preset_dialog->show_all ();
}

void
PlugUIBase::manage_pins ()
{
	assert (_pi);
	PluginPinWindowProxy* proxy = _pi->pinmgr_proxy ();
	if (proxy) {
		proxy->get (true);
		proxy->present ();
		proxy->get ()->raise ();
	}
}

bool
PlugUIBase::bypass_button_release (GdkEventButton*)
{
	assert (_pi);
	bool view_says_bypassed = (_bypass_button.active_state () != 0);

	if (view_says_bypassed != _pi->enabled ()) {
		_pi->enable (view_says_bypassed);
	}

	return false;
}

bool
PlugUIBase::focus_toggled (GdkEventButton*)
{
	if (Keyboard::the_keyboard ().some_magic_widget_has_focus ()) {
		Keyboard::the_keyboard ().magic_widget_drop_focus ();
		_focus_button.remove ();
		_focus_button.add (*_focus_out_image);
		_focus_out_image->show ();
		set_tooltip (_focus_button, string_compose (_("Click to allow the plugin to receive keyboard events that %1 would normally use as a shortcut"), PROGRAM_NAME));
		KeyboardFocused (false);
	} else {
		Keyboard::the_keyboard ().magic_widget_grab_focus ();
		_focus_button.remove ();
		_focus_button.add (*_focus_in_image);
		_focus_in_image->show ();
		set_tooltip (_focus_button, string_compose (_("Click to allow normal use of %1 keyboard shortcuts"), PROGRAM_NAME));
		KeyboardFocused (true);
	}

	return true;
}

void
PlugUIBase::toggle_description ()
{
	if (description_expander.get_expanded () &&
	    !description_expander.get_child ()) {
		const std::string text = plugin->get_docs ();
		if (text.empty ()) {
			return;
		}

		Gtk::Label* label = manage (new Gtk::Label (text));
		label->set_line_wrap (true);
		label->set_line_wrap_mode (Pango::WRAP_WORD);
		description_expander.add (*label);
		description_expander.show_all ();
	}

	if (!description_expander.get_expanded ()) {
		const int child_height = description_expander.get_child ()->get_height ();

		description_expander.remove ();

		Gtk::Window* toplevel = (Gtk::Window*)description_expander.get_ancestor (GTK_TYPE_WINDOW);

		if (toplevel) {
			Gtk::Requisition wr;
			toplevel->get_size (wr.width, wr.height);
			wr.height -= child_height;
			toplevel->resize (wr.width, wr.height);
		}
	}
}

void
PlugUIBase::toggle_plugin_analysis ()
{
	assert (_pi);
	if (plugin_analysis_expander.get_expanded () &&
	    !plugin_analysis_expander.get_child ()) {
		// Create the GUI
		if (eqgui == 0) {
			eqgui = new PluginEqGui (_pi);
		}

		plugin_analysis_expander.add (*eqgui);
		plugin_analysis_expander.show_all ();
	}

	if (!plugin_analysis_expander.get_expanded ()) {
		// Hide & remove from expander
		const int child_height = plugin_analysis_expander.get_child ()->get_height ();

		eqgui->hide ();
		plugin_analysis_expander.remove ();

		Gtk::Window* toplevel = (Gtk::Window*)plugin_analysis_expander.get_ancestor (GTK_TYPE_WINDOW);

		if (toplevel) {
			Gtk::Requisition wr;
			toplevel->get_size (wr.width, wr.height);
			wr.height -= child_height;
			toplevel->resize (wr.width, wr.height);
		}
	}
}

void
PlugUIBase::toggle_cpuload_display ()
{
	if (cpuload_expander.get_expanded () && !cpuload_expander.get_child ()) {
		if (stats_gui == 0) {
			stats_gui = new PluginLoadStatsGui (_pib);
		}
		cpuload_expander.add (*stats_gui);
		cpuload_expander.show_all ();
		stats_gui->start_updating ();
	}

	if (!cpuload_expander.get_expanded ()) {
		const int child_height = cpuload_expander.get_child ()->get_height ();

		stats_gui->hide ();
		stats_gui->stop_updating ();
		cpuload_expander.remove ();

		Gtk::Window* toplevel = (Gtk::Window*)cpuload_expander.get_ancestor (GTK_TYPE_WINDOW);

		if (toplevel) {
			Gtk::Requisition wr;
			toplevel->get_size (wr.width, wr.height);
			wr.height -= child_height;
			toplevel->resize (wr.width, wr.height);
		}
	}
}

void
PlugUIBase::update_preset_list ()
{
	using namespace Menu_Helpers;

	vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets ();

	++_no_load_preset;

	// Add a menu entry for each preset
	_preset_combo.clear_items ();
	for (vector<ARDOUR::Plugin::PresetRecord>::const_iterator i = presets.begin (); i != presets.end (); ++i) {
		_preset_combo.AddMenuElem (
		    MenuElem (i->label, sigc::bind (sigc::mem_fun (*this, &PlugUIBase::preset_selected), *i)));
	}

	// Add an empty entry for un-setting current preset (see preset_selected)
	Plugin::PresetRecord no_preset;
	_preset_combo.AddMenuElem (
	    MenuElem ("", sigc::bind (sigc::mem_fun (*this, &PlugUIBase::preset_selected), no_preset)));

	--_no_load_preset;
}

void
PlugUIBase::update_preset ()
{
	Plugin::PresetRecord p = plugin->last_preset ();

	++_no_load_preset;
	if (p.uri.empty ()) {
		_preset_combo.set_text (_("(none)"));
	} else {
		_preset_combo.set_text (p.label);
	}
	--_no_load_preset;

	_delete_button.set_sensitive (!p.uri.empty () && p.user);
	update_preset_modified ();
}

void
PlugUIBase::update_preset_modified ()
{
	Plugin::PresetRecord p = plugin->last_preset ();

	if (p.uri.empty ()) {
		_save_button.set_sensitive (false);
		_preset_modified.set_text ("");
		return;
	}

	bool const c = plugin->parameter_changed_since_last_preset ();
	if (_preset_modified.get_text ().empty () == c) {
		_preset_modified.set_text (c ? "*" : "");
	}
	_save_button.set_sensitive (c && p.user);
}

void
PlugUIBase::preset_added_or_removed ()
{
	/* Update both the list and the currently-displayed preset */
	update_preset_list ();
	update_preset ();
}