enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / libs / surfaces / mackie / gui.cc
1 /*
2         Copyright (C) 2010 Paul Davis
3
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.
8
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.
13
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.
17 */
18
19 #include <gtkmm/comboboxtext.h>
20 #include <gtkmm/box.h>
21 #include <gtkmm/spinbutton.h>
22 #include <gtkmm/table.h>
23 #include <gtkmm/treeview.h>
24 #include <gtkmm/liststore.h>
25 #include <gtkmm/treestore.h>
26 #include <gtkmm/notebook.h>
27 #include <gtkmm/cellrenderercombo.h>
28 #include <gtkmm/scale.h>
29 #include <gtkmm/alignment.h>
30
31 #include "pbd/error.h"
32 #include "pbd/unwind.h"
33 #include "pbd/strsplit.h"
34 #include "pbd/stacktrace.h"
35
36 #include "gtkmm2ext/actions.h"
37 #include "gtkmm2ext/bindings.h"
38 #include "gtkmm2ext/gui_thread.h"
39 #include "gtkmm2ext/utils.h"
40
41 #include "ardour/audioengine.h"
42 #include "ardour/port.h"
43 #include "ardour/rc_configuration.h"
44
45 #include "mackie_control_protocol.h"
46 #include "device_info.h"
47 #include "gui.h"
48 #include "surface.h"
49 #include "surface_port.h"
50
51 #include "pbd/i18n.h"
52
53 using namespace std;
54 using namespace Gtk;
55 using namespace ArdourSurface;
56 using namespace Mackie;
57
58 void*
59 MackieControlProtocol::get_gui () const
60 {
61         if (!_gui) {
62                 const_cast<MackieControlProtocol*>(this)->build_gui ();
63         }
64         static_cast<Gtk::Notebook*>(_gui)->show_all();
65         return _gui;
66 }
67
68 void
69 MackieControlProtocol::tear_down_gui ()
70 {
71         if (_gui) {
72                 Gtk::Widget *w = static_cast<Gtk::Widget*>(_gui)->get_parent();
73                 if (w) {
74                         w->hide();
75                         delete w;
76                 }
77         }
78         delete (MackieControlProtocolGUI*) _gui;
79         _gui = 0;
80 }
81
82 void
83 MackieControlProtocol::build_gui ()
84 {
85         _gui = (void *) new MackieControlProtocolGUI (*this);
86 }
87
88 MackieControlProtocolGUI::MackieControlProtocolGUI (MackieControlProtocol& p)
89         : _cp (p)
90         , table (2, 9)
91         , touch_sensitivity_adjustment (0, 0, 9, 1, 4)
92         , touch_sensitivity_scale (touch_sensitivity_adjustment)
93         , recalibrate_fader_button (_("Recalibrate Faders"))
94         , ipmidi_base_port_adjustment (_cp.ipmidi_base(), 0, 32767, 1, 1000)
95         , discover_button (_("Discover Mackie Devices"))
96         , _device_dependent_widget (0)
97         , ignore_active_change (false)
98 {
99         Gtk::Label* l;
100         Gtk::Alignment* align;
101         int row = 0;
102
103         set_border_width (12);
104
105         table.set_row_spacings (4);
106         table.set_col_spacings (6);
107         table.set_border_width (12);
108         table.set_homogeneous (false);
109
110         l = manage (new Gtk::Label (_("Device Type:")));
111         l->set_alignment (1.0, 0.5);
112         table.attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions(0));
113         table.attach (_surface_combo, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions(0), 0, 0);
114         row++;
115
116         vector<string> surfaces;
117
118         for (std::map<std::string,DeviceInfo>::iterator i = DeviceInfo::device_info.begin(); i != DeviceInfo::device_info.end(); ++i) {
119                 surfaces.push_back (i->first);
120         }
121         Gtkmm2ext::set_popdown_strings (_surface_combo, surfaces);
122         _surface_combo.signal_changed().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::surface_combo_changed));
123
124         _cp.DeviceChanged.connect (device_change_connection, invalidator (*this), boost::bind (&MackieControlProtocolGUI::device_changed, this), gui_context());
125         _cp.ConnectionChange.connect (connection_change_connection, invalidator (*this), boost::bind (&MackieControlProtocolGUI::connection_handler, this), gui_context());
126
127         ipmidi_base_port_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::ipmidi_spinner_changed));
128
129         /* device-dependent part */
130
131         device_dependent_row = row;
132
133         if (_device_dependent_widget) {
134                 table.remove (*_device_dependent_widget);
135                 _device_dependent_widget = 0;
136         }
137
138         _device_dependent_widget = device_dependent_widget ();
139         table.attach (*_device_dependent_widget, 0, 12, row, row+1, AttachOptions(0), AttachOptions(0), 0, 0);
140         row++;
141
142         /* back to the boilerplate */
143
144         RadioButtonGroup rb_group = absolute_touch_mode_button.get_group();
145         touch_move_mode_button.set_group (rb_group);
146
147         recalibrate_fader_button.signal_clicked().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::recalibrate_faders));
148         backlight_button.signal_clicked().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::toggle_backlight));
149
150         touch_sensitivity_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::touch_sensitive_change));
151         touch_sensitivity_scale.set_update_policy (Gtk::UPDATE_DISCONTINUOUS);
152
153         l = manage (new Gtk::Label (_("Button click")));
154         l->set_alignment (1.0, 0.5);
155         table.attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
156         align = manage (new Alignment);
157         align->set (0.0, 0.5);
158         align->add (relay_click_button);
159         table.attach (*align, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
160         row++;
161
162         l = manage (new Gtk::Label (_("Backlight")));
163         l->set_alignment (1.0, 0.5);
164         table.attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
165         align = manage (new Alignment);
166         align->set (0.0, 0.5);
167         align->add (backlight_button);
168         table.attach (*align, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
169         row++;
170
171         l = manage (new Gtk::Label (_("Send Fader Position Only When Touched")));
172         l->set_alignment (1.0, 0.5);
173         table.attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
174         align = manage (new Alignment);
175         align->set (0.0, 0.5);
176         align->add (absolute_touch_mode_button);
177         table.attach (*align, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
178         row++;
179
180         l = manage (new Gtk::Label (_("Send Fader Position When Moved")));
181         l->set_alignment (1.0, 0.5);
182         table.attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
183         align = manage (new Alignment);
184         align->set (0.0, 0.5);
185         align->add (touch_move_mode_button);
186         table.attach (*align, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
187         row++;
188
189         l = manage (new Gtk::Label (_("Fader Touch Sense Sensitivity")));
190         l->set_alignment (1.0, 0.5);
191         table.attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
192         touch_sensitivity_scale.property_digits() = 0;
193         touch_sensitivity_scale.property_draw_value() = false;
194         table.attach (touch_sensitivity_scale, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
195         row++;
196         table.attach (recalibrate_fader_button, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
197         row++;
198
199
200         table.attach (discover_button, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
201         discover_button.signal_clicked().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::discover_clicked));
202         row++;
203
204         vector<string> profiles;
205
206         for (std::map<std::string,DeviceProfile>::iterator i = DeviceProfile::device_profiles.begin(); i != DeviceProfile::device_profiles.end(); ++i) {
207                 cerr << "add discovered profile " << i->first << endl;
208                 profiles.push_back (i->first);
209         }
210         Gtkmm2ext::set_popdown_strings (_profile_combo, profiles);
211         cerr << "set active profile from " << p.device_profile().name() << endl;
212         _profile_combo.set_active_text (p.device_profile().name());
213         _profile_combo.signal_changed().connect (sigc::mem_fun (*this, &MackieControlProtocolGUI::profile_combo_changed));
214
215         append_page (table, _("Device Setup"));
216         table.show_all();
217
218         /* function key editor */
219
220         VBox* fkey_packer = manage (new VBox);
221         HBox* profile_packer = manage (new HBox);
222         HBox* observation_packer = manage (new HBox);
223
224         l = manage (new Gtk::Label (_("Profile/Settings:")));
225         profile_packer->pack_start (*l, false, false);
226         profile_packer->pack_start (_profile_combo, true, true);
227         profile_packer->set_spacing (12);
228         profile_packer->set_border_width (12);
229
230         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.")));
231         observation_packer->pack_start (*l, false, false);
232
233         fkey_packer->pack_start (*profile_packer, false, false);
234         fkey_packer->pack_start (function_key_scroller, true, true);
235         fkey_packer->pack_start (*observation_packer, false, false);
236         fkey_packer->set_spacing (12);
237         function_key_scroller.property_shadow_type() = Gtk::SHADOW_NONE;
238         function_key_scroller.add (function_key_editor);
239         append_page (*fkey_packer, _("Function Keys"));
240
241         build_available_action_menu ();
242         build_function_key_editor ();
243         refresh_function_key_editor ();
244         fkey_packer->show_all();
245 }
246
247 void
248 MackieControlProtocolGUI::connection_handler ()
249 {
250         /* ignore all changes to combobox active strings here, because we're
251            updating them to match a new ("external") reality - we were called
252            because port connections have changed.
253         */
254
255         PBD::Unwinder<bool> ici (ignore_active_change, true);
256
257         vector<Gtk::ComboBox*>::iterator ic;
258         vector<Gtk::ComboBox*>::iterator oc;
259
260         vector<string> midi_inputs;
261         vector<string> midi_outputs;
262
263         ARDOUR::AudioEngine::instance()->get_ports ("", ARDOUR::DataType::MIDI, ARDOUR::PortFlags (ARDOUR::IsOutput|ARDOUR::IsTerminal), midi_inputs);
264         ARDOUR::AudioEngine::instance()->get_ports ("", ARDOUR::DataType::MIDI, ARDOUR::PortFlags (ARDOUR::IsInput|ARDOUR::IsTerminal), midi_outputs);
265
266         for (ic = input_combos.begin(), oc = output_combos.begin(); ic != input_combos.end() && oc != output_combos.end(); ++ic, ++oc) {
267
268                 boost::shared_ptr<Surface> surface = _cp.get_surface_by_raw_pointer ((*ic)->get_data ("surface"));
269
270                 if (surface) {
271                         update_port_combos (midi_inputs, midi_outputs, *ic, *oc, surface);
272                 }
273         }
274 }
275
276 void
277 MackieControlProtocolGUI::update_port_combos (vector<string> const& midi_inputs, vector<string> const& midi_outputs,
278                                               Gtk::ComboBox* input_combo,
279                                               Gtk::ComboBox* output_combo,
280                                               boost::shared_ptr<Surface> surface)
281 {
282         Glib::RefPtr<Gtk::ListStore> input = build_midi_port_list (midi_inputs, true);
283         Glib::RefPtr<Gtk::ListStore> output = build_midi_port_list (midi_outputs, false);
284         bool input_found = false;
285         bool output_found = false;
286         int n;
287
288         input_combo->set_model (input);
289         output_combo->set_model (output);
290
291         Gtk::TreeModel::Children children = input->children();
292         Gtk::TreeModel::Children::iterator i;
293         i = children.begin();
294         ++i; /* skip "Disconnected" */
295
296
297         for (n = 1;  i != children.end(); ++i, ++n) {
298                 string port_name = (*i)[midi_port_columns.full_name];
299                 if (surface->port().input().connected_to (port_name)) {
300                         input_combo->set_active (n);
301                         input_found = true;
302                         break;
303                 }
304         }
305
306         if (!input_found) {
307                 input_combo->set_active (0); /* disconnected */
308         }
309
310         children = output->children();
311         i = children.begin();
312         ++i; /* skip "Disconnected" */
313
314         for (n = 1;  i != children.end(); ++i, ++n) {
315                 string port_name = (*i)[midi_port_columns.full_name];
316                 if (surface->port().output().connected_to (port_name)) {
317                         output_combo->set_active (n);
318                         output_found = true;
319                         break;
320                 }
321         }
322
323         if (!output_found) {
324                 output_combo->set_active (0); /* disconnected */
325         }
326 }
327
328 Gtk::Widget*
329 MackieControlProtocolGUI::device_dependent_widget ()
330 {
331         Gtk::Table* dd_table;
332         Gtk::Label* l;
333         int row = 0;
334
335         uint32_t n_surfaces = 1 + _cp.device_info().extenders();
336
337         if (!_cp.device_info().uses_ipmidi()) {
338                 dd_table = Gtk::manage (new Gtk::Table (n_surfaces, 2));
339         } else {
340                 dd_table = Gtk::manage (new Gtk::Table (1, 2));
341         }
342
343         dd_table = Gtk::manage (new Gtk::Table (2, n_surfaces));
344         dd_table->set_row_spacings (4);
345         dd_table->set_col_spacings (6);
346         dd_table->set_border_width (12);
347
348         _surface_combo.set_active_text (_cp.device_info().name());
349
350         vector<string> midi_inputs;
351         vector<string> midi_outputs;
352
353         ARDOUR::AudioEngine::instance()->get_ports ("", ARDOUR::DataType::MIDI, ARDOUR::PortFlags (ARDOUR::IsOutput|ARDOUR::IsPhysical), midi_inputs);
354         ARDOUR::AudioEngine::instance()->get_ports ("", ARDOUR::DataType::MIDI, ARDOUR::PortFlags (ARDOUR::IsInput|ARDOUR::IsPhysical), midi_outputs);
355
356         input_combos.clear ();
357         output_combos.clear ();
358
359         if (!_cp.device_info().uses_ipmidi()) {
360
361                 for (uint32_t n = 0; n < n_surfaces; ++n) {
362
363                         boost::shared_ptr<Surface> surface = _cp.nth_surface (n);
364
365                         if (!surface) {
366                                 PBD::fatal << string_compose (_("programming error: %1\n"), string_compose ("n=%1 surface not found!", n)) << endmsg;
367                                 /*NOTREACHED*/
368                         }
369
370                         Gtk::ComboBox* input_combo = manage (new Gtk::ComboBox);
371                         Gtk::ComboBox* output_combo = manage (new Gtk::ComboBox);
372
373                         update_port_combos (midi_inputs, midi_outputs, input_combo, output_combo, surface);
374
375                         input_combo->pack_start (midi_port_columns.short_name);
376                         input_combo->set_data ("surface", surface.get());
377                         input_combos.push_back (input_combo);
378                         output_combo->pack_start (midi_port_columns.short_name);
379                         output_combo->set_data ("surface", surface.get());
380                         output_combos.push_back (output_combo);
381
382                         boost::weak_ptr<Surface> ws (surface);
383                         input_combo->signal_changed().connect (sigc::bind (sigc::mem_fun (*this, &MackieControlProtocolGUI::active_port_changed), input_combo, ws, true));
384                         output_combo->signal_changed().connect (sigc::bind (sigc::mem_fun (*this, &MackieControlProtocolGUI::active_port_changed), output_combo, ws, false));
385
386                         string send_string;
387                         string receive_string;
388
389                         if (n_surfaces > 1) {
390                                 if (n == 0) {
391                                         send_string = _("Main surface sends via:");
392                                         receive_string = _("Main surface receives via:");
393                                 } else {
394                                         send_string = string_compose (_("Extender %1 sends via:"), n);
395                                         receive_string = string_compose (_("Extender %1 receives via:"), n);
396                                 }
397                         } else {
398                                 send_string = _("Surface sends via:");
399                                 receive_string = _("Surface receives via:");
400                         }
401
402                         l = manage (new Gtk::Label (send_string));
403                         l->set_alignment (1.0, 0.5);
404                         dd_table->attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions(0));
405                         dd_table->attach (*input_combo, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions(0), 0, 0);
406                         row++;
407
408                         l = manage (new Gtk::Label (receive_string));
409                         l->set_alignment (1.0, 0.5);
410                         dd_table->attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions(0));
411                         dd_table->attach (*output_combo, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions(0), 0, 0);
412                         row++;
413                 }
414
415         } else {
416
417                 l = manage (new Gtk::Label (_("ipMIDI Port (lowest)")));
418                 l->set_alignment (1.0, 0.5);
419
420                 Gtk::SpinButton*  ipmidi_base_port_spinner = manage (new Gtk::SpinButton (ipmidi_base_port_adjustment));
421                 dd_table->attach (*l, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
422                 dd_table->attach (*ipmidi_base_port_spinner, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), AttachOptions (0));
423                 row++;
424         }
425
426         return dd_table;
427 }
428
429 CellRendererCombo*
430 MackieControlProtocolGUI::make_action_renderer (Glib::RefPtr<TreeStore> model, Gtk::TreeModelColumnBase column)
431 {
432         CellRendererCombo* renderer = manage (new CellRendererCombo);
433         renderer->property_model() = model;
434         renderer->property_editable() = true;
435         renderer->property_text_column() = 0;
436         renderer->property_has_entry() = false;
437         renderer->signal_edited().connect (sigc::bind (sigc::mem_fun(*this, &MackieControlProtocolGUI::action_changed), column));
438
439         return renderer;
440 }
441
442 void
443 MackieControlProtocolGUI::build_available_action_menu ()
444 {
445         /* build a model of all available actions (needs to be tree structured
446          * more)
447          */
448
449         available_action_model = TreeStore::create (available_action_columns);
450
451         vector<string> paths;
452         vector<string> labels;
453         vector<string> tooltips;
454         vector<string> keys;
455         vector<Glib::RefPtr<Gtk::Action> > actions;
456
457         typedef std::map<string,TreeIter> NodeMap;
458         NodeMap nodes;
459         NodeMap::iterator r;
460
461         Gtkmm2ext::ActionMap::get_all_actions (paths, labels, tooltips, keys, actions);
462
463         vector<string>::iterator k;
464         vector<string>::iterator p;
465         vector<string>::iterator t;
466         vector<string>::iterator l;
467
468         available_action_model->clear ();
469
470         /* Because there are button bindings built in that are not
471            in the key binding map, there needs to be a way to undo
472            a profile edit.
473         */
474         TreeIter rowp;
475         TreeModel::Row parent;
476         rowp = available_action_model->append();
477         parent = *(rowp);
478         parent[available_action_columns.name] = _("Remove Binding");
479
480         /* Key aliasing */
481
482         rowp = available_action_model->append();
483         parent = *(rowp);
484         parent[available_action_columns.name] = _("Shift");
485         rowp = available_action_model->append();
486         parent = *(rowp);
487         parent[available_action_columns.name] = _("Control");
488         rowp = available_action_model->append();
489         parent = *(rowp);
490         parent[available_action_columns.name] = _("Option");
491         rowp = available_action_model->append();
492         parent = *(rowp);
493         parent[available_action_columns.name] = _("CmdAlt");
494
495         for (l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l) {
496
497                 TreeModel::Row row;
498                 vector<string> parts;
499
500                 parts.clear ();
501
502                 split (*p, parts, '/');
503
504                 if (parts.empty()) {
505                         continue;
506                 }
507
508                 //kinda kludgy way to avoid displaying menu items as mappable
509                 if ( parts[1] == _("Main_menu") )
510                         continue;
511                 if ( parts[1] == _("JACK") )
512                         continue;
513                 if ( parts[1] == _("redirectmenu") )
514                         continue;
515                 if ( parts[1] == _("Editor_menus") )
516                         continue;
517                 if ( parts[1] == _("RegionList") )
518                         continue;
519                 if ( parts[1] == _("ProcessorMenu") )
520                         continue;
521
522                 if ((r = nodes.find (parts[1])) == nodes.end()) {
523
524                         /* top level is missing */
525
526                         TreeIter rowp;
527                         TreeModel::Row parent;
528                         rowp = available_action_model->append();
529                         nodes[parts[1]] = rowp;
530                         parent = *(rowp);
531                         parent[available_action_columns.name] = parts[1];
532
533                         row = *(available_action_model->append (parent.children()));
534
535                 } else {
536
537                         row = *(available_action_model->append ((*r->second)->children()));
538
539                 }
540
541                 /* add this action */
542
543                 if (l->empty ()) {
544                         row[available_action_columns.name] = *t;
545                         action_map[*t] = *p;
546                 } else {
547                         row[available_action_columns.name] = *l;
548                         action_map[*l] = *p;
549                 }
550
551                 row[available_action_columns.path] = (*p);
552         }
553 }
554
555 void
556 MackieControlProtocolGUI::build_function_key_editor ()
557 {
558         function_key_editor.append_column (_("Key"), function_key_columns.name);
559
560         TreeViewColumn* col;
561         CellRendererCombo* renderer;
562
563         renderer = make_action_renderer (available_action_model, function_key_columns.plain);
564         col = manage (new TreeViewColumn (_("Plain"), *renderer));
565         col->add_attribute (renderer->property_text(), function_key_columns.plain);
566         function_key_editor.append_column (*col);
567
568         renderer = make_action_renderer (available_action_model, function_key_columns.shift);
569         col = manage (new TreeViewColumn (_("Shift"), *renderer));
570         col->add_attribute (renderer->property_text(), function_key_columns.shift);
571         function_key_editor.append_column (*col);
572
573         renderer = make_action_renderer (available_action_model, function_key_columns.control);
574         col = manage (new TreeViewColumn (_("Control"), *renderer));
575         col->add_attribute (renderer->property_text(), function_key_columns.control);
576         function_key_editor.append_column (*col);
577
578         renderer = make_action_renderer (available_action_model, function_key_columns.option);
579         col = manage (new TreeViewColumn (_("Option"), *renderer));
580         col->add_attribute (renderer->property_text(), function_key_columns.option);
581         function_key_editor.append_column (*col);
582
583         renderer = make_action_renderer (available_action_model, function_key_columns.cmdalt);
584         col = manage (new TreeViewColumn (_("Cmd/Alt"), *renderer));
585         col->add_attribute (renderer->property_text(), function_key_columns.cmdalt);
586         function_key_editor.append_column (*col);
587
588         renderer = make_action_renderer (available_action_model, function_key_columns.shiftcontrol);
589         col = manage (new TreeViewColumn (_("Shift+Control"), *renderer));
590         col->add_attribute (renderer->property_text(), function_key_columns.shiftcontrol);
591         function_key_editor.append_column (*col);
592
593         function_key_model = ListStore::create (function_key_columns);
594         function_key_editor.set_model (function_key_model);
595 }
596
597 void
598 MackieControlProtocolGUI::refresh_function_key_editor ()
599 {
600         function_key_editor.set_model (Glib::RefPtr<TreeModel>());
601         function_key_model->clear ();
602
603         /* now fill with data */
604
605         TreeModel::Row row;
606         DeviceProfile dp (_cp.device_profile());
607         DeviceInfo di;
608
609         for (int n = 0; n < Mackie::Button::FinalGlobalButton; ++n) {
610
611                 Mackie::Button::ID bid = (Mackie::Button::ID) n;
612
613                 row = *(function_key_model->append());
614                 if (di.global_buttons().find (bid) == di.global_buttons().end()) {
615                         row[function_key_columns.name] = Mackie::Button::id_to_name (bid);
616                 } else {
617                         row[function_key_columns.name] = di.get_global_button_name (bid) + "*";
618                 }
619                 row[function_key_columns.id] = bid;
620
621                 Glib::RefPtr<Gtk::Action> act;
622                 string action;
623                 const string defstring = "\u2022";
624
625                 /* We only allow plain bindings for Fn keys. All others are
626                  * reserved for hard-coded actions.
627                  */
628
629                 if (bid >= Mackie::Button::F1 && bid <= Mackie::Button::F8) {
630
631                         action = dp.get_button_action (bid, 0);
632                         if (action.empty()) {
633                                 row[function_key_columns.plain] = defstring;
634                         } else {
635                                 if (action.find ('/') == string::npos) {
636                                         /* Probably a key alias */
637                                         row[function_key_columns.plain] = action;
638                                 } else {
639
640                                         act = ActionManager::get_action (action.c_str());
641                                         if (act) {
642                                                 row[function_key_columns.plain] = act->get_label();
643                                         } else {
644                                                 row[function_key_columns.plain] = defstring;
645                                         }
646                                 }
647                         }
648                 }
649
650                 /* We only allow plain bindings for Fn keys. All others are
651                  * reserved for hard-coded actions.
652                  */
653
654                 if (bid >= Mackie::Button::F1 && bid <= Mackie::Button::F8) {
655
656                         action = dp.get_button_action (bid, MackieControlProtocol::MODIFIER_SHIFT);
657                         if (action.empty()) {
658                                 row[function_key_columns.shift] = defstring;
659                         } else {
660                                 if (action.find ('/') == string::npos) {
661                                         /* Probably a key alias */
662                                         row[function_key_columns.shift] = action;
663                                 } else {
664                                         act = ActionManager::get_action (action.c_str());
665                                         if (act) {
666                                                 row[function_key_columns.shift] = act->get_label();
667                                         } else {
668                                                 row[function_key_columns.shift] = defstring;
669                                         }
670                                 }
671                         }
672                 }
673
674                 action = dp.get_button_action (bid, MackieControlProtocol::MODIFIER_CONTROL);
675                 if (action.empty()) {
676                         row[function_key_columns.control] = defstring;
677                 } else {
678                         if (action.find ('/') == string::npos) {
679                                 /* Probably a key alias */
680                                 row[function_key_columns.control] = action;
681                         } else {
682                                 act = ActionManager::get_action (action.c_str());
683                                 if (act) {
684                                         row[function_key_columns.control] = act->get_label();
685                                 } else {
686                                         row[function_key_columns.control] = defstring;
687                                 }
688                         }
689                 }
690
691                 action = dp.get_button_action (bid, MackieControlProtocol::MODIFIER_OPTION);
692                 if (action.empty()) {
693                         row[function_key_columns.option] = defstring;
694                 } else {
695                         if (action.find ('/') == string::npos) {
696                                 /* Probably a key alias */
697                                 row[function_key_columns.option] = action;
698                         } else {
699                                 act = ActionManager::get_action (action.c_str());
700                                 if (act) {
701                                         row[function_key_columns.option] = act->get_label();
702                                 } else {
703                                         row[function_key_columns.option] = defstring;
704                                 }
705                         }
706                 }
707
708                 action = dp.get_button_action (bid, MackieControlProtocol::MODIFIER_CMDALT);
709                 if (action.empty()) {
710                         row[function_key_columns.cmdalt] = defstring;
711                 } else {
712                         if (action.find ('/') == string::npos) {
713                                 /* Probably a key alias */
714                                 row[function_key_columns.cmdalt] = action;
715                         } else {
716                                 act = ActionManager::get_action (action.c_str());
717                                 if (act) {
718                                         row[function_key_columns.cmdalt] = act->get_label();
719                                 } else {
720                                         row[function_key_columns.cmdalt] = defstring;
721                                 }
722                         }
723                 }
724
725                 action = dp.get_button_action (bid, (MackieControlProtocol::MODIFIER_SHIFT|MackieControlProtocol::MODIFIER_CONTROL));
726                 if (action.empty()) {
727                         row[function_key_columns.shiftcontrol] = defstring;
728                 } else {
729                         act = ActionManager::get_action (action.c_str());
730                         if (act) {
731                                 row[function_key_columns.shiftcontrol] = act->get_label();
732                         } else {
733                                 row[function_key_columns.shiftcontrol] = defstring;
734                         }
735                 }
736         }
737
738         function_key_editor.set_model (function_key_model);
739 }
740
741 void
742 MackieControlProtocolGUI::action_changed (const Glib::ustring &sPath, const Glib::ustring &text, TreeModelColumnBase col)
743 {
744         // Remove Binding is not in the action map but still valid
745         bool remove (false);
746         if ( text == "Remove Binding") {
747                 remove = true;
748         }
749         Gtk::TreePath path(sPath);
750         Gtk::TreeModel::iterator row = function_key_model->get_iter(path);
751
752         if (row) {
753
754                 std::map<std::string,std::string>::iterator i = action_map.find (text);
755
756                 if (i == action_map.end()) {
757                         if (!remove) {
758                                 return;
759                         }
760                 }
761                 Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (i->second.c_str());
762
763                 if (act || remove) {
764                         /* update visible text, using string supplied by
765                            available action model so that it matches and is found
766                            within the model.
767                         */
768                         if (remove) {
769                                 Glib::ustring dot = "\u2022";
770                                 (*row).set_value (col.index(), dot);
771                         } else {
772                                 (*row).set_value (col.index(), text);
773                         }
774
775                         /* update the current DeviceProfile, using the full
776                          * path
777                          */
778
779                         int modifier;
780
781                         switch (col.index()) {
782                         case 3:
783                                 modifier = MackieControlProtocol::MODIFIER_SHIFT;
784                                 break;
785                         case 4:
786                                 modifier = MackieControlProtocol::MODIFIER_CONTROL;
787                                 break;
788                         case 5:
789                                 modifier = MackieControlProtocol::MODIFIER_OPTION;
790                                 break;
791                         case 6:
792                                 modifier = MackieControlProtocol::MODIFIER_CMDALT;
793                                 break;
794                         case 7:
795                                 modifier = (MackieControlProtocol::MODIFIER_SHIFT|MackieControlProtocol::MODIFIER_CONTROL);
796                                 break;
797                         default:
798                                 modifier = 0;
799                         }
800
801                         if (remove) {
802                                 _cp.device_profile().set_button_action ((*row)[function_key_columns.id], modifier, "");
803                         } else {
804                                 _cp.device_profile().set_button_action ((*row)[function_key_columns.id], modifier, i->second);
805                         }
806
807                 } else {
808                         std::cerr << "no such action\n";
809                 }
810         }
811 }
812
813 void
814 MackieControlProtocolGUI::surface_combo_changed ()
815 {
816         _cp.set_device (_surface_combo.get_active_text(), false);
817 }
818
819 void
820 MackieControlProtocolGUI::device_changed ()
821 {
822         if (_device_dependent_widget) {
823                 table.remove (*_device_dependent_widget);
824                 _device_dependent_widget = 0;
825         }
826
827         _device_dependent_widget = device_dependent_widget ();
828         _device_dependent_widget->show_all ();
829
830         table.attach (*_device_dependent_widget, 0, 12, device_dependent_row, device_dependent_row+1, AttachOptions(0), AttachOptions(0), 0, 0);
831 }
832
833 void
834 MackieControlProtocolGUI::profile_combo_changed ()
835 {
836         string profile = _profile_combo.get_active_text();
837
838         _cp.set_profile (profile);
839
840         refresh_function_key_editor ();
841 }
842
843 void
844 MackieControlProtocolGUI::ipmidi_spinner_changed ()
845 {
846         _cp.set_ipmidi_base ((int16_t) lrintf (ipmidi_base_port_adjustment.get_value()));
847 }
848
849 void
850 MackieControlProtocolGUI::discover_clicked ()
851 {
852         /* this should help to get things started */
853         _cp.ping_devices ();
854 }
855
856 void
857 MackieControlProtocolGUI::recalibrate_faders ()
858 {
859         _cp.recalibrate_faders ();
860 }
861
862 void
863 MackieControlProtocolGUI::toggle_backlight ()
864 {
865         _cp.toggle_backlight ();
866 }
867
868 void
869 MackieControlProtocolGUI::touch_sensitive_change ()
870 {
871         int sensitivity = (int) touch_sensitivity_adjustment.get_value ();
872         _cp.set_touch_sensitivity (sensitivity);
873 }
874
875 Glib::RefPtr<Gtk::ListStore>
876 MackieControlProtocolGUI::build_midi_port_list (vector<string> const & ports, bool for_input)
877 {
878         Glib::RefPtr<Gtk::ListStore> store = ListStore::create (midi_port_columns);
879         TreeModel::Row row;
880
881         row = *store->append ();
882         row[midi_port_columns.full_name] = string();
883         row[midi_port_columns.short_name] = _("Disconnected");
884
885         for (vector<string>::const_iterator p = ports.begin(); p != ports.end(); ++p) {
886                 row = *store->append ();
887                 row[midi_port_columns.full_name] = *p;
888                 std::string pn = ARDOUR::AudioEngine::instance()->get_pretty_name_by_name (*p);
889                 if (pn.empty ()) {
890                         pn = (*p).substr ((*p).find (':') + 1);
891                 }
892                 row[midi_port_columns.short_name] = pn;
893         }
894
895         return store;
896 }
897
898 void
899 MackieControlProtocolGUI::active_port_changed (Gtk::ComboBox* combo, boost::weak_ptr<Surface> ws, bool for_input)
900 {
901         if (ignore_active_change) {
902                 return;
903         }
904
905         boost::shared_ptr<Surface> surface = ws.lock();
906
907         if (!surface) {
908                 return;
909         }
910
911         TreeModel::iterator active = combo->get_active ();
912         string new_port = (*active)[midi_port_columns.full_name];
913
914         if (new_port.empty()) {
915                 if (for_input) {
916                         surface->port().input().disconnect_all ();
917                 } else {
918                         surface->port().output().disconnect_all ();
919                 }
920
921                 return;
922         }
923
924         if (for_input) {
925                 if (!surface->port().input().connected_to (new_port)) {
926                         surface->port().input().disconnect_all ();
927                         surface->port().input().connect (new_port);
928                 }
929         } else {
930                 if (!surface->port().output().connected_to (new_port)) {
931                         surface->port().output().disconnect_all ();
932                         surface->port().output().connect (new_port);
933                 }
934         }
935 }