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