switch to WM::Proxy Action management
[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         if (create_meterbridge ()) {
82                 error << _("UI: cannot setup meterbridge") << endmsg;
83                 return -1;
84         }
85
86         /* all other dialogs are created conditionally */
87
88         we_have_dependents ();
89
90 #ifdef TOP_MENUBAR
91         HBox* status_bar_packer = manage (new HBox);
92         EventBox* status_bar_event_box = manage (new EventBox);
93
94         status_bar_event_box->add (status_bar_label);
95         status_bar_event_box->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
96         status_bar_label.set_size_request (300, -1);
97         status_bar_packer->pack_start (*status_bar_event_box, true, true, 6);
98         status_bar_packer->pack_start (error_log_button, false, false);
99
100         status_bar_label.show ();
101         status_bar_event_box->show ();
102         status_bar_packer->show ();
103         error_log_button.show ();
104
105         error_log_button.signal_clicked().connect (mem_fun (*this, &UI::toggle_errors));
106         status_bar_event_box->signal_button_press_event().connect (mem_fun (*this, &ARDOUR_UI::status_bar_button_press));
107
108         editor->get_status_bar_packer().pack_start (*status_bar_packer, true, true);
109         editor->get_status_bar_packer().pack_start (menu_bar_base, false, false, 6);
110 #else
111         top_packer.pack_start (menu_bar_base, false, false);
112 #endif
113
114         top_packer.pack_start (transport_frame, false, false);
115
116         editor->add_toplevel_controls (top_packer);
117
118         setup_transport();
119
120         build_menu_bar ();
121
122         setup_tooltips ();
123
124         return 0;
125 }
126
127 void
128 ARDOUR_UI::setup_tooltips ()
129 {
130         set_tip (roll_button, _("Play from playhead"));
131         set_tip (stop_button, _("Stop playback"));
132         set_tip (rec_button, _("Toggle record"));
133         set_tip (play_selection_button, _("Play range/selection"));
134         set_tip (goto_start_button, _("Go to start of session"));
135         set_tip (goto_end_button, _("Go to end of session"));
136         set_tip (auto_loop_button, _("Play loop range"));
137         set_tip (midi_panic_button, _("MIDI Panic\nSend note off and reset controller messages on all MIDI channels"));
138         set_tip (auto_return_button, _("Return to last playback start when stopped"));
139         set_tip (follow_edits_button, _("Playhead follows Range Selections and Edits"));
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, _("<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"));
146         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"));
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
248         follow_edits_button.set_text(_("Follow Edits"));
249
250 //      auto_input_button.set_text (_("Auto Input"));
251
252         click_button.set_image (get_icon (X_("metronome")));
253         act = ActionManager::get_action ("Transport", "ToggleClick");
254         click_button.set_related_action (act);
255         click_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::click_button_clicked), false);
256
257         auto_return_button.set_name ("transport option button");
258         follow_edits_button.set_name ("transport option button");
259         auto_input_button.set_name ("transport option button");
260
261         /* these have to provide a clear indication of active state */
262
263         click_button.set_name ("transport button");
264         sync_button.set_name ("transport active option button");
265
266         stop_button.set_active (true);
267
268         goto_start_button.set_image (get_icon (X_("transport_start")));
269         goto_end_button.set_image (get_icon (X_("transport_end")));
270         roll_button.set_image (get_icon (X_("transport_play")));
271         stop_button.set_image (get_icon (X_("transport_stop")));
272         play_selection_button.set_image (get_icon (X_("transport_range")));
273         rec_button.set_image (get_icon (X_("transport_record")));
274         auto_loop_button.set_image (get_icon (X_("transport_loop")));
275
276         midi_panic_button.set_image (get_icon (X_("midi_panic")));
277         /* the icon for this has an odd aspect ratio, so fatten up the button */
278         midi_panic_button.set_size_request (25, -1);
279         
280         act = ActionManager::get_action (X_("Transport"), X_("Stop"));
281         stop_button.set_related_action (act);
282         act = ActionManager::get_action (X_("Transport"), X_("Roll"));
283         roll_button.set_related_action (act);
284         act = ActionManager::get_action (X_("Transport"), X_("Record"));
285         rec_button.set_related_action (act);
286         act = ActionManager::get_action (X_("Transport"), X_("GotoStart"));
287         goto_start_button.set_related_action (act);
288         act = ActionManager::get_action (X_("Transport"), X_("GotoEnd"));
289         goto_end_button.set_related_action (act);
290         act = ActionManager::get_action (X_("Transport"), X_("Loop"));
291         auto_loop_button.set_related_action (act);
292         act = ActionManager::get_action (X_("Transport"), X_("PlaySelection"));
293         play_selection_button.set_related_action (act);
294         act = ActionManager::get_action (X_("MIDI"), X_("panic"));
295         midi_panic_button.set_related_action (act);
296         act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
297         sync_button.set_related_action (act);
298
299         /* clocks, etc. */
300
301         ARDOUR_UI::Clock.connect (sigc::mem_fun (primary_clock, &AudioClock::set));
302         ARDOUR_UI::Clock.connect (sigc::mem_fun (secondary_clock, &AudioClock::set));
303
304         primary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::primary_clock_value_changed));
305         secondary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::secondary_clock_value_changed));
306         big_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::big_clock_value_changed));
307
308         act = ActionManager::get_action ("Transport", "ToggleAutoReturn");
309         auto_return_button.set_related_action (act);
310         act = ActionManager::get_action (X_("Transport"), X_("ToggleFollowEdits"));
311         follow_edits_button.set_related_action (act);
312         act = ActionManager::get_action ("Transport", "ToggleAutoInput");
313         auto_input_button.set_related_action (act);
314
315         /* alerts */
316
317         /* CANNOT sigc::bind these to clicked or toggled, must use pressed or released */
318
319         solo_alert_button.set_name ("rude solo");
320         solo_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::solo_alert_press), false);
321         auditioning_alert_button.set_name ("rude audition");
322         auditioning_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::audition_alert_press), false);
323         feedback_alert_button.set_name ("feedback alert");
324         feedback_alert_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::feedback_alert_press), false);
325
326         alert_box.pack_start (solo_alert_button, true, false);
327         alert_box.pack_start (auditioning_alert_button, true, false);
328         alert_box.pack_start (feedback_alert_button, true, false);
329
330         /* all transport buttons should be the same size vertically and
331          * horizontally 
332          */
333
334         Glib::RefPtr<SizeGroup> transport_button_size_group = SizeGroup::create (SIZE_GROUP_BOTH);
335         transport_button_size_group->add_widget (goto_start_button);
336         transport_button_size_group->add_widget (goto_end_button);
337         transport_button_size_group->add_widget (auto_loop_button);
338         transport_button_size_group->add_widget (rec_button);
339         transport_button_size_group->add_widget (play_selection_button);
340         transport_button_size_group->add_widget (roll_button);
341         transport_button_size_group->add_widget (stop_button);
342
343         goto_start_button.set_size_request (-1, 40);
344
345         HBox* tbox1 = manage (new HBox);
346         HBox* tbox2 = manage (new HBox);
347         HBox* tbox = manage (new HBox);
348
349         VBox* vbox1 = manage (new VBox);
350         VBox* vbox2 = manage (new VBox);
351
352         Alignment* a1 = manage (new Alignment);
353         Alignment* a2 = manage (new Alignment);
354
355         tbox1->set_spacing (2);
356         tbox2->set_spacing (2);
357         tbox->set_spacing (2);
358
359         tbox1->pack_start (midi_panic_button, false, false, 5);
360         tbox1->pack_start (click_button, false, false, 5);
361         tbox1->pack_start (goto_start_button, false, false);
362         tbox1->pack_start (goto_end_button, false, false);
363         tbox1->pack_start (auto_loop_button, false, false);
364
365         tbox2->pack_start (play_selection_button, false, false);
366         tbox2->pack_start (roll_button, false, false);
367         tbox2->pack_start (stop_button, false, false);
368         tbox2->pack_start (rec_button, false, false, 5);
369
370         vbox1->pack_start (*tbox1, false, false);
371         vbox2->pack_start (*tbox2, false, false);
372
373         a1->add (*vbox1);
374         a1->set (0.5, 1.0, 0.0, 0.0);
375         a2->add (*vbox2);
376         a2->set (0.5, 1.0, 0.0, 0.0);
377
378         tbox->pack_start (*a1, false, false);
379         tbox->pack_start (*a2, false, false);
380
381         HBox* clock_box = manage (new HBox);
382
383         clock_box->pack_start (*primary_clock, false, false);
384         if (!ARDOUR::Profile->get_small_screen()) {
385                 clock_box->pack_start (*secondary_clock, false, false);
386         }
387         clock_box->set_spacing (3);
388
389         shuttle_box = new ShuttleControl;
390         shuttle_box->show ();
391
392         VBox* transport_vbox = manage (new VBox);
393         transport_vbox->set_name ("TransportBase");
394         transport_vbox->set_border_width (0);
395         transport_vbox->set_spacing (3);
396         transport_vbox->pack_start (*tbox, true, true, 0);
397         transport_vbox->pack_start (*shuttle_box, false, false, 0);
398
399         transport_tearoff_hbox.pack_start (*transport_vbox, false, false);
400
401         /* transport related toggle controls */
402
403         VBox* auto_box = manage (new VBox);
404         auto_box->set_homogeneous (true);
405         auto_box->set_spacing (2);
406         auto_box->pack_start (sync_button, false, false);
407         auto_box->pack_start (follow_edits_button, false, false);
408         auto_box->pack_start (auto_return_button, false, false);
409
410         transport_tearoff_hbox.pack_start (*auto_box, false, false);
411         transport_tearoff_hbox.pack_start (*clock_box, true, true);
412
413         time_info_box = manage (new TimeInfoBox);
414         transport_tearoff_hbox.pack_start (*time_info_box, false, false);
415
416         if (Profile->get_small_screen()) {
417                 transport_tearoff_hbox.pack_start (_editor_transport_box, false, false);
418         }
419         transport_tearoff_hbox.pack_start (alert_box, false, false);
420
421         if (Profile->get_sae()) {
422                 Image* img = manage (new Image ((::get_icon (X_("sae")))));
423                 transport_tearoff_hbox.pack_end (*img, false, false);
424         }
425
426         /* desensitize */
427
428         set_transport_sensitivity (false);
429
430         XMLNode* tnode = tearoff_settings ("transport");
431         if (tnode) {
432                 transport_tearoff->set_state (*tnode);
433         }
434 }
435
436 void
437 ARDOUR_UI::detach_tearoff (Box* b, Widget* w)
438 {
439 //      editor->ensure_float (transport_tearoff->tearoff_window());
440         b->remove (*w);
441 }
442
443 void
444 ARDOUR_UI::reattach_tearoff (Box* b, Widget* w, int32_t n)
445 {
446         b->pack_start (*w);
447         b->reorder_child (*w, n);
448 }
449
450 void
451 ARDOUR_UI::soloing_changed (bool onoff)
452 {
453         if (solo_alert_button.get_active() != onoff) {
454                 solo_alert_button.set_active (onoff);
455         }
456 }
457
458 void
459 ARDOUR_UI::_auditioning_changed (bool onoff)
460 {
461         auditioning_alert_button.set_active (onoff);
462         set_transport_sensitivity (!onoff);
463 }
464
465 void
466 ARDOUR_UI::auditioning_changed (bool onoff)
467 {
468         UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::_auditioning_changed, this, onoff));
469 }
470
471 bool
472 ARDOUR_UI::audition_alert_press (GdkEventButton*)
473 {
474         if (_session) {
475                 _session->cancel_audition();
476         }
477         return true;
478 }
479
480 bool
481 ARDOUR_UI::solo_alert_press (GdkEventButton*)
482 {
483         if (_session) {
484                 if (_session->soloing()) {
485                         _session->set_solo (_session->get_routes(), false);
486                 } else if (_session->listening()) {
487                         _session->set_listen (_session->get_routes(), false);
488                 }
489         }
490         return true;
491 }
492
493 bool
494 ARDOUR_UI::feedback_alert_press (GdkEventButton *)
495 {
496         return true;
497 }
498
499 void
500 ARDOUR_UI::solo_blink (bool onoff)
501 {
502         if (_session == 0) {
503                 return;
504         }
505
506         if (_session->soloing() || _session->listening()) {
507                 if (onoff) {
508                         solo_alert_button.set_active (true);
509                 } else {
510                         solo_alert_button.set_active (false);
511                 }
512         } else {
513                 solo_alert_button.set_active (false);
514         }
515 }
516
517 void
518 ARDOUR_UI::sync_blink (bool onoff)
519 {
520         if (_session == 0 || !_session->config.get_external_sync()) {
521                 /* internal sync */
522                 sync_button.set_active (false);
523                 return;
524         }
525
526         if (!_session->transport_locked()) {
527                 /* not locked, so blink on and off according to the onoff argument */
528
529                 if (onoff) {
530                         sync_button.set_active (true);
531                 } else {
532                         sync_button.set_active (false);
533                 }
534         } else {
535                 /* locked */
536                 sync_button.set_active (true);
537         }
538 }
539
540 void
541 ARDOUR_UI::audition_blink (bool onoff)
542 {
543         if (_session == 0) {
544                 return;
545         }
546
547         if (_session->is_auditioning()) {
548                 if (onoff) {
549                         auditioning_alert_button.set_active (true);
550                 } else {
551                         auditioning_alert_button.set_active (false);
552                 }
553         } else {
554                 auditioning_alert_button.set_active (false);
555         }
556 }
557
558 void
559 ARDOUR_UI::feedback_blink (bool onoff)
560 {
561         if (_feedback_exists) {
562                 if (onoff) {
563                         feedback_alert_button.set_active (true);
564                 } else {
565                         feedback_alert_button.set_active (false);
566                 }
567         } else {
568                 feedback_alert_button.set_active (false);
569         }
570 }
571
572 void
573 ARDOUR_UI::set_transport_sensitivity (bool yn)
574 {
575         ActionManager::set_sensitive (ActionManager::transport_sensitive_actions, yn);
576         shuttle_box->set_sensitive (yn);
577 }
578
579 void
580 ARDOUR_UI::editor_realized ()
581 {
582         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
583         Config->map_parameters (pc);
584
585         reset_dpi ();
586 }
587
588 void
589 ARDOUR_UI::update_tearoff_visibility ()
590 {
591         if (editor) {
592                 editor->update_tearoff_visibility ();
593         }
594 }
595
596 void
597 ARDOUR_UI::maximise_editing_space ()
598 {
599         if (editor) {
600                 editor->maximise_editing_space ();
601         }
602 }
603
604 void
605 ARDOUR_UI::restore_editing_space ()
606 {
607         if (editor) {
608                 editor->restore_editing_space ();
609         }
610 }
611
612 bool
613 ARDOUR_UI::click_button_clicked (GdkEventButton* ev)
614 {
615         if (ev->button != 3) {
616                 /* this handler is just for button-3 clicks */
617                 return false;
618         }
619
620         RefPtr<Action> act = ActionManager::get_action (X_("Window"), X_("toggle-rc-options-editor"));
621         assert (act);
622
623         act->activate();
624
625         rc_option_editor->set_current_page (_("Misc"));
626         return true;
627 }
628
629 void
630 ARDOUR_UI::toggle_always_play_range ()
631 {
632         RefPtr<Action> act = ActionManager::get_action (X_("Transport"), X_("ToggleFollowEdits"));
633         assert (act);
634
635         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic (act);
636         assert (tact);
637
638         Config->set_always_play_range (tact->get_active ());
639 }
640
641