Fix corruption of follow playhead state on quit (#4048).
[ardour2.git] / gtk2_ardour / generic_pluginui.cc
blob3ed935275551e65b2e059b9f566d7a2ed3d277c4
1 /*
2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifdef WAF_BUILD
21 #include "gtk2ardour-config.h"
22 #endif
24 #include <climits>
25 #include <cerrno>
26 #include <cmath>
27 #include <string>
29 #include "pbd/stl_delete.h"
30 #include "pbd/xml++.h"
31 #include "pbd/failed_constructor.h"
33 #include <gtkmm2ext/click_box.h>
34 #include <gtkmm2ext/fastmeter.h>
35 #include <gtkmm2ext/barcontroller.h>
36 #include <gtkmm2ext/utils.h>
37 #include <gtkmm2ext/doi.h>
38 #include <gtkmm2ext/slider_controller.h>
40 #include "midi++/manager.h"
42 #include "ardour/plugin.h"
43 #include "ardour/plugin_insert.h"
44 #include "ardour/session.h"
46 #include <lrdf.h>
48 #include "ardour_ui.h"
49 #include "prompter.h"
50 #include "plugin_ui.h"
51 #include "utils.h"
52 #include "gui_thread.h"
53 #include "automation_controller.h"
55 #include "i18n.h"
57 using namespace std;
58 using namespace ARDOUR;
59 using namespace PBD;
60 using namespace Gtkmm2ext;
61 using namespace Gtk;
63 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
64 : PlugUIBase (pi),
65 button_table (initial_button_rows, initial_button_cols),
66 output_table (initial_output_rows, initial_output_cols),
67 hAdjustment(0.0, 0.0, 0.0),
68 vAdjustment(0.0, 0.0, 0.0),
69 scroller_view(hAdjustment, vAdjustment),
70 automation_menu (0),
71 is_scrollable(scrollable)
73 set_name ("PluginEditor");
74 set_border_width (10);
75 //set_homogeneous (false);
77 pack_start (main_contents, false, false);
78 settings_box.set_homogeneous (false);
80 HBox* constraint_hbox = manage (new HBox);
81 HBox* smaller_hbox = manage (new HBox);
82 smaller_hbox->set_spacing (4);
83 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
84 combo_label->set_use_markup (true);
86 latency_button.add (latency_label);
87 latency_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
88 set_latency_label ();
90 smaller_hbox->pack_start (latency_button, false, false, 10);
91 smaller_hbox->pack_start (_preset_box, false, false);
92 smaller_hbox->pack_start (add_button, false, false);
93 smaller_hbox->pack_start (save_button, false, false);
94 smaller_hbox->pack_start (delete_button, false, false);
95 smaller_hbox->pack_start (bypass_button, false, true);
97 constraint_hbox->set_spacing (5);
98 constraint_hbox->set_homogeneous (false);
100 VBox* v1_box = manage (new VBox);
101 VBox* v2_box = manage (new VBox);
102 pack_end (plugin_analysis_expander, true, true);
104 v1_box->pack_start (*smaller_hbox, false, true);
105 v2_box->pack_start (focus_button, false, true);
107 main_contents.pack_start (settings_box, false, false);
109 constraint_hbox->pack_end (*v2_box, false, false);
110 constraint_hbox->pack_end (*v1_box, false, false);
112 main_contents.pack_start (*constraint_hbox, false, false);
114 if ( is_scrollable ) {
115 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
116 scroller.set_name ("PluginEditor");
117 scroller_view.set_name("PluginEditor");
118 scroller_view.add (hpacker);
119 scroller.add (scroller_view);
121 main_contents.pack_start (scroller, true, true);
124 else {
125 main_contents.pack_start (hpacker, false, false);
128 pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
130 bypass_button.set_active (!pi->active());
132 build ();
135 GenericPluginUI::~GenericPluginUI ()
137 if (output_controls.size() > 0) {
138 screen_update_connection.disconnect();
142 void
143 GenericPluginUI::build ()
145 guint32 i = 0;
146 guint32 x = 0;
147 Frame* frame;
148 Frame* bt_frame;
149 VBox* box;
150 int output_row, output_col;
151 int button_row, button_col;
152 int output_rows, output_cols;
153 int button_rows, button_cols;
155 prefheight = 30;
156 hpacker.set_spacing (10);
158 output_rows = initial_output_rows;
159 output_cols = initial_output_cols;
160 button_rows = initial_button_rows;
161 button_cols = initial_button_cols;
162 output_row = 0;
163 button_row = 0;
164 output_col = 0;
165 button_col = 0;
167 button_table.set_homogeneous (false);
168 button_table.set_row_spacings (2);
169 button_table.set_col_spacings (2);
170 output_table.set_homogeneous (true);
171 output_table.set_row_spacings (2);
172 output_table.set_col_spacings (2);
173 button_table.set_border_width (5);
174 output_table.set_border_width (5);
176 hpacker.set_border_width (10);
178 bt_frame = manage (new Frame);
179 bt_frame->set_name ("BaseFrame");
180 bt_frame->add (button_table);
181 hpacker.pack_start(*bt_frame, true, true);
183 box = manage (new VBox);
184 box->set_border_width (5);
185 box->set_spacing (1);
187 frame = manage (new Frame);
188 frame->set_name ("BaseFrame");
189 frame->set_label (_("Controls"));
190 frame->add (*box);
191 hpacker.pack_start(*frame, true, true);
193 /* find all ports. build control elements for all appropriate control ports */
195 for (i = 0; i < plugin->parameter_count(); ++i) {
197 if (plugin->parameter_is_control (i)) {
199 /* Don't show latency control ports */
201 if (plugin->describe_parameter (Evoral::Parameter(PluginAutomation, 0, i)) == X_("latency")) {
202 continue;
205 ControlUI* cui;
207 /* if we are scrollable, just use one long column */
209 if (!is_scrollable) {
210 if (x++ > 20){
211 frame = manage (new Frame);
212 frame->set_name ("BaseFrame");
213 box = manage (new VBox);
215 box->set_border_width (5);
216 box->set_spacing (1);
218 frame->add (*box);
219 hpacker.pack_start(*frame,true,true);
221 x = 1;
225 boost::shared_ptr<ARDOUR::AutomationControl> c
226 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
227 insert->control(Evoral::Parameter(PluginAutomation, 0, i)));
229 if ((cui = build_control_ui (i, c)) == 0) {
230 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
231 continue;
234 if (cui->controller || cui->clickbox || cui->combo) {
236 box->pack_start (*cui, false, false);
238 } else if (cui->button) {
240 if (button_row == button_rows) {
241 button_row = 0;
242 if (++button_col == button_cols) {
243 button_cols += 2;
244 button_table.resize (button_rows, button_cols);
248 button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
249 FILL|EXPAND, FILL);
250 button_row++;
252 } else if (cui->display) {
254 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
255 FILL|EXPAND, FILL);
257 // TODO: The meters should be divided into multiple rows
259 if (++output_col == output_cols) {
260 output_cols ++;
261 output_table.resize (output_rows, output_cols);
264 /* old code, which divides meters into
265 * columns first, rows later. New code divides into one row
267 if (output_row == output_rows) {
268 output_row = 0;
269 if (++output_col == output_cols) {
270 output_cols += 2;
271 output_table.resize (output_rows, output_cols);
275 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
276 FILL|EXPAND, FILL);
278 output_row++;
282 /* HACK: ideally the preferred height would be queried from
283 the complete hpacker, but I can't seem to get that
284 information in time, so this is an estimation
287 prefheight += 30;
292 if (box->children().empty()) {
293 hpacker.remove (*frame);
296 if (button_table.children().empty()) {
297 hpacker.remove (*bt_frame);
300 if (!output_table.children().empty()) {
301 frame = manage (new Frame);
302 frame->set_name ("BaseFrame");
303 frame->add (output_table);
304 hpacker.pack_end (*frame, true, true);
307 output_update ();
309 output_table.show_all ();
310 button_table.show_all ();
313 GenericPluginUI::ControlUI::ControlUI ()
314 : automate_button (X_("")) // force creation of a label
316 automate_button.set_name ("PluginAutomateButton");
317 ARDOUR_UI::instance()->set_tip (automate_button, _("Automation control"));
319 /* XXX translators: use a string here that will be at least as long
320 as the longest automation label (see ::automation_state_changed()
321 below). be sure to include a descender.
324 set_size_request_to_display_given_text (automate_button, _("Mgnual"), 15, 10);
326 ignore_change = 0;
327 display = 0;
328 button = 0;
329 clickbox = 0;
330 meterinfo = 0;
333 GenericPluginUI::ControlUI::~ControlUI()
335 if (meterinfo) {
336 delete meterinfo->meter;
337 delete meterinfo;
341 void
342 GenericPluginUI::automation_state_changed (ControlUI* cui)
344 /* update button label */
346 // don't lock to avoid deadlock because we're triggered by
347 // AutomationControl::Changed() while the automation lock is taken
348 switch (insert->get_parameter_automation_state (cui->parameter())
349 & (Off|Play|Touch|Write)) {
350 case Off:
351 cui->automate_button.set_label (_("Manual"));
352 break;
353 case Play:
354 cui->automate_button.set_label (_("Play"));
355 break;
356 case Write:
357 cui->automate_button.set_label (_("Write"));
358 break;
359 case Touch:
360 cui->automate_button.set_label (_("Touch"));
361 break;
362 default:
363 cui->automate_button.set_label (_("???"));
364 break;
369 static void integer_printer (char buf[32], Adjustment &adj, void */*arg*/)
371 snprintf (buf, 32, "%.0f", adj.get_value());
374 void
375 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
377 plugin->print_parameter (param, buf, len);
380 GenericPluginUI::ControlUI*
381 GenericPluginUI::build_control_ui (guint32 port_index, boost::shared_ptr<AutomationControl> mcontrol)
383 ControlUI* control_ui = 0;
385 Plugin::ParameterDescriptor desc;
387 plugin->get_parameter_descriptor (port_index, desc);
389 control_ui = manage (new ControlUI ());
390 control_ui->combo = 0;
391 control_ui->combo_map = 0;
392 control_ui->control = mcontrol;
393 control_ui->update_pending = false;
394 control_ui->label.set_text (desc.label);
395 control_ui->label.set_alignment (0.0, 0.5);
396 control_ui->label.set_name ("PluginParameterLabel");
397 control_ui->port_index = port_index;
399 control_ui->set_spacing (5);
401 Gtk::Requisition req (control_ui->automate_button.size_request());
403 if (plugin->parameter_is_input(port_index)) {
405 /* Build a combo box */
407 boost::shared_ptr<ARDOUR::Plugin::ScalePoints> points
408 = plugin->get_scale_points(port_index);
410 if (points) {
411 std::vector<std::string> labels;
412 for (ARDOUR::Plugin::ScalePoints::const_iterator i = points->begin();
413 i != points->end(); ++i) {
414 labels.push_back(i->first);
417 control_ui->combo = new Gtk::ComboBoxText();
418 set_popdown_strings(*control_ui->combo, labels);
419 control_ui->combo->signal_changed().connect(
420 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
421 control_ui));
422 mcontrol->Changed.connect(control_connections, invalidator(*this),
423 boost::bind(&GenericPluginUI::ui_parameter_changed,
424 this, control_ui),
425 gui_context());
426 control_ui->pack_start(control_ui->label, true, true);
427 control_ui->pack_start(*control_ui->combo, false, true);
429 update_control_display(control_ui);
431 return control_ui;
434 if (desc.toggled) {
436 /* Build a button */
438 control_ui->button = manage (new ToggleButton ());
439 control_ui->button->set_name ("PluginEditorButton");
440 control_ui->button->set_size_request (20, 20);
442 control_ui->pack_start (control_ui->label, true, true);
443 control_ui->pack_start (*control_ui->button, false, true);
444 control_ui->pack_start (control_ui->automate_button, false, false);
446 control_ui->button->signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui));
447 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
449 mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::toggle_parameter_changed, this, control_ui), gui_context());
450 mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
452 if (plugin->get_parameter (port_index) > 0.5){
453 control_ui->button->set_active(true);
456 automation_state_changed (control_ui);
458 return control_ui;
461 /* create the controller */
463 if (mcontrol) {
464 control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), mcontrol);
467 /* XXX this code is not right yet, because it doesn't handle
468 the absence of bounds in any sensible fashion.
471 Adjustment* adj = control_ui->controller->adjustment();
472 boost::shared_ptr<PluginInsert::PluginControl> pc = boost::dynamic_pointer_cast<PluginInsert::PluginControl> (control_ui->control);
474 adj->set_lower (pc->user_to_ui (desc.lower));
475 adj->set_upper (pc->user_to_ui (desc.upper));
477 adj->set_step_increment (desc.step);
478 adj->set_page_increment (desc.largestep);
480 if (desc.integer_step) {
481 control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox");
482 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
483 control_ui->clickbox->set_print_func (integer_printer, 0);
484 } else {
485 //sigc::slot<void,char*,uint32_t> pslot = sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
487 control_ui->controller->set_size_request (200, req.height);
488 control_ui->controller->set_name (X_("PluginSlider"));
489 control_ui->controller->set_style (BarController::LeftToRight);
490 control_ui->controller->set_use_parent (true);
491 control_ui->controller->set_logarithmic (desc.logarithmic);
493 control_ui->controller->StartGesture.connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::start_touch), control_ui));
494 control_ui->controller->StopGesture.connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::stop_touch), control_ui));
498 adj->set_value (pc->plugin_to_ui (plugin->get_parameter (port_index)));
500 /* XXX memory leak: SliderController not destroyed by ControlUI
501 destructor, and manage() reports object hierarchy
502 ambiguity.
505 control_ui->pack_start (control_ui->label, true, true);
506 if (desc.integer_step) {
507 control_ui->pack_start (*control_ui->clickbox, false, false);
508 } else {
509 control_ui->pack_start (*control_ui->controller, false, false);
512 control_ui->pack_start (control_ui->automate_button, false, false);
513 control_ui->automate_button.signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
515 automation_state_changed (control_ui);
517 mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::ui_parameter_changed, this, control_ui), gui_context());
518 mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
520 input_controls.push_back (control_ui);
522 } else if (plugin->parameter_is_output (port_index)) {
524 control_ui->display = manage (new EventBox);
525 control_ui->display->set_name ("ParameterValueDisplay");
527 control_ui->display_label = manage (new Label);
529 control_ui->display_label->set_name ("ParameterValueDisplay");
531 control_ui->display->add (*control_ui->display_label);
532 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
534 control_ui->display->show_all ();
536 /* set up a meter */
537 /* TODO: only make a meter if the port is Hinted for it */
539 MeterInfo * info = new MeterInfo(port_index);
540 control_ui->meterinfo = info;
542 info->meter = new FastMeter (5, 5, FastMeter::Vertical);
544 info->min_unbound = desc.min_unbound;
545 info->max_unbound = desc.max_unbound;
547 info->min = desc.lower;
548 info->max = desc.upper;
550 control_ui->vbox = manage (new VBox);
551 control_ui->hbox = manage (new HBox);
553 control_ui->label.set_angle(90);
554 control_ui->hbox->pack_start (control_ui->label, false, false);
555 control_ui->hbox->pack_start (*info->meter, false, false);
557 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
559 control_ui->vbox->pack_start (*control_ui->display, false, false);
561 control_ui->pack_start (*control_ui->vbox);
563 control_ui->meterinfo->meter->show_all();
564 control_ui->meterinfo->packed = true;
566 output_controls.push_back (control_ui);
569 if (mcontrol) {
570 mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::ui_parameter_changed, this, control_ui), gui_context());
573 return control_ui;
576 void
577 GenericPluginUI::start_touch (GenericPluginUI::ControlUI* cui)
579 cui->control->start_touch (cui->control->session().transport_frame());
582 void
583 GenericPluginUI::stop_touch (GenericPluginUI::ControlUI* cui)
585 cui->control->stop_touch (false, cui->control->session().transport_frame());
588 void
589 GenericPluginUI::astate_clicked (ControlUI* cui, uint32_t /*port*/)
591 using namespace Menu_Helpers;
593 if (automation_menu == 0) {
594 automation_menu = manage (new Menu);
595 automation_menu->set_name ("ArdourContextMenu");
598 MenuList& items (automation_menu->items());
600 items.clear ();
601 items.push_back (MenuElem (_("Manual"),
602 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Off, cui)));
603 items.push_back (MenuElem (_("Play"),
604 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
605 items.push_back (MenuElem (_("Write"),
606 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
607 items.push_back (MenuElem (_("Touch"),
608 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
610 automation_menu->popup (1, gtk_get_current_event_time());
613 void
614 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
616 insert->set_parameter_automation_state (cui->parameter(), state);
619 void
620 GenericPluginUI::toggle_parameter_changed (ControlUI* cui)
622 float val = cui->control->get_value();
624 if (!cui->ignore_change) {
625 if (val > 0.5) {
626 cui->button->set_active (true);
627 } else {
628 cui->button->set_active (false);
633 void
634 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
636 if (!cui->update_pending) {
637 cui->update_pending = true;
638 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
642 void
643 GenericPluginUI::update_control_display (ControlUI* cui)
645 /* XXX how do we handle logarithmic stuff here ? */
647 cui->update_pending = false;
649 float val = cui->control->get_value();
651 cui->ignore_change++;
653 if (cui->combo) {
654 std::map<string,float>::iterator it;
655 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
656 if (it->second == val) {
657 cui->combo->set_active_text(it->first);
658 break;
661 } else if (cui->button) {
663 if (val > 0.5) {
664 cui->button->set_active (true);
665 } else {
666 cui->button->set_active (false);
670 if( cui->controller ) {
671 cui->controller->display_effective_value();
675 /*} else {
676 if (cui->logarithmic) {
677 val = log(val);
679 if (val != cui->adjustment->get_value()) {
680 cui->adjustment->set_value (val);
683 cui->ignore_change--;
686 void
687 GenericPluginUI::control_port_toggled (ControlUI* cui)
689 cui->ignore_change++;
690 insert->automation_control (cui->parameter())->set_value (cui->button->get_active());
691 cui->ignore_change--;
694 void
695 GenericPluginUI::control_combo_changed (ControlUI* cui)
697 if (!cui->ignore_change) {
698 string value = cui->combo->get_active_text();
699 std::map<string,float> mapping = *cui->combo_map;
700 insert->automation_control(cui->parameter())->set_value(mapping[value]);
704 void
705 GenericPluginUI::processor_active_changed (boost::weak_ptr<Processor> weak_processor)
707 ENSURE_GUI_THREAD (*this, &GenericPluginUI::processor_active_changed, weak_processor)
709 boost::shared_ptr<Processor> processor = weak_processor.lock();
711 bypass_button.set_active (!processor || !processor->active());
714 bool
715 GenericPluginUI::start_updating (GdkEventAny*)
717 if (output_controls.size() > 0 ) {
718 screen_update_connection.disconnect();
719 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
720 (sigc::mem_fun(*this, &GenericPluginUI::output_update));
722 return false;
725 bool
726 GenericPluginUI::stop_updating (GdkEventAny*)
728 for (vector<ControlUI*>::iterator i = input_controls.begin(); i != input_controls.end(); ++i) {
729 (*i)->controller->stop_updating ();
732 if (output_controls.size() > 0 ) {
733 screen_update_connection.disconnect();
736 return false;
739 void
740 GenericPluginUI::output_update ()
742 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
743 float val = plugin->get_parameter ((*i)->port_index);
744 char buf[32];
745 snprintf (buf, sizeof(buf), "%.2f", val);
746 (*i)->display_label->set_text (buf);
748 /* autoscaling for the meter */
749 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
751 if (val < (*i)->meterinfo->min) {
752 if ((*i)->meterinfo->min_unbound)
753 (*i)->meterinfo->min = val;
754 else
755 val = (*i)->meterinfo->min;
758 if (val > (*i)->meterinfo->max) {
759 if ((*i)->meterinfo->max_unbound)
760 (*i)->meterinfo->max = val;
761 else
762 val = (*i)->meterinfo->max;
765 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
766 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
767 (*i)->meterinfo->meter->set (lval );