Add EngineControl::stop_engine method to show errors when stopping engine
[ardour.git] / gtk2_ardour / generic_pluginui.cc
index fb35882b348e41a8e9a0990d43de00746594b94e..47b5f93a9829b296c0fdb5829d04b938444e68a4 100644 (file)
 #include "ardour/plugin.h"
 #include "ardour/plugin_insert.h"
 #include "ardour/session.h"
+#include "ardour/value_as_string.h"
 
-#include "ardour_ui.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"
 
@@ -55,6 +58,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)
@@ -75,21 +79,40 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrol
 
        HBox* constraint_hbox = manage (new HBox);
        HBox* smaller_hbox = manage (new HBox);
+       HBox* automation_hbox = manage (new HBox);
        smaller_hbox->set_spacing (4);
+       automation_hbox->set_spacing (6);
        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"));
+       automation_play_all_button.set_name (X_("generic button"));
+       automation_write_all_button.set_text(_("Write"));
+       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);
+       automation_hbox->pack_start (automation_manual_all_button, false, false);
+       automation_hbox->pack_start (automation_play_all_button, false, false);
+       automation_hbox->pack_start (automation_write_all_button, false, false);
+       automation_hbox->pack_start (automation_touch_all_button, false, false);
 
        constraint_hbox->set_spacing (5);
        constraint_hbox->set_homogeneous (false);
@@ -101,7 +124,9 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrol
                pack_end (description_expander, false, false);
        }
 
+       v1_box->set_spacing (6);
        v1_box->pack_start (*smaller_hbox, false, true);
+       v1_box->pack_start (*automation_hbox, false, true);
        v2_box->pack_start (focus_button, false, true);
 
        main_contents.pack_start (settings_box, false, false);
@@ -158,7 +183,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;
@@ -168,7 +193,7 @@ std::size_t length, n = 0;
                if (!match_or_digit(s1[n], s2[n]))
                        break;
                n++;
-       } 
+       }
        return n;
 }
 
@@ -181,7 +206,7 @@ std::size_t s1pos, s2pos, n = 0;
                if (!match_or_digit(s1[s1pos], s2[s2pos])       )
                        break;
                n++;
-       } 
+       }
        return n;
 }
 
@@ -248,33 +273,37 @@ GenericPluginUI::build ()
 
                        /* Don't show latency control ports */
 
-                       if (plugin->describe_parameter (Evoral::Parameter(PluginAutomation, 0, i)) == X_("latency")) {
+                       const Evoral::Parameter param(PluginAutomation, 0, i);
+                       if (plugin->describe_parameter (param) == X_("latency")) {
                                continue;
                        }
 
-                       if (plugin->describe_parameter (Evoral::Parameter(PluginAutomation, 0, i)) == X_("hidden")) {
+                       if (plugin->describe_parameter (param) == X_("hidden")) {
                                continue;
                        }
 
+                       const float value = plugin->get_parameter(i);
+
                        ControlUI* cui;
 
                        boost::shared_ptr<ARDOUR::AutomationControl> c
                                = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
-                                       insert->control(Evoral::Parameter(PluginAutomation, 0, i)));
+                                       insert->control(param));
 
                        ParameterDescriptor desc;
                        plugin->get_parameter_descriptor(i, desc);
-                       if ((cui = build_control_ui (desc, c, plugin->parameter_is_input(i))) == 0) {
+                       if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i))) == 0) {
                                error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
                                continue;
                        }
 
                        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);
                }
        }
 
@@ -282,17 +311,18 @@ GenericPluginUI::build ()
        const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
        for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
                const ParameterDescriptor& desc = d->second;
+               const Evoral::Parameter    param(PluginPropertyAutomation, 0, desc.key);
 
                boost::shared_ptr<ARDOUR::AutomationControl> c
                        = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
-                               insert->control(Evoral::Parameter(PluginPropertyAutomation, 0, desc.key)));
+                               insert->control(param));
 
                if (!c) {
                        error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
                        continue;
                }
 
-               ControlUI* cui = build_control_ui(desc, c, true);
+               ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
                if (!cui) {
                        error << string_compose(_("Plugin Editor: could not build control element for property %1"),
                                                desc.key) << endmsg;
@@ -344,13 +374,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();
@@ -359,12 +389,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]);
@@ -376,32 +406,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);
@@ -447,14 +477,20 @@ 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));
+       automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
 }
 
-GenericPluginUI::ControlUI::ControlUI ()
-       : automate_button (X_("")) // force creation of a label
+GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
+       : param(p)
+       , automate_button (X_("")) // force creation of a label
        , 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()
