13
0
livetrax/gtk2_ardour/plugin_ui.cc
Carl Hetherington c3bfc3ec4e Stop crash on deleting a plugin when its generic UI window is open.
git-svn-id: svn://localhost/ardour2/branches/3.0@6626 d708f5d6-7413-0410-9779-e7cbd77b26cf
2010-02-03 00:52:45 +00:00

608 lines
14 KiB
C++

/*
Copyright (C) 2000 Paul Davis
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.
*/
#ifdef WAF_BUILD
#include "gtk2ardour-config.h"
#endif
#include <climits>
#include <cerrno>
#include <cmath>
#include <string>
#include "pbd/stl_delete.h"
#include "pbd/xml++.h"
#include "pbd/failed_constructor.h"
#include <gtkmm/widget.h>
#include <gtkmm/box.h>
#include <gtkmm2ext/click_box.h>
#include <gtkmm2ext/fastmeter.h>
#include <gtkmm2ext/barcontroller.h>
#include <gtkmm2ext/utils.h>
#include <gtkmm2ext/doi.h>
#include <gtkmm2ext/slider_controller.h>
#include "midi++/manager.h"
#include "ardour/session.h"
#include "ardour/plugin.h"
#include "ardour/plugin_insert.h"
#include "ardour/ladspa_plugin.h"
#ifdef VST_SUPPORT
#include "ardour/vst_plugin.h"
#endif
#ifdef HAVE_SLV2
#include "ardour/lv2_plugin.h"
#include "lv2_plugin_ui.h"
#endif
#include <lrdf.h>
#include "ardour_dialog.h"
#include "ardour_ui.h"
#include "prompter.h"
#include "plugin_ui.h"
#include "utils.h"
#include "gui_thread.h"
#include "public_editor.h"
#include "keyboard.h"
#include "latency_gui.h"
#include "plugin_eq_gui.h"
#include "i18n.h"
using namespace std;
using namespace ARDOUR;
using namespace PBD;
using namespace Gtkmm2ext;
using namespace Gtk;
PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert> insert, bool scrollable)
: parent (win)
{
bool have_gui = false;
non_gtk_gui = false;
was_visible = false;
Label* label = manage (new Label());
label->set_markup ("<b>THIS IS THE PLUGIN UI</b>");
if (insert->plugin()->has_editor()) {
switch (insert->type()) {
case ARDOUR::VST:
have_gui = create_vst_editor (insert);
break;
case ARDOUR::AudioUnit:
have_gui = create_audiounit_editor (insert);
break;
case ARDOUR::LADSPA:
error << _("Eh? LADSPA plugins don't have editors!") << endmsg;
break;
case ARDOUR::LV2:
have_gui = create_lv2_editor (insert);
break;
default:
#ifndef VST_SUPPORT
error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
<< endmsg;
#else
error << _("unknown type of editor-supplying plugin")
<< endmsg;
#endif
throw failed_constructor ();
}
}
if (!have_gui) {
GenericPluginUI* pu = new GenericPluginUI (insert, scrollable);
_pluginui = pu;
add (*pu);
/*
Gtk::HBox *hbox = new Gtk::HBox();
hbox->pack_start( *pu);
// TODO: this should be nicer
hbox->pack_start( eqgui_bin );
add (*manage(hbox));
*/
set_wmclass (X_("ardour_plugin_editor"), "Ardour");
signal_map_event().connect (sigc::mem_fun (*pu, &GenericPluginUI::start_updating));
signal_unmap_event().connect (sigc::mem_fun (*pu, &GenericPluginUI::stop_updating));
}
// set_position (Gtk::WIN_POS_MOUSE);
set_name ("PluginEditor");
add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)), false);
insert->DropReferences.connect (death_connection, 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;
if (w > 600) w = 600;
if (w < 0) {
w = 450;
}
}
set_default_size (w, h);
}
PluginUIWindow::~PluginUIWindow ()
{
delete _pluginui;
}
void
PluginUIWindow::set_parent (Gtk::Window* win)
{
parent = win;
}
void
PluginUIWindow::on_map ()
{
Window::on_map ();
set_keep_above (true);
}
bool
PluginUIWindow::on_enter_notify_event (GdkEventCrossing *ev)
{
Keyboard::the_keyboard().enter_window (ev, this);
return false;
}
bool
PluginUIWindow::on_leave_notify_event (GdkEventCrossing *ev)
{
Keyboard::the_keyboard().leave_window (ev, this);
return false;
}
bool
PluginUIWindow::on_focus_in_event (GdkEventFocus *ev)
{
Window::on_focus_in_event (ev);
//Keyboard::the_keyboard().magic_widget_grab_focus ();
return false;
}
bool
PluginUIWindow::on_focus_out_event (GdkEventFocus *ev)
{
Window::on_focus_out_event (ev);
//Keyboard::the_keyboard().magic_widget_drop_focus ();
return false;
}
void
PluginUIWindow::on_show ()
{
set_role("plugin_ui");
if (_pluginui) {
_pluginui->update_presets ();
}
if (_pluginui) {
if (_pluginui->on_window_show (_title)) {
Window::on_show ();
}
}
if (parent) {
// set_transient_for (*parent);
}
}
void
PluginUIWindow::on_hide ()
{
Window::on_hide ();
if (_pluginui) {
_pluginui->on_window_hide ();
}
}
void
PluginUIWindow::set_title(const Glib::ustring& title)
{
//cout << "PluginUIWindow::set_title(\"" << title << "\"" << endl;
Gtk::Window::set_title(title);
_title = title;
}
bool
#ifdef VST_SUPPORT
PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
#else
PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert>)
#endif
{
#ifndef VST_SUPPORT
return false;
#else
boost::shared_ptr<VSTPlugin> vp;
if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (insert->plugin())) == 0) {
error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
<< endmsg;
throw failed_constructor ();
} else {
VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
_pluginui = vpu;
add (*vpu);
vpu->package (*this);
}
non_gtk_gui = true;
return true;
#endif
}
bool
#if defined (HAVE_AUDIOUNITS) && defined (GTKOSX)
PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
#else
PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert>)
#endif
{
#if !defined(HAVE_AUDIOUNITS) || !defined(GTKOSX)
return false;
#else
VBox* box;
_pluginui = create_au_gui (insert, &box);
add (*box);
non_gtk_gui = true;
extern sigc::signal<void,bool> ApplicationActivationChanged;
ApplicationActivationChanged.connect (sigc::mem_fun (*this, &PluginUIWindow::app_activated));
return true;
#endif
}
void
#if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
PluginUIWindow::app_activated (bool yn)
#else
PluginUIWindow::app_activated (bool)
#endif
{
#if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
cerr << "APP activated ? " << yn << endl;
if (_pluginui) {
if (yn) {
if (was_visible) {
_pluginui->activate ();
present ();
was_visible = true;
}
} else {
was_visible = is_visible();
hide ();
_pluginui->deactivate ();
}
}
#endif
}
bool
PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
{
#ifndef HAVE_SLV2
return false;
#else
boost::shared_ptr<LV2Plugin> vp;
if ((vp = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin())) == 0) {
error << _("create_lv2_editor called on non-LV2 plugin") << endmsg;
throw failed_constructor ();
} else {
LV2PluginUI* lpu = new LV2PluginUI (insert, vp);
_pluginui = lpu;
add (*lpu);
lpu->package (*this);
}
non_gtk_gui = false;
return true;
#endif
}
bool
PluginUIWindow::on_key_press_event (GdkEventKey* event)
{
return relay_key_press (event, this);
}
bool
PluginUIWindow::on_key_release_event (GdkEventKey *)
{
return true;
}
void
PluginUIWindow::plugin_going_away ()
{
ENSURE_GUI_THREAD (*this, &PluginUIWindow::plugin_going_away)
if (_pluginui) {
_pluginui->stop_updating(0);
}
death_connection.disconnect ();
delete_when_idle (this);
}
PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
: insert (pi),
plugin (insert->plugin()),
save_button(_("Add")),
bypass_button (_("Bypass")),
latency_gui (0),
plugin_analysis_expander (_("Plugin analysis"))
{
//preset_combo.set_use_arrows_always(true);
update_presets();
preset_combo.set_size_request (100, -1);
preset_combo.set_active_text ("");
preset_combo.signal_changed().connect(sigc::mem_fun(*this, &PlugUIBase::setting_selected));
no_load_preset = false;
save_button.set_name ("PluginSaveButton");
save_button.signal_clicked().connect(sigc::mem_fun(*this, &PlugUIBase::save_plugin_setting));
insert->ActiveChanged.connect (active_connection, boost::bind (&PlugUIBase::processor_active_changed, this, boost::weak_ptr<Processor>(insert)), gui_context());
bypass_button.set_active (!pi->active());
bypass_button.set_name ("PluginBypassButton");
bypass_button.signal_toggled().connect (sigc::mem_fun(*this, &PlugUIBase::bypass_toggled));
focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
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);
ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
ARDOUR_UI::instance()->set_tip (&bypass_button, _("Click to enable/disable this plugin"), "");
plugin_analysis_expander.property_expanded().signal_changed().connect( sigc::mem_fun(*this, &PlugUIBase::toggle_plugin_analysis));
plugin_analysis_expander.set_expanded(false);
insert->DropReferences.connect (death_connection, boost::bind (&PlugUIBase::plugin_going_away, this), gui_context());
}
PlugUIBase::~PlugUIBase()
{
delete latency_gui;
}
void
PlugUIBase::plugin_going_away ()
{
/* drop references to the plugin/insert */
insert.reset ();
plugin.reset ();
death_connection.disconnect ();
}
void
PlugUIBase::set_latency_label ()
{
char buf[64];
nframes_t l = insert->effective_latency ();
nframes_t sr = insert->session().frame_rate();
if (l < sr / 1000) {
snprintf (buf, sizeof (buf), "latency (%d samples)", l);
} else {
snprintf (buf, sizeof (buf), "latency (%.2f msecs)", (float) l / ((float) sr / 1000.0f));
}
latency_label.set_text (buf);
}
void
PlugUIBase::latency_button_clicked ()
{
if (!latency_gui) {
latency_gui = new LatencyGUI (*(insert.get()), insert->session().frame_rate(), insert->session().get_block_size());
latency_dialog = new ArdourDialog ("Edit Latency", false, false);
latency_dialog->get_vbox()->pack_start (*latency_gui);
latency_dialog->signal_hide().connect (sigc::mem_fun (*this, &PlugUIBase::set_latency_label));
}
latency_dialog->show_all ();
}
void
PlugUIBase::processor_active_changed (boost::weak_ptr<Processor> weak_p)
{
ENSURE_GUI_THREAD (*this, &PlugUIBase::processor_active_changed, weak_p)
boost::shared_ptr<Processor> p (weak_p);
if (p) {
bypass_button.set_active (!p->active());
}
}
void
PlugUIBase::setting_selected()
{
if (no_load_preset) {
return;
}
if (preset_combo.get_active_text().length() > 0) {
const Plugin::PresetRecord* pr = plugin->preset_by_label(preset_combo.get_active_text());
if (pr) {
plugin->load_preset(pr->uri);
} else {
warning << string_compose(_("Plugin preset %1 not found"),
preset_combo.get_active_text()) << endmsg;
}
}
}
void
PlugUIBase::save_plugin_setting ()
{
ArdourPrompter prompter (true);
prompter.set_prompt(_("Name of New Preset:"));
prompter.add_button (Gtk::Stock::ADD, Gtk::RESPONSE_ACCEPT);
prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
prompter.set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
prompter.show_all();
prompter.present ();
switch (prompter.run ()) {
case Gtk::RESPONSE_ACCEPT:
string name;
prompter.get_result(name);
if (name.length()) {
if (plugin->save_preset(name)) {
update_presets();
no_load_preset = true;
preset_combo.set_active_text (name);
no_load_preset = false;
}
}
break;
}
}
void
PlugUIBase::bypass_toggled ()
{
bool x;
if ((x = bypass_button.get_active()) == insert->active()) {
if (x) {
insert->deactivate ();
} else {
insert->activate ();
}
}
}
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 ();
ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
} else {
Keyboard::the_keyboard().magic_widget_grab_focus();
focus_button.remove ();
focus_button.add (*focus_in_image);
focus_in_image->show ();
ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow normal use of Ardour keyboard shortcuts"), "");
}
return true;
}
void
PlugUIBase::toggle_plugin_analysis()
{
if (plugin_analysis_expander.get_expanded() &&
!plugin_analysis_expander.get_child()) {
// Create the GUI
PluginEqGui *foo = new PluginEqGui(insert);
plugin_analysis_expander.add( *foo );
plugin_analysis_expander.show_all();
}
Gtk::Widget *gui;
if (!plugin_analysis_expander.get_expanded() &&
(gui = plugin_analysis_expander.get_child())) {
// Hide & remove
gui->hide();
//plugin_analysis_expander.remove(*gui);
plugin_analysis_expander.remove();
delete gui;
Gtk::Widget *toplevel = plugin_analysis_expander.get_toplevel();
if (!toplevel) {
std::cerr << "No toplevel widget?!?!" << std::endl;
return;
}
Gtk::Container *cont = dynamic_cast<Gtk::Container *>(toplevel);
if (!cont) {
std::cerr << "Toplevel widget is not a container?!?" << std::endl;
return;
}
Gtk::Allocation alloc(0, 0, 50, 50); // Just make it small
toplevel->size_allocate(alloc);
}
}
void
PlugUIBase::update_presets ()
{
vector<string> preset_labels;
vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets();
no_load_preset = true;
for (vector<ARDOUR::Plugin::PresetRecord>::const_iterator i = presets.begin(); i != presets.end(); ++i) {
preset_labels.push_back(i->label);
}
set_popdown_strings (preset_combo, preset_labels);
no_load_preset = false;
}