Remove redundant calls to start/end_touch.
[ardour.git] / gtk2_ardour / generic_pluginui.cc
index b50d888f2feb3fd805cbd275fd45caa46ed2e45e..aec77b5a2c358bd921421803123bbe82b7e31012 100644 (file)
@@ -41,6 +41,7 @@
 #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"
@@ -75,7 +76,9 @@ 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);
 
@@ -90,6 +93,23 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrol
        smaller_hbox->pack_start (save_button, false, false);
        smaller_hbox->pack_start (delete_button, false, false);
        smaller_hbox->pack_start (bypass_button, false, true);
+       
+       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 +121,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);
@@ -239,32 +261,35 @@ GenericPluginUI::build ()
        frame->add (*box);
        hpacker.pack_start(*frame, true, true);
 
-       /* find all ports. build control elements for all appropriate control ports */
-       std::vector<ControlUI *> cui_controls_list;
+       std::vector<ControlUI *> control_uis;
 
+       // Build a ControlUI for each control port
        for (i = 0; i < plugin->parameter_count(); ++i) {
 
                if (plugin->parameter_is_control (i)) {
 
                        /* 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));
 
-                       Plugin::ParameterDescriptor desc;
+                       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;
                        }
@@ -274,77 +299,75 @@ GenericPluginUI::build ()
                                ARDOUR_UI::instance()->set_tip(cui, param_docs.c_str());
                        }
 
-                       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) {
-
-                               if (!is_scrollable && button_row == button_rows) {
-                                       button_row = 0;
-                                       if (++button_col == button_cols) {
-                                               button_cols += 2;
-                                               button_table.resize (button_rows, button_cols);
-                                       }
-                               }
+                       control_uis.push_back(cui);
+                       input_controls_with_automation.push_back (cui);
+               }
+       }
 
-                               button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
-                                                    FILL|EXPAND, FILL);
-                               button_row++;
+       // Build a ControlUI for each property
+       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);
 
-                       } else if (cui->display) {
+               boost::shared_ptr<ARDOUR::AutomationControl> c
+                       = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
+                               insert->control(param));
+
+               if (!c) {
+                       error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
+                       continue;
+               }
 
-                               output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
-                                                    FILL|EXPAND, FILL);
+               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;
+                       continue;
+               }
 
-                               // TODO: The meters should be divided into multiple rows
+               control_uis.push_back(cui);
+       }
+       if (!descs.empty()) {
+               plugin->announce_property_values();
+       }
 
-                               if (++output_col == output_cols) {
-                                       output_cols ++;
-                                       output_table.resize (output_rows, output_cols);
+       // Add special controls to UI, and build list of normal controls to be layed out later
+       std::vector<ControlUI *> cui_controls_list;
+       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 (!is_scrollable && button_row == button_rows) {
+                               button_row = 0;
+                               if (++button_col == button_cols) {
+                                       button_cols += 2;
+                                       button_table.resize (button_rows, button_cols);
                                }
                        }
-               } 
-       }
-
-       // Add property controls (currently file chooser button for paths only)
-       typedef std::vector<Plugin::ParameterDescriptor> Descs;
-       Descs descs;
-       plugin->get_supported_properties(descs);
-       for (Descs::const_iterator d = descs.begin(); d != descs.end(); ++d) {
-               if (d->datatype == Variant::PATH) {
-                       // Create/add label
-                       Gtk::Label* label = manage(new Label(d->label));
-                       button_table.attach(*label,
-                                           0, button_cols, button_row, button_row + 1,
-                                           FILL|EXPAND, FILL);
-                       ++button_row;
 
-                       // Create/add controller
-                       Gtk::FileChooserButton* widget = manage(
-                               new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
-                       widget->set_title(d->label);
-                       _property_controls.insert(std::make_pair(d->key, widget));
-                       button_table.attach(*widget,
-                                           0, button_cols, button_row, button_row + 1,
-                                           FILL|EXPAND, FILL);
-                       ++button_row;
-
-                       // Connect signals
-                       widget->signal_file_set().connect(
-                               sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_property), *d, widget));
-                       plugin->PropertyChanged.connect(*this, invalidator(*this),
-                                                       boost::bind(&GenericPluginUI::property_changed, this, _1, _2),
-                                                       gui_context());
-               } else {
-                       // TODO: widgets for other datatypes, use ControlUI?
-                       std::cerr << "warning: unsupported property " << d->key
-                                 << " type " << d->datatype << std::endl;
+                       button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
+                                            FILL|EXPAND, FILL);
+                       button_row++;
+
+               } else if (cui->display) {
+
+                       output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
+                                            FILL|EXPAND, FILL);
+
+                       // TODO: The meters should be divided into multiple rows
+
+                       if (++output_col == output_cols) {
+                               output_cols ++;
+                               output_table.resize (output_rows, output_cols);
+                       }
                }
        }
-       if (!descs.empty()) {
-               plugin->announce_property_values();
-       }
 
        // Iterate over the list of controls to find which adjacent controls
        // are similar enough to be grouped together.
@@ -451,10 +474,17 @@ 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"));
@@ -507,51 +537,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) {
-               Plugin::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) {
-               Plugin::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;
 }
 
@@ -561,16 +563,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 Plugin::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;
@@ -601,7 +606,7 @@ GenericPluginUI::build_control_ui (const Plugin::ParameterDescriptor&   desc,
 
                        std::vector<std::string> labels;
                        for (
-                               ARDOUR::Plugin::ScalePoints::const_iterator i = control_ui->scale_points->begin();
+                               ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
                                i != control_ui->scale_points->end();
                                ++i) {
                                
@@ -652,10 +657,35 @@ GenericPluginUI::build_control_ui (const Plugin::ParameterDescriptor&   desc,
                        return control_ui;
                }
 
+               if (desc.datatype == Variant::PATH) {
+
+                       /* Build a file selector button */
+
+                       // Create/add controller
+                       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->file_button, true, true);
+
+                       // Connect signals (TODO: do this via the Control)
+                       control_ui->file_button->signal_file_set().connect(
+                               sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_property),
+                                          desc, control_ui->file_button));
+                       plugin->PropertyChanged.connect(*this, invalidator(*this),
+                                                       boost::bind(&GenericPluginUI::property_changed, this, _1, _2),
+                                                       gui_context());
+
+                       _property_controls.insert(std::make_pair(desc.key, control_ui->file_button));
+                       control_ui->file_button = control_ui->file_button;
+
+                       return control_ui;
+               }
+
                /* create the controller */
 
                if (mcontrol) {
-                       control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), mcontrol);
+                       control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol);
                }
 
                /* XXX this code is not right yet, because it doesn't handle
@@ -663,12 +693,11 @@ GenericPluginUI::build_control_ui (const Plugin::ParameterDescriptor&   desc,
                */
 
                Adjustment* adj = control_ui->controller->adjustment();
