add session-scope selection ops for Stripables
[ardour.git] / gtk2_ardour / generic_pluginui.cc
index 8442d8b9667f1ef55d7626039c203dbc3932eb6d..d6090dea739ce34590c8a6cb7fd29834371fcb18 100644 (file)
 #include "ardour/session.h"
 #include "ardour/value_as_string.h"
 
-#include "ardour_ui.h"
+#include "ardour_spinner.h"
 #include "prompter.h"
 #include "plugin_ui.h"
 #include "gui_thread.h"
 #include "automation_controller.h"
+#include "timers.h"
+#include "tooltips.h"
+#include "ui_config.h"
 
 #include "i18n.h"
 
@@ -56,6 +59,7 @@ using namespace ARDOUR;
 using namespace PBD;
 using namespace Gtkmm2ext;
 using namespace Gtk;
+using namespace ARDOUR_UI_UTILS;
 
 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
        : PlugUIBase (pi)
@@ -82,18 +86,18 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrol
        Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
        combo_label->set_use_markup (true);
 
-       latency_button.add (latency_label);
-       latency_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
+       latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
        set_latency_label ();
 
-       smaller_hbox->pack_start (latency_button, false, false, 10);
+       smaller_hbox->pack_start (latency_button, false, false, 4);
        smaller_hbox->pack_start (_preset_combo, false, false);
        smaller_hbox->pack_start (_preset_modified, false, false);
        smaller_hbox->pack_start (add_button, false, false);
        smaller_hbox->pack_start (save_button, false, false);
        smaller_hbox->pack_start (delete_button, false, false);
-       smaller_hbox->pack_start (bypass_button, false, true);
-       
+       smaller_hbox->pack_start (reset_button, false, false, 4);
+       smaller_hbox->pack_start (bypass_button, false, true, 4);
+
        automation_manual_all_button.set_text(_("Manual"));
        automation_manual_all_button.set_name (X_("generic button"));
        automation_play_all_button.set_text(_("Play"));
@@ -102,7 +106,7 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrol
        automation_write_all_button.set_name (X_("generic button"));
        automation_touch_all_button.set_text(_("Touch"));
        automation_touch_all_button.set_name (X_("generic button"));
-       
+
        Label* l = manage (new Label (_("All Automation")));
        l->set_alignment (1.0, 0.5);
        automation_hbox->pack_start (*l, true, true);
@@ -180,7 +184,7 @@ int value = -1;
 
 static int match_or_digit(char c1, char c2) {
        return c1 == c2 || (isdigit(c1) && isdigit(c2));
-}      
+}
 
 static std::size_t matching_chars_at_head(const string s1, const string s2) {
 std::size_t length, n = 0;
@@ -190,7 +194,7 @@ std::size_t length, n = 0;
                if (!match_or_digit(s1[n], s2[n]))
                        break;
                n++;
-       } 
+       }
        return n;
 }
 
@@ -203,7 +207,7 @@ std::size_t s1pos, s2pos, n = 0;
                if (!match_or_digit(s1[s1pos], s2[s2pos])       )
                        break;
                n++;
-       } 
+       }
        return n;
 }
 
@@ -296,10 +300,11 @@ GenericPluginUI::build ()
 
                        const std::string param_docs = plugin->get_parameter_docs(i);
                        if (!param_docs.empty()) {
-                               ARDOUR_UI::instance()->set_tip(cui, param_docs.c_str());
+                               set_tooltip(cui, param_docs.c_str());
                        }
 
                        control_uis.push_back(cui);
+                       input_controls_with_automation.push_back (cui);
                }
        }
 
