add support to display and set key aliases in mackie GUI
[ardour.git] / libs / surfaces / mackie / gui.cc
index 8728b4a88c51e8c097a371d9f98557a08098cc4e..d9d473728fc8c9133aee80656ccb84a6ce87e73d 100644 (file)
@@ -42,8 +42,9 @@
 #include "i18n.h"
 
 using namespace std;
-using namespace Mackie;
 using namespace Gtk;
+using namespace ArdourSurface;
+using namespace Mackie;
 
 void*
 MackieControlProtocol::get_gui () const
@@ -51,14 +52,22 @@ MackieControlProtocol::get_gui () const
        if (!_gui) {
                const_cast<MackieControlProtocol*>(this)->build_gui ();
        }
-
+       static_cast<Gtk::Notebook*>(_gui)->show_all();
        return _gui;
 }
 
 void
 MackieControlProtocol::tear_down_gui ()
 {
+       if (_gui) {
+               Gtk::Widget *w = static_cast<Gtk::Widget*>(_gui)->get_parent();
+               if (w) {
+                       w->hide();
+                       delete w;
+               }
+       }
        delete (MackieControlProtocolGUI*) _gui;
+       _gui = 0;
 }
 
 void
@@ -74,15 +83,17 @@ MackieControlProtocolGUI::MackieControlProtocolGUI (MackieControlProtocol& p)
        , recalibrate_fader_button (_("Recalibrate Faders"))
        , ipmidi_base_port_adjustment (_cp.ipmidi_base(), 0, 32767, 1, 1000)
        , ipmidi_base_port_spinner (ipmidi_base_port_adjustment)
+       , discover_button (_("Discover Mackie Devices"))
 {
        Gtk::Label* l;
        Gtk::Alignment* align;
 
        set_border_width (12);
 
-       Gtk::Table* table = Gtk::manage (new Gtk::Table (2, 8));
+       Gtk::Table* table = Gtk::manage (new Gtk::Table (2, 9));
        table->set_row_spacings (4);
        table->set_col_spacings (6);
+       table->set_border_width (12);
        l = manage (new Gtk::Label (_("Device Type:")));
        l->set_alignment (1.0, 0.5);
        table->attach (*l, 0, 1, 0, 1, AttachOptions(FILL|EXPAND), AttachOptions(0));
@@ -100,6 +111,12 @@ MackieControlProtocolGUI::MackieControlProtocolGUI (MackieControlProtocol& p)
        RadioButtonGroup rb_group = absolute_touch_mode_button.get_group();
        touch_move_mode_button.set_group (rb_group);
 
+       recalibrate_fader_button.signal_clicked().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::recalibrate_faders));
+       backlight_button.signal_clicked().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::toggle_backlight));
+
+       touch_sensitivity_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::touch_sensitive_change));
+       touch_sensitivity_scale.set_update_policy (Gtk::UPDATE_DISCONTINUOUS);
+       
        l = manage (new Gtk::Label (_("Button click")));
        l->set_alignment (1.0, 0.5);
        table->attach (*l, 0, 1, 1, 2, AttachOptions(FILL|EXPAND), AttachOptions (0));
@@ -143,6 +160,9 @@ MackieControlProtocolGUI::MackieControlProtocolGUI (MackieControlProtocol& p)
 
        ipmidi_base_port_spinner.set_sensitive (_cp.device_info().uses_ipmidi());
        ipmidi_base_port_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::ipmidi_spinner_changed));
+       
+       table->attach (discover_button, 1, 2, 8, 9, AttachOptions(FILL|EXPAND), AttachOptions (0));
+       discover_button.signal_clicked().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::discover_clicked));
 
        vector<string> profiles;
        
@@ -162,21 +182,25 @@ MackieControlProtocolGUI::MackieControlProtocolGUI (MackieControlProtocol& p)
 
        VBox* fkey_packer = manage (new VBox);
        HBox* profile_packer = manage (new HBox);
-
+       HBox* observation_packer = manage (new HBox);
+       
        l = manage (new Gtk::Label (_("Profile/Settings:")));
        profile_packer->pack_start (*l, false, false);
        profile_packer->pack_start (_profile_combo, true, true);
        profile_packer->set_spacing (12);
        profile_packer->set_border_width (12);
+       
+       l = manage (new Gtk::Label (_("* Button available at the original Mackie MCU PRO or current device if enabled (NOT implemented yet). Device specific name presented.")));
+       observation_packer->pack_start (*l, false, false);
 
        fkey_packer->pack_start (*profile_packer, false, false);
        fkey_packer->pack_start (function_key_scroller, true, true);
+       fkey_packer->pack_start (*observation_packer, false, false);
        fkey_packer->set_spacing (12);
-       function_key_scroller.set_size_request (700,700);
        function_key_scroller.property_shadow_type() = Gtk::SHADOW_NONE;
        function_key_scroller.add (function_key_editor);
        append_page (*fkey_packer, _("Function Keys"));
