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