@@ -336,11 +341,7 @@ GenericPluginUI::build ()
        for (i = 0; i < control_uis.size(); ++i) {
                ControlUI* cui = control_uis[i];
 
-               if (cui->controller || cui->clickbox || cui->combo) {
-                       // Get all of the controls into a list, so that
-                       // we can lay them out a bit more nicely later.
-                       cui_controls_list.push_back(cui);
-               } else if (cui->button || cui->file_button) {
+               if (cui->button || cui->file_button) {
 
                        if (!is_scrollable && button_row == button_rows) {
                                button_row = 0;
@@ -354,6 +355,11 @@ GenericPluginUI::build ()
                                             FILL|EXPAND, FILL);
                        button_row++;
 
+               } else if (cui->controller || cui->clickbox || cui->combo) {
+                       // Get all of the controls into a list, so that
+                       // we can lay them out a bit more nicely later.
+                       cui_controls_list.push_back(cui);
+
                } else if (cui->display) {
 
                        output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
@@ -370,13 +376,13 @@ GenericPluginUI::build ()
 
        // Iterate over the list of controls to find which adjacent controls
        // are similar enough to be grouped together.
-       
+
        string label, previous_label = "";
        std::vector<int> numbers_in_labels(cui_controls_list.size());
-       
+
        std::vector<float> similarity_scores(cui_controls_list.size());
        float most_similar = 0.0, least_similar = 1.0;
-       
+
        i = 0;
        for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
                label = (*cuip)->label.get_text();
@@ -385,12 +391,12 @@ GenericPluginUI::build ()
                if (i > 0) {
                        // A hand-wavy calculation of how similar this control's
                        // label is to the previous.
-                       similarity_scores[i] = 
-                               (float) ( 
-                                       ( matching_chars_at_head(label, previous_label) + 
+                       similarity_scores[i] =
+                               (float) (
+                                       ( matching_chars_at_head(label, previous_label) +
                                          matching_chars_at_tail(label, previous_label) +
-                                         1 
-                                       ) 
+                                         1
+                                       )
                                ) / (label.length() + previous_label.length());
                        if (numbers_in_labels[i] >= 0) {
                                similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
@@ -402,32 +408,32 @@ GenericPluginUI::build ()
                }
 
                // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
-               previous_label = label;                                
+               previous_label = label;
        }
 
-       
+
        // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
        float similarity_threshold;
-       
+
        if (most_similar > 1.0) {
                similarity_threshold = default_similarity_threshold;
        } else {
                similarity_threshold = most_similar - (1 - default_similarity_threshold);
        }
-       
+
        // Now iterate over the list of controls to display them, placing an
-       // HSeparator between controls of less than a certain similarity, and 
+       // HSeparator between controls of less than a certain similarity, and
        // starting a new column when necessary.
-       
+
        i = 0;
        for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 
                ControlUI* cui = *cuip;
-               
+
                if (!is_scrollable) {
                        x++;
                }
-               
+
                if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
                        if (x > min_controls_per_column) {
                                frame = manage (new Frame);
@@ -473,7 +479,7 @@ GenericPluginUI::build ()
 
        output_table.show_all ();
        button_table.show_all ();
-       
+
        automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
        automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
        automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
@@ -486,7 +492,7 @@ GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
        , file_button(NULL)
 {
        automate_button.set_name ("PluginAutomateButton");
-       ARDOUR_UI::instance()->set_tip (automate_button, _("Automation control"));
+       set_tooltip (automate_button, _("Automation control"));
 
        /* XXX translators: use a string here that will be at least as long
           as the longest automation label (see ::automation_state_changed()
@@ -497,7 +503,7 @@ GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 
        ignore_change = 0;
        display = 0;
-       button = 0;
+       button = false;
        clickbox = 0;
        meterinfo = 0;
 }
@@ -597,7 +603,7 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 
                if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
-                       
+
                        /* Either:
                         *   a) There is a label for each possible value of this input, or
                         *   b) This port is marked as being an enumeration.
@@ -608,7 +614,7 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                                ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
                                i != control_ui->scale_points->end();
                                ++i) {
-                               
+
                                labels.push_back(i->first);
                        }
 
@@ -629,33 +635,6 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                        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 (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui));
-                       control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
-
-                       mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::toggle_parameter_changed, this, control_ui), gui_context());
-                       mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
-
-                       if (value > 0.5){
-                               control_ui->button->set_active(true);
-                       }
-
-                       automation_state_changed (control_ui);
-
-                       return control_ui;
-               }
-
                if (desc.datatype == Variant::PATH) {
 
                        /* Build a file selector button */
@@ -664,7 +643,7 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                        control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
                        control_ui->file_button->set_title(desc.label);
 
-                       control_ui->pack_start (control_ui->label, true, true);
+                       control_ui->pack_start (control_ui->label, false, true);
                        control_ui->pack_start (*control_ui->file_button, true, true);
 
                        // Connect signals (TODO: do this via the Control)
@@ -682,9 +661,10 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                }
 
                /* create the controller */
+               bool use_knob = false; // XXX TODO
 
                if (mcontrol) {
-                       control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol);
+                       control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol, use_knob);
                }
 
                /* XXX this code is not right yet, because it doesn't handle
@@ -693,23 +673,22 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 
                Adjustment* adj = control_ui->controller->adjustment();
 
-               if (desc.integer_step) {
-                       control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", desc.enumeration);
+               if (desc.integer_step && !desc.toggled) {
+                       control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", true);
                        Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
                        if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
                                control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
                        } else {
                                control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
                        }
+               } else if (desc.toggled || use_knob) {
+                       control_ui->controller->set_size_request (req.height, req.height);
                } else {
                        //sigc::slot<void,char*,uint32_t> pslot = sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
 
                        control_ui->controller->set_size_request (200, req.height);
                        control_ui->controller->set_name (X_("ProcessorControlSlider"));
 
-                       control_ui->controller->StartGesture.connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::start_touch), control_ui));
-                       control_ui->controller->StopGesture.connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::stop_touch), control_ui));
-
                }
 
                adj->set_value (mcontrol->internal_to_interface(value));
@@ -720,21 +699,39 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                */
 
                control_ui->pack_start (control_ui->label, true, true);
-               if (desc.integer_step) {
+
+               if (desc.toggled) {
+                       control_ui->button = true;
+                       ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
+                       assert (but);
+                       but->set_name ("pluginui toggle");
+                       update_control_display(control_ui);
+               }
+
+               if (desc.integer_step && !desc.toggled) {
                        control_ui->pack_start (*control_ui->clickbox, false, false);
                } else {
+                       if (!desc.toggled && use_knob) {
+                               ArdourSpinner* spb = manage (new ArdourSpinner (mcontrol, adj, insert));
+                               control_ui->pack_start (*spb, false, false);
+                       }
                        control_ui->pack_start (*control_ui->controller, false, false);
                }
 
                control_ui->pack_start (control_ui->automate_button, false, false);
-               control_ui->automate_button.signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
 
-               automation_state_changed (control_ui);
+               if (mcontrol->flags () & Controllable::NotAutomatable) {
+                       control_ui->automate_button.set_sensitive (false);
+                       set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
+               } else {
+                       control_ui->automate_button.signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
+                       mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
+               }
 
-               mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::ui_parameter_changed, this, control_ui), gui_context());
-               mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
+               automation_state_changed (control_ui);
 
                input_controls.push_back (control_ui);
+               input_controls_with_automation.push_back (control_ui);
 
        } else if (!is_input) {
 
@@ -750,48 +747,55 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 
                control_ui->display->show_all ();
 
-               /* set up a meter */
-               /* TODO: only make a meter if the port is Hinted for it */
+               control_ui->vbox = manage (new VBox);
+               control_ui->vbox->set_spacing(3);
 
-               MeterInfo * info = new MeterInfo();
-               control_ui->meterinfo = info;
+               if (desc.integer_step || desc.enumeration) {
+                       control_ui->vbox->pack_end (*control_ui->display, false, false);
+                       control_ui->vbox->pack_end (control_ui->label, false, false);
+               } else {
+                       /* set up a meter for float ports */
 
-               info->meter = new FastMeter (
-                               5, 5, FastMeter::Vertical, 0,
-                               0x0000aaff,
-                               0x008800ff, 0x008800ff,
-                               0x00ff00ff, 0x00ff00ff,
-                               0xcccc00ff, 0xcccc00ff,
-                               0xffaa00ff, 0xffaa00ff,
-                               0xff0000ff,
-                               ARDOUR_UI::config()->get_MeterBackgroundBot(),
-                               ARDOUR_UI::config()->get_MeterBackgroundTop()
-                               );
+                       MeterInfo * info = new MeterInfo();
+                       control_ui->meterinfo = info;
 
-               info->min_unbound = desc.min_unbound;
-               info->max_unbound = desc.max_unbound;
+                       info->meter = new FastMeter (
+                                       5, 5, FastMeter::Vertical, 0,
+                                       0x0000aaff,
+                                       0x008800ff, 0x008800ff,
+                                       0x00ff00ff, 0x00ff00ff,
+                                       0xcccc00ff, 0xcccc00ff,
+                                       0xffaa00ff, 0xffaa00ff,
+                                       0xff0000ff,
+                                       UIConfiguration::instance().color ("meter background bottom"),
+                                       UIConfiguration::instance().color ("meter background top")
+                                       );
 
-               info->min = desc.lower;
-               info->max = desc.upper;
+                       info->min_unbound = desc.min_unbound;
+                       info->max_unbound = desc.max_unbound;
 
-               control_ui->vbox = manage (new VBox);
-               control_ui->hbox = manage (new HBox);
+                       info->min = desc.lower;
+                       info->max = desc.upper;
 
-               control_ui->hbox->set_spacing(1);
-               control_ui->vbox->set_spacing(3);
+                       control_ui->label.set_angle(90);
 
-               control_ui->label.set_angle(90);
-               control_ui->hbox->pack_start (control_ui->label, false, false);
-               control_ui->hbox->pack_start (*info->meter, false, false);
+                       HBox* center =  manage (new HBox);
+                       center->set_spacing(1);
+                       center->pack_start (control_ui->label, false, false);
+                       center->pack_start (*info->meter, false, false);
 
-               control_ui->vbox->pack_start (*control_ui->hbox, false, false);
+                       control_ui->hbox = manage (new HBox);
+                       control_ui->hbox->pack_start (*center, true, false);
 
-               control_ui->vbox->pack_start (*control_ui->display, false, false);
+                       // horizontally center this hbox in the vbox
+                       control_ui->vbox->pack_start (*control_ui->hbox, false, false);
 
-               control_ui->pack_start (*control_ui->vbox);
+                       control_ui->meterinfo->meter->show_all();
+                       control_ui->meterinfo->packed = true;
+                       control_ui->vbox->pack_start (*control_ui->display, false, false);
+               }
 
-               control_ui->meterinfo->meter->show_all();
-               control_ui->meterinfo->packed = true;
+               control_ui->pack_start (*control_ui->vbox);
 
                output_controls.push_back (control_ui);
        }
@@ -803,18 +807,6 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
        return control_ui;
 }
 
