e663b149de3512c223720fb95892e62347657cef
[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         build_menu_bar ();
118
119         setup_tooltips ();
120
121         return 0;
122 }
123
124 void
125 ARDOUR_UI::setup_tooltips ()
126 {
127         set_tip (roll_button, _("Play from playhead"));
128         set_tip (stop_button, _("Stop playback"));
129         set_tip (rec_button, _("Toggle record"));
130         set_tip (play_selection_button, _("Play range/selection"));
131         set_tip (join_play_range_button, _("Always play range/selection"));
132         set_tip (goto_start_button, _("Go to start of session"));
133         set_tip (goto_end_button, _("Go to end of session"));
134         set_tip (auto_loop_button, _("Play loop range"));
135
136         set_tip (auto_return_button, _("Return to last playback start when stopped"));
137         set_tip (auto_play_button, _("Start playback after any locate"));
138         set_tip (auto_input_button, _("Be sensible about input monitoring"));
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"));
145
146         synchronize_sync_source_and_video_pullup ();
147
148         editor->setup_tooltips ();
149 }
150
151 bool
152 ARDOUR_UI::status_bar_button_press (GdkEventButton* ev)
153 {
154         bool handled = false;
155
156         switch (ev->button) {
157         case 1:
158                 status_bar_label.set_text ("");
159                 handled = true;
160                 break;
161         default:
162                 break;
163         }
164
165         return handled;
166 }
167
168 void
169 ARDOUR_UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
170 {
171         string text;
172
173         UI::display_message (prefix, prefix_len, ptag, mtag, msg);
174 #ifdef TOP_MENUBAR
175
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\">???";
184         }
185
186         text += prefix;
187         text += "</span>";
188         text += msg;
189
190         status_bar_label.set_markup (text);
191 #endif
192 }
193
194 XMLNode*
195 ARDOUR_UI::tearoff_settings (const char* name) const
196 {
197         XMLNode* ui_node = Config->extra_xml(X_("UI"));
198
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;
204                 }
205         }
206
207         return 0;
208 }
209
210 void
211 ARDOUR_UI::setup_transport ()
212 {
213         RefPtr<Action> act;
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         auto_play_button.set_text(_("Auto Play"));
243         auto_input_button.set_text (_("Auto Input"));
244
245         click_button.set_image (get_icon (X_("metronome")));
246         act = ActionManager::get_action ("Transport", "ToggleClick");
247         click_button.set_related_action (act);
248         click_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::click_button_clicked), false);
249
250         auto_return_button.set_name ("transport option button");
251         auto_play_button.set_name ("transport option button");
252         auto_input_button.set_name ("transport option button");
253         click_button.set_name ("transport option button");
254
255         time_master_button.set_name ("TransportButton");
256         sync_button.set_name ("TransportSyncButton");
257
258         stop_button.set_active_state (Active);
259
260         goto_start_button.set_image (get_icon (X_("transport_start")));
261         goto_end_button.set_image (get_icon (X_("transport_end")));
262         roll_button.set_image (get_icon (X_("transport_play")));
263         stop_button.set_image (get_icon (X_("transport_stop")));
264         play_selection_button.set_image (get_icon (X_("transport_range")));
265         rec_button.set_image (get_icon (X_("transport_record")));
266         auto_loop_button.set_image (get_icon (X_("transport_loop")));
267         join_play_range_button.set_image (get_icon (X_("tool_object_range")));
268
269         act = ActionManager::get_action (X_("Transport"), X_("Stop"));
270         stop_button.set_related_action (act);
271         act = ActionManager::get_action (X_("Transport"), X_("Roll"));
272         roll_button.set_related_action (act);
273         act = ActionManager::get_action (X_("Transport"), X_("Record"));
274         rec_button.set_related_action (act);
275         act = ActionManager::get_action (X_("Transport"), X_("GotoStart"));
276         goto_start_button.set_related_action (act);
277         act = ActionManager::get_action (X_("Transport"), X_("GotoEnd"));
278         goto_end_button.set_related_action (act);
279         act = ActionManager::get_action (X_("Transport"), X_("Loop"));
280         auto_loop_button.set_related_action (act);
281         act = ActionManager::get_action (X_("Transport"), X_("PlaySelection"));
282         play_selection_button.set_related_action (act);
283
284
285         act = ActionManager::get_action (X_("Transport"), X_("ToggleTimeMaster"));
286         act->connect_proxy (time_master_button);
287         act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
288         act->connect_proxy (sync_button);
289
290
291         /* clocks, etc. */
292
293         ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (primary_clock, &AudioClock::set), 'p'));
294         ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (secondary_clock, &AudioClock::set), 's'));
295
296         primary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::primary_clock_value_changed));
297         secondary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::secondary_clock_value_changed));
298         big_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::big_clock_value_changed));
299
300         act = ActionManager::get_action ("Transport", "ToggleAutoReturn");
301         auto_return_button.set_related_action (act);
302         act = ActionManager::get_action ("Transport", "ToggleAutoPlay");
303         auto_play_button.set_related_action (act);
304         act = ActionManager::get_action ("Transport", "ToggleAutoInput");
305         auto_input_button.set_related_action (act);
306
307         /* alerts */
308
309         /* CANNOT sigc::bind these to clicked or toggled, must use pressed or released */
310
311         solo_alert_button.set_name ("TransportSoloAlert");
312         solo_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::solo_alert_press), false);
313         auditioning_alert_button.set_name ("TransportAuditioningAlert");
314         auditioning_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::audition_alert_press), false);
315
316         alert_box.pack_start (solo_alert_button, false, false);
317         alert_box.pack_start (auditioning_alert_button, false, false);
318
319         HBox* tbox = manage (new HBox);
320         tbox->set_spacing (2);
321
322         transport_tearoff_hbox.set_border_width (3);
323
324         tbox->pack_start (goto_start_button, false, false);
325         tbox->pack_start (goto_end_button, false, false);
326
327         /* translators: Egternal is "External" with a descender character */
328         set_size_request_to_display_given_text (sync_button, X_("Egternal"), 4, 10);
329
330         // transport_tearoff_hbox.pack_start (*svbox, false, false, 3);
331
332         Glib::RefPtr<SizeGroup> transport_button_size_group1 = SizeGroup::create (SIZE_GROUP_HORIZONTAL);
333         transport_button_size_group1->add_widget (goto_start_button);
334         transport_button_size_group1->add_widget (goto_end_button);
335         transport_button_size_group1->add_widget (auto_loop_button);
336         transport_button_size_group1->add_widget (rec_button);
337
338         if (Profile->get_sae()) {
339                 tbox->pack_start (auto_loop_button);
340                 tbox->pack_start (roll_button);
341                 transport_button_size_group1->add_widget (play_selection_button);
342                 transport_button_size_group1->add_widget (roll_button);
343
344         } else {
345
346                 tbox->pack_start (auto_loop_button, false, false);
347
348                 Frame* jpframe = manage (new Frame);
349                 HBox* jpbox = manage (new HBox);
350
351                 jpframe->add (*jpbox);
352                 jpframe->set_shadow_type (SHADOW_NONE);
353                 
354                 jpbox->pack_start (play_selection_button, false, false);
355                 jpbox->pack_start (join_play_range_button, false, false);
356                 jpbox->pack_start (roll_button, false, false);
357
358                 tbox->pack_start (*jpframe, false, false);
359
360                 Glib::RefPtr<SizeGroup> transport_button_size_group2 = SizeGroup::create (SIZE_GROUP_HORIZONTAL);
361                 transport_button_size_group2->add_widget (play_selection_button);
362                 transport_button_size_group2->add_widget (join_play_range_button);
363                 transport_button_size_group2->add_widget (roll_button);
364         }
365
366         tbox->pack_start (stop_button, false, false);
367         tbox->pack_start (rec_button, false, false, 6);
368
369         HBox* clock_box = manage (new HBox);
370         clock_box->set_border_width (2);
371         primary_clock->set_border_width (2);
372         clock_box->pack_start (*primary_clock, false, false);
373         if (!ARDOUR::Profile->get_small_screen()) {
374                 secondary_clock->set_border_width (2);
375                 clock_box->pack_start (*secondary_clock, false, false);
376         }
377
378
379         shuttle_box = new ShuttleControl;
380         shuttle_box->show ();
381
382         VBox* transport_vbox = manage (new VBox);
383         transport_vbox->set_name ("TransportBase");
384         transport_vbox->set_border_width (3);
385         transport_vbox->set_spacing (3);
386         transport_vbox->pack_start (*tbox, true, true, 0);
387         transport_vbox->pack_start (*shuttle_box, false, false, 0);
388
389         transport_tearoff_hbox.pack_start (*transport_vbox, false, false, 0);
390
391         /* transport related toggle controls */
392
393         HBox* toggle_box = manage(new HBox);
394         VBox* auto_box = manage (new VBox);
395         auto_box->set_spacing (2);
396         auto_box->set_homogeneous (true);
397         toggle_box->set_spacing (2);
398         toggle_box->set_homogeneous (true);
399         auto_box->pack_start (auto_play_button, true, false);
400         auto_box->pack_start (auto_return_button, true, false);
401         if (!Profile->get_small_screen()) {
402                 toggle_box->pack_start (*auto_box, false, false);
403         }
404         //VBox* io_box = manage (new VBox);
405         //io_box->pack_start (auto_input_button, false, false);
406         //io_box->pack_start (click_button, false, false);
407         //if (!Profile->get_small_screen()) {
408         // toggle_box->pack_start (*io_box, false, false);
409         //}
410         transport_tearoff_hbox.pack_start (*toggle_box, false, false, 4);
411
412         Table* time_controls_table = manage (new Table (2, 2));
413         time_controls_table->set_col_spacings (6);
414         time_controls_table->attach (sync_button, 0, 1, 0, 1, Gtk::AttachOptions(FILL|EXPAND), Gtk::AttachOptions(0));
415         time_controls_table->attach (time_master_button, 0, 1, 1, 2, Gtk::AttachOptions(FILL|EXPAND), Gtk::AttachOptions(0));
416
417         time_controls_table->attach (click_button, 1, 2, 0, 2, Gtk::AttachOptions(FILL|EXPAND), FILL);
418
419         transport_tearoff_hbox.pack_start (*clock_box, false, false);
420         transport_tearoff_hbox.pack_start (*time_controls_table, false, false, 4);
421
422         time_info_box = manage (new TimeInfoBox);
423         transport_tearoff_hbox.pack_start (*time_info_box, false, false);
424
425
426         if (Profile->get_small_screen()) {
427                 transport_tearoff_hbox.pack_start (_editor_transport_box, false, false, 4);
428         }
429         transport_tearoff_hbox.pack_start (alert_box, false, false);
430
431         if (Profile->get_sae()) {
432                 Image* img = manage (new Image ((::get_icon (X_("sae")))));
433                 transport_tearoff_hbox.pack_end (*img, false, false, 6);
434         }
435
436         /* desensitize */
437
438         set_transport_sensitivity (false);
439
440         XMLNode* tnode = tearoff_settings ("transport");
441         if (tnode) {
442                 transport_tearoff->set_state (*tnode);
443         }
444 }
445
446 void
447 ARDOUR_UI::manage_window (Window& win)
448 {
449         win.signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), &win));
450         win.signal_enter_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::enter_window), &win));
451         win.signal_leave_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::leave_window), &win));
452 }
453
454 void
455 ARDOUR_UI::detach_tearoff (Box* b, Widget* w)
456 {
457 //      editor->ensure_float (transport_tearoff->tearoff_window());
458         b->remove (*w);
459 }
460
461 void
462 ARDOUR_UI::reattach_tearoff (Box* b, Widget* w, int32_t n)
463 {
464         b->pack_start (*w);
465         b->reorder_child (*w, n);
466 }
467
468 void
469 ARDOUR_UI::soloing_changed (bool onoff)
470 {
471         if (solo_alert_button.get_active() != onoff) {
472                 solo_alert_button.set_active (onoff);
473         }
474 }
475
476 void
477 ARDOUR_UI::_auditioning_changed (bool onoff)
478 {
479         if (auditioning_alert_button.get_active() != onoff) {
480                 auditioning_alert_button.set_active (onoff);
481                 set_transport_sensitivity (!onoff);
482         }
483 }
484
485 void
486 ARDOUR_UI::auditioning_changed (bool onoff)
487 {
488         UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::_auditioning_changed, this, onoff));
489 }
490
491 bool
492 ARDOUR_UI::audition_alert_press (GdkEventButton*)
493 {
494         if (_session) {
495                 _session->cancel_audition();
496         }
497         return true;
498 }
499
500 bool
501 ARDOUR_UI::solo_alert_press (GdkEventButton*)
502 {
503         if (_session) {
504                 if (_session->soloing()) {
505                         _session->set_solo (_session->get_routes(), false);
506                 } else if (_session->listening()) {
507                         _session->set_listen (_session->get_routes(), false);
508                 }
509         }
510         return true;
511 }
512
513 void
514 ARDOUR_UI::solo_blink (bool onoff)
515 {
516         if (_session == 0) {
517                 return;
518         }
519
520         if (_session->soloing() || _session->listening()) {
521                 if (onoff) {
522                         solo_alert_button.set_state (STATE_ACTIVE);
523                 } else {
524                         solo_alert_button.set_state (STATE_NORMAL);
525                 }
526         } else {
527                 solo_alert_button.set_active (false);
528                 solo_alert_button.set_state (STATE_NORMAL);
529         }
530 }
531
532 void
533 ARDOUR_UI::sync_blink (bool onoff)
534 {
535         if (_session == 0 || !_session->config.get_external_sync()) {
536                 /* internal sync */
537                 sync_button.set_visual_state (0);
538                 return;
539         }
540
541         if (!_session->transport_locked()) {
542                 /* not locked, so blink on and off according to the onoff argument */
543
544                 if (onoff) {
545                         sync_button.set_visual_state (1); // "-active"
546                 } else {
547                         sync_button.set_visual_state (0); // normal
548                 }
549         } else {
550                 /* locked */
551                 sync_button.set_visual_state (1); // "-active"
552         }
553 }
554
555 void
556 ARDOUR_UI::audition_blink (bool onoff)
557 {
558         if (_session == 0) {
559                 return;
560         }
561
562         if (_session->is_auditioning()) {
563                 if (onoff) {
564                         auditioning_alert_button.set_state (STATE_ACTIVE);
565                 } else {
566                         auditioning_alert_button.set_state (STATE_NORMAL);
567                 }
568         } else {
569                 auditioning_alert_button.set_active (false);
570                 auditioning_alert_button.set_state (STATE_NORMAL);
571         }
572 }
573
574 void
575 ARDOUR_UI::set_transport_sensitivity (bool yn)
576 {
577         ActionManager::set_sensitive (ActionManager::transport_sensitive_actions, yn);
578         shuttle_box->set_sensitive (yn);
579 }
580
581 void
582 ARDOUR_UI::editor_realized ()
583 {
584         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
585         Config->map_parameters (pc);
586
587         reset_dpi ();
588 }
589
590 void
591 ARDOUR_UI::maximise_editing_space ()
592 {
593         if (!editor) {
594                 return;
595         }
596
597         transport_tearoff->set_visible (false);
598         editor->maximise_editing_space ();
599         if (Config->get_keep_tearoffs()) {
600                 transport_tearoff->set_visible (true);
601         }
602 }
603
604 void
605 ARDOUR_UI::restore_editing_space ()
606 {
607         if (!editor) {
608                 return;
609         }
610
611         transport_tearoff->set_visible (true);
612         editor->restore_editing_space ();
613 }
614
615 bool
616 ARDOUR_UI::click_button_clicked (GdkEventButton* ev)
617 {
618         if (ev->button != 3) {
619                 /* this handler is just for button-3 clicks */
620                 return false;
621         }
622
623         RefPtr<Action> act = ActionManager::get_action (X_("Common"), X_("ToggleRCOptionsEditor"));
624         assert (act);
625
626         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic (act);
627         tact->set_active ();
628
629         rc_option_editor->set_current_page (_("Misc"));
630         return true;
631 }