-               boost::shared_ptr<PluginInsert::PluginControl> pc = boost::dynamic_pointer_cast<PluginInsert::PluginControl> (control_ui->control);
 
                if (desc.integer_step) {
-                       control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox");
+                       control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", desc.enumeration);
                        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));
@@ -679,9 +708,6 @@ GenericPluginUI::build_control_ui (const Plugin::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));
@@ -707,6 +733,7 @@ GenericPluginUI::build_control_ui (const Plugin::ParameterDescriptor&   desc,
                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) {
 
@@ -775,18 +802,6 @@ GenericPluginUI::build_control_ui (const Plugin::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)
 {
@@ -812,6 +827,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)
 {
@@ -855,7 +880,7 @@ GenericPluginUI::update_control_display (ControlUI* cui)
        cui->ignore_change++;
 
        if (cui->combo && cui->scale_points) {
-               for (ARDOUR::Plugin::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
+               for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
                        if (it->second == val) {
                                cui->combo->set_active_text(it->first);
                                break;
@@ -938,7 +963,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);
@@ -969,8 +994,8 @@ GenericPluginUI::output_update ()
 }
 
 void
-GenericPluginUI::set_property (const Plugin::ParameterDescriptor& desc,
-                               Gtk::FileChooserButton*            widget)
+GenericPluginUI::set_property (const ParameterDescriptor& desc,
+                               Gtk::FileChooserButton*    widget)
 {
        plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
 }