7c3465241907e417ba4ec010069f63632ddc6731
[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         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);
216
217         if (Profile->get_sae()) {
218                 transport_tearoff->set_can_be_torn_off (false);
219         }
220
221         transport_hbox.pack_start (*transport_tearoff, true, false);
222
223         transport_base.set_name ("TransportBase");
224         transport_base.add (transport_hbox);
225
226         transport_frame.set_shadow_type (SHADOW_OUT);
227         transport_frame.set_name ("BaseFrame");
228         transport_frame.add (transport_base);
229
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));
238
239         auto_return_button.set_name ("TransportButton");
240         auto_play_button.set_name ("TransportButton");
241         auto_input_button.set_name ("TransportButton");
242         click_button.set_name ("TransportButton");
243         time_master_button.set_name ("TransportButton");
244         sync_button.set_name ("TransportSyncButton");
245
246         Widget* w;
247
248         stop_button.set_active_state (Active);
249
250         goto_start_button.set_image (get_icon (X_("transport_start")));
251         goto_end_button.set_image (get_icon (X_("transport_end")));
252         roll_button.set_image (get_icon (X_("transport_play")));
253         stop_button.set_image (get_icon (X_("transport_stop")));
254         play_selection_button.set_image (get_icon (X_("transport_range")));
255         rec_button.set_image (get_icon (X_("transport_record")));
256         auto_loop_button.set_image (get_icon (X_("transport_loop")));
257         join_play_range_button.set_image (get_icon (X_("tool_object_range")));
258
259         RefPtr<Action> act;
260
261         act = ActionManager::get_action (X_("Transport"), X_("Stop"));
262         stop_button.set_related_action (act);
263         act = ActionManager::get_action (X_("Transport"), X_("Roll"));
264         roll_button.set_related_action (act);
265         act = ActionManager::get_action (X_("Transport"), X_("Record"));
266         rec_button.set_related_action (act);
267         act = ActionManager::get_action (X_("Transport"), X_("GotoStart"));
268         goto_start_button.set_related_action (act);
269         act = ActionManager::get_action (X_("Transport"), X_("GotoEnd"));
270         goto_end_button.set_related_action (act);
271         act = ActionManager::get_action (X_("Transport"), X_("Loop"));
272         auto_loop_button.set_related_action (act);
273         act = ActionManager::get_action (X_("Transport"), X_("PlaySelection"));
274         play_selection_button.set_related_action (act);
275
276
277         act = ActionManager::get_action (X_("Transport"), X_("ToggleTimeMaster"));
278         act->connect_proxy (time_master_button);
279         act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
280         act->connect_proxy (sync_button);
281
282
283         /* clocks, etc. */
284
285         ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (primary_clock, &AudioClock::set), 'p'));
286         ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (secondary_clock, &AudioClock::set), 's'));
287
288         primary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::primary_clock_value_changed));
289         secondary_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::secondary_clock_value_changed));
290         big_clock->ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::big_clock_value_changed));
291
292         ActionManager::get_action ("Transport", "ToggleAutoReturn")->connect_proxy (auto_return_button);
293         ActionManager::get_action ("Transport", "ToggleAutoPlay")->connect_proxy (auto_play_button);
294         ActionManager::get_action ("Transport", "ToggleAutoInput")->connect_proxy (auto_input_button);
295
296         /* alerts */
297
298         /* CANNOT sigc::bind these to clicked or toggled, must use pressed or released */
299
300         solo_alert_button.set_name ("TransportSoloAlert");
301         solo_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::solo_alert_press), false);
302         auditioning_alert_button.set_name ("TransportAuditioningAlert");
303         auditioning_alert_button.signal_button_press_event().connect (sigc::mem_fun(*this,&ARDOUR_UI::audition_alert_press), false);
304
305         alert_box.pack_start (solo_alert_button, false, false);
306         alert_box.pack_start (auditioning_alert_button, false, false);
307
308         HBox* tbox = manage (new HBox);
309         tbox->set_spacing (2);
310
311         transport_tearoff_hbox.set_border_width (3);
312
313         tbox->pack_start (goto_start_button, false, false);
314         tbox->pack_start (goto_end_button, false, false);
315
316         /* translators: Egternal is "External" with a descender character */
317         set_size_request_to_display_given_text (sync_button, X_("Egternal"), 4, 10);
318
319         // transport_tearoff_hbox.pack_start (*svbox, false, false, 3);
320
321         if (Profile->get_sae()) {
322                 tbox->pack_start (auto_loop_button);
323                 tbox->pack_start (roll_button);
324         } else {
325                 tbox->pack_start (auto_loop_button, false, false);
326
327                 Frame* jpframe = manage (new Frame);
328                 HBox* jpbox = manage (new HBox);
329
330                 jpframe->add (*jpbox);
331                 jpframe->set_shadow_type (SHADOW_NONE);
332                 
333                 jpbox->pack_start (play_selection_button, false, false);
334                 jpbox->pack_start (join_play_range_button, false, false);
335                 jpbox->pack_start (roll_button, false, false);
336
337                 tbox->pack_start (*jpframe, false, false);
338         }
339         tbox->pack_start (stop_button, false, false);
340         tbox->pack_start (rec_button, false, false, 6);
341
342         HBox* clock_box = manage (new HBox);
343         clock_box->set_border_width (2);
344         primary_clock->set_border_width (2);
345         clock_box->pack_start (*primary_clock, false, false);
346         if (!ARDOUR::Profile->get_small_screen()) {
347                 secondary_clock->set_border_width (2);
348                 clock_box->pack_start (*secondary_clock, false, false);
349         }
350
351
352         shuttle_box = new ShuttleControl;
353         shuttle_box->show ();
354
355         VBox* transport_vbox = manage (new VBox);
356         transport_vbox->set_name ("TransportBase");
357         transport_vbox->set_border_width (3);
358         transport_vbox->set_spacing (3);
359         transport_vbox->pack_start (*tbox, true, true, 0);
360         transport_vbox->pack_start (*shuttle_box, false, false, 0);
361
362         transport_tearoff_hbox.pack_start (*transport_vbox, false, false, 0);
363
364         Table* time_controls_table = manage (new Table (2, 2));
365         time_controls_table->set_col_spacings (6);
366         time_controls_table->attach (sync_button, 0, 1, 0, 1, Gtk::AttachOptions(FILL|EXPAND), Gtk::AttachOptions(0));
367         time_controls_table->attach (time_master_button, 0, 1, 1, 2, Gtk::AttachOptions(FILL|EXPAND), Gtk::AttachOptions(0));
368
369         w = manage (new Image (get_icon (X_("metronome"))));
370         w->show ();
371         click_button.add (*w);
372
373         ActionManager::get_action ("Transport", "ToggleClick")->connect_proxy (click_button);
374
375         click_button.signal_button_press_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::click_button_clicked), false);
376         
377         time_controls_table->attach (click_button, 1, 2, 0, 2, Gtk::AttachOptions(FILL|EXPAND), FILL);
378
379         transport_tearoff_hbox.pack_start (*clock_box, false, false);
380         transport_tearoff_hbox.pack_start (*time_controls_table, false, false, 4);
381
382         time_info_box = manage (new TimeInfoBox);
383         transport_tearoff_hbox.pack_start (*time_info_box, false, false);
384
385         HBox* toggle_box = manage(new HBox);
386
387         VBox* auto_box = manage (new VBox);
388         auto_box->pack_start (auto_play_button, false, false);
389         auto_box->pack_start (auto_return_button, false, false);
390         if (!Profile->get_small_screen()) {
391                 toggle_box->pack_start (*auto_box, false, false);
392         }
393
394         VBox* io_box = manage (new VBox);
395         io_box->pack_start (auto_input_button, false, false);
396         //io_box->pack_start (click_button, false, false);
397         if (!Profile->get_small_screen()) {
398                 toggle_box->pack_start (*io_box, false, false);
399         }
400
401         /* desensitize */
402
403         set_transport_sensitivity (false);
404
405         transport_tearoff_hbox.pack_start (*toggle_box, false, false, 4);
406         if (Profile->get_small_screen()) {
407                 transport_tearoff_hbox.pack_start (_editor_transport_box, false, false, 4);
408         }
409         transport_tearoff_hbox.pack_start (alert_box, false, false);
410
411         if (Profile->get_sae()) {
412                 Image* img = manage (new Image ((::get_icon (X_("sae")))));
413                 transport_tearoff_hbox.pack_end (*img, false, false, 6);
414         }
415
416         XMLNode* tnode = tearoff_settings ("transport");
417         if (tnode) {
418                 transport_tearoff->set_state (*tnode);
419         }
420 }
421
422 void
423 ARDOUR_UI::manage_window (Window& win)
424 {
425         win.signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), &win));
426         win.signal_enter_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::enter_window), &win));
427         win.signal_leave_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::leave_window), &win));
428 }
429
430 void
431 ARDOUR_UI::detach_tearoff (Box* b, Widget* w)
432 {
433 //      editor->ensure_float (transport_tearoff->tearoff_window());
434         b->remove (*w);
435 }
436
437 void
438 ARDOUR_UI::reattach_tearoff (Box* b, Widget* w, int32_t n)
439 {
440         b->pack_start (*w);
441         b->reorder_child (*w, n);
442 }
443
444 void
445 ARDOUR_UI::soloing_changed (bool onoff)
446 {
447         if (solo_alert_button.get_active() != onoff) {
448                 solo_alert_button.set_active (onoff);
449         }
450 }
451
452 void
453 ARDOUR_UI::_auditioning_changed (bool onoff)
454 {
455         if (auditioning_alert_button.get_active() != onoff) {
456                 auditioning_alert_button.set_active (onoff);
457                 set_transport_sensitivity (!onoff);
458         }
459 }
460
461 void
462 ARDOUR_UI::auditioning_changed (bool onoff)
463 {
464         UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::_auditioning_changed, this, onoff));
465 }
466
467 bool
468 ARDOUR_UI::audition_alert_press (GdkEventButton*)
469 {
470         if (_session) {
471                 _session->cancel_audition();
472         }
473         return true;
474 }
475
476 bool
477 ARDOUR_UI::solo_alert_press (GdkEventButton*)
478 {
479         if (_session) {
480                 if (_session->soloing()) {
481                         _session->set_solo (_session->get_routes(), false);
482                 } else if (_session->listening()) {
483                         _session->set_listen (_session->get_routes(), false);
484                 }
485         }
486         return true;
487 }
488
489 void
490 ARDOUR_UI::solo_blink (bool onoff)
491 {
492         if (_session == 0) {
493                 return;
494         }
495
496         if (_session->soloing() || _session->listening()) {
497                 if (onoff) {
498                         solo_alert_button.set_state (STATE_ACTIVE);
499                 } else {
500                         solo_alert_button.set_state (STATE_NORMAL);
501                 }
502         } else {
503                 solo_alert_button.set_active (false);
504                 solo_alert_button.set_state (STATE_NORMAL);
505         }
506 }
507
508 void
509 ARDOUR_UI::sync_blink (bool onoff)
510 {
511         if (_session == 0 || !_session->config.get_external_sync()) {
512                 /* internal sync */
513                 sync_button.set_visual_state (0);
514                 return;
515         }
516
517         if (!_session->transport_locked()) {
518                 /* not locked, so blink on and off according to the onoff argument */
519
520                 if (onoff) {
521                         sync_button.set_visual_state (1); // "-active"
522                 } else {
523                         sync_button.set_visual_state (0); // normal
524                 }
525         } else {
526                 /* locked */
527                 sync_button.set_visual_state (1); // "-active"
528         }
529 }
530
531 void
532 ARDOUR_UI::audition_blink (bool onoff)
533 {
534         if (_session == 0) {
535                 return;
536         }
537
538         if (_session->is_auditioning()) {
539                 if (onoff) {
540                         auditioning_alert_button.set_state (STATE_ACTIVE);
541                 } else {
542                         auditioning_alert_button.set_state (STATE_NORMAL);
543                 }
544         } else {
545                 auditioning_alert_button.set_active (false);
546                 auditioning_alert_button.set_state (STATE_NORMAL);
547         }
548 }
549
550 void
551 ARDOUR_UI::set_transport_sensitivity (bool yn)
552 {
553         ActionManager::set_sensitive (ActionManager::transport_sensitive_actions, yn);
554         shuttle_box->set_sensitive (yn);
555 }
556
557 void
558 ARDOUR_UI::editor_realized ()
559 {
560         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
561         Config->map_parameters (pc);
562
563         reset_dpi ();
564 }
565
566 void
567 ARDOUR_UI::maximise_editing_space ()
568 {
569         if (!editor) {
570                 return;
571         }
572
573         transport_tearoff->set_visible (false);
574         editor->maximise_editing_space ();
575         if (Config->get_keep_tearoffs()) {
576                 transport_tearoff->set_visible (true);
577         }
578 }
579
580 void
581 ARDOUR_UI::restore_editing_space ()
582 {
583         if (!editor) {
584                 return;
585         }
586
587         transport_tearoff->set_visible (true);
588         editor->restore_editing_space ();
589 }
590
591 bool
592 ARDOUR_UI::click_button_clicked (GdkEventButton* ev)
593 {
594         if (ev->button != 3) {
595                 /* this handler is just for button-3 clicks */
596                 return false;
597         }
598
599         RefPtr<Action> act = ActionManager::get_action (X_("Common"), X_("ToggleRCOptionsEditor"));
600         assert (act);
601
602         RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic (act);
603         tact->set_active ();
604
605         rc_option_editor->set_current_page (_("Misc"));
606         return true;
607 }