-void
-GenericPluginUI::start_touch (GenericPluginUI::ControlUI* cui)
-{
-       cui->control->start_touch (cui->control->session().transport_frame());
-}
-
-void
-GenericPluginUI::stop_touch (GenericPluginUI::ControlUI* cui)
-{
-       cui->control->stop_touch (false, cui->control->session().transport_frame());
-}
-
 void
 GenericPluginUI::astate_clicked (ControlUI* cui)
 {
@@ -840,10 +832,10 @@ GenericPluginUI::astate_clicked (ControlUI* cui)
        automation_menu->popup (1, gtk_get_current_event_time());
 }
 
-void 
+void
 GenericPluginUI::set_all_automation (AutoState as)
 {
-       for (vector<ControlUI*>::iterator i = input_controls.begin(); i != input_controls.end(); ++i) {
+       for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
                if ((*i)->controller || (*i)->button) {
                        set_automation_state (as, (*i));
                }
@@ -856,22 +848,6 @@ GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
        insert->set_parameter_automation_state (cui->parameter(), state);
 }
 
-void
-GenericPluginUI::toggle_parameter_changed (ControlUI* cui)
-{
-       float val = cui->control->get_value();
-
-       if (!cui->ignore_change) {
-               if (val > 0.5) {
-                       cui->button->set_active (true);
-                       cui->button->set_name ("PluginEditorButton-active");
-               } else {
-                       cui->button->set_active (false);
-                       cui->button->set_name ("PluginEditorButton");
-               }
-       }
-}
-
 void
 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
 {
@@ -900,12 +876,7 @@ GenericPluginUI::update_control_display (ControlUI* cui)
                        }
                }
        } else if (cui->button) {
-
-               if (val > 0.5) {
-                       cui->button->set_active (true);
-               } else {
-                       cui->button->set_active (false);
-               }
+               // AutomationController handles this
        }
 
        if( cui->controller ) {
@@ -924,26 +895,12 @@ GenericPluginUI::update_control_display (ControlUI* cui)
        cui->ignore_change--;
 }
 
-void
-GenericPluginUI::control_port_toggled (ControlUI* cui)
-{
-       cui->ignore_change++;
-       const bool active = cui->button->get_active();
-       if (active) {
-               cui->button->set_name ("PluginEditorButton-active");
-       } else {
-               cui->button->set_name ("PluginEditorButton");
-       }
-       insert->automation_control (cui->parameter())->set_value (active);
-       cui->ignore_change--;
-}
-
 void
 GenericPluginUI::control_combo_changed (ControlUI* cui)
 {
        if (!cui->ignore_change && cui->scale_points) {
                string value = cui->combo->get_active_text();
-               insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value]);
+               insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value], Controllable::NoGroup);
        }
 }
 
@@ -952,8 +909,7 @@ GenericPluginUI::start_updating (GdkEventAny*)
 {
        if (output_controls.size() > 0 ) {
                screen_update_connection.disconnect();
-               screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
-                       (sigc::mem_fun(*this, &GenericPluginUI::output_update));
+               screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
        }
        return false;
 }