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