add a peak reset button to the editor meter
[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         set_tip (editor_meter_peak_display, _("Reset Level Meter"));
148
149         synchronize_sync_source_and_video_pullup ();
150
151         editor->setup_tooltips ();
152 }
153
154 bool
155 ARDOUR_UI::status_bar_button_press (GdkEventButton* ev)
156 {
157         bool handled = false;
158
159         switch (ev->button) {
160         case 1:
161                 status_bar_label.set_text ("");
162                 handled = true;
163                 break;
164         default:
165                 break;
166         }
167
168         return handled;
169 }
170
171 void
172 ARDOUR_UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
173 {
174         string text;
175
176         UI::display_message (prefix, prefix_len, ptag, mtag, msg);
177 #ifdef TOP_MENUBAR
178
179         if (strcmp (prefix, _("[ERROR]: ")) == 0) {
180                 text = "<span color=\"red\" weight=\"bold\">";
181         } else if (strcmp (prefix, _("[WARNING]: ")) == 0) {
182                 text = "<span color=\"yellow\" weight=\"bold\">";
183         } else if (strcmp (prefix, _("[INFO]: ")) == 0) {
184                 text = "<span color=\"green\" weight=\"bold\">";
185         } else {
186                 text = "<span color=\"white\" weight=\"bold\">???";
187         }
188
189         text += prefix;
190         text += "</span>";
191         text += msg;
192
193         status_bar_label.set_markup (text);
194 #endif
195 }
196
197 XMLNode*
198 ARDOUR_UI::tearoff_settings (const char* name) const
199 {
200         XMLNode* ui_node = Config->extra_xml(X_("UI"));
201
202         if (ui_node) {
203                 XMLNode* tearoff_node = ui_node->child (X_("Tearoffs"));
204                 if (tearoff_node) {
205                         XMLNode* mnode = tearoff_node->child (name);
206                         return mnode;
207                 }
208         }
209
210         return 0;
211 }
212
213 void
214 ARDOUR_UI::setup_transport ()
215 {
216         RefPtr<Action> act;
217
218         transport_tearoff_hbox.set_border_width (3);
219         transport_tearoff_hbox.set_spacing (3);
220
221         transport_tearoff = manage (new TearOff (transport_tearoff_hbox));
222         transport_tearoff->set_name ("TransportBase");
223         transport_tearoff->tearoff_window().signal_key_press_event().connect (sigc::bind (sigc::ptr_fun (relay_key_press), &transport_tearoff->tearoff_window()), false);
224
225         if (Profile->get_sae()) {
226                 transport_tearoff->set_can_be_torn_off (false);
227         }
228
229         transport_hbox.pack_start (*transport_tearoff, true, false);
230
231         transport_base.set_name ("TransportBase");
232         transport_base.add (transport_hbox);
233
234         transport_frame.set_shadow_type (SHADOW_OUT);
235         transport_frame.set_name ("BaseFrame");
236         transport_frame.add (transport_base);
237
238         transport_tearoff->Detach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
239                                                  static_cast<Widget*>(&transport_frame)));
240         transport_tearoff->Attach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
241                                                  static_cast<Widget*> (&transport_frame), 1));
242         transport_tearoff->Hidden.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
243                                                  static_cast<Widget*>(&transport_frame)));
244         transport_tearoff->Visible.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
245                                                   static_cast<Widget*> (&transport_frame), 1));
246
247         auto_return_button.set_text(_("Auto Return"));
248
249         follow_edits_button.set_text(_("Follow Edits"));
250
251 //      auto_input_button.set_text (_("Auto Input"));
252
253         click_button.set_image (get_icon (X_("metronome")));
254         act = ActionManager::get_action ("Transport", "ToggleClick");
255         click_button.set_related_action (act);
256         click_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::click_button_clicked), false);
257
258         auto_return_button.set_name ("transport option button");
259         follow_edits_button.set_name ("transport option button");
260         auto_input_button.set_name ("transport option button");
261
262         /* these have to provide a clear indication of active state */
263
264         click_button.set_name ("transport button");
265         sync_button.set_name ("transport active option button");
266
267         stop_button.set_active (true);
268
269         goto_start_button.set_image (get_icon (X_("transport_start")));
270         goto_end_button.set_image (get_icon (X_("transport_end")));
271         roll_button.set_image (get_icon (X_("transport_play")));
272         stop_button.set_image (get_icon (X_("transport_stop")));
273         play_selection_button.set_image (get_icon (X_("transport_range")));
274         rec_button.set_image (get_icon (X_("transport_record")));
275         auto_loop_button.set_image (get_icon (X_("transport_loop")));
276
277         midi_panic_button.set_image (get_icon (X_("midi_panic")));
278         /* the icon for this has an odd aspect ratio, so fatten up the button */
279         midi_panic_button.set_size_request (25, -1);
280         
281         act = ActionManager::get_action (X_("Transport"), X_("Stop"));
282         stop_button.set_related_action (act);
283         act = ActionManager::get_action (X_("Transport"), X_("Roll"));
284         roll_button.set_related_action (act);
285         act = ActionManager::get_action (X_("Transport"), X_("Record"));
286         rec_button.set_related_action (act);
287         act = ActionManager::get_action (X_("Transport"), X_("GotoStart"));
288         goto_start_button.set_related_action (act);
289         act = ActionManager::get_action (X_("Transport"), X_("GotoEnd"));
290         goto_end_button.set_related_action (act);
291         act = ActionManager::get_action (X_("Transport"), X_("Loop"));
292         auto_loop_button.set_related_action (act);
293         act = ActionManager::get_action (X_("Transport"), X_("PlaySelection"));
294         play_selection_button.set_related_action (act);
295         act = ActionManager::get_action (X_("MIDI"), X_("panic"));
296         midi_panic_button.set_related_action (act);
297         act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
298         sync_button.set_related_action (act);
299
300         /* clocks, etc. */
301
302         ARDOUR_UI::Clock.connect (sigc::mem_fun (primary_clock, &AudioClock::set));
303         ARDOUR_UI::Clock.connect (sigc::mem_fun (secondary_clock, &AudioClock::set));
304
305         primary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::primary_clock_value_changed));
306         secondary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::secondary_clock_value_changed));
307         big_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::big_clock_value_changed));
308
309         act = ActionManager::get_action ("Transport", "ToggleAutoReturn");
310         auto_return_button.set_related_action (act);
311         act = ActionManager::get_action (X_("Transport"), X_("ToggleFollowEdits"));
312         follow_edits_button.set_related_action (act);
313         act = ActionManager::get_action ("Transport", "ToggleAutoInput");
314         auto_input_button.set_related_action (act);
315
316         /* alerts */
317
318         /* CANNOT sigc::bind these to clicked or toggled, must use pressed or released */
319
320         solo_alert_button.set_name ("rude solo");
321         solo_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::solo_alert_press), false);
322         auditioning_alert_button.set_name ("rude audition");
323         auditioning_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::audition_alert_press), false);
324         feedback_alert_button.set_name ("feedback alert");
325         feedback_alert_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::feedback_alert_press), false);
326
327         alert_box.pack_start (solo_alert_button, true, false);
328         alert_box.pack_start (auditioning_alert_button, true, false);
329         alert_box.pack_start (feedback_alert_button, true, false);
330
331         /* all transport buttons should be the same size vertically and
332          * horizontally 
333          */
334
335         Glib::RefPtr<SizeGroup> transport_button_size_group = SizeGroup::create (SIZE_GROUP_BOTH);
336         transport_button_size_group->add_widget (goto_start_button);
337         transport_button_size_group->add_widget (goto_end_button);
338         transport_button_size_group->add_widget (auto_loop_button);
339         transport_button_size_group->add_widget (rec_button);
340         transport_button_size_group->add_widget (play_selection_button);
341         transport_button_size_group->add_widget (roll_button);
342         transport_button_size_group->add_widget (stop_button);
343
344         goto_start_button.set_size_request (-1, 40);
345
346         HBox* tbox1 = manage (new HBox);
347         HBox* tbox2 = manage (new HBox);
348         HBox* tbox = manage (new HBox);
349
350         VBox* vbox1 = manage (new VBox);
351         VBox* vbox2 = manage (new VBox);
352
353         Alignment* a1 = manage (new Alignment);
354         Alignment* a2 = manage (new Alignment);
355
356         tbox1->set_spacing (2);
357         tbox2->set_spacing (2);
358         tbox->set_spacing (2);
359
360         tbox1->pack_start (midi_panic_button, false, false, 5);
361         tbox1->pack_start (click_button, false, false, 5);
362         tbox1->pack_start (goto_start_button, false, false);
363         tbox1->pack_start (goto_end_button, false, false);
364         tbox1->pack_start (auto_loop_button, false, false);
365
366         tbox2->pack_start (play_selection_button, false, false);
367         tbox2->pack_start (roll_button, false, false);
368         tbox2->pack_start (stop_button, false, false);
369         tbox2->pack_start (rec_button, false, false, 5);
370
371         vbox1->pack_start (*tbox1, false, false);
372         vbox2->pack_start (*tbox2, false, false);
373
374         a1->add (*vbox1);
375         a1->set (0.5, 1.0, 0.0, 0.0);
376         a2->add (*vbox2);
377         a2->set (0.5, 1.0, 0.0, 0.0);
378
379         tbox->pack_start (*a1, false, false);
380         tbox->pack_start (*a2, false, false);
381
382         HBox* clock_box = manage (new HBox);
383
384         clock_box->pack_start (*primary_clock, false, false);
385         if (!ARDOUR::Profile->get_small_screen()) {
386                 clock_box->pack_start (*secondary_clock, false, false);
387         }
388         clock_box->set_spacing (3);
389
390         shuttle_box = new ShuttleControl;
391         shuttle_box->show ();
392
393         VBox* transport_vbox = manage (new VBox);
394         transport_vbox->set_name ("TransportBase");
395         transport_vbox->set_border_width (0);
396         transport_vbox->set_spacing (3);
397         transport_vbox->pack_start (*tbox, true, true, 0);
398         transport_vbox->pack_start (*shuttle_box, false, false, 0);
399
400         transport_tearoff_hbox.pack_start (*transport_vbox, false, false);
401
402         /* transport related toggle controls */
403
404         VBox* auto_box = manage (new VBox);
405         auto_box->set_homogeneous (true);
406         auto_box->set_spacing (2);
407         auto_box->pack_start (sync_button, false, false);
408         auto_box->pack_start (follow_edits_button, false, false);
409         auto_box->pack_start (auto_return_button, false, false);
410
411         transport_tearoff_hbox.pack_start (*auto_box, false, false);
412         transport_tearoff_hbox.pack_start (*clock_box, true, true);
413
414         time_info_box = manage (new TimeInfoBox);
415         transport_tearoff_hbox.pack_start (*time_info_box, false, false);
416
417         if (Profile->get_small_screen()) {
418                 transport_tearoff_hbox.pack_start (_editor_transport_box, false, false);
419         }
420         transport_tearoff_hbox.pack_start (alert_box, false, false);
421         transport_tearoff_hbox.pack_start (meter_box, false, false);
422         transport_tearoff_hbox.pack_start (editor_meter_peak_display, false, false);
423
424         if (Profile->get_sae()) {
425                 Image* img = manage (new Image ((::get_icon (X_("sae")))));
426                 transport_tearoff_hbox.pack_end (*img, false, false);
427         }
428
429         /* desensitize */
430
431         set_transport_sensitivity (false);
432
433         XMLNode* tnode = tearoff_settings ("transport");
434         if (tnode) {
435                 transport_tearoff->set_state (*tnode);
436         }
437 }
438
439 void
440 ARDOUR_UI::detach_tearoff (Box* b, Widget* w)
441 {
442 //      editor->ensure_float (transport_tearoff->tearoff_window());
443         b->remove (*w);
444 }
445
446 void
447 ARDOUR_UI::reattach_tearoff (Box* b, Widget* w, int32_t n)
448 {
449         b->pack_start (*w);
450         b->reorder_child (*w, n);
451 }
452
453 void
454 ARDOUR_UI::soloing_changed (bool onoff)
455 {
456         if (solo_alert_button.get_active() != onoff) {
457                 solo_alert_button.set_active (onoff);
458         }
459 }
460
461 void
462 ARDOUR_UI::_auditioning_changed (bool onoff)
463 {
464         auditioning_alert_button.set_active (onoff);
465         set_transport_sensitivity (!onoff);
466 }
467
468 void
469 ARDOUR_UI::auditioning_changed (bool onoff)
470 {
471         UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::_auditioning_changed, this, onoff));
472 }
473
474 bool
475 ARDOUR_UI::audition_alert_press (GdkEventButton*)
476 {
477         if (_session) {
478                 _session->cancel_audition();
479         }
480         return true;
481 }
482
483 bool
484 ARDOUR_UI::solo_alert_press (GdkEventButton*)
485 {
486         if (_session) {
487                 if (_session->soloing()) {
488                         _session->set_solo (_session->get_routes(), false);
489                 } else if (_session->listening()) {
490                         _session->set_listen (_session->get_routes(), false);
491                 }
492         }
493         return true;
494 }
495
496 bool
497 ARDOUR_UI::feedback_alert_press (GdkEventButton *)
498 {
499         return true;
500 }
501
502 void
503 ARDOUR_UI::solo_blink (bool onoff)
504 {
505         if (_session == 0) {
506                 return;
507         }
508
509         if (_session->soloing() || _session->listening()) {
510                 if (onoff) {
511                         solo_alert_button.set_active (true);
512                 } else {
513                         solo_alert_button.set_active (false);
514                 }
515         } else {
516                 solo_alert_button.set_active (false);
517         }
518 }
519
520 void
521 ARDOUR_UI::sync_blink (bool onoff)
522 {
523         if (_session == 0 || !_session->config.get_external_sync()) {
524                 /* internal sync */
525                 sync_button.set_active (false);
526                 return;
527         }
528
529         if (!_session->transport_locked()) {
530                 /* not locked, so blink on and off according to the onoff argument */
531
532                 if (onoff) {
533                         sync_button.set_active (true);
534                 } else {
535                         sync_button.set_active (false);
536                 }
537         } else {
538                 /* locked */
539                 sync_button.set_active (true);
540         }
541 }
542
543 void
544 ARDOUR_UI::audition_blink (bool onoff)
545 {
546         if (_session == 0) {
547                 return;
548         }
549
550         if (_session->is_auditioning()) {
551                 if (onoff) {
552                         auditioning_alert_button.set_active (true);
553                 } else {
554                         auditioning_alert_button.set_active (false);
555                 }
556         } else {
557                 auditioning_alert_button.set_active (false);
558         }
559 }
560
561 void
562 ARDOUR_UI::feedback_blink (bool onoff)
563 {
564         if (_feedback_exists) {
565                 if (onoff) {
566                         feedback_alert_button.set_active (true);
567                 } else {
568                         feedback_alert_button.set_active (false);
569                 }
570         } else {
571                 feedback_alert_button.set_active (false);
572         }
573 }
574
575 void
576 ARDOUR_UI::set_transport_sensitivity (bool yn)
577 {
578         ActionManager::set_sensitive (ActionManager::transport_sensitive_actions, yn);
579         shuttle_box->set_sensitive (yn);
580 }
581
582 void
583 ARDOUR_UI::editor_realized ()
584 {
585         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
586         Config->map_parameters (pc);
587
588         reset_dpi ();
589 }
590
591 void
592 ARDOUR_UI::update_tearoff_visibility ()
593 {
594         if (editor) {
595                 editor->update_tearoff_visibility ();
596         }
597 }
598
599 void
600 ARDOUR_UI::maximise_editing_space ()
601 {
602         if (editor) {
603                 editor->maximise_editing_space ();
604         }
605 }
606
607 void
608 ARDOUR_UI::restore_editing_space ()
609 {
610         if (editor) {
611                 editor->restore_editing_space ();
612         }
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_("Window"), X_("toggle-rc-options-editor"));
624         assert (act);
625
626         act->activate();
627
628         rc_option_editor->set_current_page (_("Misc"));
629         return true;
630 }
631
632 void
633 ARDOUR_UI::toggle_always_play_range ()
634 {
635         RefPtr<Action> act = ActionManager::get_action (X_("Transport"), X_("ToggleFollowEdits"));
636         assert (act);
637
638         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic (act);
639         assert (tact);
640
641         Config->set_always_play_range (tact->get_active ());
642 }
643
644