avoid crash caused by referencing non-existent route in mixer strip button name setting
[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, _("Click to 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, longest_label.c_str(), 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 (_("iso"));
636                 solo_safe_led->set_text (_("Lck"));
637
638                 Gtkmm2ext::set_size_request_to_display_given_text (name_button, "long", 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         output_selector->set_keep_above (true);
777 }
778
779 void
780 MixerStrip::edit_input_configuration ()
781 {
782         if (input_selector == 0) {
783                 input_selector = new IOSelectorWindow (_session, _route->input());
784         }
785
786         if (input_selector->is_visible()) {
787                 input_selector->get_toplevel()->get_window()->raise();
788         } else {
789                 input_selector->present ();
790         }
791
792         input_selector->set_keep_above (true);
793 }
794
795 gint
796 MixerStrip::input_press (GdkEventButton *ev)
797 {
798         using namespace Menu_Helpers;
799
800         MenuList& citems = input_menu.items();
801         input_menu.set_name ("ArdourContextMenu");
802         citems.clear();
803
804         if (!_session->engine().connected()) {
805                 MessageDialog msg (_("Not connected to JACK - no I/O changes are possible"));
806                 msg.run ();
807                 return true;
808         }
809
810         if (_session->actively_recording() && _route->record_enabled())
811                 return true;
812
813         switch (ev->button) {
814
815         case 1:
816                 edit_input_configuration ();
817                 break;
818
819         case 3:
820         {
821                 citems.push_back (MenuElem (_("Disconnect"), sigc::mem_fun (*(static_cast<RouteUI*>(this)), &RouteUI::disconnect_input)));
822
823                 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
824                         citems.push_back (
825                                 MenuElem (
826                                         string_compose ("Add %1 port", (*i).to_i18n_string()),
827                                         sigc::bind (sigc::mem_fun (*this, &MixerStrip::add_input_port), *i)
828                                         )
829                                 );
830                 }
831
832                 citems.push_back (SeparatorElem());
833                 uint32_t const n_with_separator = citems.size ();
834                 
835                 input_menu_bundles.clear ();
836
837                 ARDOUR::BundleList current = _route->input()->bundles_connected ();
838
839                 boost::shared_ptr<ARDOUR::BundleList> b = _session->bundles ();
840
841                 /* give user bundles first chance at being in the menu */
842
843                 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
844                         if (boost::dynamic_pointer_cast<UserBundle> (*i)) {
845                                 maybe_add_bundle_to_input_menu (*i, current);
846                         }
847                 }
848
849                 for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
850                         if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0) {
851                                 maybe_add_bundle_to_input_menu (*i, current);
852                         }
853                 }
854
855                 boost::shared_ptr<ARDOUR::RouteList> routes = _session->get_routes ();
856                 RouteList copy = *routes;
857                 copy.sort (RouteCompareByName ());
858                 for (ARDOUR::RouteList::const_iterator i = copy.begin(); i != copy.end(); ++i) {
859                         maybe_add_bundle_to_input_menu ((*i)->output()->bundle(), current);
860                 }
861
862                 if (citems.size() == n_with_separator) {
863                         /* no routes added; remove the separator */
864                         citems.pop_back ();
865                 }
866
867                 input_menu.popup (1, ev->time);
868                 break;
869         }
870         default:
871                 break;
872         }
873         return TRUE;
874 }
875
876 void
877 MixerStrip::bundle_input_chosen (boost::shared_ptr<ARDOUR::Bundle> c)
878 {
879         if (ignore_toggle) {
880                 return;
881         }
882
883         ARDOUR::BundleList current = _route->input()->bundles_connected ();
884
885         if (std::find (current.begin(), current.end(), c) == current.end()) {
886                 _route->input()->connect_ports_to_bundle (c, true, this);
887         } else {
888                 _route->input()->disconnect_ports_from_bundle (c, this);
889         }
890 }
891
892 void
893 MixerStrip::bundle_output_chosen (boost::shared_ptr<ARDOUR::Bundle> c)
894 {
895         if (ignore_toggle) {
896                 return;
897         }
898
899         ARDOUR::BundleList current = _route->output()->bundles_connected ();
900
901         if (std::find (current.begin(), current.end(), c) == current.end()) {
902                 _route->output()->connect_ports_to_bundle (c, true, this);
903         } else {
904                 _route->output()->disconnect_ports_from_bundle (c, this);
905         }
906 }
907
908 void
909 MixerStrip::maybe_add_bundle_to_input_menu (boost::shared_ptr<Bundle> b, ARDOUR::BundleList const & current)
910 {
911         using namespace Menu_Helpers;
912
913         if (b->ports_are_outputs() == false || b->nchannels() != _route->n_inputs() || *b == *_route->output()->bundle()) {
914                 return;
915         }
916
917         list<boost::shared_ptr<Bundle> >::iterator i = input_menu_bundles.begin ();
918         while (i != input_menu_bundles.end() && b->has_same_ports (*i) == false) {
919                 ++i;
920         }
921
922         if (i != input_menu_bundles.end()) {
923                 return;
924         }
925
926         input_menu_bundles.push_back (b);
927
928         MenuList& citems = input_menu.items();
929
930         std::string n = b->name ();
931         replace_all (n, "_", " ");
932
933         citems.push_back (MenuElem (n, sigc::bind (sigc::mem_fun(*this, &MixerStrip::bundle_input_chosen), b)));
934 }
935
936 void
937 MixerStrip::maybe_add_bundle_to_output_menu (boost::shared_ptr<Bundle> b, ARDOUR::BundleList const & current)
938 {
939         using namespace Menu_Helpers;
940
941         if (b->ports_are_inputs() == false || b->nchannels() != _route->n_outputs() || *b == *_route->input()->bundle()) {
942                 return;
943         }
944
945         list<boost::shared_ptr<Bundle> >::iterator i = output_menu_bundles.begin ();
946         while (i != output_menu_bundles.end() && b->has_same_ports (*i) == false) {
947                 ++i;
948         }
949
950         if (i != output_menu_bundles.end()) {
951                 return;
952         }
953
954         output_menu_bundles.push_back (b);
955
956         MenuList& citems = output_menu.items();
957
958         std::string n = b->name ();
959         replace_all (n, "_", " ");
960
961         citems.push_back (MenuElem (n, sigc::bind (sigc::mem_fun(*this, &MixerStrip::bundle_output_chosen), b)));
962 }
963
964 void
965 MixerStrip::update_diskstream_display ()
966 {
967         if (is_track()) {
968
969                 if (input_selector) {
970                         input_selector->hide_all ();
971                 }
972
973                 route_color_changed ();
974
975         } else {
976
977                 show_passthru_color ();
978         }
979 }
980
981 void
982 MixerStrip::connect_to_pan ()
983 {
984         ENSURE_GUI_THREAD (*this, &MixerStrip::connect_to_pan)
985
986         panstate_connection.disconnect ();
987         panstyle_connection.disconnect ();
988
989         if (!_route->panner()) {
990                 return;
991         }
992
993         boost::shared_ptr<Pannable> p = _route->pannable ();
994
995         p->automation_state_changed.connect (panstate_connection, invalidator (*this), boost::bind (&PannerUI::pan_automation_state_changed, &panners), gui_context());
996         p->automation_style_changed.connect (panstyle_connection, invalidator (*this), boost::bind (&PannerUI::pan_automation_style_changed, &panners), gui_context());
997
998         panners.panshell_changed ();
999 }
1000
1001
1002 /*
1003  * Output port labelling
1004  * =====================
1005  *
1006  * Case 1: Each output has one connection, all connections are to system:playback_%i
1007  *   out 1 -> system:playback_1
1008  *   out 2 -> system:playback_2
1009  *   out 3 -> system:playback_3
1010  *   Display as: 1/2/3
1011  *
1012  * Case 2: Each output has one connection, all connections are to ardour:track_x/in 1
1013  *   out 1 -> ardour:track_x/in 1
1014  *   out 2 -> ardour:track_x/in 2
1015  *   Display as: track_x
1016  *
1017  * Case 3: Each output has one connection, all connections are to Jack client "program x"
1018  *   out 1 -> program x:foo
1019  *   out 2 -> program x:foo
1020  *   Display as: program x
1021  *
1022  * Case 4: No connections (Disconnected)
1023  *   Display as: -
1024  *
1025  * Default case (unusual routing):
1026  *   Display as: *number of connections*
1027  *
1028  * Tooltips
1029  * ========
1030  * .-----------------------------------------------.
1031  * | Mixdown                                       |
1032  * | out 1 -> ardour:master/in 1, jamin:input/in 1 |
1033  * | out 2 -> ardour:master/in 2, jamin:input/in 2 |
1034  * '-----------------------------------------------'
1035  * .-----------------------------------------------.
1036  * | Guitar SM58                                   |
1037  * | Disconnected                                  |
1038  * '-----------------------------------------------'
1039  */
1040
1041 void
1042 MixerStrip::update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width width, bool for_input)
1043 {
1044         uint32_t io_count;
1045         uint32_t io_index;
1046         boost::shared_ptr<Port> port;
1047         vector<string> port_connections;
1048
1049         uint32_t total_connection_count = 0;
1050         uint32_t io_connection_count = 0;
1051         uint32_t ardour_connection_count = 0;
1052         uint32_t system_connection_count = 0;
1053         uint32_t other_connection_count = 0;
1054
1055         ostringstream label;
1056         string label_string;
1057
1058         bool have_label = false;
1059         bool each_io_has_one_connection = true;
1060
1061         string connection_name;
1062         string ardour_track_name;
1063         string other_connection_type;
1064         string system_ports;
1065         string system_port;
1066
1067         ostringstream tooltip;
1068         char * tooltip_cstr;
1069
1070         if (for_input) {
1071                 io_count = route->n_inputs().n_total();
1072                 tooltip << string_compose (_("<b>INPUT</b> to %1"), Glib::Markup::escape_text(route->name()));
1073         } else {
1074                 io_count = route->n_outputs().n_total();
1075                 tooltip << string_compose (_("<b>OUTPUT</b> from %1"), Glib::Markup::escape_text(route->name()));
1076         }
1077
1078
1079         for (io_index = 0; io_index < io_count; ++io_index) {
1080                 if (for_input) {
1081                         port = route->input()->nth (io_index);
1082                 } else {
1083                         port = route->output()->nth (io_index);
1084                 }
1085
1086                 port_connections.clear ();
1087                 port->get_connections(port_connections);
1088                 io_connection_count = 0;
1089
1090                 if (!port_connections.empty()) {
1091                         for (vector<string>::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1092                                 string& connection_name (*i);
1093
1094                                 if (io_connection_count == 0) {
1095                                         tooltip << endl << Glib::Markup::escape_text(port->name().substr(port->name().find("/") + 1)) << " -> " << Glib::Markup::escape_text(connection_name);
1096                                 } else {
1097                                         tooltip << ", " << Glib::Markup::escape_text(connection_name);
1098                                 }
1099
1100                                 if (connection_name.find("ardour:") == 0) {
1101                                         if (ardour_track_name.empty()) {
1102                                                 // "ardour:Master/in 1" -> "ardour:Master/"
1103                                                 string::size_type slash = connection_name.find("/");
1104                                                 if (slash != string::npos) {
1105                                                         ardour_track_name = connection_name.substr(0, slash + 1);
1106                                                 }
1107                                         }
1108
1109                                         if (connection_name.find(ardour_track_name) == 0) {
1110                                                 ++ardour_connection_count;
1111                                         }
1112                                 } else if (connection_name.find("system:") == 0) {
1113                                         if (for_input) {
1114                                                 // "system:capture_123" -> "123"
1115                                                 system_port = connection_name.substr(15);
1116                                         } else {
1117                                                 // "system:playback_123" -> "123"
1118                                                 system_port = connection_name.substr(16);
1119                                         }
1120
1121                                         if (system_ports.empty()) {
1122                                                 system_ports += system_port;
1123                                         } else {
1124                                                 system_ports += "/" + system_port;
1125                                         }
1126
1127                                         ++system_connection_count;
1128                                 } else {
1129                                         if (other_connection_type.empty()) {
1130                                                 // "jamin:in 1" -> "jamin:"
1131                                                 other_connection_type = connection_name.substr(0, connection_name.find(":") + 1);
1132                                         }
1133
1134                                         if (connection_name.find(other_connection_type) == 0) {
1135                                                 ++other_connection_count;
1136                                         }
1137                                 }
1138
1139                                 ++total_connection_count;
1140                                 ++io_connection_count;
1141                         }
1142                 }
1143
1144                 if (io_connection_count != 1) {
1145                         each_io_has_one_connection = false;
1146                 }
1147         }
1148
1149         if (total_connection_count == 0) {
1150                 tooltip << endl << _("Disconnected");
1151         }
1152
1153         tooltip_cstr = new char[tooltip.str().size() + 1];
1154         strcpy(tooltip_cstr, tooltip.str().c_str());
1155
1156         if (for_input) {
1157                 ARDOUR_UI::instance()->set_tip (&input_button, tooltip_cstr, "");
1158         } else {
1159                 ARDOUR_UI::instance()->set_tip (&output_button, tooltip_cstr, "");
1160         }
1161
1162         if (each_io_has_one_connection) {
1163                 if (total_connection_count == ardour_connection_count) {
1164                         // all connections are to the same track in ardour
1165                         // "ardour:Master/" -> "Master"
1166                         string::size_type slash = ardour_track_name.find("/");
1167                         if (slash != string::npos) {
1168                                 label << ardour_track_name.substr(7, slash - 7);
1169                                 have_label = true;
1170                         }
1171                 }
1172                 else if (total_connection_count == system_connection_count) {
1173                         // all connections are to system ports
1174                         label << system_ports;
1175                         have_label = true;
1176                 }
1177                 else if (total_connection_count == other_connection_count) {
1178                         // all connections are to the same external program eg jamin
1179                         // "jamin:" -> "jamin"
1180                         label << other_connection_type.substr(0, other_connection_type.size() - 1);
1181                         have_label = true;
1182                 }
1183         }
1184
1185         if (!have_label) {
1186                 if (total_connection_count == 0) {
1187                         // Disconnected
1188                         label << "-";
1189                 } else {
1190                         // Odd configuration
1191                         label << "*" << total_connection_count << "*";
1192                 }
1193         }
1194
1195         switch (width) {
1196         case Wide:
1197                 label_string = label.str().substr(0, 7);
1198                 break;
1199         case Narrow:
1200                 label_string = label.str().substr(0, 3);
1201                 break;
1202         }
1203
1204         if (for_input) {
1205                 input_button.set_text (label_string);
1206         } else {
1207                 output_button.set_text (label_string);
1208         }
1209 }
1210
1211 void
1212 MixerStrip::update_input_display ()
1213 {
1214         update_io_button (_route, _width, true);
1215         panners.setup_pan ();
1216 }
1217
1218 void
1219 MixerStrip::update_output_display ()
1220 {
1221         update_io_button (_route, _width, false);
1222         gpm.setup_meters ();
1223         panners.setup_pan ();
1224 }
1225
1226 void
1227 MixerStrip::fast_update ()
1228 {
1229         gpm.update_meters ();
1230 }
1231
1232 void
1233 MixerStrip::diskstream_changed ()
1234 {
1235         Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&MixerStrip::update_diskstream_display, this));
1236 }
1237
1238 void
1239 MixerStrip::port_connected_or_disconnected (boost::weak_ptr<Port> wa, boost::weak_ptr<Port> wb)
1240 {
1241         boost::shared_ptr<Port> a = wa.lock ();
1242         boost::shared_ptr<Port> b = wb.lock ();
1243
1244         if ((a && _route->input()->has_port (a)) || (b && _route->input()->has_port (b))) {
1245                 update_input_display ();
1246                 set_width_enum (_width, this);
1247         }
1248
1249         if ((a && _route->output()->has_port (a)) || (b && _route->output()->has_port (b))) {
1250                 update_output_display ();
1251                 set_width_enum (_width, this);
1252         }
1253 }
1254
1255 void
1256 MixerStrip::setup_comment_button ()
1257 {
1258         switch (_width) {
1259
1260         case Wide:
1261                 if (_route->comment().empty ()) {
1262                         _comment_button.unset_bg (STATE_NORMAL);
1263                         _comment_button.set_text (_("Comments"));
1264                 } else {
1265                         _comment_button.modify_bg (STATE_NORMAL, color ());
1266                         _comment_button.set_text (_("*Comments*"));
1267                 }
1268                 break;
1269
1270         case Narrow:
1271                 if (_route->comment().empty ()) {
1272                         _comment_button.unset_bg (STATE_NORMAL);
1273                         _comment_button.set_text (_("Cmt"));
1274                 } else {
1275                         _comment_button.modify_bg (STATE_NORMAL, color ());
1276                         _comment_button.set_text (_("*Cmt*"));
1277                 }
1278                 break;
1279         }
1280
1281         ARDOUR_UI::instance()->set_tip (
1282                 _comment_button, _route->comment().empty() ? _("Click to Add/Edit Comments") : _route->comment()
1283                 );
1284 }
1285
1286 void
1287 MixerStrip::comment_editor_done_editing ()
1288 {
1289         string const str = comment_area->get_buffer()->get_text();
1290         if (str == _route->comment ()) {
1291                 return;
1292         }
1293
1294         _route->set_comment (str, this);
1295         setup_comment_button ();
1296 }
1297
1298 void
1299 MixerStrip::toggle_comment_editor ()
1300 {
1301         if (ignore_toggle) {
1302                 return;
1303         }
1304
1305         if (comment_window && comment_window->is_visible ()) {
1306                 comment_window->hide ();
1307         } else {
1308                 open_comment_editor ();
1309         }
1310 }
1311
1312 void
1313 MixerStrip::open_comment_editor ()
1314 {
1315         if (comment_window == 0) {
1316                 setup_comment_editor ();
1317         }
1318
1319         string title;
1320         title = _route->name();
1321         title += _(": comment editor");
1322
1323         comment_window->set_title (title);
1324         comment_window->present();
1325 }
1326
1327 void
1328 MixerStrip::setup_comment_editor ()
1329 {
1330         comment_window = new ArdourWindow (""); // title will be reset to show route
1331         comment_window->set_position (Gtk::WIN_POS_MOUSE);
1332         comment_window->set_skip_taskbar_hint (true);
1333         comment_window->signal_hide().connect (sigc::mem_fun(*this, &MixerStrip::comment_editor_done_editing));
1334         comment_window->set_default_size (400, 200);
1335
1336         comment_area = manage (new TextView());
1337         comment_area->set_name ("MixerTrackCommentArea");
1338         comment_area->set_wrap_mode (WRAP_WORD);
1339         comment_area->set_editable (true);
1340         comment_area->get_buffer()->set_text (_route->comment());
1341         comment_area->show ();
1342
1343         comment_window->add (*comment_area);
1344 }
1345
1346 void
1347 MixerStrip::comment_changed (void *src)
1348 {
1349         ENSURE_GUI_THREAD (*this, &MixerStrip::comment_changed, src)
1350
1351         if (src != this) {
1352                 ignore_comment_edit = true;
1353                 if (comment_area) {
1354                         comment_area->get_buffer()->set_text (_route->comment());
1355                 }
1356                 ignore_comment_edit = false;
1357         }
1358 }
1359
1360 bool
1361 MixerStrip::select_route_group (GdkEventButton *ev)
1362 {
1363         using namespace Menu_Helpers;
1364
1365         if (ev->button == 1) {
1366
1367                 if (group_menu == 0) {
1368
1369                         PropertyList* plist = new PropertyList();
1370
1371                         plist->add (Properties::gain, true);
1372                         plist->add (Properties::mute, true);
1373                         plist->add (Properties::solo, true);
1374
1375                         group_menu = new RouteGroupMenu (_session, plist);
1376                 }
1377
1378                 WeakRouteList r;
1379                 r.push_back (route ());
1380                 group_menu->build (r);
1381                 group_menu->menu()->popup (1, ev->time);
1382         }
1383
1384         return true;
1385 }
1386
1387 void
1388 MixerStrip::route_group_changed ()
1389 {
1390         ENSURE_GUI_THREAD (*this, &MixerStrip::route_group_changed)
1391
1392         RouteGroup *rg = _route->route_group();
1393
1394         if (rg) {
1395                 group_button.set_text (PBD::short_version (rg->name(), 5));
1396         } else {
1397                 switch (_width) {
1398                 case Wide:
1399                         group_button.set_text (_("Grp"));
1400                         break;
1401                 case Narrow:
1402                         group_button.set_text (_("~G"));
1403                         break;
1404                 }
1405         }
1406 }
1407
1408 void
1409 MixerStrip::route_color_changed ()
1410 {
1411         name_button.modify_bg (STATE_NORMAL, color());
1412         top_event_box.modify_bg (STATE_NORMAL, color());
1413         reset_strip_style ();
1414 }
1415
1416 void
1417 MixerStrip::show_passthru_color ()
1418 {
1419         reset_strip_style ();
1420 }
1421
1422 void
1423 MixerStrip::build_route_ops_menu ()
1424 {
1425         using namespace Menu_Helpers;
1426         route_ops_menu = new Menu;
1427         route_ops_menu->set_name ("ArdourContextMenu");
1428
1429         MenuList& items = route_ops_menu->items();
1430
1431         items.push_back (MenuElem (_("Comments..."), sigc::mem_fun (*this, &MixerStrip::open_comment_editor)));
1432         if (!_route->is_master()) {
1433                 items.push_back (MenuElem (_("Save As Template..."), sigc::mem_fun(*this, &RouteUI::save_as_template)));
1434         }
1435         items.push_back (MenuElem (_("Rename..."), sigc::mem_fun(*this, &RouteUI::route_rename)));
1436         rename_menu_item = &items.back();
1437
1438         items.push_back (SeparatorElem());
1439         items.push_back (CheckMenuElem (_("Active")));
1440         CheckMenuItem* i = dynamic_cast<CheckMenuItem *> (&items.back());
1441         i->set_active (_route->active());
1442         i->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &RouteUI::set_route_active), !_route->active(), false));
1443
1444         items.push_back (SeparatorElem());
1445
1446         items.push_back (MenuElem (_("Adjust Latency..."), sigc::mem_fun (*this, &RouteUI::adjust_latency)));
1447
1448         items.push_back (SeparatorElem());
1449         items.push_back (CheckMenuElem (_("Protect Against Denormals"), sigc::mem_fun (*this, &RouteUI::toggle_denormal_protection)));
1450         denormal_menu_item = dynamic_cast<CheckMenuItem *> (&items.back());
1451         denormal_menu_item->set_active (_route->denormal_protection());
1452
1453         if (!Profile->get_sae()) {
1454                 items.push_back (SeparatorElem());
1455                 items.push_back (MenuElem (_("Remote Control ID..."), sigc::mem_fun (*this, &RouteUI::open_remote_control_id_dialog)));
1456         }
1457
1458         items.push_back (SeparatorElem());
1459         items.push_back (MenuElem (_("Remove"), sigc::bind (sigc::mem_fun(*this, &RouteUI::remove_this_route), false)));
1460 }
1461
1462 gboolean
1463 MixerStrip::name_button_button_press (GdkEventButton* ev)
1464 {
1465         /* show menu for either button 1 or 3, so as not to confuse people
1466            and also not hide stuff from them.
1467         */
1468
1469         if (ev->button == 3 || ev->button == 1) {
1470                 list_route_operations ();
1471
1472                 /* do not allow rename if the track is record-enabled */
1473                 rename_menu_item->set_sensitive (!_route->record_enabled());
1474                 route_ops_menu->popup (1, ev->time);
1475         }
1476
1477         return false;
1478 }
1479
1480 void
1481 MixerStrip::list_route_operations ()
1482 {
1483         delete route_ops_menu;
1484         build_route_ops_menu ();
1485 }
1486
1487 void
1488 MixerStrip::set_selected (bool yn)
1489 {
1490         AxisView::set_selected (yn);
1491         if (_selected) {
1492                 global_frame.set_shadow_type (Gtk::SHADOW_ETCHED_OUT);
1493                 global_frame.set_name ("MixerStripSelectedFrame");
1494         } else {
1495                 global_frame.set_shadow_type (Gtk::SHADOW_IN);
1496                 global_frame.set_name ("MixerStripFrame");
1497         }
1498         global_frame.queue_draw ();
1499 }
1500
1501 void
1502 MixerStrip::property_changed (const PropertyChange& what_changed)
1503 {
1504         RouteUI::property_changed (what_changed);
1505
1506         if (what_changed.contains (ARDOUR::Properties::name)) {
1507                 name_changed ();
1508         }
1509 }
1510
1511 void
1512 MixerStrip::name_changed ()
1513 {
1514         switch (_width) {
1515         case Wide:
1516                 name_button.set_text (_route->name());
1517                 break;
1518         case Narrow:
1519                 name_button.set_text (PBD::short_version (_route->name(), 5));
1520                 break;
1521         }
1522
1523         ARDOUR_UI::instance()->set_tip (name_button, _route->name());
1524 }
1525
1526 void
1527 MixerStrip::name_button_resized (Gtk::Allocation& alloc)
1528 {
1529         name_button.layout()->set_width (alloc.get_width() * PANGO_SCALE);
1530 }
1531
1532 bool
1533 MixerStrip::width_button_pressed (GdkEventButton* ev)
1534 {
1535         if (ev->button != 1) {
1536                 return false;
1537         }
1538         
1539         if (Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier | Keyboard::TertiaryModifier)) && _mixer_owned) {
1540                 switch (_width) {
1541                 case Wide:
1542                         _mixer.set_strip_width (Narrow);
1543                         break;
1544
1545                 case Narrow:
1546                         _mixer.set_strip_width (Wide);
1547                         break;
1548                 }
1549         } else {
1550                 switch (_width) {
1551                 case Wide:
1552                         set_width_enum (Narrow, this);
1553                         break;
1554                 case Narrow:
1555                         set_width_enum (Wide, this);
1556                         break;
1557                 }
1558         }
1559
1560         return true;
1561 }
1562
1563 void
1564 MixerStrip::hide_clicked ()
1565 {
1566         // LAME fix to reset the button status for when it is redisplayed (part 1)
1567         hide_button.set_sensitive(false);
1568
1569         if (_embedded) {
1570                 Hiding(); /* EMIT_SIGNAL */
1571         } else {
1572                 _mixer.hide_strip (this);
1573         }
1574
1575         // (part 2)
1576         hide_button.set_sensitive(true);
1577 }
1578
1579 void
1580 MixerStrip::set_embedded (bool yn)
1581 {
1582         _embedded = yn;
1583 }
1584
1585 void
1586 MixerStrip::map_frozen ()
1587 {
1588         ENSURE_GUI_THREAD (*this, &MixerStrip::map_frozen)
1589
1590         boost::shared_ptr<AudioTrack> at = audio_track();
1591
1592         if (at) {
1593                 switch (at->freeze_state()) {
1594                 case AudioTrack::Frozen:
1595                         processor_box.set_sensitive (false);
1596                         hide_redirect_editors ();
1597                         break;
1598                 default:
1599                         processor_box.set_sensitive (true);
1600                         // XXX need some way, maybe, to retoggle redirect editors
1601                         break;
1602                 }
1603         }
1604 }
1605
1606 void
1607 MixerStrip::hide_redirect_editors ()
1608 {
1609         _route->foreach_processor (sigc::mem_fun (*this, &MixerStrip::hide_processor_editor));
1610 }
1611
1612 void
1613 MixerStrip::hide_processor_editor (boost::weak_ptr<Processor> p)
1614 {
1615         boost::shared_ptr<Processor> processor (p.lock ());
1616         if (!processor) {
1617                 return;
1618         }
1619
1620         Gtk::Window* w = processor_box.get_processor_ui (processor);
1621
1622         if (w) {
1623                 w->hide ();
1624         }
1625 }
1626
1627 void
1628 MixerStrip::reset_strip_style ()
1629 {
1630         if (_current_delivery && boost::dynamic_pointer_cast<Send>(_current_delivery)) {
1631
1632                 gpm.set_fader_name ("SendStripBase");
1633
1634         } else {
1635
1636                 if (is_midi_track()) {
1637                         if (_route->active()) {
1638                                 set_name ("MidiTrackStripBase");
1639                                 gpm.set_meter_strip_name ("MidiTrackMetrics");
1640                         } else {
1641                                 set_name ("MidiTrackStripBaseInactive");
1642                                 gpm.set_meter_strip_name ("MidiTrackMetricsInactive");
1643                         }
1644                         gpm.set_fader_name ("MidiTrackFader");
1645                 } else if (is_audio_track()) {
1646                         if (_route->active()) {
1647                                 set_name ("AudioTrackStripBase");
1648                                 gpm.set_meter_strip_name ("AudioTrackMetrics");
1649                         } else {
1650                                 set_name ("AudioTrackStripBaseInactive");
1651                                 gpm.set_meter_strip_name ("AudioTrackMetricsInactive");
1652                         }
1653                         gpm.set_fader_name ("AudioTrackFader");
1654                 } else {
1655                         if (_route->active()) {
1656                                 set_name ("AudioBusStripBase");
1657                                 gpm.set_meter_strip_name ("AudioBusMetrics");
1658                         } else {
1659                                 set_name ("AudioBusStripBaseInactive");
1660                                 gpm.set_meter_strip_name ("AudioBusMetricsInactive");
1661                         }
1662                         gpm.set_fader_name ("AudioBusFader");
1663
1664                         /* (no MIDI busses yet) */
1665                 }
1666         }
1667 }
1668
1669
1670 void
1671 MixerStrip::engine_stopped ()
1672 {
1673 }
1674
1675 void
1676 MixerStrip::engine_running ()
1677 {
1678 }
1679
1680 string
1681 MixerStrip::meter_point_string (MeterPoint mp)
1682 {
1683         switch (_width) {
1684         case Wide:
1685                 switch (mp) {
1686                 case MeterInput:
1687                         return _("in");
1688                         break;
1689                         
1690                 case MeterPreFader:
1691                         return _("pre");
1692                         break;
1693                         
1694                 case MeterPostFader:
1695                         return _("post");
1696                         break;
1697                         
1698                 case MeterOutput:
1699                         return _("out");
1700                         break;
1701                         
1702                 case MeterCustom:
1703                 default:
1704                         return _("custom");
1705                         break;
1706                 }
1707                 break;
1708         case Narrow:
1709                 switch (mp) {
1710                 case MeterInput:
1711                         return _("in");
1712                         break;
1713                         
1714                 case MeterPreFader:
1715                         return _("pr");
1716                         break;
1717                         
1718                 case MeterPostFader:
1719                         return _("po");
1720                         break;
1721                         
1722                 case MeterOutput:
1723                         return _("o");
1724                         break;
1725                         
1726                 case MeterCustom:
1727                 default:
1728                         return _("c");
1729                         break;
1730                 }
1731                 break;
1732         }
1733
1734 }
1735
1736 /** Called when the metering point has changed */
1737 void
1738 MixerStrip::meter_changed ()
1739 {
1740         meter_point_button.set_text (meter_point_string (_route->meter_point()));
1741         gpm.setup_meters ();
1742         // reset peak when meter point changes
1743         gpm.reset_peak_display();
1744 }
1745
1746 /** The bus that we are displaying sends to has changed, or been turned off.
1747  *  @param send_to New bus that we are displaying sends to, or 0.
1748  */
1749 void
1750 MixerStrip::bus_send_display_changed (boost::shared_ptr<Route> send_to)
1751 {
1752         RouteUI::bus_send_display_changed (send_to);
1753
1754         if (send_to) {
1755                 boost::shared_ptr<Send> send = _route->internal_send_for (send_to);
1756
1757                 if (send) {
1758                         show_send (send);
1759                 } else {
1760                         revert_to_default_display ();
1761                 }
1762         } else {
1763                 revert_to_default_display ();
1764         }
1765 }
1766
1767 void
1768 MixerStrip::drop_send ()
1769 {
1770         boost::shared_ptr<Send> current_send;
1771
1772         if (_current_delivery && ((current_send = boost::dynamic_pointer_cast<Send>(_current_delivery)) != 0)) {
1773                 current_send->set_metering (false);
1774         }
1775
1776         send_gone_connection.disconnect ();
1777         input_button.set_sensitive (true);
1778         output_button.set_sensitive (true);
1779         group_button.set_sensitive (true);
1780         set_invert_sensitive (true);
1781         meter_point_button.set_sensitive (true);
1782         mute_button->set_sensitive (true);
1783         solo_button->set_sensitive (true);
1784         rec_enable_button->set_sensitive (true);
1785         solo_isolated_led->set_sensitive (true);
1786         solo_safe_led->set_sensitive (true);
1787         monitor_input_button->set_sensitive (true);
1788         monitor_disk_button->set_sensitive (true);
1789         _comment_button.set_sensitive (true);
1790 }
1791
1792 void
1793 MixerStrip::set_current_delivery (boost::shared_ptr<Delivery> d)
1794 {
1795         _current_delivery = d;
1796         DeliveryChanged (_current_delivery);
1797 }
1798
1799 void
1800 MixerStrip::show_send (boost::shared_ptr<Send> send)
1801 {
1802         assert (send != 0);
1803
1804         drop_send ();
1805
1806         set_current_delivery (send);
1807
1808         send->set_metering (true);
1809         _current_delivery->DropReferences.connect (send_gone_connection, invalidator (*this), boost::bind (&MixerStrip::revert_to_default_display, this), gui_context());
1810
1811         gain_meter().set_controls (_route, send->meter(), send->amp());
1812         gain_meter().setup_meters ();
1813
1814         panner_ui().set_panner (_current_delivery->panner_shell(), _current_delivery->panner());
1815         panner_ui().setup_pan ();
1816
1817         input_button.set_sensitive (false);
1818         group_button.set_sensitive (false);
1819         set_invert_sensitive (false);
1820         meter_point_button.set_sensitive (false);
1821         mute_button->set_sensitive (false);
1822         solo_button->set_sensitive (false);
1823         rec_enable_button->set_sensitive (false);
1824         solo_isolated_led->set_sensitive (false);
1825         solo_safe_led->set_sensitive (false);
1826         monitor_input_button->set_sensitive (false);
1827         monitor_disk_button->set_sensitive (false);
1828         _comment_button.set_sensitive (false);
1829
1830         if (boost::dynamic_pointer_cast<InternalSend>(send)) {
1831                 output_button.set_sensitive (false);
1832         }
1833
1834         reset_strip_style ();
1835 }
1836
1837 void
1838 MixerStrip::revert_to_default_display ()
1839 {
1840         drop_send ();
1841
1842         set_current_delivery (_route->main_outs ());
1843
1844         gain_meter().set_controls (_route, _route->shared_peak_meter(), _route->amp());
1845         gain_meter().setup_meters ();
1846
1847         panner_ui().set_panner (_route->main_outs()->panner_shell(), _route->main_outs()->panner());
1848         panner_ui().setup_pan ();
1849
1850         reset_strip_style ();
1851 }
1852
1853 void
1854 MixerStrip::set_button_names ()
1855 {
1856         switch (_width) {
1857         case Wide:
1858                 rec_enable_button->set_text (_("Rec"));
1859                 mute_button->set_text (_("Mute"));
1860                 monitor_input_button->set_text (_("In"));
1861                 monitor_disk_button->set_text (_("Disk"));
1862
1863                 if (_route && _route->solo_safe()) {
1864                         if (solo_safe_pixbuf == 0) {
1865                                 solo_safe_pixbuf = ::get_icon("solo-safe-icon");
1866                         }
1867                         solo_button->set_image (solo_safe_pixbuf);
1868                         solo_button->set_text (string());
1869                 } else {
1870                         solo_button->set_image (Glib::RefPtr<Gdk::Pixbuf>());
1871                         if (!Config->get_solo_control_is_listen_control()) {
1872                                 solo_button->set_text (_("Solo"));
1873                         } else {
1874                                 switch (Config->get_listen_position()) {
1875                                 case AfterFaderListen:
1876                                         solo_button->set_text (_("AFL"));
1877                                         break;
1878                                 case PreFaderListen:
1879                                         solo_button->set_text (_("PFL"));
1880                                         break;
1881                                 }
1882                         }
1883                 }
1884                 break;
1885
1886         default:
1887                 rec_enable_button->set_text (_("R"));
1888                 mute_button->set_text (_("M"));
1889                 monitor_input_button->set_text (_("I"));
1890                 monitor_disk_button->set_text (_("D"));
1891                 if (_route && _route->solo_safe()) {
1892                         solo_button->remove ();
1893                         if (solo_safe_pixbuf == 0) {
1894                                 solo_safe_pixbuf =::get_icon("solo-safe-icon");
1895                         }
1896                         solo_button->set_image (solo_safe_pixbuf);
1897                         solo_button->set_text (string());
1898                 } else {
1899                         solo_button->set_image (Glib::RefPtr<Gdk::Pixbuf>());
1900                         if (!Config->get_solo_control_is_listen_control()) {
1901                                 solo_button->set_text (_("S"));
1902                         } else {
1903                                 switch (Config->get_listen_position()) {
1904                                 case AfterFaderListen:
1905                                         solo_button->set_text (_("A"));
1906                                         break;
1907                                 case PreFaderListen:
1908                                         solo_button->set_text (_("P"));
1909                                         break;
1910                                 }
1911                         }
1912                 }
1913                 break;
1914
1915         }
1916
1917         if (_route) {
1918                 meter_point_button.set_text (meter_point_string (_route->meter_point()));
1919         } else {
1920                 meter_point_button.set_text ("");
1921         }
1922 }
1923
1924 PluginSelector*
1925 MixerStrip::plugin_selector()
1926 {
1927         return _mixer.plugin_selector();
1928 }
1929
1930 void
1931 MixerStrip::hide_things ()
1932 {
1933         processor_box.hide_things ();
1934 }
1935
1936 bool
1937 MixerStrip::input_active_button_press (GdkEventButton*)
1938 {
1939         /* nothing happens on press */
1940         return true;
1941 }
1942
1943 bool
1944 MixerStrip::input_active_button_release (GdkEventButton* ev)
1945 {
1946         boost::shared_ptr<MidiTrack> mt = midi_track ();
1947
1948         if (!mt) {
1949                 return true;
1950         }
1951
1952         boost::shared_ptr<RouteList> rl (new RouteList);
1953
1954         rl->push_back (route());
1955
1956         _session->set_exclusive_input_active (rl, !mt->input_active(),
1957                                               Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::SecondaryModifier)));
1958
1959         return true;
1960 }
1961
1962 void
1963 MixerStrip::midi_input_status_changed ()
1964 {
1965         if (midi_input_enable_button) {
1966                 boost::shared_ptr<MidiTrack> mt = midi_track ();
1967                 assert (mt);
1968                 midi_input_enable_button->set_active (mt->input_active ());
1969         }
1970 }
1971
1972 string
1973 MixerStrip::state_id () const
1974 {
1975         return string_compose ("strip %1", _route->id().to_s());
1976 }
1977
1978 void
1979 MixerStrip::parameter_changed (string p)
1980 {
1981         if (p == _visibility.get_state_name()) {
1982                 /* The user has made changes to the mixer strip visibility, so get
1983                    our VisibilityGroup to reflect these changes in our widgets.
1984                 */
1985                 _visibility.set_state (Config->get_mixer_strip_visibility ());
1986         }
1987 }
1988
1989 /** Called to decide whether the solo isolate / solo lock button visibility should
1990  *  be overridden from that configured by the user.  We do this for the master bus.
1991  *
1992  *  @return optional value that is present if visibility state should be overridden.
1993  */
1994 boost::optional<bool>
1995 MixerStrip::override_solo_visibility () const
1996 {
1997         if (_route && _route->is_master ()) {
1998                 return boost::optional<bool> (false);
1999         }
2000         
2001         return boost::optional<bool> ();
2002 }
2003
2004 void
2005 MixerStrip::add_input_port (DataType t)
2006 {
2007         _route->input()->add_port ("", this, t);
2008 }
2009
2010 void
2011 MixerStrip::add_output_port (DataType t)
2012 {
2013         _route->output()->add_port ("", this, t);
2014 }
2015
2016 void
2017 MixerStrip::route_active_changed ()
2018 {
2019         reset_strip_style ();
2020 }
2021
2022 void
2023 MixerStrip::copy_processors ()
2024 {
2025         processor_box.processor_operation (ProcessorBox::ProcessorsCopy);
2026 }
2027
2028 void
2029 MixerStrip::cut_processors ()
2030 {
2031         processor_box.processor_operation (ProcessorBox::ProcessorsCut);
2032 }
2033
2034 void
2035 MixerStrip::paste_processors ()
2036 {
2037         processor_box.processor_operation (ProcessorBox::ProcessorsPaste);
2038 }
2039
2040 void
2041 MixerStrip::select_all_processors ()
2042 {
2043         processor_box.processor_operation (ProcessorBox::ProcessorsSelectAll);
2044 }
2045
2046 void
2047 MixerStrip::delete_processors ()
2048 {
2049         processor_box.processor_operation (ProcessorBox::ProcessorsDelete);
2050 }
2051
2052 void
2053 MixerStrip::toggle_processors ()
2054 {
2055         processor_box.processor_operation (ProcessorBox::ProcessorsToggleActive);
2056 }
2057
2058 void
2059 MixerStrip::ab_plugins ()
2060 {
2061         processor_box.processor_operation (ProcessorBox::ProcessorsAB);
2062 }
2063
2064 bool
2065 MixerStrip::level_meter_button_press (GdkEventButton* ev)
2066 {
2067         if (ev->button == 3) {
2068                 popup_level_meter_menu (ev);
2069                 return true;
2070         }
2071
2072         return false;
2073 }
2074
2075 void
2076 MixerStrip::popup_level_meter_menu (GdkEventButton* ev)
2077 {
2078         using namespace Gtk::Menu_Helpers;
2079
2080         Gtk::Menu* m = manage (new Menu);
2081         MenuList& items = m->items ();
2082
2083         RadioMenuItem::Group group;
2084
2085         add_level_meter_item (items, group, _("Input"), MeterInput);
2086         add_level_meter_item (items, group, _("Pre-fader"), MeterPreFader);
2087         add_level_meter_item (items, group, _("Post-fader"), MeterPostFader);
2088         add_level_meter_item (items, group, _("Output"), MeterOutput);
2089         add_level_meter_item (items, group, _("Custom"), MeterCustom);
2090
2091         m->popup (ev->button, ev->time);
2092 }
2093
2094 void
2095 MixerStrip::add_level_meter_item (Menu_Helpers::MenuList& items, RadioMenuItem::Group& group, string const & name, MeterPoint point)
2096 {
2097         using namespace Menu_Helpers;
2098         
2099         items.push_back (RadioMenuElem (group, name, sigc::bind (sigc::mem_fun (*this, &MixerStrip::set_meter_point), point)));
2100         RadioMenuItem* i = dynamic_cast<RadioMenuItem *> (&items.back ());
2101         i->set_active (_route->meter_point() == point);
2102 }
2103
2104 void
2105 MixerStrip::set_meter_point (MeterPoint p)
2106 {
2107         _route->set_meter_point (p);
2108 }