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