/* 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. $Id$ */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef VST_SUPPORT #include #endif #include #include "ardour_ui.h" #include "prompter.h" #include "plugin_ui.h" #include "utils.h" #include "gui_thread.h" #include "i18n.h" using namespace std; using namespace ARDOUR; using namespace Gtkmm2ext; using namespace Gtk; using namespace sigc; PluginUIWindow::PluginUIWindow (AudioEngine &engine, PluginInsert& insert, bool scrollable) : ArdourDialog ("plugin ui") { if (insert.plugin().has_editor()) { #ifdef VST_SUPPORT VSTPlugin* vp; if ((vp = dynamic_cast (&insert.plugin())) != 0) { VSTPluginUI* vpu = new VSTPluginUI (insert, *vp); _pluginui = vpu; add (*vpu); vpu->package (*this); } else { #endif error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)") << endmsg; throw failed_constructor (); #ifdef VST_SUPPORT } #endif } else { PluginUI* pu = new PluginUI (engine, insert, scrollable); _pluginui = pu; add (*pu); map_event.connect (mem_fun (*pu, &PluginUI::start_updating)); unmap_event.connect (mem_fun (*pu, &PluginUI::stop_updating)); } set_position (Gtk::WIN_POS_MOUSE); set_name ("PluginEditor"); add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK); delete_event.connect (bind (ptr_fun (just_hide_it), reinterpret_cast (this))); insert.GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away)); if (scrollable) { gint h = _pluginui->get_preferred_height (); if (h > 600) h = 600; set_default_size (450, h); } } PluginUIWindow::~PluginUIWindow () { } PluginUI::PluginUI (AudioEngine &engine, PluginInsert& pi, bool scrollable) : PlugUIBase (pi), engine(engine), button_table (initial_button_rows, initial_button_cols), output_table (initial_output_rows, initial_output_cols), automation_menu (0), is_scrollable(scrollable) { set_name ("PluginEditor"); set_border_width (10); set_homogeneous (false); settings_box.set_homogeneous (false); HBox* constraint_hbox = manage (new HBox); HBox* smaller_hbox = manage (new HBox); smaller_hbox->pack_start (combo, false, false); smaller_hbox->pack_start (save_button, false, false); constraint_hbox->set_spacing (10); constraint_hbox->pack_start (*smaller_hbox, true, false); constraint_hbox->pack_end (bypass_button, false, false); // name_ebox.add (*text_hbox); // info_vbox.pack_start (name_ebox, false, false); // info_vbox.pack_start (makerinfo_label, false, false); // info_vbox.pack_start (paraminfo_label, false, false, 5); // settings_box.pack_start (info_vbox, false, false, 10); settings_box.pack_end (*constraint_hbox, false, false); pack_start (settings_box, false, false); if ( is_scrollable ) { scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC); scroller.set_name ("PluginEditor"); scroller_view.set_name("PluginEditor"); scroller_view.add (hpacker); scroller.add (scroller_view); pack_start (scroller, true, true); } else { pack_start (hpacker, false, false); // this is a hack to get the theme right name_ebox.set_name ("PluginNameBox"); } insert.active_changed.connect (mem_fun(*this, &PluginUI::redirect_active_changed)); bypass_button.set_active (!insert.active()); build (engine); } PluginUI::~PluginUI () { if (output_controls.size() > 0) { screen_update_connection.disconnect(); } } void PluginUI::build (AudioEngine &engine) { guint32 i = 0; guint32 x = 0; Frame* frame; Frame* bt_frame; VBox* box; char info[32]; int output_row, output_col; int button_row, button_col; int output_rows, output_cols; int button_rows, button_cols; guint32 n_ins=0, n_outs = 0; prefheight = 30; hpacker.set_spacing (10); output_rows = initial_output_rows; output_cols = initial_output_cols; button_rows = initial_button_rows; button_cols = initial_button_cols; output_row = 0; button_row = 0; output_col = 0; button_col = 0; button_table.set_homogeneous (false); button_table.set_row_spacings (2); button_table.set_col_spacings (2); output_table.set_homogeneous (true); output_table.set_row_spacings (2); output_table.set_col_spacings (2); button_table.set_border_width (5); output_table.set_border_width (5); hpacker.set_border_width (10); bt_frame = manage (new Frame); bt_frame->set_name ("BaseFrame"); bt_frame->add (button_table); hpacker.pack_start(*bt_frame, true, true); box = manage (new VBox); frame = manage (new Frame); frame->set_name ("BaseFrame"); frame->add (*box); hpacker.pack_start(*frame, true, true); box->set_border_width (5); box->set_spacing (1); /* find all ports. build control elements for all appropriate control ports */ for (i = 0; i < plugin.parameter_count(); ++i) { if (plugin.parameter_is_control (i)) { ControlUI* cui; /* if we are scrollable, just use one long column */ if (!is_scrollable) { if (x++ > 7){ frame = manage (new Frame); frame->set_name ("BaseFrame"); box = manage (new VBox); box->set_border_width (5); box->set_spacing (1); frame->add (*box); hpacker.pack_start(*frame,true,true); x = 0; } } /* Don't show latency control ports */ if (plugin.describe_parameter (i) == X_("latency")) { continue; } if ((cui = build_control_ui (engine, i, plugin.get_nth_midi_control (i))) == 0) { error << compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg; continue; } if (cui->control || cui->clickbox || cui->combo) { box->pack_start (*cui, false, false); } else if (cui->button) { if (button_row == button_rows) { button_row = 0; if (++button_col == button_cols) { button_cols += 2; button_table.resize (button_rows, button_cols); } } button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1, Gtk::FILL|Gtk::EXPAND, 0); button_row++; } else if (cui->display) { if (output_row == output_rows) { output_row = 0; if (++output_col == output_cols) { output_cols += 2; output_table.resize (output_rows, output_cols); } } output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1, Gtk::FILL|Gtk::EXPAND, 0); output_row++; } /* HACK: ideally the preferred height would be queried from the complete hpacker, but I can't seem to get that information in time, so this is an estimation */ prefheight += 30; } } n_ins = plugin.get_info().n_inputs; n_outs = plugin.get_info().n_outputs; if (box->children().empty()) { hpacker.remove (*frame); } if (button_table.children().empty()) { hpacker.remove (*bt_frame); } if (!output_table.children().empty()) { frame = manage (new Frame); frame->set_name ("BaseFrame"); frame->add (output_table); hpacker.pack_end (*frame, true, true); } output_update (); string pname = plugin.name(); if (pname.length() > 24) { pname = pname.substr (0, 24); pname += "..."; ARDOUR_UI::instance()->tooltips().set_tip(name_ebox, plugin.name()); } nameinfo_label.set_text (pname); nameinfo_label.set_name ("PluginNameInfo"); nameinfo_label.set_alignment (0.0, 0.0); string maker = plugin.maker(); string::size_type email_pos; if ((email_pos = maker.find_first_of ('<')) != string::npos) { maker = maker.substr (0, email_pos - 1); } if (maker.length() > 32) { maker = maker.substr (0, 32); maker += " ..."; } makerinfo_label.set_text (maker); makerinfo_label.set_name ("PluginMakerInfo"); makerinfo_label.set_alignment (0.0, 0.0); snprintf (info, sizeof(info),"[ %u %s | %u %s ]", n_ins, ngettext(_("in"), _("ins"), n_ins), n_outs, ngettext(_("out"), _("outs"), n_outs)); paraminfo_label.set_text (info); paraminfo_label.set_name ("PluginParameterInfo"); paraminfo_label.set_alignment (0.0, 0.0); output_table.show_all (); button_table.show_all (); } PluginUI::ControlUI::ControlUI () : automate_button (X_("")) // force creation of a label { automate_button.set_name ("PluginAutomateButton"); ARDOUR_UI::instance()->tooltips().set_tip (automate_button, _("automation control")); /* don't fix the height, it messes up the bar controllers */ set_size_request_to_display_given_text (automate_button, X_("longenuff"), 2, -1); ignore_change = 0; display = 0; button = 0; control = 0; clickbox = 0; adjustment = 0; meterinfo = 0; } PluginUI::ControlUI::~ControlUI() { if (adjustment) { delete adjustment; } if (meterinfo) { delete meterinfo->meter; delete meterinfo; } } void PluginUI::automation_state_changed (ControlUI* cui) { /* update button label */ switch (insert.get_port_automation_state (cui->port_index) & (Off|Play|Touch|Write)) { case Off: static_cast(cui->automate_button.get_child())->set_text (_("off")); break; case Play: static_cast(cui->automate_button.get_child())->set_text (_("play")); break; case Write: static_cast(cui->automate_button.get_child())->set_text (_("write")); break; case Touch: static_cast(cui->automate_button.get_child())->set_text (_("touch")); break; default: static_cast(cui->automate_button.get_child())->set_text (_("???")); break; } } static void integer_printer (char buf[32], Adjustment &adj, void *arg) { snprintf (buf, 32, "%.0f", adj.get_value()); } void PluginUI::print_parameter (char *buf, uint32_t len, uint32_t param) { plugin.print_parameter (param, buf, len); } PluginUI::ControlUI* PluginUI::build_control_ui (AudioEngine &engine, guint32 port_index, MIDI::Controllable* mcontrol) { ControlUI* control_ui; Plugin::ParameterDescriptor desc; plugin.get_parameter_descriptor (port_index, desc); control_ui = manage (new ControlUI ()); control_ui->adjustment = 0; control_ui->combo = 0; control_ui->combo_map = 0; control_ui->port_index = port_index; control_ui->update_pending = false; control_ui->label.set_text (desc.label); control_ui->label.set_alignment (0.0, 0.5); control_ui->label.set_name ("PluginParameterLabel"); control_ui->set_spacing (5); if (plugin.parameter_is_input (port_index)) { LadspaPlugin* lp; if ((lp = dynamic_cast(&plugin)) != 0) { lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index); if (defaults && defaults->count > 0) { control_ui->combo = new Gtk::Combo; control_ui->combo->set_value_in_list(true, false); set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui)); control_ui->combo->get_popwin()->signal_unmap_event(), un(*this, &PluginUI::control_combo_changed), control_ui)); plugin.ParameterChanged.connect (bind (mem_fun(*this, &PluginUI::parameter_changed), control_ui)); control_ui->pack_start(control_ui->label, true, true); control_ui->pack_start(*control_ui->combo, false, true); update_control_display(control_ui); lrdf_free_setting_values(defaults); return control_ui; } } if (desc.toggled) { /* Build a button */ control_ui->button = manage (new ToggleButton ()); control_ui->button->set_name ("PluginEditorButton"); control_ui->button->set_size_request (20, 20); control_ui->pack_start (control_ui->label, true, true); control_ui->pack_start (*control_ui->button, false, true); control_ui->pack_start (control_ui->automate_button, false, false); control_ui->button-.signal_clicked().connect (bind (mem_fun(*this, &PluginUI::control_port_toggled), control_ui)); if(plugin.get_parameter (port_index) == 1){ control_ui->button->set_active(true); } return control_ui; } control_ui->adjustment = new Adjustment (0, 0, 0, 0, 0); /* XXX this code is not right yet, because it doesn't handle the absence of bounds in any sensible fashion. */ control_ui->adjustment->set_lower (desc.lower); control_ui->adjustment->set_upper (desc.upper); control_ui->logarithmic = desc.logarithmic; if (control_ui->logarithmic) { if (control_ui->adjustment->get_lower() == 0.0) { control_ui->adjustment->set_lower (control_ui->adjustment->get_upper()/10000); } control_ui->adjustment->set_upper (log(control_ui->adjustment->get_upper())); control_ui->adjustment->set_lower (log(control_ui->adjustment->get_lower())); } float delta = desc.upper - desc.lower; control_ui->adjustment->set_page_size (delta/100.0); control_ui->adjustment->set_step_increment (desc.step); control_ui->adjustment->set_page_increment (desc.largestep); if (desc.integer_step) { control_ui->clickbox = new ClickBox (control_ui->adjustment, "PluginUIClickBox"); Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2); control_ui->clickbox->set_print_func (integer_printer, 0); } else { // control_ui->control = new HSliderController (ARDOUR_UI::instance()->plugin_ui_slider_pix(), // control_ui->adjustment, // mcontrol); sigc::slot pslot = sigc::bind (mem_fun(*this, &PluginUI::print_parameter), (uint32_t) port_index); control_ui->control = new BarController (*control_ui->adjustment, mcontrol, pslot); control_ui->control->set_size_request (200, 15); control_ui->control->set_name (X_("PluginSlider")); control_ui->control->set_style (BarController::LeftToRight); control_ui->control->set_use_parent (true); control_ui->control->get_spin_button().signal_focus_in_event()().connect (mem_fun(*this, &PluginUI::entry_focus_event)); control_ui->control->get_spin_button().signal_focus_out_event()().connect (mem_fun(*this, &PluginUI::entry_focus_event)); control_ui->control->StartGesture.connect (bind (mem_fun(*this, &PluginUI::start_touch), control_ui)); control_ui->control->StopGesture.connect (bind (mem_fun(*this, &PluginUI::stop_touch), control_ui)); } if (control_ui->logarithmic) { control_ui->adjustment->set_value(log(plugin.get_parameter(port_index))); } else{ control_ui->adjustment->set_value(plugin.get_parameter(port_index)); } /* XXX memory leak: SliderController not destroyed by ControlUI destructor, and manage() reports object hierarchy ambiguity. */ control_ui->pack_start (control_ui->label, true, true); if (desc.integer_step) { control_ui->pack_start (*control_ui->clickbox, false, false); } else { control_ui->pack_start (*control_ui->control, false, false); } control_ui->pack_start (control_ui->automate_button, false, false); control_ui->adjustment->value_changed.connect (bind (mem_fun(*this, &PluginUI::control_adjustment_changed), control_ui)); control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &PluginUI::astate_clicked), control_ui, (uint32_t) port_index)); automation_state_changed (control_ui); plugin.ParameterChanged.connect (bind (mem_fun(*this, &PluginUI::parameter_changed), control_ui)); insert.automation_list (port_index).automation_state_changed.connect (bind (mem_fun(*this, &PluginUI::automation_state_changed), control_ui)); } else if (plugin.parameter_is_output (port_index)) { control_ui->display = manage (new EventBox); control_ui->display->set_name ("ParameterValueDisplay"); control_ui->display_label = manage (new Label); control_ui->display_label->set_name ("ParameterValueDisplay"); control_ui->display->add (*control_ui->display_label); Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "g999999", 2, 2); control_ui->display->show_all (); /* set up a meter */ /* TODO: only make a meter if the port is Hinted for it */ MeterInfo * info = new MeterInfo(port_index); control_ui->meterinfo = info; info->meter = new FastMeter (100, 5, FastMeter::Horizontal); info->min_unbound = desc.min_unbound; info->max_unbound = desc.max_unbound; info->min = desc.lower; info->max = desc.upper; control_ui->vbox = manage (new VBox); control_ui->vbox->pack_start (control_ui->label, false, false); control_ui->vbox->pack_start (*info->meter, false, false); control_ui->pack_start (*control_ui->vbox, false, false); control_ui->pack_start (*control_ui->display, false, false); control_ui->meterinfo->meter->show_all(); control_ui->meterinfo->packed = true; output_controls.push_back (control_ui); } plugin.ParameterChanged.connect (bind (mem_fun(*this, &PluginUI::parameter_changed), control_ui)); return control_ui; } void PluginUI::start_touch (PluginUI::ControlUI* cui) { insert.automation_list (cui->port_index).start_touch (); } void PluginUI::stop_touch (PluginUI::ControlUI* cui) { insert.automation_list (cui->port_index).stop_touch (); } void PluginUI::astate_clicked (ControlUI* cui, uint32_t port) { using namespace Menu_Helpers; if (automation_menu == 0) { automation_menu = manage (new Menu); automation_menu->set_name ("ArdourContextMenu"); } MenuList& items (automation_menu->items()); items.clear (); items.push_back (MenuElem (_("off"), bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Off, cui))); items.push_back (MenuElem (_("play"), bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Play, cui))); items.push_back (MenuElem (_("write"), bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Write, cui))); items.push_back (MenuElem (_("touch"), bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Touch, cui))); automation_menu->popup (1, 0); } void PluginUI::set_automation_state (AutoState state, ControlUI* cui) { insert.set_port_automation_state (cui->port_index, state); } void PluginUI::control_adjustment_changed (ControlUI* cui) { if (cui->ignore_change) { return; } double value = cui->adjustment->get_value(); if (cui->logarithmic) { value = exp(value); } insert.set_parameter (cui->port_index, (float) value); } void PluginUI::parameter_changed (uint32_t abs_port_id, float val, ControlUI* cui) { if (cui->port_index == abs_port_id) { if (!cui->update_pending) { cui->update_pending = true; Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &PluginUI::update_control_display), cui)); } } } void PluginUI::update_control_display (ControlUI* cui) { /* XXX how do we handle logarithmic stuff here ? */ cui->update_pending = false; float val = plugin.get_parameter (cui->port_index); cui->ignore_change++; if (cui->combo) { map::iterator it; for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) { if (it->second == val) { cui->combo->get_entry()->set_text(it->first); break; } } } else if (cui->adjustment == 0) { if (val > 0.5) { cui->button->set_active (true); } else { cui->button->set_active (false); } } else { if (cui->logarithmic) { val = log(val); } if (val != cui->adjustment->get_value()) { cui->adjustment->set_value (val); } } cui->ignore_change--; } void PluginUI::control_port_toggled (ControlUI* cui) { if (!cui->ignore_change) { insert.set_parameter (cui->port_index, cui->button->get_active()); } } gint PluginUI::control_combo_changed (GdkEventAny* ignored, ControlUI* cui) { if (!cui->ignore_change) { string value = cui->combo->get_entry()->get_text(); map mapping = *cui->combo_map; insert.set_parameter (cui->port_index, mapping[value]); } return FALSE; } void PluginUIWindow::plugin_going_away (ARDOUR::Redirect* ignored) { ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginUIWindow::plugin_going_away), ignored)); _pluginui->stop_updating(0); delete_when_idle (this); } gint PluginUI::entry_focus_event (GdkEventFocus* ev) { if (ev->in) { ARDOUR_UI::instance()->allow_focus (true); } else { ARDOUR_UI::instance()->allow_focus (false); } return TRUE; } void PluginUI::redirect_active_changed (Redirect* r, void* src) { ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginUI::redirect_active_changed), r, src)); bypass_button.set_active (!r->active()); } gint PluginUI::start_updating (GdkEventAny *ev) { if (output_controls.size() > 0 ) { screen_update_connection.disconnect(); screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect (mem_fun(*this, &PluginUI::output_update)); } return FALSE; } gint PluginUI::stop_updating (GdkEventAny *ev) { if (output_controls.size() > 0 ) { screen_update_connection.disconnect(); } return FALSE; } void PluginUI::output_update () { for (vector::iterator i = output_controls.begin(); i != output_controls.end(); ++i) { float val = plugin.get_parameter ((*i)->port_index); char buf[32]; snprintf (buf, sizeof(buf), "%.2f", val); (*i)->display_label->set_text (buf); /* autoscaling for the meter */ if ((*i)->meterinfo && (*i)->meterinfo->packed) { if (val < (*i)->meterinfo->min) { if ((*i)->meterinfo->min_unbound) (*i)->meterinfo->min = val; else val = (*i)->meterinfo->min; } if (val > (*i)->meterinfo->max) { if ((*i)->meterinfo->max_unbound) (*i)->meterinfo->max = val; else val = (*i)->meterinfo->max; } if ((*i)->meterinfo->max > (*i)->meterinfo->min ) { float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ; (*i)->meterinfo->meter->set (lval ); } } } } list PluginUI::setup_scale_values(guint32 port_index, ControlUI* cui) { list enums; LadspaPlugin* lp = dynamic_cast (&plugin); cui->combo_map = new map; lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index); if (defaults) { for (uint32_t i = 0; i < defaults->count; ++i) { enums.push_back(defaults->items[i].label); pair newpair; newpair.first = defaults->items[i].label; newpair.second = defaults->items[i].value; cui->combo_map->insert(newpair); } lrdf_free_setting_values(defaults); } return enums; } PlugUIBase::PlugUIBase (PluginInsert& pi) : insert (pi), plugin (insert.plugin()), save_button(_("save")), bypass_button (_("bypass")) { combo.set_value_in_list(true,true); combo.set_use_arrows(true); combo.set_use_arrows_always(true); set_popdown_strings (combo, plugin.get_presets()); combo.set_active_text (""); combo.get_popwin()->signal_unmap_event().connect(mem_fun(*this, &PlugUIBase::setting_selected)); save_button.set_name ("PluginSaveButton"); save_button.clicked.connect(mem_fun(*this, &PlugUIBase::save_plugin_setting)); bypass_button.set_name ("PluginBypassButton"); bypass_button.toggled.connect (mem_fun(*this, &PlugUIBase::bypass_toggled)); } gint PlugUIBase::setting_selected(GdkEventAny* ignored) { Entry* entry = combo.get_entry(); if (entry->get_text().length() > 0) { if (!plugin.load_preset(entry->get_text())) { warning << compose(_("Plugin preset %1 not found"), entry->get_text()) << endmsg; } } return FALSE; } void PlugUIBase::save_plugin_setting () { ArdourPrompter prompter (true); prompter.set_prompt(_("Name for plugin settings:")); prompter.show_all(); prompter.done.connect(Main::quit.slot()); Main::run(); if (prompter.status == Gtkmm2ext::Prompter::entered) { string name; prompter.get_result(name); if (name.length()) { if(plugin.save_preset(name)){ set_popdown_strings (combo, plugin.get_presets()); combo.set_active_text (name); } } } } void PlugUIBase::bypass_toggled () { bool x; if ((x = bypass_button.get_active()) == insert.active()) { insert.set_active (!x, this); } }