288e9f830d0cde0293e0d06d2a2c456aefdde17e
[ardour.git] / gtk2_ardour / mixer_strip.cc
1 /*
2     Copyright (C) 2000-2006 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 <cmath>
20 #include <algorithm>
21
22 #include <sigc++/bind.h>
23
24 #include "pbd/convert.h"
25 #include "pbd/enumwriter.h"
26 #include "pbd/replace_all.h"
27 #include "pbd/stacktrace.h"
28
29 #include <gtkmm2ext/gtk_ui.h>
30 #include <gtkmm2ext/utils.h>
31 #include <gtkmm2ext/choice.h>
32 #include <gtkmm2ext/doi.h>
33 #include <gtkmm2ext/slider_controller.h>
34 #include <gtkmm2ext/bindable_button.h>
35
36 #include "ardour/ardour.h"
37 #include "ardour/amp.h"
38 #include "ardour/session.h"
39 #include "ardour/audioengine.h"
40 #include "ardour/internal_send.h"
41 #include "ardour/route.h"
42 #include "ardour/route_group.h"
43 #include "ardour/audio_track.h"
44 #include "ardour/midi_track.h"
45 #include "ardour/pannable.h"
46 #include "ardour/panner.h"
47 #include "ardour/panner_shell.h"
48 #include "ardour/send.h"
49 #include "ardour/processor.h"
50 #include "ardour/profile.h"
51 #include "ardour/ladspa_plugin.h"
52 #include "ardour/user_bundle.h"
53 #include "ardour/port.h"
54
55 #include "ardour_ui.h"
56 #include "ardour_dialog.h"
57 #include "mixer_strip.h"
58 #include "mixer_ui.h"
59 #include "keyboard.h"
60 #include "ardour_button.h"
61 #include "public_editor.h"
62 #include "send_ui.h"
63 #include "io_selector.h"
64 #include "utils.h"
65 #include "gui_thread.h"
66 #include "route_group_menu.h"
67
68 #include "i18n.h"
69
70 using namespace ARDOUR;
71 using namespace PBD;
72 using namespace Gtk;
73 using namespace Gtkmm2ext;
74 using namespace std;
75
76 int MixerStrip::scrollbar_height = 0;
77 PBD::Signal1<void,MixerStrip*> MixerStrip::CatchDeletion;
78
79 MixerStrip::MixerStrip (Mixer_UI& mx, Session* sess, bool in_mixer)
80         : AxisView(sess)
81         , RouteUI (sess)
82         , _mixer(mx)
83         , _mixer_owned (in_mixer)
84         , processor_box (sess, boost::bind (&MixerStrip::plugin_selector, this), mx.selection(), this, in_mixer)
85         , gpm (sess, 250)
86         , panners (sess)
87         , button_table (3, 1)
88         , rec_solo_table (2, 2)
89         , top_button_table (1, 2)
90         , middle_button_table (1, 2)
91         , bottom_button_table (1, 2)
92         , meter_point_label (_("pre"))
93         , midi_input_enable_button (0)
94         , _comment_button (_("Comments"))
95         , _visibility (X_("mixer-strip-visibility"))
96 {
97         init ();
98
99         if (!_mixer_owned) {
100                 /* the editor mixer strip: don't destroy it every time
101                    the underlying route goes away.
102                 */
103
104                 self_destruct = false;
105         }
106 }
107
108 MixerStrip::MixerStrip (Mixer_UI& mx, Session* sess, boost::shared_ptr<Route> rt, bool in_mixer)
109         : AxisView(sess)
110         , RouteUI (sess)
111         , _mixer(mx)
112         , _mixer_owned (in_mixer)
113         , processor_box (sess, sigc::mem_fun(*this, &MixerStrip::plugin_selector), mx.selection(), this, in_mixer)
114         , gpm (sess, 250)
115         , panners (sess)
116         , button_table (3, 1)
117         , middle_button_table (1, 2)
118         , bottom_button_table (1, 2)
119         , meter_point_label (_("pre"))
120         , midi_input_enable_button (0)
121         , _comment_button (_("Comments"))
122         , _visibility (X_("mixer-strip-visibility"))
123 {
124         init ();
125         set_route (rt);
126 }
127
128 void
129 MixerStrip::init ()
130 {
131         input_selector = 0;
132         output_selector = 0;
133         group_menu = 0;
134         route_ops_menu = 0;
135         ignore_comment_edit = false;
136         ignore_toggle = false;
137         comment_window = 0;
138         comment_area = 0;
139         _width_owner = 0;
140         spacer = 0;
141
142         /* the length of this string determines the width of the mixer strip when it is set to `wide' */
143         longest_label = "longest label";
144
145         Gtk::Image* img;
146
147         img = manage (new Gtk::Image (::get_icon("strip_width")));
148         img->show ();
149
150         width_button.add (*img);
151
152         img = manage (new Gtk::Image (::get_icon("hide")));
153         img->show ();
154
155         hide_button.add (*img);
156
157         input_label.set_text (_("Input"));
158         ARDOUR_UI::instance()->set_tip (&input_button, _("Button 1 to choose inputs from a port matrix, button 3 to select inputs from a menu"), "");
159         input_button.add (input_label);
160         input_button.set_name ("MixerIOButton");
161         input_label.set_name ("MixerIOButtonLabel");
162         input_button_box.pack_start (input_button, true, true);
163
164         output_label.set_text (_("Output"));
165         ARDOUR_UI::instance()->set_tip (&output_button, _("Button 1 to choose outputs from a port matrix, button 3 to select inputs from a menu"), "");
166         output_button.add (output_label);
167         output_button.set_name ("MixerIOButton");
168         output_label.set_name ("MixerIOButtonLabel");
169         Gtkmm2ext::set_size_request_to_display_given_text (output_button, longest_label.c_str(), 4, 4);
170
171         ARDOUR_UI::instance()->set_tip (&meter_point_button, _("Select metering point"), "");
172         meter_point_button.add (meter_point_label);
173         meter_point_button.set_name ("MixerStripMeterPreButton");
174         meter_point_label.set_name ("MixerStripMeterPreButton");
175
176         /* TRANSLATORS: this string should be longest of the strings
177            used to describe meter points. In english, it's "input".
178         */
179         set_size_request_to_display_given_text (meter_point_button, _("tupni"), 5, 5);
180
181         bottom_button_table.attach (meter_point_button, 1, 2, 0, 1);
182
183         meter_point_button.signal_button_press_event().connect (sigc::mem_fun (gpm, &GainMeter::meter_press), false);
184         meter_point_button.signal_button_release_event().connect (sigc::mem_fun (gpm, &GainMeter::meter_release), false);
185
186         hide_button.set_events (hide_button.get_events() & ~(Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK));
187
188         monitor_input_button->set_diameter (3);
189         monitor_disk_button->set_diameter (3);
190
191         solo_isolated_led = manage (new ArdourButton (ArdourButton::led_default_elements));
192         solo_isolated_led->show ();
193         solo_isolated_led->set_diameter (3);
194         solo_isolated_led->set_no_show_all (true);
195         solo_isolated_led->set_name (X_("solo isolate"));
196         solo_isolated_led->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
197         solo_isolated_led->signal_button_release_event().connect (sigc::mem_fun (*this, &RouteUI::solo_isolate_button_release));
198         UI::instance()->set_tip (solo_isolated_led, _("Isolate Solo"), "");
199
200         solo_safe_led = manage (new ArdourButton (ArdourButton::led_default_elements));
201         solo_safe_led->show ();
202         solo_safe_led->set_diameter (3);
203         solo_safe_led->set_no_show_all (true);
204         solo_safe_led->set_name (X_("solo safe"));
205         solo_safe_led->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
206         solo_safe_led->signal_button_release_event().connect (sigc::mem_fun (*this, &RouteUI::solo_safe_button_release));
207         UI::instance()->set_tip (solo_safe_led, _("Lock Solo Status"), "");
208
209         solo_safe_led->set_text (_("lock"));
210         solo_isolated_led->set_text (_("iso"));
211
212         top_button_table.set_homogeneous (true);
213         top_button_table.set_spacings (2);
214         top_button_table.attach (*monitor_input_button, 0, 1, 0, 1);
215         top_button_table.attach (*monitor_disk_button, 1, 2, 0, 1);
216         top_button_table.show ();
217
218         rec_solo_table.set_homogeneous (false);
219         rec_solo_table.set_row_spacings (2);
220         rec_solo_table.set_col_spacings (2);
221         rec_solo_table.attach (*solo_isolated_led, 1, 2, 0, 1);
222         rec_solo_table.attach (*solo_safe_led, 1, 2, 1, 2);
223         rec_solo_table.show ();
224
225         button_table.set_homogeneous (false);
226         button_table.set_spacings (0);
227
228         button_table.attach (name_button, 0, 1, 0, 1);
229         button_table.attach (input_button_box, 0, 1, 1, 2);
230         button_table.attach (_invert_button_box, 0, 1, 2, 3);
231
232         middle_button_table.set_homogeneous (true);
233         middle_button_table.set_spacings (0);
234         middle_button_table.attach (*mute_button, 0, 1, 0, 1);
235         middle_button_table.attach (*solo_button, 1, 2, 0, 1);
236
237         bottom_button_table.set_col_spacings (0);
238         bottom_button_table.set_homogeneous (true);
239         bottom_button_table.attach (group_button, 0, 1, 0, 1);
240
241         name_button.add (name_label);
242         name_button.set_name ("MixerNameButton");
243         Gtkmm2ext::set_size_request_to_display_given_text (name_button, longest_label.c_str(), 2, 2);
244
245         name_label.set_name ("MixerNameButtonLabel");
246         ARDOUR_UI::instance()->set_tip (&group_button, _("Mix group"), "");
247         group_button.add (group_label);
248         group_button.set_name ("MixerGroupButton");
249         Gtkmm2ext::set_size_request_to_display_given_text (group_button, "Group", 2, 2);
250         group_label.set_name ("MixerGroupButtonLabel");
251
252         _comment_button.set_name (X_("MixerCommentButton"));
253         _comment_button.signal_clicked().connect (sigc::mem_fun (*this, &MixerStrip::toggle_comment));
254
255         global_vpacker.set_border_width (0);
256         global_vpacker.set_spacing (0);
257
258         width_button.set_name ("MixerWidthButton");
259         hide_button.set_name ("MixerHideButton");
260         top_event_box.set_name ("MixerTopEventBox");
261
262         width_button.signal_clicked().connect (sigc::mem_fun(*this, &MixerStrip::width_clicked));
263         hide_button.signal_clicked().connect (sigc::mem_fun(*this, &MixerStrip::hide_clicked));
264
265         width_hide_box.pack_start (width_button, false, true);
266         width_hide_box.pack_start (top_event_box, true, true);
267         width_hide_box.pack_end (hide_button, false, true);
268
269         whvbox.pack_start (width_hide_box, true, true);
270
271         global_vpacker.pack_start (whvbox, Gtk::PACK_SHRINK);
272         global_vpacker.pack_start (button_table, Gtk::PACK_SHRINK);
273         global_vpacker.pack_start (processor_box, true, true);
274         global_vpacker.pack_start (panners, Gtk::PACK_SHRINK);
275         global_vpacker.pack_start (top_button_table, Gtk::PACK_SHRINK, 2);
276         global_vpacker.pack_start (rec_solo_table, Gtk::PACK_SHRINK, 2);
277         global_vpacker.pack_start (middle_button_table, Gtk::PACK_SHRINK, 2);
278         global_vpacker.pack_start (gpm, Gtk::PACK_SHRINK);
279         global_vpacker.pack_start (bottom_button_table, Gtk::PACK_SHRINK);
280         global_vpacker.pack_start (output_button, Gtk::PACK_SHRINK);
281         global_vpacker.pack_start (_comment_button, Gtk::PACK_SHRINK);
282
283         global_frame.add (global_vpacker);
284         global_frame.set_shadow_type (Gtk::SHADOW_IN);
285         global_frame.set_name ("BaseFrame");
286
287         add (global_frame);
288
289         /* force setting of visible selected status */
290
291         _selected = true;
292         set_selected (false);
293
294         _packed = false;
295         _embedded = false;
296
297         _session->engine().Stopped.connect (*this, invalidator (*this), boost::bind (&MixerStrip::engine_stopped, this), gui_context());
298         _session->engine().Running.connect (*this, invalidator (*this), boost::bind (&MixerStrip::engine_running, this), gui_context());
299
300         input_button.signal_button_press_event().connect (sigc::mem_fun(*this, &MixerStrip::input_press), false);
301         output_button.signal_button_press_event().connect (sigc::mem_fun(*this, &MixerStrip::output_press), false);
302
303         /* ditto for this button and busses */
304
305         name_button.signal_button_press_event().connect (sigc::mem_fun(*this, &MixerStrip::name_button_button_press), false);
306         group_button.signal_button_press_event().connect (sigc::mem_fun(*this, &MixerStrip::select_route_group), false);
307
308         _width = (Width) -1;
309
310         /* start off as a passthru strip. we'll correct this, if necessary,
311            in update_diskstream_display().
312         */
313
314         /* start off as a passthru strip. we'll correct this, if necessary,
315            in update_diskstream_display().
316         */
317
318         if (is_midi_track()) {
319                 set_name ("MidiTrackStripBase");
320         } else {
321                 set_name ("AudioTrackStripBase");
322         }
323
324         add_events (Gdk::BUTTON_RELEASE_MASK|
325                     Gdk::ENTER_NOTIFY_MASK|
326                     Gdk::LEAVE_NOTIFY_MASK|
327                     Gdk::KEY_PRESS_MASK|
328                     Gdk::KEY_RELEASE_MASK);
329
330         set_flags (get_flags() | Gtk::CAN_FOCUS);
331
332         AudioEngine::instance()->PortConnectedOrDisconnected.connect (
333                 *this, invalidator (*this), boost::bind (&MixerStrip::port_connected_or_disconnected, this, _1, _3), gui_context ()
334                 );
335
336         /* Add the widgets under visibility control to the VisibilityGroup; the names used here
337            must be the same as those used in RCOptionEditor so that the configuration changes
338            are recognised when they occur.
339         */
340         _visibility.add (&_invert_button_box, X_("PhaseInvert"), _("Phase Invert"));
341         _visibility.add (solo_safe_led, X_("SoloSafe"), _("Solo Safe"), true, boost::bind (&MixerStrip::override_solo_visibility, this));
342         _visibility.add (solo_isolated_led, X_("SoloIsolated"), _("Solo Isolated"), true, boost::bind (&MixerStrip::override_solo_visibility, this));
343         _visibility.add (&_comment_button, X_("Comments"), _("Comments"));
344         _visibility.add (&group_button, X_("Group"), _("Group"));
345         _visibility.add (&meter_point_button, X_("MeterPoint"), _("Meter Point"));
346
347         parameter_changed (X_("mixer-strip-visibility"));
348
349         Config->ParameterChanged.connect (_config_connection, MISSING_INVALIDATOR, ui_bind (&MixerStrip::parameter_changed, this, _1), gui_context());
350 }
351
352 MixerStrip::~MixerStrip ()
353 {
354         CatchDeletion (this);
355
356         delete input_selector;
357         delete output_selector;
358         delete comment_window;
359 }
360
361 void
362 MixerStrip::set_route (boost::shared_ptr<Route> rt)
363 {
364         if (rec_enable_button->get_parent()) {
365                 rec_solo_table.remove (*rec_enable_button);
366         }
367
368         if (show_sends_button->get_parent()) {
369                 rec_solo_table.remove (*show_sends_button);
370         }
371
372         processor_box.set_route (rt);
373
374         RouteUI::set_route (rt);
375
376         /* map the current state */
377
378         mute_changed (0);
379         update_solo_display ();
380
381         delete input_selector;
382         input_selector = 0;
383
384         delete output_selector;
385         output_selector = 0;
386
387         revert_to_default_display ();
388
389         if (route()->is_master()) {
390                 solo_button->hide ();
391                 rec_solo_table.hide ();
392         } else {
393                 solo_button->show ();
394                 rec_solo_table.show ();
395         }
396
397         if (_mixer_owned && (route()->is_master() || route()->is_monitor())) {
398
399                 if (scrollbar_height == 0) {
400                         HScrollbar scrollbar;
401                         Gtk::Requisition requisition(scrollbar.size_request ());
402                         scrollbar_height = requisition.height;
403                 }
404
405                 spacer = manage (new EventBox);
406                 spacer->set_size_request (-1, scrollbar_height);
407                 global_vpacker.pack_start (*spacer, false, false);
408         }
409
410         if (is_track()) {
411                 monitor_input_button->show ();
412                 monitor_disk_button->show ();
413         } else {
414                 monitor_input_button->hide();
415                 monitor_disk_button->hide ();
416         }
417
418         if (is_midi_track()) {
419                 if (midi_input_enable_button == 0) {
420                         Image* img = manage (new Image (get_icon (X_("midi_socket_small"))));
421                         midi_input_enable_button = manage (new StatefulToggleButton);
422                         midi_input_enable_button->set_name ("MixerMidiInputEnableButton");
423                         midi_input_enable_button->set_image (*img);
424                         midi_input_enable_button->signal_button_press_event().connect (sigc::mem_fun (*this, &MixerStrip::input_active_button_press), false);
425                         midi_input_enable_button->signal_button_release_event().connect (sigc::mem_fun (*this, &MixerStrip::input_active_button_release), false);
426                         ARDOUR_UI::instance()->set_tip (midi_input_enable_button, _("Enable/Disable MIDI input"));
427                 } else {
428                         input_button_box.remove (*midi_input_enable_button);
429                 }
430                 /* get current state */
431                 midi_input_status_changed ();
432                 input_button_box.pack_start (*midi_input_enable_button, false, false);
433                 /* follow changes */
434                 midi_track()->InputActiveChanged.connect (route_connections, invalidator (*this), boost::bind (&MixerStrip::midi_input_status_changed, this), gui_context());
435         } else {
436                 if (midi_input_enable_button) {
437                         /* removal from the container will delete it */
438                         input_button_box.remove (*midi_input_enable_button);
439                         midi_input_enable_button = 0;
440                 }
441         }
442
443         if (is_audio_track()) {
444                 boost::shared_ptr<AudioTrack> at = audio_track();
445                 at->FreezeChange.connect (route_connections, invalidator (*this), boost::bind (&MixerStrip::map_frozen, this), gui_context());
446         }
447
448         if (has_audio_outputs ()) {
449                 panners.show_all ();
450         } else {
451                 panners.hide_all ();
452         }
453
454         if (is_track ()) {
455
456                 rec_solo_table.attach (*rec_enable_button, 0, 1, 0, 2);
457                 rec_enable_button->set_sensitive (_session->writable());
458                 rec_enable_button->show();
459
460         } else {
461
462                 /* non-master bus */
463
464                 if (!_route->is_master()) {
465                         rec_solo_table.attach (*show_sends_button, 0, 1, 0, 2);
466                         show_sends_button->show();
467                 }
468         }
469
470         meter_point_label.set_text (meter_point_string (_route->meter_point()));
471
472         delete route_ops_menu;
473         route_ops_menu = 0;
474
475         _route->meter_change.connect (route_connections, invalidator (*this), bind (&MixerStrip::meter_changed, this), gui_context());
476         _route->route_group_changed.connect (route_connections, invalidator (*this), boost::bind (&MixerStrip::route_group_changed, this), gui_context());
477
478         if (_route->panner_shell()) {
479                 _route->panner_shell()->Changed.connect (route_connections, invalidator (*this), boost::bind (&MixerStrip::connect_to_pan, this), gui_context());
480         }
481
482         if (is_audio_track()) {
483                 audio_track()->DiskstreamChanged.connect (route_connections, invalidator (*this), boost::bind (&MixerStrip::diskstream_changed, this), gui_context());
484         }
485
486         _route->comment_changed.connect (route_connections, invalidator (*this), ui_bind (&MixerStrip::comment_changed, this, _1), gui_context());
487
488         set_stuff_from_route ();
489
490         /* now force an update of all the various elements */
491
492         mute_changed (0);
493         update_solo_display ();
494         name_changed ();
495         comment_changed (0);
496         route_group_changed ();
497
498         connect_to_pan ();
499         panners.setup_pan ();
500
501         update_diskstream_display ();
502         update_input_display ();
503         update_output_display ();
504
505         add_events (Gdk::BUTTON_RELEASE_MASK);
506
507         processor_box.show ();
508
509         if (!route()->is_master() && !route()->is_monitor()) {
510                 /* we don't allow master or control routes to be hidden */
511                 hide_button.show();
512         }
513
514         width_button.show();
515         width_hide_box.show();
516         whvbox.show ();
517         global_frame.show();
518         global_vpacker.show();
519         button_table.show();
520         middle_button_table.show();
521         bottom_button_table.show();
522         gpm.show_all ();
523         gain_unit_button.show();
524         gain_unit_label.show();
525         meter_point_button.show();
526         meter_point_label.show();
527         diskstream_button.show();
528         diskstream_label.show();
529         input_button_box.show_all();
530         output_button.show();
531         output_label.show();
532         name_label.show();
533         name_button.show();
534         _comment_button.show();
535         group_button.show();
536         group_label.show();
537
538         parameter_changed ("mixer-strip-visibility");
539
540         show ();
541 }
542
543 void
544 MixerStrip::set_stuff_from_route ()
545 {
546         /* if width is not set, it will be set by the MixerUI or editor */
547
548         string str = gui_property ("strip-width");
549         if (!str.empty()) {
550                 set_width_enum (Width (string_2_enum (str, _width)), this);
551         }
552 }
553
554 void
555 MixerStrip::set_width_enum (Width w, void* owner)
556 {
557         /* always set the gpm width again, things may be hidden */
558
559         gpm.set_width (w);
560         panners.set_width (w);
561
562         boost::shared_ptr<AutomationList> gain_automation = _route->gain_control()->alist();
563
564         _width_owner = owner;
565
566         _width = w;
567
568         if (_width_owner == this) {
569                 set_gui_property ("strip-width", enum_2_string (_width));
570         }
571
572         set_button_names ();
573
574         switch (w) {
575         case Wide:
576                 if (show_sends_button)  {
577                         show_sends_button->set_text (_("Sends"));
578                 }
579
580                 ((Gtk::Label*)gpm.gain_automation_style_button.get_child())->set_text (
581                                 gpm.astyle_string(gain_automation->automation_style()));
582                 ((Gtk::Label*)gpm.gain_automation_state_button.get_child())->set_text (
583                                 gpm.astate_string(gain_automation->automation_state()));
584
585                 if (_route->panner()) {
586                         ((Gtk::Label*)panners.pan_automation_style_button.get_child())->set_text (
587                                         panners.astyle_string(_route->panner()->automation_style()));
588                         ((Gtk::Label*)panners.pan_automation_state_button.get_child())->set_text (
589                                         panners.astate_string(_route->panner()->automation_state()));
590                 }
591
592                 solo_isolated_led->set_text (_("iso"));
593                 solo_safe_led->set_text (_("lock"));
594
595                 Gtkmm2ext::set_size_request_to_display_given_text (name_button, "long", 2, 2);
596                 set_size_request (-1, -1);
597                 break;
598
599         case Narrow:
600                 if (show_sends_button) {
601                         show_sends_button->set_text (_("Snd"));
602                 }
603
604                 ((Gtk::Label*)gpm.gain_automation_style_button.get_child())->set_text (
605                                 gpm.short_astyle_string(gain_automation->automation_style()));
606                 ((Gtk::Label*)gpm.gain_automation_state_button.get_child())->set_text (
607                                 gpm.short_astate_string(gain_automation->automation_state()));
608
609                 if (_route->panner()) {
610                         ((Gtk::Label*)panners.pan_automation_style_button.get_child())->set_text (
611                         panners.short_astyle_string(_route->panner()->automation_style()));
612                         ((Gtk::Label*)panners.pan_automation_state_button.get_child())->set_text (
613                         panners.short_astate_string(_route->panner()->automation_state()));
614                 }
615                 
616                 solo_isolated_led->set_text ("");
617                 solo_safe_led->set_text ("");
618
619                 Gtkmm2ext::set_size_request_to_display_given_text (name_button, longest_label.c_str(), 2, 2);
620                 set_size_request (max (50, gpm.get_gm_width()), -1);
621                 break;
622         }
623
624         processor_box.set_width (w);
625
626         update_input_display ();
627         update_output_display ();
628         setup_comment_button ();
629         route_group_changed ();
630         name_changed ();
631         WidthChanged ();
632 }
633
634 void
635 MixerStrip::set_packed (bool yn)
636 {
637         _packed = yn;
638
639         if (_packed) {
640                 set_gui_property ("visible", true);
641         } else {
642                 set_gui_property ("visible", false);
643         }
644 }
645
646
647 struct RouteCompareByName {
648         bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
649                 return a->name().compare (b->name()) < 0;
650         }
651 };
652
653 gint
654 MixerStrip::output_press (GdkEventButton *ev)
655 {
656         using namespace Menu_Helpers;
657         if (!_session->engine().connected()) {
658                 MessageDialog msg (_("Not connected to JACK - no I/O changes are possible"));
659                 msg.run ();
660                 return true;
661         }
662
663         MenuList& citems = output_menu.items();
664         switch (ev->button) {
665
666         case 1:
667                 edit_output_configuration ();
668                 break;
669
670         case 3:
671         {
672                 output_menu.set_name ("ArdourContextMenu");
673                 citems.clear ();
674                 output_menu_bundles.clear ();
675
676                 citems.push_back (MenuElem (_("Disconnect"), sigc::mem_fun (*(static_cast<RouteUI*>(this)), &RouteUI::disconnect_output)));
677                 citems.push_back (SeparatorElem());
678
679                 ARDOUR::BundleList current = _route->output()->bundles_connected ();
680
681                 boost::shared_ptr<ARDOUR::BundleList> b = _session->bundles ();
682
683                 /* give user bundles first chance at being in the menu */
684
685                 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
686                         if (boost::dynamic_pointer_cast<UserBundle> (*i)) {
687                                 maybe_add_bundle_to_output_menu (*i, current);
688                         }
689                 }
690
691                 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
692                         if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0) {
693                                 maybe_add_bundle_to_output_menu (*i, current);
694                         }
695                 }
696
697                 boost::shared_ptr<ARDOUR::RouteList> routes = _session->get_routes ();
698                 RouteList copy = *routes;
699                 copy.sort (RouteCompareByName ());
700                 for (ARDOUR::RouteList::const_iterator i = copy.begin(); i != copy.end(); ++i) {
701                         maybe_add_bundle_to_output_menu ((*i)->input()->bundle(), current);
702                 }
703
704                 if (citems.size() == 2) {
705                         /* no routes added; remove the separator */
706                         citems.pop_back ();
707                 }
708
709                 output_menu.popup (1, ev->time);
710                 break;
711         }
712
713         default:
714                 break;
715         }
716         return TRUE;
717 }
718
719 void
720 MixerStrip::edit_output_configuration ()
721 {
722         if (output_selector == 0) {
723
724                 boost::shared_ptr<Send> send;
725                 boost::shared_ptr<IO> output;
726
727                 if ((send = boost::dynamic_pointer_cast<Send>(_current_delivery)) != 0) {
728                         if (!boost::dynamic_pointer_cast<InternalSend>(send)) {
729                                 output = send->output();
730                         } else {
731                                 output = _route->output ();
732                         }
733                 } else {
734                         output = _route->output ();
735                 }
736
737                 output_selector = new IOSelectorWindow (_session, output);
738         }
739
740         if (output_selector->is_visible()) {
741                 output_selector->get_toplevel()->get_window()->raise();
742         } else {
743                 output_selector->present ();
744         }
745 }
746
747 void
748 MixerStrip::edit_input_configuration ()
749 {
750         if (input_selector == 0) {
751                 input_selector = new IOSelectorWindow (_session, _route->input());
752         }
753
754         if (input_selector->is_visible()) {
755                 input_selector->get_toplevel()->get_window()->raise();
756         } else {
757                 input_selector->present ();
758         }
759 }
760
761 gint
762 MixerStrip::input_press (GdkEventButton *ev)
763 {
764         using namespace Menu_Helpers;
765
766         MenuList& citems = input_menu.items();
767         input_menu.set_name ("ArdourContextMenu");
768         citems.clear();
769
770         if (!_session->engine().connected()) {
771                 MessageDialog msg (_("Not connected to JACK - no I/O changes are possible"));
772                 msg.run ();
773                 return true;
774         }
775
776         if (_session->actively_recording() && _route->record_enabled())
777                 return true;
778
779         switch (ev->button) {
780
781         case 1:
782                 edit_input_configuration ();
783                 break;
784
785         case 3:
786         {
787                 citems.push_back (MenuElem (_("Disconnect"), sigc::mem_fun (*(static_cast<RouteUI*>(this)), &RouteUI::disconnect_input)));
788                 citems.push_back (SeparatorElem());
789                 input_menu_bundles.clear ();
790
791                 ARDOUR::BundleList current = _route->input()->bundles_connected ();
792
793                 boost::shared_ptr<ARDOUR::BundleList> b = _session->bundles ();
794
795                 /* give user bundles first chance at being in the menu */
796
797                 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
798                         if (boost::dynamic_pointer_cast<UserBundle> (*i)) {
799                                 maybe_add_bundle_to_input_menu (*i, current);
800                         }
801                 }
802
803                 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
804                         if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0) {
805                                 maybe_add_bundle_to_input_menu (*i, current);
806                         }
807                 }
808
809                 boost::shared_ptr<ARDOUR::RouteList> routes = _session->get_routes ();
810                 RouteList copy = *routes;
811                 copy.sort (RouteCompareByName ());
812                 for (ARDOUR::RouteList::const_iterator i = copy.begin(); i != copy.end(); ++i) {
813                         maybe_add_bundle_to_input_menu ((*i)->output()->bundle(), current);
814                 }
815
816                 if (citems.size() == 2) {
817                         /* no routes added; remove the separator */
818                         citems.pop_back ();
819                 }
820
821                 input_menu.popup (1, ev->time);
822                 break;
823         }
824         default:
825                 break;
826         }
827         return TRUE;
828 }
829
830 void
831 MixerStrip::bundle_input_toggled (boost::shared_ptr<ARDOUR::Bundle> c)
832 {
833         if (ignore_toggle) {
834                 return;
835         }
836
837         ARDOUR::BundleList current = _route->input()->bundles_connected ();
838
839         if (std::find (current.begin(), current.end(), c) == current.end()) {
840                 _route->input()->connect_ports_to_bundle (c, this);
841         } else {
842                 _route->input()->disconnect_ports_from_bundle (c, this);
843         }
844 }
845
846 void
847 MixerStrip::bundle_output_toggled (boost::shared_ptr<ARDOUR::Bundle> c)
848 {
849         if (ignore_toggle) {
850                 return;
851         }
852
853         ARDOUR::BundleList current = _route->output()->bundles_connected ();
854
855         if (std::find (current.begin(), current.end(), c) == current.end()) {
856                 _route->output()->connect_ports_to_bundle (c, this);
857         } else {
858                 _route->output()->disconnect_ports_from_bundle (c, this);
859         }
860 }
861
862 void
863 MixerStrip::maybe_add_bundle_to_input_menu (boost::shared_ptr<Bundle> b, ARDOUR::BundleList const & current)
864 {
865         using namespace Menu_Helpers;
866
867         if (b->ports_are_outputs() == false || b->nchannels() != _route->n_inputs()) {
868                 return;
869         }
870
871         list<boost::shared_ptr<Bundle> >::iterator i = input_menu_bundles.begin ();
872         while (i != input_menu_bundles.end() && b->has_same_ports (*i) == false) {
873                 ++i;
874         }
875
876         if (i != input_menu_bundles.end()) {
877                 return;
878         }
879
880         input_menu_bundles.push_back (b);
881
882         MenuList& citems = input_menu.items();
883
884         std::string n = b->name ();
885         replace_all (n, "_", " ");
886
887         citems.push_back (CheckMenuElem (n, sigc::bind (sigc::mem_fun(*this, &MixerStrip::bundle_input_toggled), b)));
888
889         if (std::find (current.begin(), current.end(), b) != current.end()) {
890                 ignore_toggle = true;
891                 dynamic_cast<CheckMenuItem *> (&citems.back())->set_active (true);
892                 ignore_toggle = false;
893         }
894 }
895
896 void
897 MixerStrip::maybe_add_bundle_to_output_menu (boost::shared_ptr<Bundle> b, ARDOUR::BundleList const & current)
898 {
899         using namespace Menu_Helpers;
900
901         if (b->ports_are_inputs() == false || b->nchannels() != _route->n_outputs()) {
902                 return;
903         }
904
905         list<boost::shared_ptr<Bundle> >::iterator i = output_menu_bundles.begin ();
906         while (i != output_menu_bundles.end() && b->has_same_ports (*i) == false) {
907                 ++i;
908         }
909
910         if (i != output_menu_bundles.end()) {
911                 return;
912         }
913
914         output_menu_bundles.push_back (b);
915
916         MenuList& citems = output_menu.items();
917
918         std::string n = b->name ();
919         replace_all (n, "_", " ");
920
921         citems.push_back (CheckMenuElem (n, sigc::bind (sigc::mem_fun(*this, &MixerStrip::bundle_output_toggled), b)));
922
923         if (std::find (current.begin(), current.end(), b) != current.end()) {
924                 ignore_toggle = true;
925                 dynamic_cast<CheckMenuItem *> (&citems.back())->set_active (true);
926                 ignore_toggle = false;
927         }
928 }
929
930 void
931 MixerStrip::update_diskstream_display ()
932 {
933         if (is_track()) {
934
935                 if (input_selector) {
936                         input_selector->hide_all ();
937                 }
938
939                 route_color_changed ();
940
941         } else {
942
943                 show_passthru_color ();
944         }
945 }
946
947 void
948 MixerStrip::connect_to_pan ()
949 {
950         ENSURE_GUI_THREAD (*this, &MixerStrip::connect_to_pan)
951
952         panstate_connection.disconnect ();
953         panstyle_connection.disconnect ();
954
955         if (!_route->panner()) {
956                 return;
957         }
958
959         boost::shared_ptr<Pannable> p = _route->pannable ();
960
961         p->automation_state_changed.connect (panstate_connection, invalidator (*this), boost::bind (&PannerUI::pan_automation_state_changed, &panners), gui_context());
962         p->automation_style_changed.connect (panstyle_connection, invalidator (*this), boost::bind (&PannerUI::pan_automation_style_changed, &panners), gui_context());
963
964         panners.panshell_changed ();
965 }
966
967
968 /*
969  * Output port labelling
970  * =====================
971  *
972  * Case 1: Each output has one connection, all connections are to system:playback_%i
973  *   out 1 -> system:playback_1
974  *   out 2 -> system:playback_2
975  *   out 3 -> system:playback_3
976  *   Display as: 1/2/3
977  *
978  * Case 2: Each output has one connection, all connections are to ardour:track_x/in 1
979  *   out 1 -> ardour:track_x/in 1
980  *   out 2 -> ardour:track_x/in 2
981  *   Display as: track_x
982  *
983  * Case 3: Each output has one connection, all connections are to Jack client "program x"
984  *   out 1 -> program x:foo
985  *   out 2 -> program x:foo
986  *   Display as: program x
987  *
988  * Case 4: No connections (Disconnected)
989  *   Display as: -
990  *
991  * Default case (unusual routing):
992  *   Display as: *number of connections*
993  *
994  * Tooltips
995  * ========
996  * .-----------------------------------------------.
997  * | Mixdown                                       |
998  * | out 1 -> ardour:master/in 1, jamin:input/in 1 |
999  * | out 2 -> ardour:master/in 2, jamin:input/in 2 |
1000  * '-----------------------------------------------'
1001  * .-----------------------------------------------.
1002  * | Guitar SM58                                   |
1003  * | Disconnected                                  |
1004  * '-----------------------------------------------'
1005  */
1006
1007 void
1008 MixerStrip::update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width width, bool for_input)
1009 {
1010         uint32_t io_count;
1011         uint32_t io_index;
1012         boost::shared_ptr<Port> port;
1013         vector<string> port_connections;
1014
1015         uint32_t total_connection_count = 0;
1016         uint32_t io_connection_count = 0;
1017         uint32_t ardour_connection_count = 0;
1018         uint32_t system_connection_count = 0;
1019         uint32_t other_connection_count = 0;
1020
1021         ostringstream label;
1022         string label_string;
1023
1024         bool have_label = false;
1025         bool each_io_has_one_connection = true;
1026
1027         string connection_name;
1028         string ardour_track_name;
1029         string other_connection_type;
1030         string system_ports;
1031         string system_port;
1032
1033         ostringstream tooltip;
1034         char * tooltip_cstr;
1035
1036         tooltip << route->name();
1037
1038         if (for_input) {
1039                 io_count = route->n_inputs().n_total();
1040         } else {
1041                 io_count = route->n_outputs().n_total();
1042         }
1043
1044         for (io_index = 0; io_index < io_count; ++io_index) {
1045                 if (for_input) {
1046                         port = route->input()->nth (io_index);
1047                 } else {
1048                         port = route->output()->nth (io_index);
1049                 }
1050
1051                 port_connections.clear ();
1052                 port->get_connections(port_connections);
1053                 io_connection_count = 0;
1054
1055                 if (!port_connections.empty()) {
1056                         for (vector<string>::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1057                                 string& connection_name (*i);
1058
1059                                 if (io_connection_count == 0) {
1060                                         tooltip << endl << port->name().substr(port->name().find("/") + 1) << " -> " << connection_name;
1061                                 } else {
1062                                         tooltip << ", " << connection_name;
1063                                 }
1064
1065                                 if (connection_name.find("ardour:") == 0) {
1066                                         if (ardour_track_name.empty()) {
1067                                                 // "ardour:Master/in 1" -> "ardour:Master/"
1068                                                 string::size_type slash = connection_name.find("/");
1069                                                 if (slash != string::npos) {
1070                                                         ardour_track_name = connection_name.substr(0, slash + 1);
1071                                                 }
1072                                         }
1073
1074                                         if (connection_name.find(ardour_track_name) == 0) {
1075                                                 ++ardour_connection_count;
1076                                         }
1077                                 } else if (connection_name.find("system:") == 0) {
1078                                         if (for_input) {
1079                                                 // "system:capture_123" -> "123"
1080                                                 system_port = connection_name.substr(15);
1081                                         } else {
1082                                                 // "system:playback_123" -> "123"
1083                                                 system_port = connection_name.substr(16);
1084                                         }
1085
1086                                         if (system_ports.empty()) {
1087                                                 system_ports += system_port;
1088                                         } else {
1089                                                 system_ports += "/" + system_port;
1090                                         }
1091
1092                                         ++system_connection_count;
1093                                 } else {
1094                                         if (other_connection_type.empty()) {
1095                                                 // "jamin:in 1" -> "jamin:"
1096                                                 other_connection_type = connection_name.substr(0, connection_name.find(":") + 1);
1097                                         }
1098
1099                                         if (connection_name.find(other_connection_type) == 0) {
1100                                                 ++other_connection_count;
1101                                         }
1102                                 }
1103
1104                                 ++total_connection_count;
1105                                 ++io_connection_count;
1106                         }
1107                 }
1108
1109                 if (io_connection_count != 1) {
1110                         each_io_has_one_connection = false;
1111                 }
1112         }
1113
1114         if (total_connection_count == 0) {
1115                 tooltip << endl << _("Disconnected");
1116         }
1117
1118         tooltip_cstr = new char[tooltip.str().size() + 1];
1119         strcpy(tooltip_cstr, tooltip.str().c_str());
1120
1121         if (for_input) {
1122                 ARDOUR_UI::instance()->set_tip (&input_button, tooltip_cstr, "");
1123         } else {
1124                 ARDOUR_UI::instance()->set_tip (&output_button, tooltip_cstr, "");
1125         }
1126
1127         if (each_io_has_one_connection) {
1128                 if ((total_connection_count == ardour_connection_count)) {
1129                         // all connections are to the same track in ardour
1130                         // "ardour:Master/" -> "Master"
1131                         string::size_type slash = ardour_track_name.find("/");
1132                         if (slash != string::npos) {
1133                                 label << ardour_track_name.substr(7, slash - 7);
1134                                 have_label = true;
1135                         }
1136                 }
1137                 else if (total_connection_count == system_connection_count) {
1138                         // all connections are to system ports
1139                         label << system_ports;
1140                         have_label = true;
1141                 }
1142                 else if (total_connection_count == other_connection_count) {
1143                         // all connections are to the same external program eg jamin
1144                         // "jamin:" -> "jamin"
1145                         label << other_connection_type.substr(0, other_connection_type.size() - 1);
1146                         have_label = true;
1147                 }
1148         }
1149
1150         if (!have_label) {
1151                 if (total_connection_count == 0) {
1152                         // Disconnected
1153                         label << "-";
1154                 } else {
1155                         // Odd configuration
1156                         label << "*" << total_connection_count << "*";
1157                 }
1158         }
1159
1160         switch (width) {
1161         case Wide:
1162                 label_string = label.str().substr(0, 6);
1163                 break;
1164         case Narrow:
1165                 label_string = label.str().substr(0, 3);
1166                 break;
1167         }
1168
1169         if (for_input) {
1170                 input_label.set_text (label_string);
1171         } else {
1172                 output_label.set_text (label_string);
1173         }
1174 }
1175
1176 void
1177 MixerStrip::update_input_display ()
1178 {
1179         update_io_button (_route, _width, true);
1180         panners.setup_pan ();
1181 }
1182
1183 void
1184 MixerStrip::update_output_display ()
1185 {
1186         update_io_button (_route, _width, false);
1187         gpm.setup_meters ();
1188         panners.setup_pan ();
1189 }
1190
1191 void
1192 MixerStrip::fast_update ()
1193 {
1194         gpm.update_meters ();
1195 }
1196
1197 void
1198 MixerStrip::diskstream_changed ()
1199 {
1200         Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&MixerStrip::update_diskstream_display, this));
1201 }
1202
1203 void
1204 MixerStrip::port_connected_or_disconnected (boost::weak_ptr<Port> wa, boost::weak_ptr<Port> wb)
1205 {
1206         boost::shared_ptr<Port> a = wa.lock ();
1207         boost::shared_ptr<Port> b = wb.lock ();
1208
1209         if ((a && _route->input()->has_port (a)) || (b && _route->input()->has_port (b))) {
1210                 update_input_display ();
1211                 set_width_enum (_width, this);
1212         }
1213
1214         if ((a && _route->output()->has_port (a)) || (b && _route->output()->has_port (b))) {
1215                 update_output_display ();
1216                 set_width_enum (_width, this);
1217         }
1218 }
1219
1220 void
1221 MixerStrip::setup_comment_button ()
1222 {
1223         switch (_width) {
1224
1225         case Wide:
1226                 if (_route->comment().empty ()) {
1227                         _comment_button.unset_bg (STATE_NORMAL);
1228                         ((Gtk::Label *) _comment_button.get_child ())->set_text (_("Comments"));
1229                 } else {
1230                         _comment_button.modify_bg (STATE_NORMAL, color ());
1231                         ((Gtk::Label *) _comment_button.get_child ())->set_text (_("*Comments*"));
1232                 }
1233                 break;
1234
1235         case Narrow:
1236                 if (_route->comment().empty ()) {
1237                         _comment_button.unset_bg (STATE_NORMAL);
1238                         ((Gtk::Label *) _comment_button.get_child ())->set_text (_("Cmt"));
1239                 } else {
1240                         _comment_button.modify_bg (STATE_NORMAL, color ());
1241                         ((Gtk::Label *) _comment_button.get_child ())->set_text (_("*Cmt*"));
1242                 }
1243                 break;
1244         }
1245
1246         ARDOUR_UI::instance()->set_tip (
1247                 _comment_button, _route->comment().empty() ? _("Click to Add/Edit Comments") : _route->comment()
1248                 );
1249 }
1250
1251 void
1252 MixerStrip::comment_editor_done_editing ()
1253 {
1254         string const str = comment_area->get_buffer()->get_text();
1255         if (str == _route->comment ()) {
1256                 return;
1257         }
1258
1259         _route->set_comment (str, this);
1260         setup_comment_button ();
1261 }
1262
1263 void
1264 MixerStrip::toggle_comment ()
1265 {
1266         if (ignore_toggle) {
1267                 return;
1268         }
1269
1270         if (comment_window == 0) {
1271                 setup_comment_editor ();
1272         }
1273
1274         if (comment_window->is_visible ()) {
1275                 comment_window->hide ();
1276                 return;
1277         }
1278
1279         string title;
1280         title = _route->name();
1281         title += _(": comment editor");
1282
1283         comment_window->set_title (title);
1284         comment_window->present();
1285 }
1286
1287 void
1288 MixerStrip::setup_comment_editor ()
1289 {
1290         comment_window = new ArdourDialog ("", false); // title will be reset to show route
1291         comment_window->set_position (Gtk::WIN_POS_MOUSE);
1292         comment_window->set_skip_taskbar_hint (true);
1293         comment_window->signal_hide().connect (sigc::mem_fun(*this, &MixerStrip::comment_editor_done_editing));
1294         comment_window->set_default_size (400, 200);
1295
1296         comment_area = manage (new TextView());
1297         comment_area->set_name ("MixerTrackCommentArea");
1298         comment_area->set_wrap_mode (WRAP_WORD);
1299         comment_area->set_editable (true);
1300         comment_area->get_buffer()->set_text (_route->comment());
1301         comment_area->show ();
1302
1303         comment_window->get_vbox()->pack_start (*comment_area);
1304         comment_window->get_action_area()->hide();
1305 }
1306
1307 void
1308 MixerStrip::comment_changed (void *src)
1309 {
1310         ENSURE_GUI_THREAD (*this, &MixerStrip::comment_changed, src)
1311
1312         if (src != this) {
1313                 ignore_comment_edit = true;
1314                 if (comment_area) {
1315                         comment_area->get_buffer()->set_text (_route->comment());
1316                 }
1317                 ignore_comment_edit = false;
1318         }
1319 }
1320
1321 bool
1322 MixerStrip::select_route_group (GdkEventButton *ev)
1323 {
1324         using namespace Menu_Helpers;
1325
1326         if (ev->button == 1) {
1327
1328                 if (group_menu == 0) {
1329
1330                         PropertyList* plist = new PropertyList();
1331
1332                         plist->add (Properties::gain, true);
1333                         plist->add (Properties::mute, true);
1334                         plist->add (Properties::solo, true);
1335
1336                         group_menu = new RouteGroupMenu (_session, plist);
1337                 }
1338
1339                 WeakRouteList r;
1340                 r.push_back (route ());
1341                 group_menu->build (r);
1342                 group_menu->menu()->popup (1, ev->time);
1343         }
1344
1345         return true;
1346 }
1347
1348 void
1349 MixerStrip::route_group_changed ()
1350 {
1351         ENSURE_GUI_THREAD (*this, &MixerStrip::route_group_changed)
1352
1353         RouteGroup *rg = _route->route_group();
1354
1355         if (rg) {
1356                 group_label.set_text (PBD::short_version (rg->name(), 5));
1357         } else {
1358                 switch (_width) {
1359                 case Wide:
1360                         group_label.set_text (_("Grp"));
1361                         break;
1362                 case Narrow:
1363                         group_label.set_text (_("~G"));
1364                         break;
1365                 }
1366         }
1367 }
1368
1369 void
1370 MixerStrip::route_color_changed ()
1371 {
1372         name_button.modify_bg (STATE_NORMAL, color());
1373         top_event_box.modify_bg (STATE_NORMAL, color());
1374         reset_strip_style ();
1375 }
1376
1377 void
1378 MixerStrip::show_passthru_color ()
1379 {
1380         reset_strip_style ();
1381 }
1382
1383 void
1384 MixerStrip::build_route_ops_menu ()
1385 {
1386         using namespace Menu_Helpers;
1387         route_ops_menu = new Menu;
1388         route_ops_menu->set_name ("ArdourContextMenu");
1389
1390         MenuList& items = route_ops_menu->items();
1391
1392         items.push_back (CheckMenuElem (_("Comments..."), sigc::mem_fun (*this, &MixerStrip::toggle_comment)));
1393         CheckMenuItem* i = dynamic_cast<CheckMenuItem*> (&items.back ());
1394         i->set_active (comment_window && comment_window->is_visible ());
1395         items.push_back (MenuElem (_("Save As Template..."), sigc::mem_fun(*this, &RouteUI::save_as_template)));
1396         items.push_back (MenuElem (_("Rename..."), sigc::mem_fun(*this, &RouteUI::route_rename)));
1397         rename_menu_item = &items.back();
1398
1399         items.push_back (SeparatorElem());
1400         items.push_back (CheckMenuElem (_("Active")));
1401         i = dynamic_cast<CheckMenuItem *> (&items.back());
1402         i->set_active (_route->active());
1403         i->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &RouteUI::set_route_active), !_route->active(), false));
1404
1405         items.push_back (SeparatorElem());
1406
1407         items.push_back (MenuElem (_("Adjust Latency..."), sigc::mem_fun (*this, &RouteUI::adjust_latency)));
1408
1409         items.push_back (SeparatorElem());
1410         items.push_back (CheckMenuElem (_("Protect Against Denormals"), sigc::mem_fun (*this, &RouteUI::toggle_denormal_protection)));
1411         denormal_menu_item = dynamic_cast<CheckMenuItem *> (&items.back());
1412         denormal_menu_item->set_active (_route->denormal_protection());
1413
1414         if (!Profile->get_sae()) {
1415                 items.push_back (SeparatorElem());
1416                 items.push_back (MenuElem (_("Remote Control ID..."), sigc::mem_fun (*this, &RouteUI::open_remote_control_id_dialog)));
1417         }
1418
1419         items.push_back (SeparatorElem());
1420         items.push_back (MenuElem (_("Remove"), sigc::bind (sigc::mem_fun(*this, &RouteUI::remove_this_route), false)));
1421 }
1422
1423 gboolean
1424 MixerStrip::name_button_button_press (GdkEventButton* ev)
1425 {
1426         if (ev->button == 3) {
1427                 list_route_operations ();
1428
1429                 /* do not allow rename if the track is record-enabled */
1430                 rename_menu_item->set_sensitive (!_route->record_enabled());
1431                 route_ops_menu->popup (1, ev->time);
1432
1433         } else if (ev->button == 1) {
1434                 revert_to_default_display ();
1435         }
1436
1437         return false;
1438 }
1439
1440 void
1441 MixerStrip::list_route_operations ()
1442 {
1443         delete route_ops_menu;
1444         build_route_ops_menu ();
1445 }
1446
1447 void
1448 MixerStrip::set_selected (bool yn)
1449 {
1450         AxisView::set_selected (yn);
1451         if (_selected) {
1452                 global_frame.set_shadow_type (Gtk::SHADOW_ETCHED_OUT);
1453                 global_frame.set_name ("MixerStripSelectedFrame");
1454         } else {
1455                 global_frame.set_shadow_type (Gtk::SHADOW_IN);
1456                 global_frame.set_name ("MixerStripFrame");
1457         }
1458         global_frame.queue_draw ();
1459 }
1460
1461 void
1462 MixerStrip::name_changed ()
1463 {
1464         switch (_width) {
1465         case Wide:
1466                 RouteUI::property_changed (PropertyChange (ARDOUR::Properties::name));
1467                 break;
1468         case Narrow:
1469                 name_label.set_text (PBD::short_version (_route->name(), 5));
1470                 break;
1471         }
1472 }
1473
1474 void
1475 MixerStrip::width_clicked ()
1476 {
1477         switch (_width) {
1478         case Wide:
1479                 set_width_enum (Narrow, this);
1480                 break;
1481         case Narrow:
1482                 set_width_enum (Wide, this);
1483                 break;
1484         }
1485 }
1486
1487 void
1488 MixerStrip::hide_clicked ()
1489 {
1490         // LAME fix to reset the button status for when it is redisplayed (part 1)
1491         hide_button.set_sensitive(false);
1492
1493         if (_embedded) {
1494                 Hiding(); /* EMIT_SIGNAL */
1495         } else {
1496                 _mixer.hide_strip (this);
1497         }
1498
1499         // (part 2)
1500         hide_button.set_sensitive(true);
1501 }
1502
1503 void
1504 MixerStrip::set_embedded (bool yn)
1505 {
1506         _embedded = yn;
1507 }
1508
1509 void
1510 MixerStrip::map_frozen ()
1511 {
1512         ENSURE_GUI_THREAD (*this, &MixerStrip::map_frozen)
1513
1514         boost::shared_ptr<AudioTrack> at = audio_track();
1515
1516         if (at) {
1517                 switch (at->freeze_state()) {
1518                 case AudioTrack::Frozen:
1519                         processor_box.set_sensitive (false);
1520                         hide_redirect_editors ();
1521                         break;
1522                 default:
1523                         processor_box.set_sensitive (true);
1524                         // XXX need some way, maybe, to retoggle redirect editors
1525                         break;
1526                 }
1527         }
1528 }
1529
1530 void
1531 MixerStrip::hide_redirect_editors ()
1532 {
1533         _route->foreach_processor (sigc::mem_fun (*this, &MixerStrip::hide_processor_editor));
1534 }
1535
1536 void
1537 MixerStrip::hide_processor_editor (boost::weak_ptr<Processor> p)
1538 {
1539         boost::shared_ptr<Processor> processor (p.lock ());
1540         if (!processor) {
1541                 return;
1542         }
1543
1544         Gtk::Window* w = processor_box.get_processor_ui (processor);
1545
1546         if (w) {
1547                 w->hide ();
1548         }
1549 }
1550
1551 void
1552 MixerStrip::reset_strip_style ()
1553 {
1554         if (_current_delivery && boost::dynamic_pointer_cast<Send>(_current_delivery)) {
1555
1556                 gpm.set_fader_name ("SendStripBase");
1557
1558         } else {
1559
1560                 if (is_midi_track()) {
1561                         if (_route->active()) {
1562                                 set_name ("MidiTrackStripBase");
1563                                 gpm.set_meter_strip_name ("MidiTrackMetrics");
1564                         } else {
1565                                 set_name ("MidiTrackStripBaseInactive");
1566                                 gpm.set_meter_strip_name ("MidiTrackMetricsInactive");
1567                         }
1568                         gpm.set_fader_name ("MidiTrackFader");
1569                 } else if (is_audio_track()) {
1570                         if (_route->active()) {
1571                                 set_name ("AudioTrackStripBase");
1572                                 gpm.set_meter_strip_name ("AudioTrackMetrics");
1573                         } else {
1574                                 set_name ("AudioTrackStripBaseInactive");
1575                                 gpm.set_meter_strip_name ("AudioTrackMetricsInactive");
1576                         }
1577                         gpm.set_fader_name ("AudioTrackFader");
1578                 } else {
1579                         if (_route->active()) {
1580                                 set_name ("AudioBusStripBase");
1581                                 gpm.set_meter_strip_name ("AudioBusMetrics");
1582                         } else {
1583                                 set_name ("AudioBusStripBaseInactive");
1584                                 gpm.set_meter_strip_name ("AudioBusMetricsInactive");
1585                         }
1586                         gpm.set_fader_name ("AudioBusFader");
1587
1588                         /* (no MIDI busses yet) */
1589                 }
1590         }
1591 }
1592
1593 RouteGroup*
1594 MixerStrip::route_group() const
1595 {
1596         return _route->route_group();
1597 }
1598
1599 void
1600 MixerStrip::engine_stopped ()
1601 {
1602 }
1603
1604 void
1605 MixerStrip::engine_running ()
1606 {
1607 }
1608
1609 string
1610 MixerStrip::meter_point_string (MeterPoint mp)
1611 {
1612         switch (mp) {
1613         case MeterInput:
1614                 return _("in");
1615                 break;
1616
1617         case MeterPreFader:
1618                 return _("pre");
1619                 break;
1620
1621         case MeterPostFader:
1622                 return _("post");
1623                 break;
1624
1625         case MeterOutput:
1626                 return _("out");
1627                 break;
1628
1629         case MeterCustom:
1630         default:
1631                 return _("custom");
1632                 break;
1633         }
1634 }
1635
1636 /** Called when the metering point has changed */
1637 void
1638 MixerStrip::meter_changed ()
1639 {
1640         meter_point_label.set_text (meter_point_string (_route->meter_point()));
1641         gpm.setup_meters ();
1642         // reset peak when meter point changes
1643         gpm.reset_peak_display();
1644 }
1645
1646 /** The bus that we are displaying sends to has changed, or been turned off.
1647  *  @param send_to New bus that we are displaying sends to, or 0.
1648  */
1649 void
1650 MixerStrip::bus_send_display_changed (boost::shared_ptr<Route> send_to)
1651 {
1652         RouteUI::bus_send_display_changed (send_to);
1653
1654         if (send_to) {
1655                 boost::shared_ptr<Send> send = _route->internal_send_for (send_to);
1656                 if (send) {
1657                         show_send (send);
1658                 } else {
1659                         revert_to_default_display ();
1660                 }
1661         } else {
1662                 revert_to_default_display ();
1663         }
1664 }
1665
1666 void
1667 MixerStrip::drop_send ()
1668 {
1669         boost::shared_ptr<Send> current_send;
1670
1671         if (_current_delivery && (current_send = boost::dynamic_pointer_cast<Send>(_current_delivery))) {
1672                 current_send->set_metering (false);
1673         }
1674
1675         send_gone_connection.disconnect ();
1676         input_button.set_sensitive (true);
1677         output_button.set_sensitive (true);
1678         group_button.set_sensitive (true);
1679         set_invert_sensitive (true);
1680         meter_point_button.set_sensitive (true);
1681         mute_button->set_sensitive (true);
1682         solo_button->set_sensitive (true);
1683         rec_enable_button->set_sensitive (true);
1684         solo_isolated_led->set_sensitive (true);
1685         solo_safe_led->set_sensitive (true);
1686         monitor_input_button->set_sensitive (true);
1687         monitor_disk_button->set_sensitive (true);
1688         _comment_button.set_sensitive (true);
1689 }
1690
1691 void
1692 MixerStrip::set_current_delivery (boost::shared_ptr<Delivery> d)
1693 {
1694         _current_delivery = d;
1695         DeliveryChanged (_current_delivery);
1696 }
1697
1698 void
1699 MixerStrip::show_send (boost::shared_ptr<Send> send)
1700 {
1701         assert (send != 0);
1702
1703         drop_send ();
1704
1705         set_current_delivery (send);
1706
1707         send->set_metering (true);
1708         _current_delivery->DropReferences.connect (send_gone_connection, invalidator (*this), boost::bind (&MixerStrip::revert_to_default_display, this), gui_context());
1709
1710         gain_meter().set_controls (_route, send->meter(), send->amp());
1711         gain_meter().setup_meters ();
1712
1713         panner_ui().set_panner (_current_delivery->panner_shell(), _current_delivery->panner());
1714         panner_ui().setup_pan ();
1715
1716         input_button.set_sensitive (false);
1717         group_button.set_sensitive (false);
1718         set_invert_sensitive (false);
1719         meter_point_button.set_sensitive (false);
1720         mute_button->set_sensitive (false);
1721         solo_button->set_sensitive (false);
1722         rec_enable_button->set_sensitive (false);
1723         solo_isolated_led->set_sensitive (false);
1724         solo_safe_led->set_sensitive (false);
1725         monitor_input_button->set_sensitive (false);
1726         monitor_disk_button->set_sensitive (false);
1727         _comment_button.set_sensitive (false);
1728
1729         if (boost::dynamic_pointer_cast<InternalSend>(send)) {
1730                 output_button.set_sensitive (false);
1731         }
1732
1733         reset_strip_style ();
1734 }
1735
1736 void
1737 MixerStrip::revert_to_default_display ()
1738 {
1739         drop_send ();
1740
1741         set_current_delivery (_route->main_outs ());
1742
1743         gain_meter().set_controls (_route, _route->shared_peak_meter(), _route->amp());
1744         gain_meter().setup_meters ();
1745
1746         panner_ui().set_panner (_route->main_outs()->panner_shell(), _route->main_outs()->panner());
1747         panner_ui().setup_pan ();
1748
1749         reset_strip_style ();
1750 }
1751
1752 void
1753 MixerStrip::set_button_names ()
1754 {
1755         switch (_width) {
1756         case Wide:
1757                 rec_enable_button->set_text (_("Rec"));
1758                 mute_button->set_text (_("Mute"));
1759                 monitor_input_button->set_text (_("In"));
1760                 monitor_disk_button->set_text (_("Disk"));
1761
1762                 if (_route && _route->solo_safe()) {
1763                         if (solo_safe_pixbuf == 0) {
1764                                 solo_safe_pixbuf = ::get_icon("solo-safe-icon");
1765                         }
1766                         solo_button->set_image (solo_safe_pixbuf);
1767                         solo_button->set_text (string());
1768                 } else {
1769                         solo_button->set_image (Glib::RefPtr<Gdk::Pixbuf>());
1770                         if (!Config->get_solo_control_is_listen_control()) {
1771                                 solo_button->set_text (_("Solo"));
1772                         } else {
1773                                 switch (Config->get_listen_position()) {
1774                                 case AfterFaderListen:
1775                                         solo_button->set_text (_("AFL"));
1776                                         break;
1777                                 case PreFaderListen:
1778                                         solo_button->set_text (_("PFL"));
1779                                         break;
1780                                 }
1781                         }
1782                 }
1783                 break;
1784
1785         default:
1786                 rec_enable_button->set_text (_("R"));
1787                 mute_button->set_text (_("M"));
1788                 monitor_input_button->set_text (_("I"));
1789                 monitor_disk_button->set_text (_("D"));
1790                 if (_route && _route->solo_safe()) {
1791                         solo_button->remove ();
1792                         if (solo_safe_pixbuf == 0) {
1793                                 solo_safe_pixbuf =::get_icon("solo-safe-icon");
1794                         }
1795                         solo_button->set_image (solo_safe_pixbuf);
1796                         solo_button->set_text (string());
1797                 } else {
1798                         solo_button->set_image (Glib::RefPtr<Gdk::Pixbuf>());
1799                         if (!Config->get_solo_control_is_listen_control()) {
1800                                 solo_button->set_text (_("S"));
1801                         } else {
1802                                 switch (Config->get_listen_position()) {
1803                                 case AfterFaderListen:
1804                                         solo_button->set_text (_("A"));
1805                                         break;
1806                                 case PreFaderListen:
1807                                         solo_button->set_text (_("P"));
1808                                         break;
1809                                 }
1810                         }
1811                 }
1812                 break;
1813
1814         }
1815 }
1816
1817 bool
1818 MixerStrip::on_key_press_event (GdkEventKey* ev)
1819 {
1820         GdkEventButton fake;
1821         fake.type = GDK_BUTTON_PRESS;
1822         fake.button = 1;
1823         fake.state = ev->state;
1824
1825         switch (ev->keyval) {
1826         case GDK_m:
1827                 mute_press (&fake);
1828                 return true;
1829                 break;
1830
1831         case GDK_s:
1832                 solo_press (&fake);
1833                 return true;
1834                 break;
1835
1836         case GDK_r:
1837                 rec_enable_press (&fake);
1838                 return true;
1839                 break;
1840
1841         case GDK_e:
1842                 show_sends_press (&fake);
1843                 return true;
1844                 break;
1845
1846         case GDK_g:
1847                 if (ev->state & Keyboard::PrimaryModifier) {
1848                         step_gain_down ();
1849                 } else {
1850                         step_gain_up ();
1851                 }
1852                 return true;
1853                 break;
1854
1855         case GDK_0:
1856                 if (_route) {
1857                         _route->set_gain (1.0, this);
1858                 }
1859                 return true;
1860
1861         default:
1862                 break;
1863         }
1864
1865         return false;
1866 }
1867
1868
1869 bool
1870 MixerStrip::on_key_release_event (GdkEventKey* ev)
1871 {
1872         GdkEventButton fake;
1873         fake.type = GDK_BUTTON_RELEASE;
1874         fake.button = 1;
1875         fake.state = ev->state;
1876
1877         switch (ev->keyval) {
1878         case GDK_m:
1879                 mute_release (&fake);
1880                 return true;
1881                 break;
1882
1883         case GDK_s:
1884                 solo_release (&fake);
1885                 return true;
1886                 break;
1887
1888         case GDK_r:
1889                 rec_enable_release (&fake);
1890                 return true;
1891                 break;
1892
1893         case GDK_e:
1894                 show_sends_release (&fake);
1895                 return true;
1896                 break;
1897
1898         case GDK_g:
1899                 return true;
1900                 break;
1901
1902         default:
1903                 break;
1904         }
1905
1906         return false;
1907 }
1908
1909 bool
1910 MixerStrip::on_enter_notify_event (GdkEventCrossing*)
1911 {
1912         Keyboard::magic_widget_grab_focus ();
1913         return false;
1914 }
1915
1916 bool
1917 MixerStrip::on_leave_notify_event (GdkEventCrossing* ev)
1918 {
1919         switch (ev->detail) {
1920         case GDK_NOTIFY_INFERIOR:
1921                 break;
1922         default:
1923                 Keyboard::magic_widget_drop_focus ();
1924         }
1925
1926         return false;
1927 }
1928
1929 PluginSelector*
1930 MixerStrip::plugin_selector()
1931 {
1932         return _mixer.plugin_selector();
1933 }
1934
1935 void
1936 MixerStrip::hide_things ()
1937 {
1938         processor_box.hide_things ();
1939 }
1940
1941 bool
1942 MixerStrip::input_active_button_press (GdkEventButton*)
1943 {
1944         /* nothing happens on press */
1945         return true;
1946 }
1947
1948 bool
1949 MixerStrip::input_active_button_release (GdkEventButton* ev)
1950 {
1951         boost::shared_ptr<MidiTrack> mt = midi_track ();
1952
1953         if (!mt) {
1954                 return true;
1955         }
1956
1957         if (mt->input_active()) {
1958                 if (Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::SecondaryModifier))) {
1959                         /* turn all other tracks using this input off */
1960                         _session->set_exclusive_input_active (mt, false);
1961                 } else {
1962                         mt->set_input_active (false);
1963                 }
1964
1965         } else {
1966                 if (Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::SecondaryModifier))) {
1967                         /* turn all other tracks using this input on */
1968                         _session->set_exclusive_input_active (mt, true);
1969                 } else {
1970                         mt->set_input_active (true);
1971                 }
1972         }
1973
1974         return true;
1975 }
1976
1977 void
1978 MixerStrip::midi_input_status_changed ()
1979 {
1980         if (midi_input_enable_button) {
1981                 boost::shared_ptr<MidiTrack> mt = midi_track ();
1982                 assert (mt);
1983                 midi_input_enable_button->set_active (mt->input_active ());
1984         }
1985 }
1986
1987 string
1988 MixerStrip::state_id () const
1989 {
1990         return string_compose ("strip %1", _route->id().to_s());
1991 }
1992
1993 void
1994 MixerStrip::parameter_changed (string p)
1995 {
1996         if (p == _visibility.get_state_name()) {
1997                 /* The user has made changes to the mixer strip visibility, so get
1998                    our VisibilityGroup to reflect these changes in our widgets.
1999                 */
2000                 _visibility.set_state (Config->get_mixer_strip_visibility ());
2001         }
2002 }
2003
2004 /** Called to decide whether the solo isolate / solo lock button visibility should
2005  *  be overridden from that configured by the user.  We do this for the master bus.
2006  *
2007  *  @return optional value that is present if visibility state should be overridden.
2008  */
2009 boost::optional<bool>
2010 MixerStrip::override_solo_visibility () const
2011 {
2012         if (_route && _route->is_master ()) {
2013                 return boost::optional<bool> (false);
2014         }
2015         
2016         return boost::optional<bool> ();
2017 }