more window management rationalization
[ardour.git] / gtk2_ardour / ardour_ui2.cc
1 /*
2     Copyright (C) 1999 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
20 #ifdef WAF_BUILD
21 #include "gtk2ardour-config.h"
22 #endif
23
24 #include <fcntl.h>
25 #include <signal.h>
26 #include <unistd.h>
27 #include <cerrno>
28 #include <iostream>
29 #include <cmath>
30
31 #include <sigc++/bind.h>
32 #include "pbd/error.h"
33 #include "pbd/basename.h"
34 #include "pbd/fastlog.h"
35 #include <gtkmm2ext/cairocell.h>
36 #include <gtkmm2ext/utils.h>
37 #include <gtkmm2ext/click_box.h>
38 #include <gtkmm2ext/tearoff.h>
39
40 #include "ardour/profile.h"
41 #include "ardour/session.h"
42 #include "ardour/types.h"
43
44 #include "ardour_ui.h"
45 #include "keyboard.h"
46 #include "public_editor.h"
47 #include "audio_clock.h"
48 #include "actions.h"
49 #include "main_clock.h"
50 #include "utils.h"
51 #include "theme_manager.h"
52 #include "midi_tracer.h"
53 #include "shuttle_control.h"
54 #include "global_port_matrix.h"
55 #include "location_ui.h"
56 #include "rc_option_editor.h"
57 #include "time_info_box.h"
58
59 #include "i18n.h"
60
61 using namespace std;
62 using namespace ARDOUR;
63 using namespace PBD;
64 using namespace Gtkmm2ext;
65 using namespace Gtk;
66 using namespace Glib;
67
68 int
69 ARDOUR_UI::setup_windows ()
70 {
71         if (create_editor ()) {
72                 error << _("UI: cannot setup editor") << endmsg;
73                 return -1;
74         }
75
76         if (create_mixer ()) {
77                 error << _("UI: cannot setup mixer") << endmsg;
78                 return -1;
79         }
80
81         /* all other dialogs are created conditionally */
82
83         we_have_dependents ();
84
85 #ifdef TOP_MENUBAR
86         HBox* status_bar_packer = manage (new HBox);
87         EventBox* status_bar_event_box = manage (new EventBox);
88
89         status_bar_event_box->add (status_bar_label);
90         status_bar_event_box->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
91         status_bar_label.set_size_request (300, -1);
92         status_bar_packer->pack_start (*status_bar_event_box, true, true, 6);
93         status_bar_packer->pack_start (error_log_button, false, false);
94
95         status_bar_label.show ();
96         status_bar_event_box->show ();
97         status_bar_packer->show ();
98         error_log_button.show ();
99
100         error_log_button.signal_clicked().connect (mem_fun (*this, &UI::toggle_errors));
101         status_bar_event_box->signal_button_press_event().connect (mem_fun (*this, &ARDOUR_UI::status_bar_button_press));
102
103         editor->get_status_bar_packer().pack_start (*status_bar_packer, true, true);
104         editor->get_status_bar_packer().pack_start (menu_bar_base, false, false, 6);
105 #else
106         top_packer.pack_start (menu_bar_base, false, false);
107 #endif
108
109         top_packer.pack_start (transport_frame, false, false);
110
111         editor->add_toplevel_controls (top_packer);
112
113         setup_transport();
114
115         build_menu_bar ();
116
117         setup_tooltips ();
118
119         return 0;
120 }
121
122 void
123 ARDOUR_UI::setup_tooltips ()
124 {
125         set_tip (roll_button, _("Play from playhead"));
126         set_tip (stop_button, _("Stop playback"));
127         set_tip (rec_button, _("Toggle record"));
128         set_tip (play_selection_button, _("Play range/selection"));
129         set_tip (goto_start_button, _("Go to start of session"));
130         set_tip (goto_end_button, _("Go to end of session"));
131         set_tip (auto_loop_button, _("Play loop range"));
132         set_tip (midi_panic_button, _("MIDI Panic\nSend note off and reset controller messages on all MIDI channels"));
133         set_tip (auto_return_button, _("Return to last playback start when stopped"));
134         set_tip (follow_edits_button, _("Playhead follows Range Selections and Edits"));
135         set_tip (auto_input_button, _("Be sensible about input monitoring"));
136         set_tip (click_button, _("Enable/Disable audio click"));
137         set_tip (solo_alert_button, _("When active, something is soloed.\nClick to de-solo everything"));
138         set_tip (auditioning_alert_button, _("When active, auditioning is taking place\nClick to stop the audition"));
139         set_tip (feedback_alert_button, _("When active, there is a feedback loop."));
140         set_tip (primary_clock, _("<b>Primary Clock</b> right-click to set display mode. Click to edit, click+drag a digit or mouse-over+scroll wheel to modify.\nText edits: right-to-left overwrite <tt>Esc</tt>: cancel; <tt>Enter</tt>: confirm; postfix the edit with '+' or '-' to enter delta times.\n"));
141         set_tip (secondary_clock, _("<b>Secondary Clock</b> right-click to set display mode. Click to edit, click+drag a digit or mouse-over+scroll wheel to modify.\nText edits: right-to-left overwrite <tt>Esc</tt>: cancel; <tt>Enter</tt>: confirm; postfix the edit with '+' or '-' to enter delta times.\n"));
142
143         synchronize_sync_source_and_video_pullup ();
144
145         editor->setup_tooltips ();
146 }
147
148 bool
149 ARDOUR_UI::status_bar_button_press (GdkEventButton* ev)
150 {
151         bool handled = false;
152
153         switch (ev->button) {
154         case 1:
155                 status_bar_label.set_text ("");
156                 handled = true;
157                 break;
158         default:
159                 break;
160         }
161
162         return handled;
163 }
164
165 void
166 ARDOUR_UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
167 {
168         string text;
169
170         UI::display_message (prefix, prefix_len, ptag, mtag, msg);
171 #ifdef TOP_MENUBAR
172
173         if (strcmp (prefix, _("[ERROR]: ")) == 0) {
174                 text = "<span color=\"red\" weight=\"bold\">";
175         } else if (strcmp (prefix, _("[WARNING]: ")) == 0) {
176                 text = "<span color=\"yellow\" weight=\"bold\">";
177         } else if (strcmp (prefix, _("[INFO]: ")) == 0) {
178                 text = "<span color=\"green\" weight=\"bold\">";
179         } else {
180                 text = "<span color=\"white\" weight=\"bold\">???";
181         }
182
183         text += prefix;
184         text += "</span>";
185         text += msg;
186
187         status_bar_label.set_markup (text);
188 #endif
189 }
190
191 XMLNode*
192 ARDOUR_UI::tearoff_settings (const char* name) const
193 {
194         XMLNode* ui_node = Config->extra_xml(X_("UI"));
195
196         if (ui_node) {
197                 XMLNode* tearoff_node = ui_node->child (X_("Tearoffs"));
198                 if (tearoff_node) {
199                         XMLNode* mnode = tearoff_node->child (name);
200                         return mnode;
201                 }
202         }
203
204         return 0;
205 }
206
207 void
208 ARDOUR_UI::setup_transport ()
209 {
210         RefPtr<Action> act;
211
212         transport_tearoff_hbox.set_border_width (3);
213         transport_tearoff_hbox.set_spacing (3);
214
215         transport_tearoff = manage (new TearOff (transport_tearoff_hbox));
216         transport_tearoff->set_name ("TransportBase");
217         transport_tearoff->tearoff_window().signal_key_press_event().connect (sigc::bind (sigc::ptr_fun (relay_key_press), &transport_tearoff->tearoff_window()), false);
218
219         if (Profile->get_sae()) {
220                 transport_tearoff->set_can_be_torn_off (false);
221         }
222
223         transport_hbox.pack_start (*transport_tearoff, true, false);
224
225         transport_base.set_name ("TransportBase");
226         transport_base.add (transport_hbox);
227
228         transport_frame.set_shadow_type (SHADOW_OUT);
229         transport_frame.set_name ("BaseFrame");
230         transport_frame.add (transport_base);
231
232         transport_tearoff->Detach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
233                                                  static_cast<Widget*>(&transport_frame)));
234         transport_tearoff->Attach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
235                                                  static_cast<Widget*> (&transport_frame), 1));
236         transport_tearoff->Hidden.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
237                                                  static_cast<Widget*>(&transport_frame)));
238         transport_tearoff->Visible.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
239                                                   static_cast<Widget*> (&transport_frame), 1));
240
241         auto_return_button.set_text(_("Auto Return"));
242
243         follow_edits_button.set_text(_("Follow Edits"));
244
245 //      auto_input_button.set_text (_("Auto Input"));
246
247         click_button.set_image (get_icon (X_("metronome")));
248         act = ActionManager::get_action ("Transport", "ToggleClick");
249         click_button.set_related_action (act);
250         click_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::click_button_clicked), false);
251
252         auto_return_button.set_name ("transport option button");
253         follow_edits_button.set_name ("transport option button");
254         auto_input_button.set_name ("transport option button");
255
256         /* these have to provide a clear indication of active state */
257
258         click_button.set_name ("transport button");
259         sync_button.set_name ("transport active option button");
260
261         stop_button.set_active (true);
262
263         goto_start_button.set_image (get_icon (X_("transport_start")));
264         goto_end_button.set_image (get_icon (X_("transport_end")));
265         roll_button.set_image (get_icon (X_("transport_play")));
266         stop_button.set_image (get_icon (X_("transport_stop")));
267         play_selection_button.set_image (get_icon (X_("transport_range")));
268         rec_button.set_image (get_icon (X_("transport_record")));
269         auto_loop_button.set_image (get_icon (X_("transport_loop")));
270
271         midi_panic_button.set_image (get_icon (X_("midi_panic")));
272         /* the icon for this has an odd aspect ratio, so fatten up the button */
273         midi_panic_button.set_size_request (25, -1);
274         
275         act = ActionManager::get_action (X_("Transport"), X_("Stop"));
276         stop_button.set_related_action (act);
277         act = ActionManager::get_action (X_("Transport"), X_("Roll"));
278         roll_button.set_related_action (act);
279         act = ActionManager::get_action (X_("Transport"), X_("Record"));
280         rec_button.set_related_action (act);
281         act = ActionManager::get_action (X_("Transport"), X_("GotoStart"));
282         goto_start_button.set_related_action (act);
283         act = ActionManager::get_action (X_("Transport"), X_("GotoEnd"));
284         goto_end_button.set_related_action (act);
285         act = ActionManager::get_action (X_("Transport"), X_("Loop"));
286         auto_loop_button.set_related_action (act);
287         act = ActionManager::get_action (X_("Transport"), X_("PlaySelection"));
288         play_selection_button.set_related_action (act);
289         act = ActionManager::get_action (X_("MIDI"), X_("panic"));
290         midi_panic_button.set_related_action (act);
291         act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
292         sync_button.set_related_action (act);
293
294         /* clocks, etc. */
295
296         ARDOUR_UI::Clock.connect (sigc::mem_fun (primary_clock, &AudioClock::set));
297         ARDOUR_UI::Clock.connect (sigc::mem_fun (secondary_clock, &AudioClock::set));
298
299         primary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::primary_clock_value_changed));
300         secondary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::secondary_clock_value_changed));
301         big_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::big_clock_value_changed));
302
303         act = ActionManager::get_action ("Transport", "ToggleAutoReturn");
304         auto_return_button.set_related_action (act);
305         act = ActionManager::get_action (X_("Transport"), X_("ToggleFollowEdits"));
306         follow_edits_button.set_related_action (act);
307         act = ActionManager::get_action ("Transport", "ToggleAutoInput");
308         auto_input_button.set_related_action (act);
309
310         /* alerts */
311
312         /* CANNOT sigc::bind these to clicked or toggled, must use pressed or released */
313
314         solo_alert_button.set_name ("rude solo");
315         solo_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::solo_alert_press), false);
316         auditioning_alert_button.set_name ("rude audition");
317         auditioning_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::audition_alert_press), false);
318         feedback_alert_button.set_name ("feedback alert");
319         feedback_alert_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::feedback_alert_press), false);
320
321         alert_box.pack_start (solo_alert_button, true, false);
322         alert_box.pack_start (auditioning_alert_button, true, false);
323         alert_box.pack_start (feedback_alert_button, true, false);
324
325         /* all transport buttons should be the same size vertically and
326          * horizontally 
327          */
328
329         Glib::RefPtr<SizeGroup> transport_button_size_group = SizeGroup::create (SIZE_GROUP_BOTH);
330         transport_button_size_group->add_widget (goto_start_button);
331         transport_button_size_group->add_widget (goto_end_button);
332         transport_button_size_group->add_widget (auto_loop_button);
333         transport_button_size_group->add_widget (rec_button);
334         transport_button_size_group->add_widget (play_selection_button);
335         transport_button_size_group->add_widget (roll_button);
336         transport_button_size_group->add_widget (stop_button);
337
338         goto_start_button.set_size_request (-1, 40);
339
340         HBox* tbox1 = manage (new HBox);
341         HBox* tbox2 = manage (new HBox);
342         HBox* tbox = manage (new HBox);
343
344         VBox* vbox1 = manage (new VBox);
345         VBox* vbox2 = manage (new VBox);
346
347         Alignment* a1 = manage (new Alignment);
348         Alignment* a2 = manage (new Alignment);
349
350         tbox1->set_spacing (2);
351         tbox2->set_spacing (2);
352         tbox->set_spacing (2);
353
354         tbox1->pack_start (midi_panic_button, false, false, 5);
355         tbox1->pack_start (click_button, false, false, 5);
356         tbox1->pack_start (goto_start_button, false, false);
357         tbox1->pack_start (goto_end_button, false, false);
358         tbox1->pack_start (auto_loop_button, false, false);
359
360         tbox2->pack_start (play_selection_button, false, false);
361         tbox2->pack_start (roll_button, false, false);
362         tbox2->pack_start (stop_button, false, false);
363         tbox2->pack_start (rec_button, false, false, 5);
364
365         vbox1->pack_start (*tbox1, false, false);
366         vbox2->pack_start (*tbox2, false, false);
367
368         a1->add (*vbox1);
369         a1->set (0.5, 1.0, 0.0, 0.0);
370         a2->add (*vbox2);
371         a2->set (0.5, 1.0, 0.0, 0.0);
372
373         tbox->pack_start (*a1, false, false);
374         tbox->pack_start (*a2, false, false);
375
376         HBox* clock_box = manage (new HBox);
377
378         clock_box->pack_start (*primary_clock, false, false);
379         if (!ARDOUR::Profile->get_small_screen()) {
380                 clock_box->pack_start (*secondary_clock, false, false);
381         }
382         clock_box->set_spacing (3);
383
384         shuttle_box = new ShuttleControl;
385         shuttle_box->show ();
386
387         VBox* transport_vbox = manage (new VBox);
388         transport_vbox->set_name ("TransportBase");
389         transport_vbox->set_border_width (0);
390         transport_vbox->set_spacing (3);
391         transport_vbox->pack_start (*tbox, true, true, 0);
392         transport_vbox->pack_start (*shuttle_box, false, false, 0);
393
394         transport_tearoff_hbox.pack_start (*transport_vbox, false, false);
395
396         /* transport related toggle controls */
397
398         VBox* auto_box = manage (new VBox);
399         auto_box->set_homogeneous (true);
400         auto_box->set_spacing (2);
401         auto_box->pack_start (sync_button, false, false);
402         auto_box->pack_start (follow_edits_button, false, false);
403         auto_box->pack_start (auto_return_button, false, false);
404
405         transport_tearoff_hbox.pack_start (*auto_box, false, false);
406         transport_tearoff_hbox.pack_start (*clock_box, true, true);
407
408         time_info_box = manage (new TimeInfoBox);
409         transport_tearoff_hbox.pack_start (*time_info_box, false, false);
410
411         if (Profile->get_small_screen()) {
412                 transport_tearoff_hbox.pack_start (_editor_transport_box, false, false);
413         }
414         transport_tearoff_hbox.pack_start (alert_box, false, false);
415
416         if (Profile->get_sae()) {
417                 Image* img = manage (new Image ((::get_icon (X_("sae")))));
418                 transport_tearoff_hbox.pack_end (*img, false, false);
419         }
420
421         /* desensitize */
422
423         set_transport_sensitivity (false);
424
425         XMLNode* tnode = tearoff_settings ("transport");
426         if (tnode) {
427                 transport_tearoff->set_state (*tnode);
428         }
429 }
430
431 void
432 ARDOUR_UI::detach_tearoff (Box* b, Widget* w)
433 {
434 //      editor->ensure_float (transport_tearoff->tearoff_window());
435         b->remove (*w);
436 }
437
438 void
439 ARDOUR_UI::reattach_tearoff (Box* b, Widget* w, int32_t n)
440 {
441         b->pack_start (*w);
442         b->reorder_child (*w, n);
443 }
444
445 void
446 ARDOUR_UI::soloing_changed (bool onoff)
447 {
448         if (solo_alert_button.get_active() != onoff) {
449                 solo_alert_button.set_active (onoff);
450         }
451 }
452
453 void
454 ARDOUR_UI::_auditioning_changed (bool onoff)
455 {
456         auditioning_alert_button.set_active (onoff);
457         set_transport_sensitivity (!onoff);
458 }
459
460 void
461 ARDOUR_UI::auditioning_changed (bool onoff)
462 {
463         UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::_auditioning_changed, this, onoff));
464 }
465
466 bool
467 ARDOUR_UI::audition_alert_press (GdkEventButton*)
468 {
469         if (_session) {
470                 _session->cancel_audition();
471         }
472         return true;
473 }
474
475 bool
476 ARDOUR_UI::solo_alert_press (GdkEventButton*)
477 {
478         if (_session) {
479                 if (_session->soloing()) {
480                         _session->set_solo (_session->get_routes(), false);
481                 } else if (_session->listening()) {
482                         _session->set_listen (_session->get_routes(), false);
483                 }
484         }
485         return true;
486 }
487
488 bool
489 ARDOUR_UI::feedback_alert_press (GdkEventButton *)
490 {
491         return true;
492 }
493
494 void
495 ARDOUR_UI::solo_blink (bool onoff)
496 {
497         if (_session == 0) {
498                 return;
499         }
500
501         if (_session->soloing() || _session->listening()) {
502                 if (onoff) {
503                         solo_alert_button.set_active (true);
504                 } else {
505                         solo_alert_button.set_active (false);
506                 }
507         } else {
508                 solo_alert_button.set_active (false);
509         }
510 }
511
512 void
513 ARDOUR_UI::sync_blink (bool onoff)
514 {
515         if (_session == 0 || !_session->config.get_external_sync()) {
516                 /* internal sync */
517                 sync_button.set_active (false);
518                 return;
519         }
520
521         if (!_session->transport_locked()) {
522                 /* not locked, so blink on and off according to the onoff argument */
523
524                 if (onoff) {
525                         sync_button.set_active (true);
526                 } else {
527                         sync_button.set_active (false);
528                 }
529         } else {
530                 /* locked */
531                 sync_button.set_active (true);
532         }
533 }
534
535 void
536 ARDOUR_UI::audition_blink (bool onoff)
537 {
538         if (_session == 0) {
539                 return;
540         }
541
542         if (_session->is_auditioning()) {
543                 if (onoff) {
544                         auditioning_alert_button.set_active (true);
545                 } else {
546                         auditioning_alert_button.set_active (false);
547                 }
548         } else {
549                 auditioning_alert_button.set_active (false);
550         }
551 }
552
553 void
554 ARDOUR_UI::feedback_blink (bool onoff)
555 {
556         if (_feedback_exists) {
557                 if (onoff) {
558                         feedback_alert_button.set_active (true);
559                 } else {
560                         feedback_alert_button.set_active (false);
561                 }
562         } else {
563                 feedback_alert_button.set_active (false);
564         }
565 }
566
567 void
568 ARDOUR_UI::set_transport_sensitivity (bool yn)
569 {
570         ActionManager::set_sensitive (ActionManager::transport_sensitive_actions, yn);
571         shuttle_box->set_sensitive (yn);
572 }
573
574 void
575 ARDOUR_UI::editor_realized ()
576 {
577         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
578         Config->map_parameters (pc);
579
580         reset_dpi ();
581 }
582
583 void
584 ARDOUR_UI::update_tearoff_visibility ()
585 {
586         if (editor) {
587                 editor->update_tearoff_visibility ();
588         }
589 }
590
591 void
592 ARDOUR_UI::maximise_editing_space ()
593 {
594         if (editor) {
595                 editor->maximise_editing_space ();
596         }
597 }
598
599 void
600 ARDOUR_UI::restore_editing_space ()
601 {
602         if (editor) {
603                 editor->restore_editing_space ();
604         }
605 }
606
607 bool
608 ARDOUR_UI::click_button_clicked (GdkEventButton* ev)
609 {
610         if (ev->button != 3) {
611                 /* this handler is just for button-3 clicks */
612                 return false;
613         }
614
615         RefPtr<Action> act = ActionManager::get_action (X_("Common"), X_("ToggleRCOptionsEditor"));
616         assert (act);
617
618         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic (act);
619         tact->set_active ();
620
621         rc_option_editor->set_current_page (_("Misc"));
622         return true;
623 }
624
625 void
626 ARDOUR_UI::toggle_always_play_range ()
627 {
628         RefPtr<Action> act = ActionManager::get_action (X_("Transport"), X_("ToggleFollowEdits"));
629         assert (act);
630
631         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic (act);
632         assert (tact);
633
634         Config->set_always_play_range (tact->get_active ());
635 }
636
637