13
0
livetrax/gtk2_ardour/plugin_ui.cc

729 lines
18 KiB
C++
Raw Normal View History

/*
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 <gtkmm2ext/application.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"
#include "vst_pluginui.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 "new_plugin_preset_dialog.h"
#include "i18n.h"
using namespace std;
using namespace ARDOUR;
Large nasty commit in the form of a 5000 line patch chock-full of completely unecessary changes. (Sorry, doing a "sprint" based thing, this is the end of the first one) Achieved MIDI track and bus creation, associated Jack port and diskstream creation, and minimal GUI stuff for creating them. Should be set to start work on actually recording and playing midi to/from disk now. Relevant (significant) changes: - Creation of a Buffer class. Base class is type agnostic so things can point to a buffer but not care what kind it is (otherwise it'd be a template). Derived into AudioBuffer and MidiBuffer, with a type tag because checking type is necessary in parts of the code where dynamic_cast wouldn't be wise. Originally I considered this a hack, but passing around a type proved to be a very good solution to all the other problems (below). There is a 1:1 mapping between jack port data types and ardour Buffer types (with a conversion function), but that's easily removed if it ever becomes necessary. Having the type scoped in the Buffer class is maybe not the best spot for it, but whatever (this is proof of concept kinda stuff right now...) - IO now has a "default" port type (passed to the constructor and stored as a member), used by ensure_io (and similar) to create n ports. IO::register_***_port has a type argument that defaults to the default type if not passed. Rationale: previous IO API is identical, no changes needed to existing code, but path is paved for multiple port types in one IO, which we will need for eg synth plugin inserts, among other things. This is not quite ideal (best would be to only have the two port register functions and have them take a type), but the alternative is a lot of work (namely destroying the 'ensure' functions and everything that uses them) for very little gain. (I am convinced after quite a few tries at the whiteboard that subclassing IO in any way is not a feasible option, look at it's inheritance diagram in Doxygen and you can see why) - AudioEngine::register_audio_input_port is now register_input_port and takes a type argument. Ditto for output. - (Most significant change) AudioDiskstream abstracted into Distream, and sibling MidiDiskstream created. Very much still a work in progress, but Diskstream is there to switch references over to (most already are), which is the important part. It is still unclear what the MIDI diskstream's relation to channels is, but I'm pretty sure they will be single channel only (so SMF Type 0) since noone can come up with a reason otherwise. - MidiTrack creation. Same thing as AudioTrack but with a different default type basically. No big deal here. - Random cleanups and variable renamings etc. because I have OCD and can't help myself. :) Known broken: Loading of sessions containing MIDI tracks. git-svn-id: svn://localhost/ardour2/branches/midi@641 d708f5d6-7413-0410-9779-e7cbd77b26cf
2006-06-26 12:01:34 -04:00
using namespace PBD;
using namespace Gtkmm2ext;
using namespace Gtk;
PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert> insert, bool scrollable)
: parent (win)
, was_visible (false)
, _keyboard_focused (false)
{
bool have_gui = 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;
_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
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"), 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_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, 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;
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_preset_list ();
_pluginui->update_preset ();
}
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 std::string& title)
{
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;
_pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
add (*vpu);
vpu->package (*this);
}
return true;
#endif
}
bool
#ifdef GTKOSX
PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
#else
PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert>)
#endif
{
#ifndef GTKOSX
return false;
#else
VBox* box;
_pluginui = create_au_gui (insert, &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 GTKOSX
PluginUIWindow::app_activated (bool yn)
#else
PluginUIWindow::app_activated (bool)
#endif
{
#ifdef 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);
}
return true;
#endif
}
void
PluginUIWindow::keyboard_focused (bool yn)
{
_keyboard_focused = yn;
}
bool
PluginUIWindow::on_key_press_event (GdkEventKey* event)
{
if (_keyboard_focused) {
if (_pluginui) {
if (_pluginui->non_gtk_gui()) {
_pluginui->forward_key_event (event);
} else {
return relay_key_press (event, this);
}
}
return true;
} else {
/* for us to be getting key press events, there really
MUST be a _pluginui, but just to be safe, check ...
*/
if (_pluginui) {
if (_pluginui->non_gtk_gui()) {
/* pass editor 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, &PublicEditor::instance());
} else {
return relay_key_press (event, this);
}
} else {
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;
}
return false;
} else {
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()),
add_button (_("Add")),
save_button (_("Save")),
delete_button (_("Delete")),
bypass_button (_("Bypass")),
latency_gui (0),
plugin_analysis_expander (_("Plugin analysis"))
{
_preset_combo.set_size_request (100, -1);
_preset_modified.set_size_request (16, -1);
_preset_combo.signal_changed().connect(sigc::mem_fun(*this, &PlugUIBase::preset_selected));
_no_load_preset = 0;
_preset_box.pack_start (_preset_combo);
_preset_box.pack_start (_preset_modified);
update_preset_list ();
update_preset ();
add_button.set_name ("PluginAddButton");
add_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::add_plugin_setting));
save_button.set_name ("PluginSaveButton");
save_button.signal_clicked().connect(sigc::mem_fun(*this, &PlugUIBase::save_plugin_setting));
delete_button.set_name ("PluginDeleteButton");
delete_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::delete_plugin_setting));
insert->ActiveChanged.connect (active_connection, invalidator (*this), 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, string_compose (_("Click to allow the plugin to receive keyboard events that %1 would normally use as a shortcut"), PROGRAM_NAME));
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, invalidator (*this), boost::bind (&PlugUIBase::plugin_going_away, this), gui_context());
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->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::parameter_changed, this, _1, _2), 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 ()
{
framecnt_t const l = insert->effective_latency ();
framecnt_t const sr = insert->session().frame_rate ();
string t;
if (l < sr / 1000) {
t = string_compose (_("latency (%1 samples)"), l);
} else {
t = string_compose (_("latency (%1 ms)"), (float) l / ((float) sr / 1000.0f));
}
latency_label.set_text (t);
}
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::preset_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);
} else {
warning << string_compose(_("Plugin preset %1 not found"),
_preset_combo.get_active_text()) << endmsg;
}
}
}
void
PlugUIBase::add_plugin_setting ()
{
NewPluginPresetDialog d (plugin);
switch (d.run ()) {
case Gtk::RESPONSE_ACCEPT:
if (d.name().empty()) {
break;
}
if (d.replace ()) {
plugin->remove_preset (d.name ());
}
Plugin::PresetRecord const r = plugin->save_preset (d.name());
if (!r.uri.empty ()) {
plugin->load_preset (r);
}
break;
}
}
void
PlugUIBase::save_plugin_setting ()
{
string const name = _preset_combo.get_active_text ();
plugin->remove_preset (name);
Plugin::PresetRecord const r = plugin->save_preset (name);
if (!r.uri.empty ()) {
plugin->load_preset (r);
}
}
void
PlugUIBase::delete_plugin_setting ()
{
plugin->remove_preset (_preset_combo.get_active_text ());
}
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, 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 ();
ARDOUR_UI::instance()->set_tip (focus_button, string_compose (_("Click to allow normal use of %1 keyboard shortcuts"), PROGRAM_NAME));
KeyboardFocused (true);
}
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_preset_list ()
{
vector<string> preset_labels;
vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets();
++_no_load_preset;
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;
}
void
PlugUIBase::update_preset ()
{
Plugin::PresetRecord p = plugin->last_preset();
++_no_load_preset;
_preset_combo.set_active_text (p.label);
--_no_load_preset;
save_button.set_sensitive (!p.uri.empty() && p.user);
delete_button.set_sensitive (!p.uri.empty() && p.user);
update_preset_modified ();
}
void
PlugUIBase::update_preset_modified ()
{
if (plugin->last_preset().uri.empty()) {
_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 ? "*" : "");
}
}
void
PlugUIBase::parameter_changed (uint32_t, float)
{
update_preset_modified ();
}
void
PlugUIBase::preset_added_or_removed ()
{
/* Update both the list and the currently-displayed preset */
update_preset_list ();
update_preset ();
}