-       
+
        build_available_action_menu ();
        build_function_key_editor ();
        refresh_function_key_editor ();
@@ -223,6 +247,31 @@ MackieControlProtocolGUI::build_available_action_menu ()
 
        available_action_model->clear ();
 
+       /* Because there are button bindings built in that are not
+       in the key binding map, there needs to be a way to undo
+       a profile edit. */
+       TreeIter rowp;
+       TreeModel::Row parent;
+       rowp = available_action_model->append();
+       parent = *(rowp);
+       parent[available_action_columns.name] = _("Remove Binding");
+
+       /* Key aliasing */
+
+       rowp = available_action_model->append();
+       parent = *(rowp);
+       parent[available_action_columns.name] = _("Shift");
+       rowp = available_action_model->append();
+       parent = *(rowp);
+       parent[available_action_columns.name] = _("Control");
+       rowp = available_action_model->append();
+       parent = *(rowp);
+       parent[available_action_columns.name] = _("Option");
+       rowp = available_action_model->append();
+       parent = *(rowp);
+       parent[available_action_columns.name] = _("CmdAlt");
+
+       
        for (l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l) {
 
                TreeModel::Row row;
@@ -335,13 +384,18 @@ MackieControlProtocolGUI::refresh_function_key_editor ()
 
        TreeModel::Row row;
        DeviceProfile dp (_cp.device_profile());
+       DeviceInfo di;
 
        for (int n = 0; n < Mackie::Button::FinalGlobalButton; ++n) {
 
                Mackie::Button::ID bid = (Mackie::Button::ID) n;
 
                row = *(function_key_model->append());
-               row[function_key_columns.name] = Mackie::Button::id_to_name (bid);
+               if (di.global_buttons().find (bid) == di.global_buttons().end()) {
+                       row[function_key_columns.name] = Mackie::Button::id_to_name (bid);
+               } else {
+                       row[function_key_columns.name] = di.get_global_button_name (bid) + "*";
+               }
                row[function_key_columns.id] = bid;
 
                Glib::RefPtr<Gtk::Action> act;
@@ -352,11 +406,17 @@ MackieControlProtocolGUI::refresh_function_key_editor ()
                if (action.empty()) {
                        row[function_key_columns.plain] = defstring;
                } else {
-                       act = ActionManager::get_action (action.c_str());
-                       if (act) {
-                               row[function_key_columns.plain] = act->get_label();
+                       if (action.find ('/') == string::npos) {
+                               /* Probably a key alias */
+                               row[function_key_columns.plain] = action;
                        } else {
-                               row[function_key_columns.plain] = defstring;
+                               
+                               act = ActionManager::get_action (action.c_str());
+                               if (act) {
+                                       row[function_key_columns.plain] = act->get_label();
+                               } else {
+                                       row[function_key_columns.plain] = defstring;
+                               }
                        }
                }
 
@@ -364,11 +424,16 @@ MackieControlProtocolGUI::refresh_function_key_editor ()
                if (action.empty()) {
                        row[function_key_columns.control] = defstring;
                } else {
-                       act = ActionManager::get_action (action.c_str());
-                       if (act) {
-                               row[function_key_columns.control] = act->get_label();
+                       if (action.find ('/') == string::npos) {
+                               /* Probably a key alias */
+                               row[function_key_columns.control] = action;
                        } else {
-                               row[function_key_columns.control] = defstring;
+                               act = ActionManager::get_action (action.c_str());
+                               if (act) {
+                                       row[function_key_columns.control] = act->get_label();
+                               } else {
+                                       row[function_key_columns.control] = defstring;
+                               }
                        }
                }
 
@@ -376,11 +441,16 @@ MackieControlProtocolGUI::refresh_function_key_editor ()
                if (action.empty()) {
                        row[function_key_columns.shift] = defstring;
                } else {
-                       act = ActionManager::get_action (action.c_str());
-                       if (act) {
-                               row[function_key_columns.shift] = act->get_label();
+                       if (action.find ('/') == string::npos) {
+                               /* Probably a key alias */
+                               row[function_key_columns.shift] = action;
                        } else {
-                               row[function_key_columns.shift] = defstring;
+                               act = ActionManager::get_action (action.c_str());
+                               if (act) {
+                                       row[function_key_columns.shift] = act->get_label();
+                               } else {
+                                       row[function_key_columns.shift] = defstring;
+                               }
                        }
                }
 
@@ -388,11 +458,16 @@ MackieControlProtocolGUI::refresh_function_key_editor ()
                if (action.empty()) {
                        row[function_key_columns.option] = defstring;
                } else {
-                       act = ActionManager::get_action (action.c_str());
-                       if (act) {
-                               row[function_key_columns.option] = act->get_label();
+                       if (action.find ('/') == string::npos) {
+                               /* Probably a key alias */
+                               row[function_key_columns.option] = action;
                        } else {
-                               row[function_key_columns.option] = defstring;
+                               act = ActionManager::get_action (action.c_str());
+                               if (act) {
+                                       row[function_key_columns.option] = act->get_label();
+                               } else {
+                                       row[function_key_columns.option] = defstring;
+                               }
                        }
                }
 
@@ -400,11 +475,16 @@ MackieControlProtocolGUI::refresh_function_key_editor ()
                if (action.empty()) {
                        row[function_key_columns.cmdalt] = defstring;
                } else {
-                       act = ActionManager::get_action (action.c_str());
-                       if (act) {
-                               row[function_key_columns.cmdalt] = act->get_label();
+                       if (action.find ('/') == string::npos) {
+                               /* Probably a key alias */
+                               row[function_key_columns.cmdalt] = action;
                        } else {
-                               row[function_key_columns.cmdalt] = defstring;
+                               act = ActionManager::get_action (action.c_str());
+                               if (act) {
+                                       row[function_key_columns.cmdalt] = act->get_label();
+                               } else {
+                                       row[function_key_columns.cmdalt] = defstring;
+                               }
                        }
                }
 
@@ -427,6 +507,11 @@ MackieControlProtocolGUI::refresh_function_key_editor ()
 void 
 MackieControlProtocolGUI::action_changed (const Glib::ustring &sPath, const Glib::ustring &text, TreeModelColumnBase col)
 {
+       // Remove Binding is not in the action map but still valid
+       bool remove (false);
+       if ( text == "Remove Binding") {
+               remove = true;
+       }
        Gtk::TreePath path(sPath);
        Gtk::TreeModel::iterator row = function_key_model->get_iter(path);
 
@@ -435,19 +520,23 @@ MackieControlProtocolGUI::action_changed (const Glib::ustring &sPath, const Glib
                std::map<std::string,std::string>::iterator i = action_map.find (text);
                
                if (i == action_map.end()) {
-                       return;
+                       if (!remove) {
+                               return;
+                       }
                }
-
-               cerr << "Changed to " << i->first << " aka " << i->second << endl;
-
                Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (i->second.c_str());
 
-               if (act) {
+               if (act || remove) {
                        /* update visible text, using string supplied by
                           available action model so that it matches and is found
                           within the model.
                        */
-                       (*row).set_value (col.index(), text);
+                       if (remove) {
+                               Glib::ustring dot = "\u2022";
+                               (*row).set_value (col.index(), dot);
+                       } else {
+                               (*row).set_value (col.index(), text);
+                       }
 
                        /* update the current DeviceProfile, using the full
                         * path
@@ -475,7 +564,12 @@ MackieControlProtocolGUI::action_changed (const Glib::ustring &sPath, const Glib
                                modifier = 0;
                        }
 
-                       _cp.device_profile().set_button_action ((*row)[function_key_columns.id], modifier, i->second);
+                       if (remove) {
+                               _cp.device_profile().set_button_action ((*row)[function_key_columns.id], modifier, "");
+                       } else {
+                               _cp.device_profile().set_button_action ((*row)[function_key_columns.id], modifier, i->second);
+                       }
+
                } else {
                        std::cerr << "no such action\n";
                }
@@ -485,12 +579,11 @@ MackieControlProtocolGUI::action_changed (const Glib::ustring &sPath, const Glib
 void
 MackieControlProtocolGUI::surface_combo_changed ()
 {
+       _cp.not_session_load();
        _cp.set_device (_surface_combo.get_active_text());
 
        /* update ipMIDI field */
 
-       cerr << "New device called " << _cp.device_info().name() << " with ipMIDI ? " << _cp.device_info().uses_ipmidi() << endl;
-
        ipmidi_base_port_spinner.set_sensitive (_cp.device_info().uses_ipmidi());
 }
 
@@ -507,6 +600,31 @@ MackieControlProtocolGUI::profile_combo_changed ()
 void
 MackieControlProtocolGUI::ipmidi_spinner_changed ()
 {
-       cerr << "Set IP MIDI base to " << ipmidi_base_port_spinner.get_value() << endl;
        _cp.set_ipmidi_base ((int16_t) lrintf (ipmidi_base_port_spinner.get_value()));
 }
+
+void
+MackieControlProtocolGUI::discover_clicked ()
+{
+       /* this should help to get things started */
+       _cp.midi_connectivity_established ();
+}
+
+void
+MackieControlProtocolGUI::recalibrate_faders ()
+{
+       _cp.recalibrate_faders ();
+}
+
+void
+MackieControlProtocolGUI::toggle_backlight ()
+{
+       _cp.toggle_backlight ();
+}
+
+void
+MackieControlProtocolGUI::touch_sensitive_change ()
+{
+       int sensitivity = (int) touch_sensitivity_adjustment.get_value ();
+       _cp.set_touch_sensitivity (sensitivity);
+}