gtk2_ardour/ardour_ui_options.cc

   1 /*
   2     Copyright (C) 2005 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 "pbd/convert.h"
  25 #include "pbd/stacktrace.h"
  26
  27 #include <gtkmm2ext/utils.h>
  28
  29 #include "ardour/rc_configuration.h"
  30 #include "ardour/session.h"
  31
  32 #include "canvas/wave_view.h"
  33
  34 #include "audio_clock.h"
  35 #include "ardour_ui.h"
  36 #include "actions.h"
  37 #include "gui_thread.h"
  38 #include "public_editor.h"
  39 #include "main_clock.h"
  40
  41 #include "i18n.h"
  42
  43 using namespace Gtk;
  44 using namespace Gtkmm2ext;
  45 using namespace ARDOUR;
  46 using namespace PBD;
  47
  48 void
  49 ARDOUR_UI::toggle_keep_tearoffs ()
  50 {
  51         ActionManager::toggle_config_state ("Common", "KeepTearoffs", &UIConfiguration::set_keep_tearoffs, &UIConfiguration::get_keep_tearoffs);
  52
  53         ARDOUR_UI::update_tearoff_visibility();
  54 }
  55
  56 void
  57 ARDOUR_UI::toggle_external_sync()
  58 {
  59         if (_session) {
  60                 if (_session->config.get_video_pullup() != 0.0f) {
  61                         if (Config->get_sync_source() == Engine) {
  62                                 MessageDialog msg (
  63                                         _("It is not possible to use JACK as the the sync source\n\
  64 when the pull up/down setting is non-zero."));
  65                                 msg.run ();
  66                                 return;
  67                         }
  68                 }
  69
  70                 ActionManager::toggle_config_state_foo ("Transport", "ToggleExternalSync", sigc::mem_fun (_session->config, &SessionConfiguration::set_external_sync), sigc::mem_fun (_session->config, &SessionConfiguration::get_external_sync));
  71
  72                 /* activating a slave is a session-property.
  73                  * The slave type is a RC property.
  74                  * When the slave is active is must not be reconfigured.
  75                  * This is a UI limitation, imposed by audio-clock and
  76                  * status displays which combine RC-config & session-properties.
  77                  *
  78                  * Notficy RCOptionEditor by emitting a signal if the active
  79                  * status changed:
  80                  */
  81                 Config->ParameterChanged("sync-source");
  82         }
  83 }
  84
  85 void
  86 ARDOUR_UI::toggle_time_master ()
  87 {
  88         ActionManager::toggle_config_state_foo ("Transport", "ToggleTimeMaster", sigc::mem_fun (_session->config, &SessionConfiguration::set_jack_time_master), sigc::mem_fun (_session->config, &SessionConfiguration::get_jack_time_master));
  89 }
  90
  91 void
  92 ARDOUR_UI::toggle_send_mtc ()
  93 {
  94         ActionManager::toggle_config_state ("options", "SendMTC", &RCConfiguration::set_send_mtc, &RCConfiguration::get_send_mtc);
  95 }
  96
  97 void
  98 ARDOUR_UI::toggle_send_mmc ()
  99 {
 100         ActionManager::toggle_config_state ("options", "SendMMC", &RCConfiguration::set_send_mmc, &RCConfiguration::get_send_mmc);
 101 }
 102
 103 void
 104 ARDOUR_UI::toggle_send_midi_clock ()
 105 {
 106         ActionManager::toggle_config_state ("options", "SendMidiClock", &RCConfiguration::set_send_midi_clock, &RCConfiguration::get_send_midi_clock);
 107 }
 108
 109 void
 110 ARDOUR_UI::toggle_use_mmc ()
 111 {
 112         ActionManager::toggle_config_state ("options", "UseMMC", &RCConfiguration::set_mmc_control, &RCConfiguration::get_mmc_control);
 113 }
 114
 115 void
 116 ARDOUR_UI::toggle_send_midi_feedback ()
 117 {
 118         ActionManager::toggle_config_state ("options", "SendMIDIfeedback", &RCConfiguration::set_midi_feedback, &RCConfiguration::get_midi_feedback);
 119 }
 120
 121 void
 122 ARDOUR_UI::toggle_auto_input ()
 123 {
 124         ActionManager::toggle_config_state_foo ("Transport", "ToggleAutoInput", sigc::mem_fun (_session->config, &SessionConfiguration::set_auto_input), sigc::mem_fun (_session->config, &SessionConfiguration::get_auto_input));
 125 }
 126
 127 void
 128 ARDOUR_UI::toggle_auto_play ()
 129 {
 130         ActionManager::toggle_config_state_foo ("Transport", "ToggleAutoPlay", sigc::mem_fun (_session->config, &SessionConfiguration::set_auto_play), sigc::mem_fun (_session->config, &SessionConfiguration::get_auto_play));
 131 }
 132
 133 void
 134 ARDOUR_UI::toggle_auto_return ()
 135 {
 136         ActionManager::toggle_config_state_foo ("Transport", "ToggleAutoReturn", sigc::mem_fun (_session->config, &SessionConfiguration::set_auto_return), sigc::mem_fun (_session->config, &SessionConfiguration::get_auto_return));
 137 }
 138
 139 void
 140 ARDOUR_UI::toggle_click ()
 141 {
 142         ActionManager::toggle_config_state ("Transport", "ToggleClick", &RCConfiguration::set_clicking, &RCConfiguration::get_clicking);
 143 }
 144
 145 void
 146 ARDOUR_UI::unset_dual_punch ()
 147 {
 148         Glib::RefPtr<Action> action = ActionManager::get_action ("Transport", "TogglePunch");
 149
 150         if (action) {
 151                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(action);
 152                 if (tact) {
 153                         ignore_dual_punch = true;
 154                         tact->set_active (false);
 155                         ignore_dual_punch = false;
 156                 }
 157         }
 158 }
 159
 160 void
 161 ARDOUR_UI::toggle_punch ()
 162 {
 163         if (ignore_dual_punch) {
 164                 return;
 165         }
 166
 167         Glib::RefPtr<Action> action = ActionManager::get_action ("Transport", "TogglePunch");
 168
 169         if (action) {
 170
 171                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(action);
 172
 173                 if (!tact) {
 174                         return;
 175                 }
 176
 177                 /* drive the other two actions from this one */
 178
 179                 Glib::RefPtr<Action> in_action = ActionManager::get_action ("Transport", "TogglePunchIn");
 180                 Glib::RefPtr<Action> out_action = ActionManager::get_action ("Transport", "TogglePunchOut");
 181
 182                 if (in_action && out_action) {
 183                         Glib::RefPtr<ToggleAction> tiact = Glib::RefPtr<ToggleAction>::cast_dynamic(in_action);
 184                         Glib::RefPtr<ToggleAction> toact = Glib::RefPtr<ToggleAction>::cast_dynamic(out_action);
 185                         tiact->set_active (tact->get_active());
 186                         toact->set_active (tact->get_active());
 187                 }
 188         }
 189 }
 190
 191 void
 192 ARDOUR_UI::toggle_punch_in ()
 193 {
 194         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Transport"), X_("TogglePunchIn"));
 195         if (!act) {
 196                 return;
 197         }
 198
 199         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
 200         if (!tact) {
 201                 return;
 202         }
 203
 204         if (tact->get_active() != _session->config.get_punch_in()) {
 205                 _session->config.set_punch_in (tact->get_active ());
 206         }
 207
 208         if (tact->get_active()) {
 209                 /* if punch-in is turned on, make sure the loop/punch ruler is visible, and stop it being hidden,
 210                    to avoid confusing the user */
 211                 show_loop_punch_ruler_and_disallow_hide ();
 212         }
 213
 214         reenable_hide_loop_punch_ruler_if_appropriate ();
 215 }
 216
 217 void
 218 ARDOUR_UI::toggle_punch_out ()
 219 {
 220         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Transport"), X_("TogglePunchOut"));
 221         if (!act) {
 222                 return;
 223         }
 224
 225         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
 226         if (!tact) {
 227                 return;
 228         }
 229
 230         if (tact->get_active() != _session->config.get_punch_out()) {
 231                 _session->config.set_punch_out (tact->get_active ());
 232         }
 233
 234         if (tact->get_active()) {
 235                 /* if punch-out is turned on, make sure the loop/punch ruler is visible, and stop it being hidden,
 236                    to avoid confusing the user */
 237                 show_loop_punch_ruler_and_disallow_hide ();
 238         }
 239
 240         reenable_hide_loop_punch_ruler_if_appropriate ();
 241 }
 242
 243 void
 244 ARDOUR_UI::show_loop_punch_ruler_and_disallow_hide ()
 245 {
 246         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Rulers"), "toggle-loop-punch-ruler");
 247         if (!act) {
 248                 return;
 249         }
 250
 251         act->set_sensitive (false);
 252
 253         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
 254         if (!tact) {
 255                 return;
 256         }
 257
 258         if (!tact->get_active()) {
 259                 tact->set_active ();
 260         }
 261 }
 262
 263 /* This is a bit of a silly name for a method */
 264 void
 265 ARDOUR_UI::reenable_hide_loop_punch_ruler_if_appropriate ()
 266 {
 267         if (!_session->config.get_punch_in() && !_session->config.get_punch_out()) {
 268                 /* if punch in/out are now both off, reallow hiding of the loop/punch ruler */
 269                 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Rulers"), "toggle-loop-punch-ruler");
 270                 if (act) {
 271                         act->set_sensitive (true);
 272                 }
 273         }
 274 }
 275
 276 void
 277 ARDOUR_UI::toggle_video_sync()
 278 {
 279         Glib::RefPtr<Action> act = ActionManager::get_action ("Transport", "ToggleVideoSync");
 280         if (act) {
 281                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 282                 _session->config.set_use_video_sync (tact->get_active());
 283         }
 284 }
 285
 286 void
 287 ARDOUR_UI::toggle_editing_space()
 288 {
 289         Glib::RefPtr<Action> act = ActionManager::get_action ("Common", "ToggleMaximalEditor");
 290
 291         if (act) {
 292                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 293                 if (tact->get_active()) {
 294                         maximise_editing_space ();
 295                 } else {
 296                         restore_editing_space ();
 297                 }
 298         }
 299 }
 300
 301 void
 302 ARDOUR_UI::setup_session_options ()
 303 {
 304         _session->config.ParameterChanged.connect (_session_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::parameter_changed, this, _1), gui_context());
 305         boost::function<void (std::string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
 306         _session->config.map_parameters (pc);
 307 }
 308
 309 void
 310 ARDOUR_UI::parameter_changed (std::string p)
 311 {
 312         if (p == "external-sync") {
 313
 314                 ActionManager::map_some_state ("Transport", "ToggleExternalSync", sigc::mem_fun (_session->config, &SessionConfiguration::get_external_sync));
 315
 316                 if (!_session->config.get_external_sync()) {
 317                         sync_button.set_text (_("Internal"));
 318                         auto_loop_button.set_sensitive (true);
 319                         ActionManager::get_action ("Transport", "ToggleAutoPlay")->set_sensitive (true);
 320                         ActionManager::get_action ("Transport", "ToggleAutoReturn")->set_sensitive (true);
 321                         ActionManager::get_action ("Transport", "ToggleFollowEdits")->set_sensitive (true);
 322                 } else {
 323                         sync_button.set_text (sync_source_to_string (Config->get_sync_source(), true));
 324                         if (_session && _session->locations()->auto_loop_location()) {
 325                                 // disable looping with external sync.
 326                                 // This is not necessary because session-transport ignores the loop-state,
 327                                 // but makes it clear to the user that it's disabled.
 328                                 _session->request_play_loop (false, false);
 329                         }
 330                         auto_loop_button.set_sensitive (false);
 331                         /* XXX we need to make sure that auto-play is off as well as insensitive */
 332                         ActionManager::get_action ("Transport", "ToggleAutoPlay")->set_sensitive (false);
 333                         ActionManager::get_action ("Transport", "ToggleAutoReturn")->set_sensitive (false);
 334                         ActionManager::get_action ("Transport", "ToggleFollowEdits")->set_sensitive (false);
 335                 }
 336
 337         } else if (p == "follow-edits") {
 338
 339                 ActionManager::map_some_state ("Transport", "ToggleFollowEdits", &UIConfiguration::get_follow_edits);
 340
 341         } else if (p == "send-mtc") {
 342
 343                 ActionManager::map_some_state ("options", "SendMTC", &RCConfiguration::get_send_mtc);
 344
 345         } else if (p == "send-mmc") {
 346
 347                 ActionManager::map_some_state ("options", "SendMMC", &RCConfiguration::get_send_mmc);
 348
 349         } else if (p == "keep-tearoffs") {
 350                 ActionManager::map_some_state ("Common", "KeepTearoffs", &UIConfiguration::get_keep_tearoffs);
 351         } else if (p == "mmc-control") {
 352                 ActionManager::map_some_state ("options", "UseMMC", &RCConfiguration::get_mmc_control);
 353         } else if (p == "midi-feedback") {
 354                 ActionManager::map_some_state ("options", "SendMIDIfeedback", &RCConfiguration::get_midi_feedback);
 355         } else if (p == "auto-play") {
 356                 ActionManager::map_some_state ("Transport", "ToggleAutoPlay", sigc::mem_fun (_session->config, &SessionConfiguration::get_auto_play));
 357         } else if (p == "auto-return") {
 358                 ActionManager::map_some_state ("Transport", "ToggleAutoReturn", sigc::mem_fun (_session->config, &SessionConfiguration::get_auto_return));
 359         } else if (p == "auto-input") {
 360                 ActionManager::map_some_state ("Transport", "ToggleAutoInput", sigc::mem_fun (_session->config, &SessionConfiguration::get_auto_input));
 361         } else if (p == "punch-out") {
 362                 ActionManager::map_some_state ("Transport", "TogglePunchOut", sigc::mem_fun (_session->config, &SessionConfiguration::get_punch_out));
 363                 if (!_session->config.get_punch_out()) {
 364                         unset_dual_punch ();
 365                 }
 366         } else if (p == "punch-in") {
 367                 ActionManager::map_some_state ("Transport", "TogglePunchIn", sigc::mem_fun (_session->config, &SessionConfiguration::get_punch_in));
 368                 if (!_session->config.get_punch_in()) {
 369                         unset_dual_punch ();
 370                 }
 371         } else if (p == "clicking") {
 372                 ActionManager::map_some_state ("Transport", "ToggleClick", &RCConfiguration::get_clicking);
 373         } else if (p == "use-video-sync") {
 374                 ActionManager::map_some_state ("Transport",  "ToggleVideoSync", sigc::mem_fun (_session->config, &SessionConfiguration::get_use_video_sync));
 375         } else if (p == "sync-source") {
 376
 377                 synchronize_sync_source_and_video_pullup ();
 378                 set_fps_timeout_connection ();
 379
 380         } else if (p == "show-track-meters") {
 381                 if (editor) editor->toggle_meter_updating();
 382         } else if (p == "primary-clock-delta-edit-cursor") {
 383                 if (UIConfiguration::instance().get_primary_clock_delta_edit_cursor()) {
 384                         primary_clock->set_is_duration (true);
 385                         primary_clock->set_editable (false);
 386                         primary_clock->set_widget_name ("transport delta");
 387                 } else {
 388                         primary_clock->set_is_duration (false);
 389                         primary_clock->set_editable (true);
 390                         primary_clock->set_widget_name ("transport");
 391                 }
 392         } else if (p == "secondary-clock-delta-edit-cursor") {
 393                 if (UIConfiguration::instance().get_secondary_clock_delta_edit_cursor()) {
 394                         secondary_clock->set_is_duration (true);
 395                         secondary_clock->set_editable (false);
 396                         secondary_clock->set_widget_name ("secondary delta");
 397                 } else {
 398                         secondary_clock->set_is_duration (false);
 399                         secondary_clock->set_editable (true);
 400                         secondary_clock->set_widget_name ("secondary");
 401                 }
 402         } else if (p == "super-rapid-clock-update") {
 403                 if (_session) {
 404                         stop_clocking ();
 405                         start_clocking ();
 406                 }
 407         } else if (p == "waveform-gradient-depth") {
 408                 ArdourCanvas::WaveView::set_global_gradient_depth (UIConfiguration::instance().get_waveform_gradient_depth());
 409         } else if (p == "show-editor-meter") {
 410                 bool show = UIConfiguration::instance().get_show_editor_meter();
 411
 412                 if (editor_meter) {
 413                         if (meter_box.get_parent()) {
 414                                 transport_tearoff_hbox.remove (meter_box);
 415                                 transport_tearoff_hbox.remove (editor_meter_peak_display);
 416                         }
 417
 418                         if (show) {
 419                                 transport_tearoff_hbox.pack_start (meter_box, false, false);
 420                                 transport_tearoff_hbox.pack_start (editor_meter_peak_display, false, false);
 421                                 meter_box.show();
 422                                 editor_meter_peak_display.show();
 423                         }
 424                 }
 425         } else if (p == "waveform-scale") {
 426                 ArdourCanvas::WaveView::set_global_logscaled (UIConfiguration::instance().get_waveform_scale() == Logarithmic);
 427         } else if (p == "widget-prelight") {
 428                 CairoWidget::set_widget_prelight (UIConfiguration::instance().get_widget_prelight());
 429         } else if (p == "waveform-shape") {
 430                 ArdourCanvas::WaveView::set_global_shape (UIConfiguration::instance().get_waveform_shape() == Rectified
 431                                 ? ArdourCanvas::WaveView::Rectified : ArdourCanvas::WaveView::Normal);
 432         } else if (p == "show-waveform-clipping") {
 433                 ArdourCanvas::WaveView::set_global_show_waveform_clipping (UIConfiguration::instance().get_show_waveform_clipping());
 434         } else if (p == "waveform-cache-size") {
 435                 /* GUI option has units of megabytes; image cache uses units of bytes */
 436                 ArdourCanvas::WaveView::set_image_cache_size (UIConfiguration::instance().get_waveform_cache_size() * 1048576);
 437         }
 438 }
 439
 440 void
 441 ARDOUR_UI::session_parameter_changed (std::string p)
 442 {
 443         if (p == "native-file-data-format" || p == "native-file-header-format") {
 444                 update_format ();
 445         } else if (p == "timecode-format") {
 446                 set_fps_timeout_connection ();
 447         } else if (p == "video-pullup" || p == "timecode-format") {
 448                 set_fps_timeout_connection ();
 449
 450                 synchronize_sync_source_and_video_pullup ();
 451                 reset_main_clocks ();
 452                 editor->queue_visual_videotimeline_update();
 453         } else if (p == "track-name-number") {
 454                 /* DisplaySuspender triggers _route->redisplay() when going out of scope
 455                  * which eventually calls reset_controls_layout_width() and re-sets the
 456                  * track-header width.
 457                  * see also RouteTimeAxisView::update_track_number_visibility()
 458                  */
 459                 DisplaySuspender ds;
 460         }
 461 }
 462
 463 void
 464 ARDOUR_UI::reset_main_clocks ()
 465 {
 466         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::reset_main_clocks)
 467
 468         if (_session) {
 469                 primary_clock->set (_session->audible_frame(), true);
 470                 secondary_clock->set (_session->audible_frame(), true);
 471         } else {
 472                 primary_clock->set (0, true);
 473                 secondary_clock->set (0, true);
 474         }
 475 }
 476
 477 void
 478 ARDOUR_UI::synchronize_sync_source_and_video_pullup ()
 479 {
 480         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Transport"), X_("ToggleExternalSync"));
 481
 482         if (!act) {
 483                 return;
 484         }
 485
 486         if (!_session) {
 487                 goto just_label;
 488         }
 489
 490         if (_session->config.get_video_pullup() == 0.0f) {
 491                 /* with no video pull up/down, any sync source is OK */
 492                 act->set_sensitive (true);
 493         } else {
 494                 /* can't sync to JACK if video pullup != 0.0 */
 495                 if (Config->get_sync_source() == Engine) {
 496                         act->set_sensitive (false);
 497                 } else {
 498                         act->set_sensitive (true);
 499                 }
 500         }
 501
 502         /* XXX should really be able to set the video pull up
 503            action to insensitive/sensitive, but there is no action.
 504            FIXME
 505         */
 506
 507   just_label:
 508         if (act->get_sensitive ()) {
 509                 set_tip (sync_button, _("Enable/Disable external positional sync"));
 510         } else {
 511                 set_tip (sync_button, _("Sync to JACK is not possible: video pull up/down is set"));
 512         }
 513
 514 }
 515