Fix corruption of follow playhead state on quit (#4048).
[ardour2.git] / gtk2_ardour / ardour_ui2.cc
blob3e3f8a15069074b93ca43476ae871fdadc3e0b42
1 /*
2 Copyright (C) 1999 Paul Davis
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.
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.
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.
20 #ifdef WAF_BUILD
21 #include "gtk2ardour-config.h"
22 #endif
24 #include <fcntl.h>
25 #include <signal.h>
26 #include <unistd.h>
27 #include <cerrno>
28 #include <iostream>
29 #include <cmath>
31 #include <sigc++/bind.h>
32 #include "pbd/error.h"
33 #include "pbd/basename.h"
34 #include "pbd/fastlog.h"
35 #include <gtkmm2ext/utils.h>
36 #include <gtkmm2ext/click_box.h>
37 #include <gtkmm2ext/tearoff.h>
39 #include "ardour/session.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/ardour.h"
42 #include "ardour/profile.h"
43 #include "ardour/route.h"
45 #include "ardour_ui.h"
46 #include "keyboard.h"
47 #include "public_editor.h"
48 #include "audio_clock.h"
49 #include "actions.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"
58 #include "i18n.h"
60 using namespace std;
61 using namespace ARDOUR;
62 using namespace PBD;
63 using namespace Gtkmm2ext;
64 using namespace Gtk;
65 using namespace Glib;
67 int
68 ARDOUR_UI::setup_windows ()
70 if (create_editor ()) {
71 error << _("UI: cannot setup editor") << endmsg;
72 return -1;
75 if (create_mixer ()) {
76 error << _("UI: cannot setup mixer") << endmsg;
77 return -1;
80 /* all other dialogs are created conditionally */
82 we_have_dependents ();
84 theme_manager->signal_unmap().connect (sigc::bind (sigc::ptr_fun(&ActionManager::uncheck_toggleaction), X_("<Actions>/Common/ToggleThemeManager")));
86 #ifdef TOP_MENUBAR
87 HBox* status_bar_packer = manage (new HBox);
88 EventBox* status_bar_event_box = manage (new EventBox);
90 status_bar_event_box->add (status_bar_label);
91 status_bar_event_box->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
92 status_bar_label.set_size_request (300, -1);
93 status_bar_packer->pack_start (*status_bar_event_box, true, true, 6);
94 status_bar_packer->pack_start (error_log_button, false, false);
96 status_bar_label.show ();
97 status_bar_event_box->show ();
98 status_bar_packer->show ();
99 error_log_button.show ();
101 error_log_button.signal_clicked().connect (mem_fun (*this, &UI::toggle_errors));
102 status_bar_event_box->signal_button_press_event().connect (mem_fun (*this, &ARDOUR_UI::status_bar_button_press));
104 editor->get_status_bar_packer().pack_start (*status_bar_packer, true, true);
105 editor->get_status_bar_packer().pack_start (menu_bar_base, false, false, 6);
106 #else
107 top_packer.pack_start (menu_bar_base, false, false);
108 #endif
110 top_packer.pack_start (transport_frame, false, false);
112 editor->add_toplevel_controls (top_packer);
114 setup_transport();
115 build_menu_bar ();
117 setup_tooltips ();
119 return 0;
122 void
123 ARDOUR_UI::setup_tooltips ()
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 (join_play_range_button, _("Always play range/selection"));
130 set_tip (goto_start_button, _("Go to start of session"));
131 set_tip (goto_end_button, _("Go to end of session"));
132 set_tip (auto_loop_button, _("Play loop range"));
134 set_tip (auto_return_button, _("Return to last playback start when stopped"));
135 set_tip (auto_play_button, _("Start playback after any locate"));
136 set_tip (auto_input_button, _("Be sensible about input monitoring"));
137 set_tip (punch_in_button, _("Start recording at auto-punch start"));
138 set_tip (punch_out_button, _("Stop recording at auto-punch end"));
139 set_tip (click_button, _("Enable/Disable audio click"));
140 set_tip (time_master_button, string_compose (_("Does %1 control the time?"), PROGRAM_NAME));
141 set_tip (solo_alert_button, _("When active, something is soloed.\nClick to de-solo everything"));
142 set_tip (auditioning_alert_button, _("When active, auditioning is taking place\nClick to stop the audition"));
143 set_tip (primary_clock, _("Primary Clock"));
144 set_tip (secondary_clock, _("Secondary Clock"));
146 synchronize_sync_source_and_video_pullup ();
148 editor->setup_tooltips ();
151 bool
152 ARDOUR_UI::status_bar_button_press (GdkEventButton* ev)
154 bool handled = false;
156 switch (ev->button) {
157 case 1:
158 status_bar_label.set_text ("");
159 handled = true;
160 break;
161 default:
162 break;
165 return handled;
168 void
169 ARDOUR_UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
171 string text;
173 UI::display_message (prefix, prefix_len, ptag, mtag, msg);
174 #ifdef TOP_MENUBAR
176 if (strcmp (prefix, _("[ERROR]: ")) == 0) {
177 text = "<span color=\"red\" weight=\"bold\">";
178 } else if (strcmp (prefix, _("[WARNING]: ")) == 0) {
179 text = "<span color=\"yellow\" weight=\"bold\">";
180 } else if (strcmp (prefix, _("[INFO]: ")) == 0) {
181 text = "<span color=\"green\" weight=\"bold\">";
182 } else {
183 text = "<span color=\"white\" weight=\"bold\">???";
186 text += prefix;
187 text += "</span>";
188 text += msg;
190 status_bar_label.set_markup (text);
191 #endif
194 XMLNode*
195 ARDOUR_UI::tearoff_settings (const char* name) const
197 XMLNode* ui_node = Config->extra_xml(X_("UI"));
199 if (ui_node) {
200 XMLNode* tearoff_node = ui_node->child (X_("Tearoffs"));
201 if (tearoff_node) {
202 XMLNode* mnode = tearoff_node->child (name);
203 return mnode;
207 return 0;
210 void
211 ARDOUR_UI::setup_transport ()
213 transport_tearoff = manage (new TearOff (transport_tearoff_hbox));
214 transport_tearoff->set_name ("TransportBase");
215 transport_tearoff->tearoff_window().signal_key_press_event().connect (sigc::bind (sigc::ptr_fun (relay_key_press), &transport_tearoff->tearoff_window()), false);
217 if (Profile->get_sae()) {
218 transport_tearoff->set_can_be_torn_off (false);
221 transport_hbox.pack_start (*transport_tearoff, true, false);
223 transport_base.set_name ("TransportBase");
224 transport_base.add (transport_hbox);
226 transport_frame.set_shadow_type (SHADOW_OUT);
227 transport_frame.set_name ("BaseFrame");
228 transport_frame.add (transport_base);
230 transport_tearoff->Detach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
231 static_cast<Widget*>(&transport_frame)));
232 transport_tearoff->Attach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
233 static_cast<Widget*> (&transport_frame), 1));
234 transport_tearoff->Hidden.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
235 static_cast<Widget*>(&transport_frame)));
236 transport_tearoff->Visible.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
237 static_cast<Widget*> (&transport_frame), 1));
239 goto_start_button.set_name ("TransportButton");
240 goto_end_button.set_name ("TransportButton");
241 roll_button.set_name ("TransportButton");
242 stop_button.set_name ("TransportButton");
243 play_selection_button.set_name ("TransportButton");
244 rec_button.set_name ("TransportRecButton");
245 auto_loop_button.set_name ("TransportButton");
246 join_play_range_button.set_name ("TransportButton");
248 auto_return_button.set_name ("TransportButton");
249 auto_play_button.set_name ("TransportButton");
250 auto_input_button.set_name ("TransportButton");
251 punch_in_button.set_name ("TransportButton");
252 punch_out_button.set_name ("TransportButton");
253 click_button.set_name ("TransportButton");
254 time_master_button.set_name ("TransportButton");
255 sync_button.set_name ("TransportSyncButton");
257 stop_button.set_size_request(29, -1);
258 roll_button.set_size_request(29, -1);
259 auto_loop_button.set_size_request(29, -1);
260 play_selection_button.set_size_request(29, -1);
261 goto_start_button.set_size_request(29, -1);
262 goto_end_button.set_size_request(29, -1);
263 rec_button.set_size_request(29, -1);
265 Widget* w;
267 stop_button.set_visual_state (1);
269 w = manage (new Image (get_icon (X_("transport_start"))));
270 w->show();
271 goto_start_button.add (*w);
272 w = manage (new Image (get_icon (X_("transport_end"))));
273 w->show();
274 goto_end_button.add (*w);
275 w = manage (new Image (get_icon (X_("transport_play"))));
276 w->show();
277 roll_button.add (*w);
278 w = manage (new Image (get_icon (X_("transport_stop"))));
279 w->show();
280 stop_button.add (*w);
281 w = manage (new Image (get_icon (X_("transport_range"))));
282 w->show();
283 play_selection_button.add (*w);
284 w = manage (new Image (get_icon (X_("transport_record"))));
285 w->show();
286 rec_button.add (*w);
287 w = manage (new Image (get_icon (X_("transport_loop"))));
288 w->show();
289 auto_loop_button.add (*w);
290 w = manage (new Image (get_icon (X_("tool_object_range"))));
291 w->show ();
292 join_play_range_button.add (*w);
294 RefPtr<Action> act;
296 act = ActionManager::get_action (X_("Transport"), X_("Stop"));
297 act->connect_proxy (stop_button);
298 act = ActionManager::get_action (X_("Transport"), X_("Roll"));
299 act->connect_proxy (roll_button);
300 act = ActionManager::get_action (X_("Transport"), X_("Record"));
301 act->connect_proxy (rec_button);
302 act = ActionManager::get_action (X_("Transport"), X_("GotoStart"));
303 act->connect_proxy (goto_start_button);
304 act = ActionManager::get_action (X_("Transport"), X_("GotoEnd"));
305 act->connect_proxy (goto_end_button);
306 act = ActionManager::get_action (X_("Transport"), X_("Loop"));
307 act->connect_proxy (auto_loop_button);
308 act = ActionManager::get_action (X_("Transport"), X_("PlaySelection"));
309 act->connect_proxy (play_selection_button);
310 act = ActionManager::get_action (X_("Transport"), X_("ToggleTimeMaster"));
311 act->connect_proxy (time_master_button);
312 act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
313 act->connect_proxy (sync_button);
316 /* clocks, etc. */
318 ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (primary_clock, &AudioClock::set), 'p'));
319 ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (secondary_clock, &AudioClock::set), 's'));
321 primary_clock.ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::primary_clock_value_changed));
322 secondary_clock.ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::secondary_clock_value_changed));
323 big_clock.ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::big_clock_value_changed));
325 ActionManager::get_action ("Transport", "ToggleAutoReturn")->connect_proxy (auto_return_button);
326 ActionManager::get_action ("Transport", "ToggleAutoPlay")->connect_proxy (auto_play_button);
327 ActionManager::get_action ("Transport", "ToggleAutoInput")->connect_proxy (auto_input_button);
328 ActionManager::get_action ("Transport", "ToggleClick")->connect_proxy (click_button);
329 ActionManager::get_action ("Transport", "TogglePunchIn")->connect_proxy (punch_in_button);
330 ActionManager::get_action ("Transport", "TogglePunchOut")->connect_proxy (punch_out_button);
332 click_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::click_button_clicked), false);
334 preroll_button.set_name ("TransportButton");
335 postroll_button.set_name ("TransportButton");
337 preroll_clock.set_mode (AudioClock::MinSec);
338 preroll_clock.set_name ("TransportClockDisplay");
339 postroll_clock.set_mode (AudioClock::MinSec);
340 postroll_clock.set_name ("TransportClockDisplay");
342 /* alerts */
344 /* CANNOT sigc::bind these to clicked or toggled, must use pressed or released */
346 solo_alert_button.set_name ("TransportSoloAlert");
347 solo_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::solo_alert_press), false);
348 auditioning_alert_button.set_name ("TransportAuditioningAlert");
349 auditioning_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::audition_alert_press), false);
351 alert_box.pack_start (solo_alert_button, false, false);
352 alert_box.pack_start (auditioning_alert_button, false, false);
354 HBox* transport_hbox = manage (new HBox);
356 transport_tearoff_hbox.set_border_width (3);
358 transport_hbox->pack_start (goto_start_button, false, false);
359 transport_hbox->pack_start (goto_end_button, false, false);
361 /* translators: Egternal is "External" with a descender character */
362 set_size_request_to_display_given_text (sync_button, X_("Egternal"), 4, 10);
364 // transport_tearoff_hbox.pack_start (*svbox, false, false, 3);
366 if (Profile->get_sae()) {
367 transport_hbox->pack_start (auto_loop_button);
368 transport_hbox->pack_start (roll_button);
369 } else {
370 transport_hbox->pack_start (auto_loop_button, false, false);
372 Frame* jpframe = manage (new Frame);
373 HBox* jpbox = manage (new HBox);
375 jpframe->add (*jpbox);
376 jpframe->set_shadow_type (SHADOW_NONE);
378 jpbox->pack_start (play_selection_button, false, false);
379 jpbox->pack_start (join_play_range_button, false, false);
380 jpbox->pack_start (roll_button, false, false);
382 transport_hbox->pack_start (*jpframe, false, false);
384 transport_hbox->pack_start (stop_button, false, false);
385 transport_hbox->pack_start (rec_button, false, false, 6);
387 HBox* clock_box = manage (new HBox);
388 clock_box->pack_start (primary_clock, false, false);
389 if (!ARDOUR::Profile->get_small_screen()) {
390 clock_box->pack_start (secondary_clock, false, false);
393 if (!Profile->get_sae()) {
394 VBox* time_controls_box = manage (new VBox);
395 time_controls_box->pack_start (sync_button, false, false);
396 time_controls_box->pack_start (time_master_button, false, false);
397 clock_box->pack_start (*time_controls_box, false, false, 1);
400 shuttle_box = new ShuttleControl;
401 shuttle_box->show ();
403 VBox* transport_vbox = manage (new VBox);
404 transport_vbox->set_name ("TransportBase");
405 transport_vbox->set_border_width (3);
406 transport_vbox->set_spacing (3);
407 transport_vbox->pack_start (*transport_hbox, true, true, 0);
408 transport_vbox->pack_start (*shuttle_box, false, false, 0);
410 transport_tearoff_hbox.pack_start (*transport_vbox, false, false, 0);
411 transport_tearoff_hbox.pack_start (*clock_box, false, false, 0);
413 HBox* toggle_box = manage(new HBox);
415 VBox* punch_box = manage (new VBox);
416 punch_box->pack_start (punch_in_button, false, false);
417 punch_box->pack_start (punch_out_button, false, false);
418 toggle_box->pack_start (*punch_box, false, false);
420 VBox* auto_box = manage (new VBox);
421 auto_box->pack_start (auto_play_button, false, false);
422 auto_box->pack_start (auto_return_button, false, false);
423 if (!Profile->get_small_screen()) {
424 toggle_box->pack_start (*auto_box, false, false);
427 VBox* io_box = manage (new VBox);
428 io_box->pack_start (auto_input_button, false, false);
429 io_box->pack_start (click_button, false, false);
430 if (!Profile->get_small_screen()) {
431 toggle_box->pack_start (*io_box, false, false);
434 /* desensitize */
436 set_transport_sensitivity (false);
438 // toggle_box->pack_start (preroll_button, false, false);
439 // toggle_box->pack_start (preroll_clock, false, false);
441 // toggle_box->pack_start (postroll_button, false, false);
442 // toggle_box->pack_start (postroll_clock, false, false);
444 transport_tearoff_hbox.pack_start (*toggle_box, false, false, 4);
445 if (Profile->get_small_screen()) {
446 transport_tearoff_hbox.pack_start (_editor_transport_box, false, false, 4);
448 transport_tearoff_hbox.pack_start (alert_box, false, false);
450 if (Profile->get_sae()) {
451 Image* img = manage (new Image ((::get_icon (X_("sae")))));
452 transport_tearoff_hbox.pack_end (*img, false, false, 6);
455 XMLNode* tnode = tearoff_settings ("transport");
456 if (tnode) {
457 transport_tearoff->set_state (*tnode);
461 void
462 ARDOUR_UI::manage_window (Window& win)
464 win.signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), &win));
465 win.signal_enter_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::enter_window), &win));
466 win.signal_leave_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::leave_window), &win));
469 void
470 ARDOUR_UI::detach_tearoff (Box* b, Widget* w)
472 // editor->ensure_float (transport_tearoff->tearoff_window());
473 b->remove (*w);
476 void
477 ARDOUR_UI::reattach_tearoff (Box* b, Widget* w, int32_t n)
479 b->pack_start (*w);
480 b->reorder_child (*w, n);
483 void
484 ARDOUR_UI::soloing_changed (bool onoff)
486 if (solo_alert_button.get_active() != onoff) {
487 solo_alert_button.set_active (onoff);
491 void
492 ARDOUR_UI::_auditioning_changed (bool onoff)
494 if (auditioning_alert_button.get_active() != onoff) {
495 auditioning_alert_button.set_active (onoff);
496 set_transport_sensitivity (!onoff);
500 void
501 ARDOUR_UI::auditioning_changed (bool onoff)
503 UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::_auditioning_changed, this, onoff));
506 bool
507 ARDOUR_UI::audition_alert_press (GdkEventButton*)
509 if (_session) {
510 _session->cancel_audition();
512 return true;
515 bool
516 ARDOUR_UI::solo_alert_press (GdkEventButton*)
518 if (_session) {
519 if (_session->soloing()) {
520 _session->set_solo (_session->get_routes(), false);
521 } else if (_session->listening()) {
522 _session->set_listen (_session->get_routes(), false);
525 return true;
528 void
529 ARDOUR_UI::solo_blink (bool onoff)
531 if (_session == 0) {
532 return;
535 if (_session->soloing() || _session->listening()) {
536 if (onoff) {
537 solo_alert_button.set_state (STATE_ACTIVE);
538 } else {
539 solo_alert_button.set_state (STATE_NORMAL);
541 } else {
542 solo_alert_button.set_active (false);
543 solo_alert_button.set_state (STATE_NORMAL);
547 void
548 ARDOUR_UI::sync_blink (bool onoff)
550 if (_session == 0 || !_session->config.get_external_sync()) {
551 /* internal sync */
552 sync_button.set_visual_state (0);
553 return;
556 if (!_session->transport_locked()) {
557 /* not locked, so blink on and off according to the onoff argument */
559 if (onoff) {
560 sync_button.set_visual_state (1); // "-active"
561 } else {
562 sync_button.set_visual_state (0); // normal
564 } else {
565 /* locked */
566 sync_button.set_visual_state (1); // "-active"
570 void
571 ARDOUR_UI::audition_blink (bool onoff)
573 if (_session == 0) {
574 return;
577 if (_session->is_auditioning()) {
578 if (onoff) {
579 auditioning_alert_button.set_state (STATE_ACTIVE);
580 } else {
581 auditioning_alert_button.set_state (STATE_NORMAL);
583 } else {
584 auditioning_alert_button.set_active (false);
585 auditioning_alert_button.set_state (STATE_NORMAL);
589 void
590 ARDOUR_UI::set_transport_sensitivity (bool yn)
592 ActionManager::set_sensitive (ActionManager::transport_sensitive_actions, yn);
593 shuttle_box->set_sensitive (yn);
596 void
597 ARDOUR_UI::editor_realized ()
599 boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
600 Config->map_parameters (pc);
602 reset_dpi ();
605 void
606 ARDOUR_UI::maximise_editing_space ()
608 if (!editor) {
609 return;
612 transport_tearoff->set_visible (false);
613 editor->maximise_editing_space ();
614 if (Config->get_keep_tearoffs()) {
615 transport_tearoff->set_visible (true);
619 void
620 ARDOUR_UI::restore_editing_space ()
622 if (!editor) {
623 return;
626 transport_tearoff->set_visible (true);
627 editor->restore_editing_space ();
630 bool
631 ARDOUR_UI::click_button_clicked (GdkEventButton* ev)
633 if (ev->button != 3) {
634 /* this handler is just for button-3 clicks */
635 return false;
638 RefPtr<Action> act = ActionManager::get_action (X_("Common"), X_("ToggleRCOptionsEditor"));
639 assert (act);
641 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic (act);
642 tact->set_active ();
644 rc_option_editor->set_current_page (_("Misc"));
645 return true;