Add tooltips for link buttons.
[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 #include <fcntl.h>
21 #include <signal.h>
22 #include <unistd.h>
23 #include <cerrno>
24 #include <iostream>
25 #include <cmath>
26
27 #include <sigc++/bind.h>
28 #include "pbd/error.h"
29 #include "pbd/basename.h"
30 #include "pbd/fastlog.h"
31 #include <gtkmm2ext/utils.h>
32 #include <gtkmm2ext/click_box.h>
33 #include <gtkmm2ext/tearoff.h>
34
35 #include "ardour/session.h"
36 #include "ardour/audioengine.h"
37 #include "ardour/ardour.h"
38 #include "ardour/profile.h"
39 #include "ardour/route.h"
40
41 #include "ardour_ui.h"
42 #include "keyboard.h"
43 #include "public_editor.h"
44 #include "audio_clock.h"
45 #include "actions.h"
46 #include "utils.h"
47 #include "theme_manager.h"
48
49 #include "i18n.h"
50
51 using namespace std;
52 using namespace ARDOUR;
53 using namespace PBD;
54 using namespace Gtkmm2ext;
55 using namespace Gtk;
56 using namespace Glib;
57
58 int
59 ARDOUR_UI::setup_windows ()
60 {
61         if (create_editor ()) {
62                 error << _("UI: cannot setup editor") << endmsg;
63                 return -1;
64         }
65
66         if (create_mixer ()) {
67                 error << _("UI: cannot setup mixer") << endmsg;
68                 return -1;
69         }
70
71         /* all other dialogs are created conditionally */
72
73         we_have_dependents ();
74
75         setup_clock ();
76         setup_transport();
77         build_menu_bar ();
78
79         theme_manager->signal_unmap().connect (sigc::bind (sigc::ptr_fun(&ActionManager::uncheck_toggleaction), X_("<Actions>/Common/ToggleThemeManager")));
80
81 #ifdef TOP_MENUBAR
82         HBox* status_bar_packer = manage (new HBox);
83
84         status_bar_label.set_size_request (300, -1);
85         status_bar_packer->pack_start (status_bar_label, true, true, 6);
86         status_bar_packer->pack_start (error_log_button, false, false);
87
88         error_log_button.signal_clicked().connect (sigc::mem_fun (*this, &UI::toggle_errors));
89
90         editor->get_status_bar_packer().pack_start (*status_bar_packer, true, true);
91         editor->get_status_bar_packer().pack_start (menu_bar_base, false, false, 6);
92 #else
93         top_packer.pack_start (menu_bar_base, false, false);
94 #endif
95
96         top_packer.pack_start (transport_frame, false, false);
97
98         editor->add_toplevel_controls (top_packer);
99
100         return 0;
101 }
102
103 void
104 ARDOUR_UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
105 {
106         ustring text;
107
108         UI::display_message (prefix, prefix_len, ptag, mtag, msg);
109 #ifdef TOP_MENUBAR
110
111         if (strcmp (prefix, _("[ERROR]: ")) == 0) {
112                 text = "<span color=\"red\" weight=\"bold\">";
113         } else if (strcmp (prefix, _("[WARNING]: ")) == 0) {
114                 text = "<span color=\"yellow\" weight=\"bold\">";
115         } else if (strcmp (prefix, _("[INFO]: ")) == 0) {
116                 text = "<span color=\"green\" weight=\"bold\">";
117         } else {
118                 text = "<span color=\"white\" weight=\"bold\">???";
119         }
120
121         text += prefix;
122         text += "</span>";
123         text += msg;
124
125         status_bar_label.set_markup (text);
126 #endif
127 }
128
129 #if 0
130 static bool
131 null_crossing (GdkEventCrossing* /* ignored */)
132 {
133         return true;
134 }
135
136 static void
137 block_prelight (Gtk::Widget& w)
138 {
139         w.signal_enter_notify_event().connect (sigc::ptr_fun (null_crossing), false);
140         w.signal_leave_notify_event().connect (sigc::ptr_fun (null_crossing), false);
141 }
142 #endif
143
144 void
145 ARDOUR_UI::setup_transport ()
146 {
147         transport_tearoff = manage (new TearOff (transport_tearoff_hbox));
148         transport_tearoff->set_name ("TransportBase");
149         transport_tearoff->tearoff_window().signal_key_press_event().connect (sigc::bind (sigc::ptr_fun (relay_key_press), &transport_tearoff->tearoff_window()), false);
150
151         if (Profile->get_sae()) {
152                 transport_tearoff->set_can_be_torn_off (false);
153         }
154
155         transport_hbox.pack_start (*transport_tearoff, true, false);
156
157         transport_base.set_name ("TransportBase");
158         transport_base.add (transport_hbox);
159
160         transport_frame.set_shadow_type (SHADOW_OUT);
161         transport_frame.set_name ("BaseFrame");
162         transport_frame.add (transport_base);
163
164         transport_tearoff->Detach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
165                                                  static_cast<Widget*>(&transport_frame)));
166         transport_tearoff->Attach.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
167                                                  static_cast<Widget*> (&transport_frame), 1));
168         transport_tearoff->Hidden.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::detach_tearoff), static_cast<Box*>(&top_packer),
169                                                  static_cast<Widget*>(&transport_frame)));
170         transport_tearoff->Visible.connect (sigc::bind (sigc::mem_fun(*this, &ARDOUR_UI::reattach_tearoff), static_cast<Box*> (&top_packer),
171                                                   static_cast<Widget*> (&transport_frame), 1));
172
173         shuttle_box.set_name ("TransportButton");
174         goto_start_button.set_name ("TransportButton");
175         goto_end_button.set_name ("TransportButton");
176         roll_button.set_name ("TransportButton");
177         stop_button.set_name ("TransportButton");
178         play_selection_button.set_name ("TransportButton");
179         rec_button.set_name ("TransportRecButton");
180         auto_loop_button.set_name ("TransportButton");
181         join_play_range_button.set_name ("TransportButton");
182
183         auto_return_button.set_name ("TransportButton");
184         auto_play_button.set_name ("TransportButton");
185         auto_input_button.set_name ("TransportButton");
186         punch_in_button.set_name ("TransportButton");
187         punch_out_button.set_name ("TransportButton");
188         click_button.set_name ("TransportButton");
189         time_master_button.set_name ("TransportButton");
190         sync_button.set_name ("TransportSyncButton");
191
192         stop_button.set_size_request(29, -1);
193         roll_button.set_size_request(29, -1);
194         auto_loop_button.set_size_request(29, -1);
195         play_selection_button.set_size_request(29, -1);
196         goto_start_button.set_size_request(29, -1);
197         goto_end_button.set_size_request(29, -1);
198         rec_button.set_size_request(29, -1);
199
200         Widget* w;
201
202         stop_button.set_visual_state (1);
203
204         w = manage (new Image (get_icon (X_("transport_start"))));
205         w->show();
206         goto_start_button.add (*w);
207         w = manage (new Image (get_icon (X_("transport_end"))));
208         w->show();
209         goto_end_button.add (*w);
210         w = manage (new Image (get_icon (X_("transport_play"))));
211         w->show();
212         roll_button.add (*w);
213         w = manage (new Image (get_icon (X_("transport_stop"))));
214         w->show();
215         stop_button.add (*w);
216         w = manage (new Image (get_icon (X_("transport_range"))));
217         w->show();
218         play_selection_button.add (*w);
219         w = manage (new Image (get_icon (X_("transport_record"))));
220         w->show();
221         rec_button.add (*w);
222         w = manage (new Image (get_icon (X_("transport_loop"))));
223         w->show();
224         auto_loop_button.add (*w);
225         w = manage (new Image (get_icon (X_("join_tools"))));
226         w->show ();
227         join_play_range_button.add (*w);
228
229         RefPtr<Action> act;
230
231         act = ActionManager::get_action (X_("Transport"), X_("Stop"));
232         act->connect_proxy (stop_button);
233         act = ActionManager::get_action (X_("Transport"), X_("Roll"));
234         act->connect_proxy (roll_button);
235         act = ActionManager::get_action (X_("Transport"), X_("Record"));
236         act->connect_proxy (rec_button);
237         act = ActionManager::get_action (X_("Transport"), X_("GotoStart"));
238         act->connect_proxy (goto_start_button);
239         act = ActionManager::get_action (X_("Transport"), X_("GotoEnd"));
240         act->connect_proxy (goto_end_button);
241         act = ActionManager::get_action (X_("Transport"), X_("Loop"));
242         act->connect_proxy (auto_loop_button);
243         act = ActionManager::get_action (X_("Transport"), X_("PlaySelection"));
244         act->connect_proxy (play_selection_button);
245         act = ActionManager::get_action (X_("Transport"), X_("ToggleTimeMaster"));
246         act->connect_proxy (time_master_button);
247         act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
248         act->connect_proxy (sync_button);
249
250         ARDOUR_UI::instance()->tooltips().set_tip (roll_button, _("Play from playhead"));
251         ARDOUR_UI::instance()->tooltips().set_tip (stop_button, _("Stop playback"));
252         ARDOUR_UI::instance()->tooltips().set_tip (play_selection_button, _("Play range/selection"));
253         ARDOUR_UI::instance()->tooltips().set_tip (join_play_range_button, _("Always play range/selection"));
254         ARDOUR_UI::instance()->tooltips().set_tip (goto_start_button, _("Go to start of session"));
255         ARDOUR_UI::instance()->tooltips().set_tip (goto_end_button, _("Go to end of session"));
256         ARDOUR_UI::instance()->tooltips().set_tip (auto_loop_button, _("Play loop range"));
257
258         ARDOUR_UI::instance()->tooltips().set_tip (auto_return_button, _("Return to last playback start when stopped"));
259         ARDOUR_UI::instance()->tooltips().set_tip (auto_play_button, _("Start playback after any locate"));
260         ARDOUR_UI::instance()->tooltips().set_tip (auto_input_button, _("Be sensible about input monitoring"));
261         ARDOUR_UI::instance()->tooltips().set_tip (punch_in_button, _("Start recording at auto-punch start"));
262         ARDOUR_UI::instance()->tooltips().set_tip (punch_out_button, _("Stop recording at auto-punch end"));
263         ARDOUR_UI::instance()->tooltips().set_tip (click_button, _("Enable/Disable audio click"));
264         ARDOUR_UI::instance()->tooltips().set_tip (sync_button, _("Enable/Disable external positional sync"));
265         ARDOUR_UI::instance()->tooltips().set_tip (time_master_button, _("Does Ardour control the time?"));
266         ARDOUR_UI::instance()->tooltips().set_tip (shuttle_box, _("Shuttle speed control"));
267         ARDOUR_UI::instance()->tooltips().set_tip (shuttle_units_button, _("Select semitones or %%-age for speed display"));
268         ARDOUR_UI::instance()->tooltips().set_tip (speed_display_box, _("Current transport speed"));
269
270
271         shuttle_box.set_flags (CAN_FOCUS);
272         shuttle_box.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::POINTER_MOTION_MASK|Gdk::SCROLL_MASK);
273         shuttle_box.set_size_request (100, 15);
274
275         shuttle_box.signal_button_press_event().connect (sigc::mem_fun(*this, &ARDOUR_UI::shuttle_box_button_press));
276         shuttle_box.signal_button_release_event().connect (sigc::mem_fun(*this, &ARDOUR_UI::shuttle_box_button_release));
277         shuttle_box.signal_scroll_event().connect (sigc::mem_fun(*this, &ARDOUR_UI::shuttle_box_scroll));
278         shuttle_box.signal_motion_notify_event().connect (sigc::mem_fun(*this, &ARDOUR_UI::shuttle_box_motion));
279         shuttle_box.signal_expose_event().connect (sigc::mem_fun(*this, &ARDOUR_UI::shuttle_box_expose));
280
281         /* clocks, etc. */
282
283         ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (primary_clock, &AudioClock::set), 'p'));
284         ARDOUR_UI::Clock.connect (sigc::bind (sigc::mem_fun (secondary_clock, &AudioClock::set), 's'));
285
286         primary_clock.ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::primary_clock_value_changed));
287         secondary_clock.ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::secondary_clock_value_changed));
288         big_clock.ValueChanged.connect (sigc::mem_fun(*this, &ARDOUR_UI::big_clock_value_changed));
289
290         ARDOUR_UI::instance()->tooltips().set_tip (primary_clock, _("Primary clock"));
291         ARDOUR_UI::instance()->tooltips().set_tip (secondary_clock, _("secondary clock"));
292
293         ActionManager::get_action ("Transport", "ToggleAutoReturn")->connect_proxy (auto_return_button);
294         ActionManager::get_action ("Transport", "ToggleAutoPlay")->connect_proxy (auto_play_button);
295         ActionManager::get_action ("Transport", "ToggleAutoInput")->connect_proxy (auto_input_button);
296         ActionManager::get_action ("Transport", "ToggleClick")->connect_proxy (click_button);
297         ActionManager::get_action ("Transport", "TogglePunchIn")->connect_proxy (punch_in_button);
298         ActionManager::get_action ("Transport", "TogglePunchOut")->connect_proxy (punch_out_button);
299
300         preroll_button.set_name ("TransportButton");
301         postroll_button.set_name ("TransportButton");
302
303         preroll_clock.set_mode (AudioClock::MinSec);
304         preroll_clock.set_name ("TransportClockDisplay");
305         postroll_clock.set_mode (AudioClock::MinSec);
306         postroll_clock.set_name ("TransportClockDisplay");
307
308         /* alerts */
309
310         /* CANNOT sigc::bind these to clicked or toggled, must use pressed or released */
311
312         solo_alert_button.set_name ("TransportSoloAlert");
313         solo_alert_button.signal_pressed().connect (sigc::mem_fun(*this,&ARDOUR_UI::solo_alert_toggle));
314         auditioning_alert_button.set_name ("TransportAuditioningAlert");
315         auditioning_alert_button.signal_pressed().connect (sigc::mem_fun(*this,&ARDOUR_UI::audition_alert_toggle));
316
317         tooltips().set_tip (solo_alert_button, _("When active, something is soloed.\nClick to de-solo everything"));
318         tooltips().set_tip (auditioning_alert_button, _("When active, auditioning is taking place\nClick to stop the audition"));
319
320         alert_box.pack_start (solo_alert_button, false, false);
321         alert_box.pack_start (auditioning_alert_button, false, false);
322
323         transport_tearoff_hbox.set_border_width (3);
324
325         transport_tearoff_hbox.pack_start (goto_start_button, false, false);
326         transport_tearoff_hbox.pack_start (goto_end_button, false, false);
327
328         Frame* sframe = manage (new Frame);
329         VBox*  svbox = manage (new VBox);
330         HBox*  shbox = manage (new HBox);
331
332         sframe->set_shadow_type (SHADOW_IN);
333         sframe->add (shuttle_box);
334
335         shuttle_box.set_name (X_("ShuttleControl"));
336
337         speed_display_box.add (speed_display_label);
338         speed_display_box.set_name (X_("ShuttleDisplay"));
339         set_size_request_to_display_given_text (speed_display_label, X_("> 24.0"), 2, 2);
340
341         shuttle_units_button.set_name (X_("ShuttleButton"));
342         shuttle_units_button.signal_clicked().connect (sigc::mem_fun(*this, &ARDOUR_UI::shuttle_unit_clicked));
343
344         shuttle_style_button.set_name (X_("ShuttleStyleButton"));
345
346         vector<string> shuttle_strings;
347         shuttle_strings.push_back (_("sprung"));
348         shuttle_strings.push_back (_("wheel"));
349         set_popdown_strings (shuttle_style_button, shuttle_strings, true);
350         shuttle_style_button.signal_changed().connect (sigc::mem_fun (*this, &ARDOUR_UI::shuttle_style_changed));
351
352         Frame* sdframe = manage (new Frame);
353
354         sdframe->set_shadow_type (SHADOW_IN);
355         sdframe->add (speed_display_box);
356
357         /* translators: Egternal is "External" with a descender character */
358         set_size_request_to_display_given_text (sync_button, X_("Egternal"), 4, 10);
359
360         shbox->pack_start (*sdframe, false, false);
361         shbox->pack_start (shuttle_units_button, true, true);
362         shbox->pack_start (shuttle_style_button, false, false);
363
364         svbox->pack_start (*sframe, false, false);
365         svbox->pack_start (*shbox, false, false);
366
367         transport_tearoff_hbox.pack_start (*svbox, false, false, 3);
368
369         if (Profile->get_sae()) {
370                 transport_tearoff_hbox.pack_start (auto_loop_button);
371                 transport_tearoff_hbox.pack_start (roll_button);
372         } else {
373                 transport_tearoff_hbox.pack_start (auto_loop_button, false, false);
374                 play_range_hbox.pack_start (play_selection_button, false, false);
375                 play_range_hbox.pack_start (roll_button, false, false);
376                 play_range_vbox.pack_start (play_range_hbox, false, false);
377                 play_range_vbox.pack_start (join_play_range_button, false, false);
378                 transport_tearoff_hbox.pack_start (play_range_vbox, false, false);
379         }
380         transport_tearoff_hbox.pack_start (stop_button, false, false);
381         transport_tearoff_hbox.pack_start (rec_button, false, false, 6);
382
383         HBox* clock_box = manage (new HBox);
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
389         if (!Profile->get_sae()) {
390                 VBox* time_controls_box = manage (new VBox);
391                 time_controls_box->pack_start (sync_button, false, false);
392                 time_controls_box->pack_start (time_master_button, false, false);
393                 clock_box->pack_start (*time_controls_box, false, false, 1);
394         }
395
396         transport_tearoff_hbox.pack_start (*clock_box, false, false, 0);
397
398         HBox* toggle_box = manage(new HBox);
399
400         VBox* punch_box = manage (new VBox);
401         punch_box->pack_start (punch_in_button, false, false);
402         punch_box->pack_start (punch_out_button, false, false);
403         toggle_box->pack_start (*punch_box, false, false);
404
405         VBox* auto_box = manage (new VBox);
406         auto_box->pack_start (auto_play_button, false, false);
407         auto_box->pack_start (auto_return_button, false, false);
408         toggle_box->pack_start (*auto_box, false, false);
409
410         VBox* io_box = manage (new VBox);
411         io_box->pack_start (auto_input_button, false, false);
412         io_box->pack_start (click_button, false, false);
413         toggle_box->pack_start (*io_box, false, false);
414
415         /* desensitize */
416
417         set_transport_sensitivity (false);
418
419 //      toggle_box->pack_start (preroll_button, false, false);
420 //      toggle_box->pack_start (preroll_clock, false, false);
421
422 //      toggle_box->pack_start (postroll_button, false, false);
423 //      toggle_box->pack_start (postroll_clock, false, false);
424
425         transport_tearoff_hbox.pack_start (*toggle_box, false, false, 4);
426         transport_tearoff_hbox.pack_start (alert_box, false, false);
427
428         if (Profile->get_sae()) {
429                 Image* img = manage (new Image ((::get_icon (X_("sae")))));
430                 transport_tearoff_hbox.pack_end (*img, false, false, 6);
431         }
432 }
433
434 void
435 ARDOUR_UI::manage_window (Window& win)
436 {
437         win.signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), &win));
438         win.signal_enter_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::enter_window), &win));
439         win.signal_leave_notify_event().connect (sigc::bind (sigc::mem_fun (Keyboard::the_keyboard(), &Keyboard::leave_window), &win));
440 }
441
442 void
443 ARDOUR_UI::detach_tearoff (Box* b, Widget* w)
444 {
445 //      editor->ensure_float (transport_tearoff->tearoff_window());
446         b->remove (*w);
447 }
448
449 void
450 ARDOUR_UI::reattach_tearoff (Box* b, Widget* w, int32_t n)
451 {
452         b->pack_start (*w);
453         b->reorder_child (*w, n);
454 }
455
456 void
457 ARDOUR_UI::soloing_changed (bool onoff)
458 {
459         if (solo_alert_button.get_active() != onoff) {
460                 solo_alert_button.set_active (onoff);
461         }
462 }
463
464 void
465 ARDOUR_UI::_auditioning_changed (bool onoff)
466 {
467         if (auditioning_alert_button.get_active() != onoff) {
468                 auditioning_alert_button.set_active (onoff);
469                 set_transport_sensitivity (!onoff);
470         }
471 }
472
473 void
474 ARDOUR_UI::auditioning_changed (bool onoff)
475 {
476         UI::instance()->call_slot (boost::bind (&ARDOUR_UI::_auditioning_changed, this, onoff));
477 }
478
479 void
480 ARDOUR_UI::audition_alert_toggle ()
481 {
482         if (_session) {
483                 _session->cancel_audition();
484         }
485 }
486
487 void
488 ARDOUR_UI::solo_alert_toggle ()
489 {
490         if (_session) {
491                 _session->set_solo (_session->get_routes(), !_session->soloing());
492         }
493 }
494
495 void
496 ARDOUR_UI::solo_blink (bool onoff)
497 {
498         if (_session == 0) {
499                 return;
500         }
501
502         if (_session->soloing()) {
503                 if (onoff) {
504                         solo_alert_button.set_state (STATE_ACTIVE);
505                 } else {
506                         solo_alert_button.set_state (STATE_NORMAL);
507                 }
508         } else {
509                 solo_alert_button.set_active (false);
510                 solo_alert_button.set_state (STATE_NORMAL);
511         }
512 }
513
514 void
515 ARDOUR_UI::sync_blink (bool onoff)
516 {
517         if (_session == 0 || !_session->config.get_external_sync()) {
518                 /* internal sync */
519                 sync_button.set_visual_state (0);
520                 return;
521         }
522
523         if (!_session->transport_locked()) {
524                 /* not locked, so blink on and off according to the onoff argument */
525
526                 if (onoff) {
527                         sync_button.set_visual_state (1); // "-active"
528                 } else {
529                         sync_button.set_visual_state (0); // normal
530                 }
531         } else {
532                 /* locked */
533                 sync_button.set_visual_state (1); // "-active"
534         }
535 }
536
537 void
538 ARDOUR_UI::audition_blink (bool onoff)
539 {
540         if (_session == 0) {
541                 return;
542         }
543
544         if (_session->is_auditioning()) {
545                 if (onoff) {
546                         auditioning_alert_button.set_state (STATE_ACTIVE);
547                 } else {
548                         auditioning_alert_button.set_state (STATE_NORMAL);
549                 }
550         } else {
551                 auditioning_alert_button.set_active (false);
552                 auditioning_alert_button.set_state (STATE_NORMAL);
553         }
554 }
555
556 void
557 ARDOUR_UI::build_shuttle_context_menu ()
558 {
559         using namespace Menu_Helpers;
560
561         shuttle_context_menu = new Menu();
562         MenuList& items = shuttle_context_menu->items();
563
564         Menu* speed_menu = manage (new Menu());
565         MenuList& speed_items = speed_menu->items();
566
567         RadioMenuItem::Group group;
568
569         speed_items.push_back (RadioMenuElem (group, "8", sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::set_shuttle_max_speed), 8.0f)));
570         if (shuttle_max_speed == 8.0) {
571                 static_cast<RadioMenuItem*>(&speed_items.back())->set_active ();
572         }
573         speed_items.push_back (RadioMenuElem (group, "6", sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::set_shuttle_max_speed), 6.0f)));
574         if (shuttle_max_speed == 6.0) {
575                 static_cast<RadioMenuItem*>(&speed_items.back())->set_active ();
576         }
577         speed_items.push_back (RadioMenuElem (group, "4", sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::set_shuttle_max_speed), 4.0f)));
578         if (shuttle_max_speed == 4.0) {
579                 static_cast<RadioMenuItem*>(&speed_items.back())->set_active ();
580         }
581         speed_items.push_back (RadioMenuElem (group, "3", sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::set_shuttle_max_speed), 3.0f)));
582         if (shuttle_max_speed == 3.0) {
583                 static_cast<RadioMenuItem*>(&speed_items.back())->set_active ();
584         }
585         speed_items.push_back (RadioMenuElem (group, "2", sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::set_shuttle_max_speed), 2.0f)));
586         if (shuttle_max_speed == 2.0) {
587                 static_cast<RadioMenuItem*>(&speed_items.back())->set_active ();
588         }
589         speed_items.push_back (RadioMenuElem (group, "1.5", sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::set_shuttle_max_speed), 1.5f)));
590         if (shuttle_max_speed == 1.5) {
591                 static_cast<RadioMenuItem*>(&speed_items.back())->set_active ();
592         }
593
594         items.push_back (MenuElem (_("Maximum speed"), *speed_menu));
595 }
596
597 void
598 ARDOUR_UI::show_shuttle_context_menu ()
599 {
600         if (shuttle_context_menu == 0) {
601                 build_shuttle_context_menu ();
602         }
603
604         shuttle_context_menu->popup (1, gtk_get_current_event_time());
605 }
606
607 void
608 ARDOUR_UI::set_shuttle_max_speed (float speed)
609 {
610         shuttle_max_speed = speed;
611 }
612
613 gint
614 ARDOUR_UI::shuttle_box_button_press (GdkEventButton* ev)
615 {
616         if (!_session) {
617                 return true;
618         }
619
620         if (shuttle_controller_binding_proxy.button_press_handler (ev)) {
621                 return true;
622         }
623
624         if (Keyboard::is_context_menu_event (ev)) {
625                 show_shuttle_context_menu ();
626                 return true;
627         }
628
629         switch (ev->button) {
630         case 1:
631                 shuttle_box.add_modal_grab ();
632                 shuttle_grabbed = true;
633                 mouse_shuttle (ev->x, true);
634                 break;
635
636         case 2:
637         case 3:
638                 return true;
639                 break;
640         }
641
642         return true;
643 }
644
645 gint
646 ARDOUR_UI::shuttle_box_button_release (GdkEventButton* ev)
647 {
648         if (!_session) {
649                 return true;
650         }
651
652         switch (ev->button) {
653         case 1:
654                 mouse_shuttle (ev->x, true);
655                 shuttle_grabbed = false;
656                 shuttle_box.remove_modal_grab ();
657                 if (Config->get_shuttle_behaviour() == Sprung) {
658                         if (_session->config.get_auto_play() || roll_button.get_visual_state()) {
659                                 shuttle_fract = SHUTTLE_FRACT_SPEED1;
660                                 _session->request_transport_speed (1.0);
661                                 stop_button.set_visual_state (0);
662                                 roll_button.set_visual_state (1);
663                         } else {
664                                 shuttle_fract = 0;
665                                 _session->request_transport_speed (0.0);
666                         }
667                         shuttle_box.queue_draw ();
668                 }
669                 return true;
670
671         case 2:
672                 if (_session->transport_rolling()) {
673                         shuttle_fract = SHUTTLE_FRACT_SPEED1;
674                         _session->request_transport_speed (1.0);
675                         stop_button.set_visual_state (0);
676                         roll_button.set_visual_state (1);
677                 } else {
678                         shuttle_fract = 0;
679                 }
680                 shuttle_box.queue_draw ();
681                 return true;
682
683         case 3:
684         default:
685                 return true;
686
687         }
688
689         use_shuttle_fract (true);
690
691         return true;
692 }
693
694 gint
695 ARDOUR_UI::shuttle_box_scroll (GdkEventScroll* ev)
696 {
697         if (!_session) {
698                 return true;
699         }
700
701         switch (ev->direction) {
702
703         case GDK_SCROLL_UP:
704                 shuttle_fract += 0.005;
705                 break;
706         case GDK_SCROLL_DOWN:
707                 shuttle_fract -= 0.005;
708                 break;
709         default:
710                 /* scroll left/right */
711                 return false;
712         }
713
714         use_shuttle_fract (true);
715
716         return true;
717 }
718
719 gint
720 ARDOUR_UI::shuttle_box_motion (GdkEventMotion* ev)
721 {
722         if (!_session || !shuttle_grabbed) {
723                 return true;
724         }
725
726         return mouse_shuttle (ev->x, false);
727 }
728
729 gint
730 ARDOUR_UI::mouse_shuttle (double x, bool force)
731 {
732         double half_width = shuttle_box.get_width() / 2.0;
733         double distance = x - half_width;
734
735         if (distance > 0) {
736                 distance = min (distance, half_width);
737         } else {
738                 distance = max (distance, -half_width);
739         }
740
741         shuttle_fract = distance / half_width;
742         use_shuttle_fract (force);
743         return true;
744 }
745
746 void
747 ARDOUR_UI::set_shuttle_fract (double f)
748 {
749         shuttle_fract = f;
750         use_shuttle_fract (false);
751 }
752
753 void
754 ARDOUR_UI::use_shuttle_fract (bool force)
755 {
756         microseconds_t now = get_microseconds();
757
758         /* do not attempt to submit a motion-driven transport speed request
759            more than once per process cycle.
760          */
761
762         if (!force && (last_shuttle_request - now) < (microseconds_t) engine->usecs_per_cycle()) {
763                 return;
764         }
765
766         last_shuttle_request = now;
767
768         if (Config->get_shuttle_units() == Semitones) {
769
770                 const double step = 1.0 / 24.0; // range is 24 semitones up & down
771                 double semitones;
772                 double speed;
773
774                 semitones = round (shuttle_fract / step);
775                 speed = pow (2.0, (semitones / 12.0));
776
777                 _session->request_transport_speed (speed);
778
779         } else {
780
781                 bool neg;
782                 double fract;
783
784                 neg = (shuttle_fract < 0.0);
785
786                 fract = 1 - sqrt (1 - (shuttle_fract * shuttle_fract)); // Formula A1
787
788                 if (neg) {
789                         fract = -fract;
790                 }
791
792                 _session->request_transport_speed (shuttle_max_speed * fract);
793         }
794
795         shuttle_box.queue_draw ();
796 }
797
798 gint
799 ARDOUR_UI::shuttle_box_expose (GdkEventExpose* event)
800 {
801         gint x;
802         Glib::RefPtr<Gdk::Window> win (shuttle_box.get_window());
803
804         /* redraw the background */
805
806         win->draw_rectangle (shuttle_box.get_style()->get_bg_gc (shuttle_box.get_state()),
807                              true,
808                              event->area.x, event->area.y,
809                              event->area.width, event->area.height);
810
811
812         x = (gint) floor ((shuttle_box.get_width() / 2.0) + (0.5 * (shuttle_box.get_width() * shuttle_fract)));
813
814         /* draw line */
815
816         win->draw_line (shuttle_box.get_style()->get_fg_gc (shuttle_box.get_state()),
817                         x,
818                         0,
819                         x,
820                         shuttle_box.get_height());
821         return true;
822 }
823
824 void
825 ARDOUR_UI::shuttle_unit_clicked ()
826 {
827         if (shuttle_unit_menu == 0) {
828                 shuttle_unit_menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/ShuttleUnitPopup"));
829         }
830         shuttle_unit_menu->popup (1, gtk_get_current_event_time());
831 }
832
833 void
834 ARDOUR_UI::shuttle_style_changed ()
835 {
836         ustring str = shuttle_style_button.get_active_text ();
837
838         if (str == _("sprung")) {
839                 Config->set_shuttle_behaviour (Sprung);
840         } else if (str == _("wheel")) {
841                 Config->set_shuttle_behaviour (Wheel);
842         }
843 }
844
845 void
846 ARDOUR_UI::update_speed_display ()
847 {
848         if (!_session) {
849                 if (last_speed_displayed != 0) {
850                         speed_display_label.set_text (_("stop"));
851                         last_speed_displayed = 0;
852                 }
853                 return;
854         }
855
856         char buf[32];
857         float x = _session->transport_speed ();
858
859         if (x != last_speed_displayed) {
860
861                 if (x != 0) {
862                         if (Config->get_shuttle_units() == Percentage) {
863                                 snprintf (buf, sizeof (buf), "%.2f", x);
864                         } else {
865
866                                 if (x < 0) {
867                                         snprintf (buf, sizeof (buf), "< %d", (int) round (12.0 * fast_log2 (-x)));
868                                 } else {
869                                         snprintf (buf, sizeof (buf), "> %d", (int) round (12.0 * fast_log2 (x)));
870                                 }
871                         }
872                         speed_display_label.set_text (buf);
873                 } else {
874                         speed_display_label.set_text (_("stop"));
875                 }
876
877                 last_speed_displayed = x;
878         }
879 }
880
881 void
882 ARDOUR_UI::set_transport_sensitivity (bool yn)
883 {
884         ActionManager::set_sensitive (ActionManager::transport_sensitive_actions, yn);
885         shuttle_box.set_sensitive (yn);
886 }
887
888 void
889 ARDOUR_UI::editor_realized ()
890 {
891         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
892         Config->map_parameters (pc);
893
894         set_size_request_to_display_given_text (speed_display_box, _("-0.55"), 2, 2);
895         reset_dpi ();
896 }
897
898 void
899 ARDOUR_UI::maximise_editing_space ()
900 {
901         if (!editor) {
902                 return;
903         }
904
905         transport_tearoff->set_visible (false);
906         editor->maximise_editing_space ();
907 }
908
909 void
910 ARDOUR_UI::restore_editing_space ()
911 {
912         if (!editor) {
913                 return;
914         }
915
916         transport_tearoff->set_visible (true);
917         editor->restore_editing_space ();
918 }