@@ -504,51 +540,23 @@ GenericPluginUI::automation_state_changed (ControlUI* cui)
        }
 }
 
-
 bool
 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 {
-       float const v = adj.get_value ();
-       
-       if (cui->scale_points) {
-               ScalePoints::const_iterator i = cui->scale_points->begin ();
-               while (i != cui->scale_points->end() && i->second != v) {
-                       ++i;
-               }
-
-               if (i != cui->scale_points->end ()) {
-                       snprintf (buf, 32, "%s", i->first.c_str());
-                       return true;
-               }
-       }
-               
-       snprintf (buf, 32, "%.0f", v);
+       float const        v   = cui->control->interface_to_internal(adj.get_value ());
+       const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
+       const size_t       len = str.copy(buf, 31);
+       buf[len] = '\0';
        return true;
 }
 
 bool
 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 {
-       float const v = adj.get_value ();
-
-       if (cui->scale_points) {
-               ScalePoints::const_iterator i = cui->scale_points->begin ();
-               while (i != cui->scale_points->end() && i->second != v) {
-                       ++i;
-               }
-
-               if (i != cui->scale_points->end ()) {
-                       snprintf (buf, 32, "%s", i->first.c_str());
-                       return true;
-               }
-       }
-       if (v >= 0 && v <= 127) {
-               int mn = rint(v);
-               const char notename[12][3] = { "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" };
-               snprintf (buf, 32, "%s %d", notename[mn%12], (mn/12)-2);
-       } else {
-               snprintf (buf, 32, "%.0f", v);
-       }
+       float const        v   = cui->control->interface_to_internal(adj.get_value ());
+       const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
+       const size_t       len = str.copy(buf, 31);
+       buf[len] = '\0';
        return true;
 }
 
@@ -558,16 +566,19 @@ GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
        plugin->print_parameter (param, buf, len);
 }
 
+/** Build a ControlUI for a parameter/property.
+ * Note that mcontrol may be NULL for outputs.
+ */
 GenericPluginUI::ControlUI*
-GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
+GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
+                                   const ParameterDescriptor&           desc,
                                    boost::shared_ptr<AutomationControl> mcontrol,
+                                   float                                value,
                                    bool                                 is_input)
 {
        ControlUI* control_ui = 0;
 
-       const float value = mcontrol->get_value();
-
-       control_ui = manage (new ControlUI ());
+       control_ui = manage (new ControlUI (param));
        control_ui->combo = 0;
        control_ui->control = mcontrol;
        control_ui->update_pending = false;
@@ -590,7 +601,7 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
                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.
@@ -601,7 +612,7 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
                                ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
                                i != control_ui->scale_points->end();
                                ++i) {
-                               
+
                                labels.push_back(i->first);
                        }
 
@@ -657,7 +668,7 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
                        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)
@@ -687,9 +698,9 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
                Adjustment* adj = control_ui->controller->adjustment();
 
                if (desc.integer_step) {
-                       control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox");
+                       control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", true);
                        Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
-                       if (desc.midinote) {
+                       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));
@@ -700,9 +711,6 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
                        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));
@@ -724,10 +732,10 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
 
                automation_state_changed (control_ui);
 
-               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());
 
                input_controls.push_back (control_ui);
+               input_controls_with_automation.push_back (control_ui);
 
        } else if (!is_input) {
 
@@ -757,8 +765,8 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
                                0xcccc00ff, 0xcccc00ff,
                                0xffaa00ff, 0xffaa00ff,
                                0xff0000ff,
-                               ARDOUR_UI::config()->get_MeterBackgroundBot(),
-                               ARDOUR_UI::config()->get_MeterBackgroundTop()
+                               UIConfiguration::instance().color ("meter background bottom"),
+                               UIConfiguration::instance().color ("meter background top")
                                );
 
                info->min_unbound = desc.min_unbound;
@@ -796,18 +804,6 @@ GenericPluginUI::build_control_ui (const ParameterDescriptor&           desc,
        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)
 {
@@ -833,6 +829,16 @@ GenericPluginUI::astate_clicked (ControlUI* cui)
        automation_menu->popup (1, gtk_get_current_event_time());
 }
 
+void
+GenericPluginUI::set_all_automation (AutoState as)
+{
+       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));
+               }
+       }
+}
+
 void
 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
 {
@@ -935,8 +941,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;
 }
@@ -959,7 +964,7 @@ void
 GenericPluginUI::output_update ()
 {
        for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
-               float val = (*i)->control->get_value();
+               float val = plugin->get_parameter ((*i)->parameter().id());
                char buf[32];
                snprintf (buf, sizeof(buf), "%.2f", val);
                (*i)->display_label->set_text (buf);