gtk2_ardour/ardour_ui.cc

   1 /*
   2     Copyright (C) 1999-2013 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 #include "gtk2ardour-version.h"
  23 #endif
  24
  25 #include <algorithm>
  26 #include <cmath>
  27 #include <iostream>
  28 #include <cerrno>
  29 #include <fstream>
  30
  31 #ifndef PLATFORM_WINDOWS
  32 #include <sys/resource.h>
  33 #endif
  34
  35 #include <stdint.h>
  36 #include <fcntl.h>
  37 #include <signal.h>
  38 #include <unistd.h>
  39 #include <time.h>
  40
  41 #include <glib.h>
  42 #include <glib/gstdio.h>
  43
  44 #include <gtkmm/messagedialog.h>
  45 #include <gtkmm/accelmap.h>
  46
  47 #include "pbd/error.h"
  48 #include "pbd/basename.h"
  49 #include "pbd/compose.h"
  50 #include "pbd/failed_constructor.h"
  51 #include "pbd/enumwriter.h"
  52 #include "pbd/memento_command.h"
  53 #include "pbd/openuri.h"
  54 #include "pbd/stl_delete.h"
  55 #include "pbd/file_utils.h"
  56 #include "pbd/localtime_r.h"
  57 #include "pbd/pthread_utils.h"
  58
  59 #include "gtkmm2ext/application.h"
  60 #include "gtkmm2ext/bindings.h"
  61 #include "gtkmm2ext/gtk_ui.h"
  62 #include "gtkmm2ext/utils.h"
  63 #include "gtkmm2ext/click_box.h"
  64 #include "gtkmm2ext/fastmeter.h"
  65 #include "gtkmm2ext/popup.h"
  66 #include "gtkmm2ext/window_title.h"
  67
  68 #include "ardour/ardour.h"
  69 #include "ardour/audio_backend.h"
  70 #include "ardour/audioengine.h"
  71 #include "ardour/audiofilesource.h"
  72 #include "ardour/automation_watch.h"
  73 #include "ardour/diskstream.h"
  74 #include "ardour/filename_extensions.h"
  75 #include "ardour/filesystem_paths.h"
  76 #include "ardour/port.h"
  77 #include "ardour/plugin_manager.h"
  78 #include "ardour/process_thread.h"
  79 #include "ardour/profile.h"
  80 #include "ardour/recent_sessions.h"
  81 #include "ardour/session_directory.h"
  82 #include "ardour/session_route.h"
  83 #include "ardour/session_state_utils.h"
  84 #include "ardour/session_utils.h"
  85 #include "ardour/slave.h"
  86 #include "ardour/system_exec.h"
  87
  88 #ifdef WINDOWS_VST_SUPPORT
  89 #include <fst.h>
  90 #endif
  91 #ifdef AUDIOUNIT_SUPPORT
  92 #include "ardour/audio_unit.h"
  93 #endif
  94
  95 #include "timecode/time.h"
  96
  97 typedef uint64_t microseconds_t;
  98
  99 #include "about.h"
 100 #include "actions.h"
 101 #include "add_route_dialog.h"
 102 #include "ambiguous_file_dialog.h"
 103 #include "ardour_ui.h"
 104 #include "audio_clock.h"
 105 #include "big_clock_window.h"
 106 #include "bundle_manager.h"
 107 #include "engine_dialog.h"
 108 #include "export_video_dialog.h"
 109 #include "export_video_infobox.h"
 110 #include "gain_meter.h"
 111 #include "global_port_matrix.h"
 112 #include "gui_object.h"
 113 #include "gui_thread.h"
 114 #include "keyboard.h"
 115 #include "keyeditor.h"
 116 #include "location_ui.h"
 117 #include "main_clock.h"
 118 #include "missing_file_dialog.h"
 119 #include "missing_plugin_dialog.h"
 120 #include "mixer_ui.h"
 121 #include "mouse_cursors.h"
 122 #include "nsm.h"
 123 #include "opts.h"
 124 #include "pingback.h"
 125 #include "processor_box.h"
 126 #include "prompter.h"
 127 #include "public_editor.h"
 128 #include "rc_option_editor.h"
 129 #include "route_time_axis.h"
 130 #include "route_params_ui.h"
 131 #include "session_dialog.h"
 132 #include "session_metadata_dialog.h"
 133 #include "session_option_editor.h"
 134 #include "shuttle_control.h"
 135 #include "speaker_dialog.h"
 136 #include "splash.h"
 137 #include "startup.h"
 138 #include "theme_manager.h"
 139 #include "time_axis_view_item.h"
 140 #include "timers.h"
 141 #include "utils.h"
 142 #include "video_server_dialog.h"
 143 #include "add_video_dialog.h"
 144 #include "transcode_video_dialog.h"
 145
 146 #include "i18n.h"
 147
 148 using namespace ARDOUR;
 149 using namespace ARDOUR_UI_UTILS;
 150 using namespace PBD;
 151 using namespace Gtkmm2ext;
 152 using namespace Gtk;
 153 using namespace std;
 154
 155 ARDOUR_UI *ARDOUR_UI::theArdourUI = 0;
 156
 157 sigc::signal<void, framepos_t, bool, framepos_t> ARDOUR_UI::Clock;
 158 sigc::signal<void>      ARDOUR_UI::CloseAllDialogs;
 159
 160
 161 static bool
 162 ask_about_configuration_copy (string const & old_dir, string const & new_dir, int version)
 163 {
 164         MessageDialog msg (string_compose (_("%1 %2.x has discovered configuration files from %1 %3.x.\n\n"
 165                                              "Would you like these files to be copied and used for %1 %2.x?\n\n"
 166                                              "(This will require you to restart %1.)"),
 167                                            PROGRAM_NAME, PROGRAM_VERSION, version),
 168                            false, /* no markup */
 169                            Gtk::MESSAGE_INFO,
 170                            Gtk::BUTTONS_YES_NO,
 171                            true /* modal, though it hardly matters since it is the only window */
 172                 );
 173
 174         msg.set_default_response (Gtk::RESPONSE_YES);
 175         msg.show_all ();
 176
 177         return (msg.run() == Gtk::RESPONSE_YES);
 178 }
 179
 180 ARDOUR_UI::ARDOUR_UI (int *argcp, char **argvp[], const char* localedir)
 181
 182         : Gtkmm2ext::UI (PROGRAM_NAME, argcp, argvp)
 183         , ui_config (new UIConfiguration)
 184         , gui_object_state (new GUIObjectState)
 185
 186         , primary_clock (new MainClock (X_("primary"), false, X_("transport"), true, true, true, false, true))
 187         , secondary_clock (new MainClock (X_("secondary"), false, X_("secondary"), true, true, false, false, true))
 188
 189           /* big clock */
 190
 191         , big_clock (new AudioClock (X_("bigclock"), false, "big", true, true, false, false))
 192         , video_timeline(0)
 193
 194           /* start of private members */
 195         , editor (0)
 196         , mixer (0)
 197         , nsm (0)
 198         , _was_dirty (false)
 199         , _mixer_on_top (false)
 200         , first_time_engine_run (true)
 201
 202           /* transport */
 203
 204         , roll_controllable (new TransportControllable ("transport roll", *this, TransportControllable::Roll))
 205         , stop_controllable (new TransportControllable ("transport stop", *this, TransportControllable::Stop))
 206         , goto_start_controllable (new TransportControllable ("transport goto start", *this, TransportControllable::GotoStart))
 207         , goto_end_controllable (new TransportControllable ("transport goto end", *this, TransportControllable::GotoEnd))
 208         , auto_loop_controllable (new TransportControllable ("transport auto loop", *this, TransportControllable::AutoLoop))
 209         , play_selection_controllable (new TransportControllable ("transport play selection", *this, TransportControllable::PlaySelection))
 210         , rec_controllable (new TransportControllable ("transport rec-enable", *this, TransportControllable::RecordEnable))
 211
 212         , auto_return_button (ArdourButton::led_default_elements)
 213         , follow_edits_button (ArdourButton::led_default_elements)
 214         , auto_input_button (ArdourButton::led_default_elements)
 215
 216         , auditioning_alert_button (_("Audition"))
 217         , solo_alert_button (_("Solo"))
 218         , feedback_alert_button (_("Feedback"))
 219         , error_alert_button ( ArdourButton::just_led_default_elements )
 220
 221         , editor_meter(0)
 222         , editor_meter_peak_display()
 223
 224         , speaker_config_window (X_("speaker-config"), _("Speaker Configuration"))
 225         , key_editor (X_("key-editor"), _("Key Bindings"))
 226         , rc_option_editor (X_("rc-options-editor"), _("Preferences"))
 227         , add_route_dialog (X_("add-routes"), _("Add Tracks/Busses"))
 228         , about (X_("about"), _("About"))
 229         , location_ui (X_("locations"), _("Locations"))
 230         , route_params (X_("inspector"), _("Tracks and Busses"))
 231         , audio_midi_setup (X_("audio-midi-setup"), _("Audio/MIDI Setup"))
 232         , export_video_dialog (X_("video-export"), _("Video Export Dialog"))
 233         , session_option_editor (X_("session-options-editor"), _("Properties"), boost::bind (&ARDOUR_UI::create_session_option_editor, this))
 234         , add_video_dialog (X_("add-video"), _("Add Tracks/Busses"), boost::bind (&ARDOUR_UI::create_add_video_dialog, this))
 235         , bundle_manager (X_("bundle-manager"), _("Bundle Manager"), boost::bind (&ARDOUR_UI::create_bundle_manager, this))
 236         , big_clock_window (X_("big-clock"), _("Big Clock"), boost::bind (&ARDOUR_UI::create_big_clock_window, this))
 237         , audio_port_matrix (X_("audio-connection-manager"), _("Audio Connections"), boost::bind (&ARDOUR_UI::create_global_port_matrix, this, ARDOUR::DataType::AUDIO))
 238         , midi_port_matrix (X_("midi-connection-manager"), _("MIDI Connections"), boost::bind (&ARDOUR_UI::create_global_port_matrix, this, ARDOUR::DataType::MIDI))
 239
 240         , _status_bar_visibility (X_("status-bar"))
 241         , _feedback_exists (false)
 242         , _log_not_acknowledged (LogLevelNone)
 243 {
 244         Gtkmm2ext::init(localedir);
 245
 246         if (ARDOUR::handle_old_configuration_files (boost::bind (ask_about_configuration_copy, _1, _2, _3))) {
 247                 MessageDialog msg (string_compose (_("Your configuration files were copied. You can now restart %1."), PROGRAM_NAME), true);
 248                 msg.run ();
 249                 /* configuration was modified, exit immediately */
 250                 _exit (0);
 251         }
 252
 253
 254         splash = 0;
 255
 256         _numpad_locate_happening = false;
 257
 258         if (theArdourUI == 0) {
 259                 theArdourUI = this;
 260         }
 261
 262         ui_config->ParameterChanged.connect (sigc::mem_fun (*this, &ARDOUR_UI::parameter_changed));
 263         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
 264         ui_config->map_parameters (pc);
 265
 266         editor = 0;
 267         mixer = 0;
 268         meterbridge = 0;
 269         editor = 0;
 270         _session_is_new = false;
 271         session_selector_window = 0;
 272         last_key_press_time = 0;
 273         video_server_process = 0;
 274         open_session_selector = 0;
 275         have_configure_timeout = false;
 276         have_disk_speed_dialog_displayed = false;
 277         session_loaded = false;
 278         ignore_dual_punch = false;
 279
 280         roll_button.set_controllable (roll_controllable);
 281         stop_button.set_controllable (stop_controllable);
 282         goto_start_button.set_controllable (goto_start_controllable);
 283         goto_end_button.set_controllable (goto_end_controllable);
 284         auto_loop_button.set_controllable (auto_loop_controllable);
 285         play_selection_button.set_controllable (play_selection_controllable);
 286         rec_button.set_controllable (rec_controllable);
 287
 288         roll_button.set_name ("transport button");
 289         stop_button.set_name ("transport button");
 290         goto_start_button.set_name ("transport button");
 291         goto_end_button.set_name ("transport button");
 292         auto_loop_button.set_name ("transport button");
 293         play_selection_button.set_name ("transport button");
 294         rec_button.set_name ("transport recenable button");
 295         midi_panic_button.set_name ("transport button");
 296
 297         last_configure_time= 0;
 298         last_peak_grab = 0;
 299
 300         ARDOUR::Diskstream::DiskOverrun.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::disk_overrun_handler, this), gui_context());
 301         ARDOUR::Diskstream::DiskUnderrun.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::disk_underrun_handler, this), gui_context());
 302
 303         ARDOUR::Session::VersionMismatch.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::session_format_mismatch, this, _1, _2), gui_context());
 304
 305         /* handle dialog requests */
 306
 307         ARDOUR::Session::Dialog.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::session_dialog, this, _1), gui_context());
 308
 309         /* handle pending state with a dialog (PROBLEM: needs to return a value and thus cannot be x-thread) */
 310
 311         ARDOUR::Session::AskAboutPendingState.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::pending_state_dialog, this));
 312
 313         /* handle Audio/MIDI setup when session requires it */
 314
 315         ARDOUR::Session::AudioEngineSetupRequired.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::do_audio_midi_setup, this, _1));
 316
 317         /* handle sr mismatch with a dialog (PROBLEM: needs to return a value and thus cannot be x-thread) */
 318
 319         ARDOUR::Session::AskAboutSampleRateMismatch.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::sr_mismatch_dialog, this, _1, _2));
 320
 321         /* handle requests to quit (coming from JACK session) */
 322
 323         ARDOUR::Session::Quit.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::finish, this), gui_context ());
 324
 325         /* tell the user about feedback */
 326
 327         ARDOUR::Session::FeedbackDetected.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::feedback_detected, this), gui_context ());
 328         ARDOUR::Session::SuccessfulGraphSort.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::successful_graph_sort, this), gui_context ());
 329
 330         /* handle requests to deal with missing files */
 331
 332         ARDOUR::Session::MissingFile.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::missing_file, this, _1, _2, _3));
 333
 334         /* and ambiguous files */
 335
 336         ARDOUR::FileSource::AmbiguousFileName.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::ambiguous_file, this, _1, _2));
 337
 338         /* also plugin scan messages */
 339         ARDOUR::PluginScanMessage.connect (forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::plugin_scan_dialog, this, _1, _2, _3), gui_context());
 340         ARDOUR::PluginScanTimeout.connect (forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::plugin_scan_timeout, this, _1), gui_context());
 341
 342         ARDOUR::GUIIdle.connect (forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::gui_idle_handler, this), gui_context());
 343
 344         Config->ParameterChanged.connect ( forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::set_flat_buttons, this), gui_context() );
 345         set_flat_buttons();
 346
 347         /* lets get this party started */
 348
 349         setup_gtk_ardour_enums ();
 350         setup_profile ();
 351
 352         SessionEvent::create_per_thread_pool ("GUI", 512);
 353
 354         /* we like keyboards */
 355
 356         keyboard = new ArdourKeyboard(*this);
 357
 358         XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
 359         if (node) {
 360                 keyboard->set_state (*node, Stateful::loading_state_version);
 361         }
 362
 363         /* we don't like certain modifiers */
 364         Bindings::set_ignored_state (GDK_LOCK_MASK|GDK_MOD2_MASK|GDK_MOD3_MASK);
 365
 366         reset_dpi();
 367
 368         TimeAxisViewItem::set_constant_heights ();
 369
 370         /* Set this up so that our window proxies can register actions */
 371
 372         ActionManager::init ();
 373
 374         /* The following must happen after ARDOUR::init() so that Config is set up */
 375
 376         const XMLNode* ui_xml = Config->extra_xml (X_("UI"));
 377
 378         if (ui_xml) {
 379                 key_editor.set_state (*ui_xml);
 380                 rc_option_editor.set_state (*ui_xml);
 381                 session_option_editor.set_state (*ui_xml);
 382                 speaker_config_window.set_state (*ui_xml);
 383                 about.set_state (*ui_xml);
 384                 add_route_dialog.set_state (*ui_xml);
 385                 add_video_dialog.set_state (*ui_xml);
 386                 route_params.set_state (*ui_xml);
 387                 bundle_manager.set_state (*ui_xml);
 388                 location_ui.set_state (*ui_xml);
 389                 big_clock_window.set_state (*ui_xml);
 390                 audio_port_matrix.set_state (*ui_xml);
 391                 midi_port_matrix.set_state (*ui_xml);
 392                 export_video_dialog.set_state (*ui_xml);
 393         }
 394
 395         WM::Manager::instance().register_window (&key_editor);
 396         WM::Manager::instance().register_window (&rc_option_editor);
 397         WM::Manager::instance().register_window (&session_option_editor);
 398         WM::Manager::instance().register_window (&speaker_config_window);
 399         WM::Manager::instance().register_window (&about);
 400         WM::Manager::instance().register_window (&add_route_dialog);
 401         WM::Manager::instance().register_window (&add_video_dialog);
 402         WM::Manager::instance().register_window (&route_params);
 403         WM::Manager::instance().register_window (&audio_midi_setup);
 404         WM::Manager::instance().register_window (&export_video_dialog);
 405         WM::Manager::instance().register_window (&bundle_manager);
 406         WM::Manager::instance().register_window (&location_ui);
 407         WM::Manager::instance().register_window (&big_clock_window);
 408         WM::Manager::instance().register_window (&audio_port_matrix);
 409         WM::Manager::instance().register_window (&midi_port_matrix);
 410
 411         /* Trigger setting up the color scheme and loading the GTK RC file */
 412
 413         ARDOUR_UI::config()->load_rc_file (false);
 414
 415         _process_thread = new ProcessThread ();
 416         _process_thread->init ();
 417
 418         DPIReset.connect (sigc::mem_fun (*this, &ARDOUR_UI::resize_text_widgets));
 419
 420         attach_to_engine ();
 421 }
 422
 423 GlobalPortMatrixWindow*
 424 ARDOUR_UI::create_global_port_matrix (ARDOUR::DataType type)
 425 {
 426         if (!_session) {
 427                 return 0;
 428         }
 429         return new GlobalPortMatrixWindow (_session, type);
 430 }
 431
 432 void
 433 ARDOUR_UI::attach_to_engine ()
 434 {
 435         AudioEngine::instance()->Running.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_running, this), gui_context());
 436         ARDOUR::Port::set_connecting_blocked (ARDOUR_COMMAND_LINE::no_connect_ports);
 437 }
 438
 439 void
 440 ARDOUR_UI::engine_stopped ()
 441 {
 442         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::engine_stopped)
 443         ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, false);
 444         ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, true);
 445 }
 446
 447 void
 448 ARDOUR_UI::engine_running ()
 449 {
 450         if (first_time_engine_run) {
 451                 post_engine();
 452                 first_time_engine_run = false;
 453         }
 454
 455         update_disk_space ();
 456         update_cpu_load ();
 457         update_sample_rate (AudioEngine::instance()->sample_rate());
 458         update_timecode_format ();
 459 }
 460
 461 void
 462 ARDOUR_UI::engine_halted (const char* reason, bool free_reason)
 463 {
 464         if (!Gtkmm2ext::UI::instance()->caller_is_ui_thread()) {
 465                 /* we can't rely on the original string continuing to exist when we are called
 466                    again in the GUI thread, so make a copy and note that we need to
 467                    free it later.
 468                 */
 469                 char *copy = strdup (reason);
 470                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_halted, this, copy, true));
 471                 return;
 472         }
 473
 474         ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, false);
 475         ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, true);
 476
 477         update_sample_rate (0);
 478
 479         string msgstr;
 480
 481         /* if the reason is a non-empty string, it means that the backend was shutdown
 482            rather than just Ardour.
 483         */
 484
 485         if (strlen (reason)) {
 486                 msgstr = string_compose (_("The audio backend was shutdown because:\n\n%1"), reason);
 487         } else {
 488                 msgstr = string_compose (_("\
 489 The audio backend has either been shutdown or it\n\
 490 disconnected %1 because %1\n\
 491 was not fast enough. Try to restart\n\
 492 the audio backend and save the session."), PROGRAM_NAME);
 493         }
 494
 495         MessageDialog msg (*editor, msgstr);
 496         pop_back_splash (msg);
 497         msg.run ();
 498
 499         if (free_reason) {
 500                 free (const_cast<char*> (reason));
 501         }
 502 }
 503
 504 void
 505 ARDOUR_UI::post_engine ()
 506 {
 507         /* Things to be done once (and once ONLY) after we have a backend running in the AudioEngine
 508          */
 509 #ifdef AUDIOUNIT_SUPPORT
 510         std::string au_msg;
 511         if (AUPluginInfo::au_get_crashlog(au_msg)) {
 512                 popup_error(_("Audio Unit Plugin Scan Failed. Automatic AU scanning has been disabled. Please see the log window for further details."));
 513                 error << _("Audio Unit Plugin Scan Failed:") << endmsg;
 514                 info << au_msg << endmsg;
 515         }
 516 #endif
 517
 518         ARDOUR::init_post_engine ();
 519
 520         /* connect to important signals */
 521
 522         AudioEngine::instance()->Stopped.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_stopped, this), gui_context());
 523         AudioEngine::instance()->SampleRateChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::update_sample_rate, this, _1), gui_context());
 524         AudioEngine::instance()->BufferSizeChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::update_sample_rate, this, _1), gui_context());
 525         AudioEngine::instance()->Halted.connect_same_thread (halt_connection, boost::bind (&ARDOUR_UI::engine_halted, this, _1, false));
 526         AudioEngine::instance()->BecameSilent.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::audioengine_became_silent, this), gui_context());
 527
 528         _tooltips.enable();
 529
 530         if (setup_windows ()) {
 531                 throw failed_constructor ();
 532         }
 533
 534         /* Do this after setup_windows (), as that's when the _status_bar_visibility is created */
 535         XMLNode* n = Config->extra_xml (X_("UI"));
 536         if (n) {
 537                 _status_bar_visibility.set_state (*n);
 538         }
 539
 540         check_memory_locking();
 541
 542         /* this is the first point at which all the keybindings are available */
 543
 544         if (ARDOUR_COMMAND_LINE::show_key_actions) {
 545                 vector<string> names;
 546                 vector<string> paths;
 547                 vector<string> tooltips;
 548                 vector<string> keys;
 549                 vector<AccelKey> bindings;
 550
 551                 ActionManager::get_all_actions (names, paths, tooltips, keys, bindings);
 552
 553                 vector<string>::iterator n;
 554                 vector<string>::iterator k;
 555                 vector<string>::iterator p;
 556                 for (n = names.begin(), k = keys.begin(), p = paths.begin(); n != names.end(); ++n, ++k, ++p) {
 557                         cout << "Action: '" << (*n) << "' bound to '" << (*k) << "' Path: '" << (*p) << "'" << endl;
 558                 }
 559
 560                 halt_connection.disconnect ();
 561                 AudioEngine::instance()->stop ();
 562                 exit (0);
 563         }
 564
 565         /* this being a GUI and all, we want peakfiles */
 566
 567         AudioFileSource::set_build_peakfiles (true);
 568         AudioFileSource::set_build_missing_peakfiles (true);
 569
 570         /* set default clock modes */
 571
 572         if (Profile->get_sae()) {
 573                 primary_clock->set_mode (AudioClock::BBT);
 574                 secondary_clock->set_mode (AudioClock::MinSec);
 575         }  else {
 576                 primary_clock->set_mode (AudioClock::Timecode);
 577                 secondary_clock->set_mode (AudioClock::BBT);
 578         }
 579
 580         /* start the time-of-day-clock */
 581
 582 #ifndef GTKOSX
 583         /* OS X provides a nearly-always visible wallclock, so don't be stupid */
 584         update_wall_clock ();
 585         Glib::signal_timeout().connect_seconds (sigc::mem_fun(*this, &ARDOUR_UI::update_wall_clock), 1);
 586 #endif
 587
 588         {
 589                 DisplaySuspender ds;
 590                 Config->ParameterChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::parameter_changed, this, _1), gui_context());
 591                 boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
 592                 Config->map_parameters (pc);
 593
 594                 ui_config->map_parameters (pc);
 595         }
 596 }
 597
 598 ARDOUR_UI::~ARDOUR_UI ()
 599 {
 600         ui_config->save_state();
 601
 602         stop_video_server();
 603
 604         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
 605                 // don't bother at 'real' exit. the OS cleans up for us.
 606                 delete big_clock;
 607                 delete primary_clock;
 608                 delete secondary_clock;
 609                 delete _process_thread;
 610                 delete gui_object_state;
 611                 FastMeter::flush_pattern_cache ();
 612         }
 613 }
 614
 615 void
 616 ARDOUR_UI::pop_back_splash (Gtk::Window& win)
 617 {
 618         if (Splash::instance()) {
 619                 Splash::instance()->pop_back_for (win);
 620         }
 621 }
 622
 623 gint
 624 ARDOUR_UI::configure_timeout ()
 625 {
 626         if (last_configure_time == 0) {
 627                 /* no configure events yet */
 628                 return true;
 629         }
 630
 631         /* force a gap of 0.5 seconds since the last configure event
 632          */
 633
 634         if (get_microseconds() - last_configure_time < 500000) {
 635                 return true;
 636         } else {
 637                 have_configure_timeout = false;
 638                 save_ardour_state ();
 639                 return false;
 640         }
 641 }
 642
 643 gboolean
 644 ARDOUR_UI::configure_handler (GdkEventConfigure* /*conf*/)
 645 {
 646         if (have_configure_timeout) {
 647                 last_configure_time = get_microseconds();
 648         } else {
 649                 Glib::signal_timeout().connect (sigc::mem_fun(*this, &ARDOUR_UI::configure_timeout), 100);
 650                 have_configure_timeout = true;
 651         }
 652
 653         return FALSE;
 654 }
 655
 656 void
 657 ARDOUR_UI::set_transport_controllable_state (const XMLNode& node)
 658 {
 659         const XMLProperty* prop;
 660
 661         if ((prop = node.property ("roll")) != 0) {
 662                 roll_controllable->set_id (prop->value());
 663         }
 664         if ((prop = node.property ("stop")) != 0) {
 665                 stop_controllable->set_id (prop->value());
 666         }
 667         if ((prop = node.property ("goto-start")) != 0) {
 668                 goto_start_controllable->set_id (prop->value());
 669         }
 670         if ((prop = node.property ("goto-end")) != 0) {
 671                 goto_end_controllable->set_id (prop->value());
 672         }
 673         if ((prop = node.property ("auto-loop")) != 0) {
 674                 auto_loop_controllable->set_id (prop->value());
 675         }
 676         if ((prop = node.property ("play-selection")) != 0) {
 677                 play_selection_controllable->set_id (prop->value());
 678         }
 679         if ((prop = node.property ("rec")) != 0) {
 680                 rec_controllable->set_id (prop->value());
 681         }
 682         if ((prop = node.property ("shuttle")) != 0) {
 683                 shuttle_box->controllable()->set_id (prop->value());
 684         }
 685 }
 686
 687 XMLNode&
 688 ARDOUR_UI::get_transport_controllable_state ()
 689 {
 690         XMLNode* node = new XMLNode(X_("TransportControllables"));
 691         char buf[64];
 692
 693         roll_controllable->id().print (buf, sizeof (buf));
 694         node->add_property (X_("roll"), buf);
 695         stop_controllable->id().print (buf, sizeof (buf));
 696         node->add_property (X_("stop"), buf);
 697         goto_start_controllable->id().print (buf, sizeof (buf));
 698         node->add_property (X_("goto_start"), buf);
 699         goto_end_controllable->id().print (buf, sizeof (buf));
 700         node->add_property (X_("goto_end"), buf);
 701         auto_loop_controllable->id().print (buf, sizeof (buf));
 702         node->add_property (X_("auto_loop"), buf);
 703         play_selection_controllable->id().print (buf, sizeof (buf));
 704         node->add_property (X_("play_selection"), buf);
 705         rec_controllable->id().print (buf, sizeof (buf));
 706         node->add_property (X_("rec"), buf);
 707         shuttle_box->controllable()->id().print (buf, sizeof (buf));
 708         node->add_property (X_("shuttle"), buf);
 709
 710         return *node;
 711 }
 712
 713 void
 714 ARDOUR_UI::save_session_at_its_request (std::string snapshot_name)
 715 {
 716         if (_session) {
 717                 _session->save_state (snapshot_name);
 718         }
 719 }
 720
 721 gint
 722 ARDOUR_UI::autosave_session ()
 723 {
 724         if (g_main_depth() > 1) {
 725                 /* inside a recursive main loop,
 726                    give up because we may not be able to
 727                    take a lock.
 728                 */
 729                 return 1;
 730         }
 731
 732         if (!Config->get_periodic_safety_backups()) {
 733                 return 1;
 734         }
 735
 736         if (_session) {
 737                 _session->maybe_write_autosave();
 738         }
 739
 740         return 1;
 741 }
 742
 743 void
 744 ARDOUR_UI::update_autosave ()
 745 {
 746         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::update_autosave)
 747
 748         if (_session && _session->dirty()) {
 749                 if (_autosave_connection.connected()) {
 750                         _autosave_connection.disconnect();
 751                 }
 752
 753                 _autosave_connection = Glib::signal_timeout().connect (sigc::mem_fun (*this, &ARDOUR_UI::autosave_session),
 754                                 Config->get_periodic_safety_backup_interval() * 1000);
 755
 756         } else {
 757                 if (_autosave_connection.connected()) {
 758                         _autosave_connection.disconnect();
 759                 }
 760         }
 761 }
 762
 763 void
 764 ARDOUR_UI::check_announcements ()
 765 {
 766 #ifdef PHONE_HOME
 767         string _annc_filename;
 768
 769 #ifdef __APPLE__
 770         _annc_filename = PROGRAM_NAME "_announcements_osx_";
 771 #else
 772         _annc_filename = PROGRAM_NAME "_announcements_linux_";
 773 #endif
 774         _annc_filename.append (VERSIONSTRING);
 775
 776         std::string path = Glib::build_filename (user_config_directory(), _annc_filename);
 777         std::ifstream announce_file (path.c_str());
 778         if ( announce_file.fail() )
 779                 _announce_string = "";
 780         else {
 781                 std::stringstream oss;
 782                 oss << announce_file.rdbuf();
 783                 _announce_string = oss.str();
 784         }
 785
 786         pingback (VERSIONSTRING, path);
 787 #endif
 788 }
 789
 790 int
 791 ARDOUR_UI::starting ()
 792 {
 793         Application* app = Application::instance ();
 794         const char *nsm_url;
 795         bool brand_new_user = ArdourStartup::required ();
 796
 797         app->ShouldQuit.connect (sigc::mem_fun (*this, &ARDOUR_UI::queue_finish));
 798         app->ShouldLoad.connect (sigc::mem_fun (*this, &ARDOUR_UI::load_from_application_api));
 799
 800         if (ARDOUR_COMMAND_LINE::check_announcements) {
 801                 check_announcements ();
 802         }
 803
 804         app->ready ();
 805
 806         /* we need to create this early because it may need to set the
 807          *  audio backend end up.
 808          */
 809
 810         try {
 811                 audio_midi_setup.get (true);
 812         } catch (...) {
 813                 std::cerr << "audio-midi engine setup failed."<< std::endl;
 814                 return -1;
 815         }
 816
 817         if ((nsm_url = g_getenv ("NSM_URL")) != 0) {
 818                 nsm = new NSM_Client;
 819                 if (!nsm->init (nsm_url)) {
 820                         /* TODO this needs fixing!
 821                          * waf's obj.target for distro versions: eg ardour4, ardourvst4
 822                          * Ardour4, Mixbus3 for bundled versions + full path on OSX & windows
 823                          * argv[0] does not apply since we need the wrapper-script (not the binary itself)
 824                          * No idea how to address all these.
 825                          */
 826                         nsm->announce (PROGRAM_NAME, ":dirty:", "ardour4");
 827
 828                         unsigned int i = 0;
 829                         // wait for announce reply from nsm server
 830                         for ( i = 0; i < 5000; ++i) {
 831                                 nsm->check ();
 832
 833                                 Glib::usleep (i);
 834                                 if (nsm->is_active()) {
 835                                         break;
 836                                 }
 837                         }
 838                         if (i == 5000) {
 839                                 error << _("NSM server did not announce itself") << endmsg;
 840                                 return -1;
 841                         }
 842                         // wait for open command from nsm server
 843                         for ( i = 0; i < 5000; ++i) {
 844                                 nsm->check ();
 845                                 Glib::usleep (1000);
 846                                 if (nsm->client_id ()) {
 847                                         break;
 848                                 }
 849                         }
 850
 851                         if (i == 5000) {
 852                                 error << _("NSM: no client ID provided") << endmsg;
 853                                 return -1;
 854                         }
 855
 856                         if (_session && nsm) {
 857                                 _session->set_nsm_state( nsm->is_active() );
 858                         } else {
 859                                 error << _("NSM: no session created") << endmsg;
 860                                 return -1;
 861                         }
 862
 863                         // nsm requires these actions disabled
 864                         vector<string> action_names;
 865                         action_names.push_back("SaveAs");
 866                         action_names.push_back("Rename");
 867                         action_names.push_back("New");
 868                         action_names.push_back("Open");
 869                         action_names.push_back("Recent");
 870                         action_names.push_back("Close");
 871
 872                         for (vector<string>::const_iterator n = action_names.begin(); n != action_names.end(); ++n) {
 873                                 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Main"), (*n).c_str());
 874                                 if (act) {
 875                                         act->set_sensitive (false);
 876                                 }
 877                         }
 878
 879                 } else {
 880                         delete nsm;
 881                         nsm = 0;
 882                         error << _("NSM: initialization failed") << endmsg;
 883                         return -1;
 884                 }
 885
 886         } else  {
 887
 888                 if (brand_new_user) {
 889                         ArdourStartup s;
 890                         s.present ();
 891                         main().run();
 892                         s.hide ();
 893                         switch (s.response ()) {
 894                         case Gtk::RESPONSE_OK:
 895                                 break;
 896                         default:
 897                                 return -1;
 898                         }
 899                 }
 900
 901 #ifdef NO_PLUGIN_STATE
 902
 903                 ARDOUR::RecentSessions rs;
 904                 ARDOUR::read_recent_sessions (rs);
 905
 906                 string path = Glib::build_filename (user_config_directory(), ".iknowaboutfreeversion");
 907
 908                 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS) && !rs.empty()) {
 909
 910                         /* already used Ardour, have sessions ... warn about plugin state */
 911
 912                         ArdourDialog d (_("Free/Demo Version Warning"), true);
 913                         Label l;
 914                         Button b (string_compose (_("Subscribe and support development of %1"), PROGRAM_NAME));
 915                         CheckButton c (_("Don't warn me about this again"));
 916
 917                         l.set_markup (string_compose (_("<span weight=\"bold\" size=\"large\">%1</span>\n\n<b>%2</b>\n\n<i>%3</i>\n\n%4"),
 918                                                       string_compose (_("This is a free/demo version of %1"), PROGRAM_NAME),
 919                                                       _("It will not restore OR save any plugin settings"),
 920                                                       _("If you load an existing session with plugin settings\n"
 921                                                         "they will not be used and will be lost."),
 922                                                       _("To get full access to updates without this limitation\n"
 923                                                         "consider becoming a subscriber for a low cost every month.")));
 924                         l.set_justify (JUSTIFY_CENTER);
 925
 926                         b.signal_clicked().connect (mem_fun(*this, &ARDOUR_UI::launch_subscribe));
 927
 928                         d.get_vbox()->pack_start (l, true, true);
 929                         d.get_vbox()->pack_start (b, false, false, 12);
 930                         d.get_vbox()->pack_start (c, false, false, 12);
 931
 932                         d.add_button (_("Quit now"), RESPONSE_CANCEL);
 933                         d.add_button (string_compose (_("Continue using %1"), PROGRAM_NAME), RESPONSE_OK);
 934
 935                         d.show_all ();
 936
 937                         c.signal_toggled().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (toggle_file_existence), path)));
 938
 939                         if (d.run () != RESPONSE_OK) {
 940                                 _exit (0);
 941                         }
 942                 }
 943 #endif
 944
 945                 /* go get a session */
 946
 947                 const bool new_session_required = (ARDOUR_COMMAND_LINE::new_session || brand_new_user);
 948
 949                 if (get_session_parameters (false, new_session_required, ARDOUR_COMMAND_LINE::load_template)) {
 950                         std::cerr << "Cannot get session parameters."<< std::endl;
 951                         return -1;
 952                 }
 953         }
 954
 955         use_config ();
 956
 957         goto_editor_window ();
 958
 959         WM::Manager::instance().show_visible ();
 960
 961         /* We have to do this here since goto_editor_window() ends up calling show_all() on the
 962          * editor window, and we may want stuff to be hidden.
 963          */
 964         _status_bar_visibility.update ();
 965
 966         BootMessage (string_compose (_("%1 is ready for use"), PROGRAM_NAME));
 967         return 0;
 968 }
 969
 970 void
 971 ARDOUR_UI::check_memory_locking ()
 972 {
 973 #if defined(__APPLE__) || defined(PLATFORM_WINDOWS)
 974         /* OS X doesn't support mlockall(2), and so testing for memory locking capability there is pointless */
 975         return;
 976 #else // !__APPLE__
 977
 978         XMLNode* memory_warning_node = Config->instant_xml (X_("no-memory-warning"));
 979
 980         if (AudioEngine::instance()->is_realtime() && memory_warning_node == 0) {
 981
 982                 struct rlimit limits;
 983                 int64_t ram;
 984                 long pages, page_size;
 985 #ifdef __FreeBSD__
 986                 size_t pages_len=sizeof(pages);
 987                 if ((page_size = getpagesize()) < 0 ||
 988                                 sysctlbyname("hw.availpages", &pages, &pages_len, NULL, 0))
 989 #else
 990                 if ((page_size = sysconf (_SC_PAGESIZE)) < 0 ||(pages = sysconf (_SC_PHYS_PAGES)) < 0)
 991 #endif
 992                 {
 993                         ram = 0;
 994                 } else {
 995                         ram = (int64_t) pages * (int64_t) page_size;
 996                 }
 997
 998                 if (getrlimit (RLIMIT_MEMLOCK, &limits)) {
 999                         return;
1000                 }
1001
1002                 if (limits.rlim_cur != RLIM_INFINITY) {
1003
1004                         if (ram == 0 || ((double) limits.rlim_cur / ram) < 0.75) {
1005
1006                                 MessageDialog msg (
1007                                         string_compose (
1008                                                 _("WARNING: Your system has a limit for maximum amount of locked memory. "
1009                                                   "This might cause %1 to run out of memory before your system "
1010                                                   "runs out of memory. \n\n"
1011                                                   "You can view the memory limit with 'ulimit -l', "
1012                                                   "and it is normally controlled by %2"),
1013                                                 PROGRAM_NAME,
1014 #ifdef __FreeBSD__
1015                                                 X_("/etc/login.conf")
1016 #else
1017                                                 X_(" /etc/security/limits.conf")
1018 #endif
1019                                         ).c_str());
1020
1021                                 msg.set_default_response (RESPONSE_OK);
1022
1023                                 VBox* vbox = msg.get_vbox();
1024                                 HBox hbox;
1025                                 CheckButton cb (_("Do not show this window again"));
1026                                 hbox.pack_start (cb, true, false);
1027                                 vbox->pack_start (hbox);
1028                                 cb.show();
1029                                 vbox->show();
1030                                 hbox.show ();
1031
1032                                 pop_back_splash (msg);
1033
1034                                 editor->ensure_float (msg);
1035                                 msg.run ();
1036
1037                                 if (cb.get_active()) {
1038                                         XMLNode node (X_("no-memory-warning"));
1039                                         Config->add_instant_xml (node);
1040                                 }
1041                         }
1042                 }
1043         }
1044 #endif // !__APPLE__
1045 }
1046
1047
1048 void
1049 ARDOUR_UI::queue_finish ()
1050 {
1051         Glib::signal_idle().connect (mem_fun (*this, &ARDOUR_UI::idle_finish));
1052 }
1053
1054 bool
1055 ARDOUR_UI::idle_finish ()
1056 {
1057         finish ();
1058         return false; /* do not call again */
1059 }
1060
1061 void
1062 ARDOUR_UI::finish()
1063 {
1064         if (_session) {
1065                 ARDOUR_UI::instance()->video_timeline->sync_session_state();
1066
1067                 if (_session->dirty()) {
1068                         vector<string> actions;
1069                         actions.push_back (_("Don't quit"));
1070                         actions.push_back (_("Just quit"));
1071                         actions.push_back (_("Save and quit"));
1072                         switch (ask_about_saving_session(actions)) {
1073                         case -1:
1074                                 return;
1075                                 break;
1076                         case 1:
1077                                 /* use the default name */
1078                                 if (save_state_canfail ("")) {
1079                                         /* failed - don't quit */
1080                                         MessageDialog msg (*editor,
1081                                                            string_compose (_("\
1082 %1 was unable to save your session.\n\n\
1083 If you still wish to quit, please use the\n\n\
1084 \"Just quit\" option."), PROGRAM_NAME));
1085                                         pop_back_splash(msg);
1086                                         msg.run ();
1087                                         return;
1088                                 }
1089                                 break;
1090                         case 0:
1091                                 break;
1092                         }
1093                 }
1094
1095                 second_connection.disconnect ();
1096                 point_one_second_connection.disconnect ();
1097                 point_zero_something_second_connection.disconnect();
1098                 fps_connection.disconnect();
1099         }
1100
1101         delete ARDOUR_UI::instance()->video_timeline;
1102         ARDOUR_UI::instance()->video_timeline = NULL;
1103         stop_video_server();
1104
1105         /* Save state before deleting the session, as that causes some
1106            windows to be destroyed before their visible state can be
1107            saved.
1108         */
1109         save_ardour_state ();
1110
1111         close_all_dialogs ();
1112
1113         if (_session) {
1114                 _session->set_clean ();
1115                 _session->remove_pending_capture_state ();
1116                 delete _session;
1117                 _session = 0;
1118         }
1119
1120         halt_connection.disconnect ();
1121         AudioEngine::instance()->stop ();
1122 #ifdef WINDOWS_VST_SUPPORT
1123         fst_stop_threading();
1124 #endif
1125         quit ();
1126 }
1127
1128 int
1129 ARDOUR_UI::ask_about_saving_session (const vector<string>& actions)
1130 {
1131         ArdourDialog window (_("Unsaved Session"));
1132         Gtk::HBox dhbox;  // the hbox for the image and text
1133         Gtk::Label  prompt_label;
1134         Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_WARNING,  Gtk::ICON_SIZE_DIALOG));
1135
1136         string msg;
1137
1138         assert (actions.size() >= 3);
1139
1140         window.add_button (actions[0], RESPONSE_REJECT);
1141         window.add_button (actions[1], RESPONSE_APPLY);
1142         window.add_button (actions[2], RESPONSE_ACCEPT);
1143
1144         window.set_default_response (RESPONSE_ACCEPT);
1145
1146         Gtk::Button noquit_button (msg);
1147         noquit_button.set_name ("EditorGTKButton");
1148
1149         string prompt;
1150
1151         if (_session->snap_name() == _session->name()) {
1152                 prompt = string_compose(_("The session \"%1\"\nhas not been saved.\n\nAny changes made this time\nwill be lost unless you save it.\n\nWhat do you want to do?"),
1153                                         _session->snap_name());
1154         } else {
1155                 prompt = string_compose(_("The snapshot \"%1\"\nhas not been saved.\n\nAny changes made this time\nwill be lost unless you save it.\n\nWhat do you want to do?"),
1156                                         _session->snap_name());
1157         }
1158
1159         prompt_label.set_text (prompt);
1160         prompt_label.set_name (X_("PrompterLabel"));
1161         prompt_label.set_alignment(ALIGN_LEFT, ALIGN_TOP);
1162
1163         dimage->set_alignment(ALIGN_CENTER, ALIGN_TOP);
1164         dhbox.set_homogeneous (false);
1165         dhbox.pack_start (*dimage, false, false, 5);
1166         dhbox.pack_start (prompt_label, true, false, 5);
1167         window.get_vbox()->pack_start (dhbox);
1168
1169         window.set_name (_("Prompter"));
1170         window.set_modal (true);
1171         window.set_resizable (false);
1172
1173         dhbox.show();
1174         prompt_label.show();
1175         dimage->show();
1176         window.show();
1177         window.present ();
1178
1179         ResponseType r = (ResponseType) window.run();
1180
1181         window.hide ();
1182
1183         switch (r) {
1184         case RESPONSE_ACCEPT: // save and get out of here
1185                 return 1;
1186         case RESPONSE_APPLY:  // get out of here
1187                 return 0;
1188         default:
1189                 break;
1190         }
1191
1192         return -1;
1193 }
1194
1195
1196 void
1197 ARDOUR_UI::every_second ()
1198 {
1199         update_cpu_load ();
1200         update_buffer_load ();
1201         update_disk_space ();
1202         update_timecode_format ();
1203
1204         if (nsm && nsm->is_active ()) {
1205                 nsm->check ();
1206
1207                 if (!_was_dirty && _session->dirty ()) {
1208                         nsm->is_dirty ();
1209                         _was_dirty = true;
1210                 }
1211                 else if (_was_dirty && !_session->dirty ()){
1212                         nsm->is_clean ();
1213                         _was_dirty = false;
1214                 }
1215         }
1216 }
1217
1218 void
1219 ARDOUR_UI::every_point_one_seconds ()
1220 {
1221         // TODO get rid of this..
1222         // ShuttleControl is updated directly via TransportStateChange signal
1223 }
1224
1225 void
1226 ARDOUR_UI::every_point_zero_something_seconds ()
1227 {
1228         // august 2007: actual update frequency: 25Hz (40ms), not 100Hz
1229
1230         if (editor_meter && ARDOUR_UI::config()->get_show_editor_meter()) {
1231                 float mpeak = editor_meter->update_meters();
1232                 if (mpeak > editor_meter_max_peak) {
1233                         if (mpeak >= ARDOUR_UI::config()->get_meter_peak()) {
1234                                 editor_meter_peak_display.set_active_state ( Gtkmm2ext::ExplicitActive );
1235                         }
1236                 }
1237         }
1238 }
1239
1240 void
1241 ARDOUR_UI::set_fps_timeout_connection ()
1242 {
1243         unsigned int interval = 40;
1244         if (!_session) return;
1245         if (_session->timecode_frames_per_second() != 0) {
1246                 /* ideally we'll use a select() to sleep and not accumulate
1247                  * idle time to provide a regular periodic signal.
1248                  * See linux_vst_gui_support.cc 'elapsed_time_ms'.
1249                  * However, that'll require a dedicated thread and cross-thread
1250                  * signals to the GUI Thread..
1251                  */
1252                 interval = floor(500. /* update twice per FPS, since Glib::signal_timeout is very irregular */
1253                                 * _session->frame_rate() / _session->nominal_frame_rate()
1254                                 / _session->timecode_frames_per_second()
1255                                 );
1256 #ifdef PLATFORM_WINDOWS
1257                 // the smallest windows scheduler time-slice is ~15ms.
1258                 // periodic GUI timeouts shorter than that will cause
1259                 // WaitForSingleObject to spinlock (100% of one CPU Core)
1260                 // and gtk never enters idle mode.
1261                 // also changing timeBeginPeriod(1) does not affect that in
1262                 // any beneficial way, so we just limit the max rate for now.
1263                 interval = std::max(30u, interval); // at most ~33Hz.
1264 #else
1265                 interval = std::max(8u, interval); // at most 120Hz.
1266 #endif
1267         }
1268         fps_connection.disconnect();
1269         Timers::set_fps_interval (interval);
1270 }
1271
1272 void
1273 ARDOUR_UI::update_sample_rate (framecnt_t)
1274 {
1275         char buf[64];
1276
1277         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::update_sample_rate, ignored)
1278
1279         if (!AudioEngine::instance()->connected()) {
1280
1281                 snprintf (buf, sizeof (buf), "%s", _("Audio: <span foreground=\"red\">none</span>"));
1282
1283         } else {
1284
1285                 framecnt_t rate = AudioEngine::instance()->sample_rate();
1286
1287                 if (rate == 0) {
1288                         /* no sample rate available */
1289                         snprintf (buf, sizeof (buf), "%s", _("Audio: <span foreground=\"red\">none</span>"));
1290                 } else {
1291
1292                         if (fmod (rate, 1000.0) != 0.0) {
1293                                 snprintf (buf, sizeof (buf), _("Audio: <span foreground=\"green\">%.1f kHz / %4.1f ms</span>"),
1294                                           (float) rate / 1000.0f,
1295                                           (AudioEngine::instance()->usecs_per_cycle() / 1000.0f));
1296                         } else {
1297                                 snprintf (buf, sizeof (buf), _("Audio: <span foreground=\"green\">%" PRId64 " kHz / %4.1f ms</span>"),
1298                                           rate/1000,
1299                                           (AudioEngine::instance()->usecs_per_cycle() / 1000.0f));
1300                         }
1301                 }
1302         }
1303         sample_rate_label.set_markup (buf);
1304 }
1305
1306 void
1307 ARDOUR_UI::update_format ()
1308 {
1309         if (!_session) {
1310                 format_label.set_text ("");
1311                 return;
1312         }
1313
1314         stringstream s;
1315         s << _("File:") << X_(" <span foreground=\"green\">");
1316
1317         switch (_session->config.get_native_file_header_format ()) {
1318         case BWF:
1319                 s << _("BWF");
1320                 break;
1321         case WAVE:
1322                 s << _("WAV");
1323                 break;
1324         case WAVE64:
1325                 s << _("WAV64");
1326                 break;
1327         case CAF:
1328                 s << _("CAF");
1329                 break;
1330         case AIFF:
1331                 s << _("AIFF");
1332                 break;
1333         case iXML:
1334                 s << _("iXML");
1335                 break;
1336         case RF64:
1337                 s << _("RF64");
1338                 break;
1339         }
1340
1341         s << " ";
1342
1343         switch (_session->config.get_native_file_data_format ()) {
1344         case FormatFloat:
1345                 s << _("32-float");
1346                 break;
1347         case FormatInt24:
1348                 s << _("24-int");
1349                 break;
1350         case FormatInt16:
1351                 s << _("16-int");
1352                 break;
1353         }
1354
1355         s << X_("</span>");
1356
1357         format_label.set_markup (s.str ());
1358 }
1359
1360 void
1361 ARDOUR_UI::update_cpu_load ()
1362 {
1363         char buf[64];
1364
1365         /* If this text is changed, the set_size_request_to_display_given_text call in ARDOUR_UI::resize_text_widgets
1366            should also be changed.
1367         */
1368
1369         double const c = AudioEngine::instance()->get_dsp_load ();
1370         snprintf (buf, sizeof (buf), _("DSP: <span foreground=\"%s\">%5.1f%%</span>"), c >= 90 ? X_("red") : X_("green"), c);
1371         cpu_load_label.set_markup (buf);
1372 }
1373
1374 void
1375 ARDOUR_UI::update_buffer_load ()
1376 {
1377         char buf[256];
1378
1379         uint32_t const playback = _session ? _session->playback_load () : 100;
1380         uint32_t const capture = _session ? _session->capture_load () : 100;
1381
1382         /* If this text is changed, the set_size_request_to_display_given_text call in ARDOUR_UI::resize_text_widgets
1383            should also be changed.
1384         */
1385
1386         if (_session) {
1387                 snprintf (
1388                         buf, sizeof (buf),
1389                         _("Buffers: <span foreground=\"green\">p:</span><span foreground=\"%s\">%" PRIu32 "%%</span> "
1390                                    "<span foreground=\"green\">c:</span><span foreground=\"%s\">%" PRIu32 "%%</span>"),
1391                         playback <= 5 ? X_("red") : X_("green"),
1392                         playback,
1393                         capture <= 5 ? X_("red") : X_("green"),
1394                         capture
1395                         );
1396
1397                 buffer_load_label.set_markup (buf);
1398         } else {
1399                 buffer_load_label.set_text ("");
1400         }
1401 }
1402
1403 void
1404 ARDOUR_UI::count_recenabled_streams (Route& route)
1405 {
1406         Track* track = dynamic_cast<Track*>(&route);
1407         if (track && track->record_enabled()) {
1408                 rec_enabled_streams += track->n_inputs().n_total();
1409         }
1410 }
1411
1412 void
1413 ARDOUR_UI::update_disk_space()
1414 {
1415         if (_session == 0) {
1416                 return;
1417         }
1418
1419         boost::optional<framecnt_t> opt_frames = _session->available_capture_duration();
1420         char buf[64];
1421         framecnt_t fr = _session->frame_rate();
1422
1423         if (fr == 0) {
1424                 /* skip update - no SR available */
1425                 return;
1426         }
1427
1428         if (!opt_frames) {
1429                 /* Available space is unknown */
1430                 snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">Unknown</span>"));
1431         } else if (opt_frames.get_value_or (0) == max_framecnt) {
1432                 snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">24hrs+</span>"));
1433         } else {
1434                 rec_enabled_streams = 0;
1435                 _session->foreach_route (this, &ARDOUR_UI::count_recenabled_streams, false);
1436
1437                 framecnt_t frames = opt_frames.get_value_or (0);
1438
1439                 if (rec_enabled_streams) {
1440                         frames /= rec_enabled_streams;
1441                 }
1442
1443                 int hrs;
1444                 int mins;
1445                 int secs;
1446
1447                 hrs  = frames / (fr * 3600);
1448
1449                 if (hrs > 24) {
1450                         snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">&gt;24 hrs</span>"));
1451                 } else {
1452                         frames -= hrs * fr * 3600;
1453                         mins = frames / (fr * 60);
1454                         frames -= mins * fr * 60;
1455                         secs = frames / fr;
1456
1457                         bool const low = (hrs == 0 && mins <= 30);
1458
1459                         snprintf (
1460                                 buf, sizeof(buf),
1461                                 _("Disk: <span foreground=\"%s\">%02dh:%02dm:%02ds</span>"),
1462                                 low ? X_("red") : X_("green"),
1463                                 hrs, mins, secs
1464                                 );
1465                 }
1466         }
1467
1468         disk_space_label.set_markup (buf);
1469 }
1470
1471 void
1472 ARDOUR_UI::update_timecode_format ()
1473 {
1474         char buf[64];
1475
1476         if (_session) {
1477                 bool matching;
1478                 TimecodeSlave* tcslave;
1479                 SyncSource sync_src = Config->get_sync_source();
1480
1481                 if ((sync_src == LTC || sync_src == MTC) && (tcslave = dynamic_cast<TimecodeSlave*>(_session->slave())) != 0) {
1482                         matching = (tcslave->apparent_timecode_format() == _session->config.get_timecode_format());
1483                 } else {
1484                         matching = true;
1485                 }
1486
1487                 snprintf (buf, sizeof (buf), S_("Timecode|TC: <span foreground=\"%s\">%s</span>"),
1488                           matching ? X_("green") : X_("red"),
1489                           Timecode::timecode_format_name (_session->config.get_timecode_format()).c_str());
1490         } else {
1491                 snprintf (buf, sizeof (buf), "TC: n/a");
1492         }
1493
1494         timecode_format_label.set_markup (buf);
1495 }
1496
1497 gint
1498 ARDOUR_UI::update_wall_clock ()
1499 {
1500         time_t now;
1501         struct tm *tm_now;
1502         static int last_min = -1;
1503
1504         time (&now);
1505         tm_now = localtime (&now);
1506         if (last_min != tm_now->tm_min) {
1507                 char buf[16];
1508                 sprintf (buf, "%02d:%02d", tm_now->tm_hour, tm_now->tm_min);
1509                 wall_clock_label.set_text (buf);
1510                 last_min = tm_now->tm_min;
1511         }
1512
1513         return TRUE;
1514 }
1515
1516 void
1517 ARDOUR_UI::redisplay_recent_sessions ()
1518 {
1519         std::vector<std::string> session_directories;
1520         RecentSessionsSorter cmp;
1521
1522         recent_session_display.set_model (Glib::RefPtr<TreeModel>(0));
1523         recent_session_model->clear ();
1524
1525         ARDOUR::RecentSessions rs;
1526         ARDOUR::read_recent_sessions (rs);
1527
1528         if (rs.empty()) {
1529                 recent_session_display.set_model (recent_session_model);
1530                 return;
1531         }
1532
1533         // sort them alphabetically
1534         sort (rs.begin(), rs.end(), cmp);
1535
1536         for (ARDOUR::RecentSessions::iterator i = rs.begin(); i != rs.end(); ++i) {
1537                 session_directories.push_back ((*i).second);
1538         }
1539
1540         for (vector<std::string>::const_iterator i = session_directories.begin();
1541                         i != session_directories.end(); ++i)
1542         {
1543                 std::vector<std::string> state_file_paths;
1544
1545                 // now get available states for this session
1546
1547                 get_state_files_in_directory (*i, state_file_paths);
1548
1549                 vector<string> states;
1550                 vector<const gchar*> item;
1551                 string fullpath = *i;
1552
1553                 /* remove any trailing / */
1554
1555                 if (fullpath[fullpath.length() - 1] == '/') {
1556                         fullpath = fullpath.substr (0, fullpath.length() - 1);
1557                 }
1558
1559                 /* check whether session still exists */
1560                 if (!Glib::file_test(fullpath.c_str(), Glib::FILE_TEST_EXISTS)) {
1561                         /* session doesn't exist */
1562                         continue;
1563                 }
1564
1565                 /* now get available states for this session */
1566                 states = Session::possible_states (fullpath);
1567
1568                 if (states.empty()) {
1569                         /* no state file? */
1570                         continue;
1571                 }
1572
1573                 std::vector<string> state_file_names(get_file_names_no_extension (state_file_paths));
1574
1575                 Gtk::TreeModel::Row row = *(recent_session_model->append());
1576
1577                 row[recent_session_columns.fullpath] = fullpath;
1578                 row[recent_session_columns.tip] = Glib::Markup::escape_text (fullpath);
1579
1580                 if (state_file_names.size() > 1) {
1581                         // multiple session files in the session directory - show the directory name.
1582                         row[recent_session_columns.visible_name] = Glib::path_get_basename (fullpath);
1583
1584                         // add the children
1585                         for (std::vector<std::string>::iterator i2 = state_file_names.begin();
1586                                         i2 != state_file_names.end(); ++i2)
1587                         {
1588
1589                                 Gtk::TreeModel::Row child_row = *(recent_session_model->append (row.children()));
1590
1591                                 child_row[recent_session_columns.visible_name] = *i2;
1592                                 child_row[recent_session_columns.fullpath] = fullpath;
1593                                 child_row[recent_session_columns.tip] = Glib::Markup::escape_text (fullpath);
1594                         }
1595                 } else {
1596                         // only a single session file in the directory - show its actual name.
1597                         row[recent_session_columns.visible_name] = state_file_names.front ();
1598                 }
1599         }
1600
1601         recent_session_display.set_tooltip_column(1); // recent_session_columns.tip
1602         recent_session_display.set_model (recent_session_model);
1603 }
1604
1605 void
1606 ARDOUR_UI::build_session_selector ()
1607 {
1608         session_selector_window = new ArdourDialog (_("Recent Sessions"));
1609
1610         Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow);
1611
1612         session_selector_window->add_button (Stock::CANCEL, RESPONSE_CANCEL);
1613         session_selector_window->add_button (Stock::OPEN, RESPONSE_ACCEPT);
1614         session_selector_window->set_default_response (RESPONSE_ACCEPT);
1615         recent_session_model = TreeStore::create (recent_session_columns);
1616         recent_session_display.set_model (recent_session_model);
1617         recent_session_display.append_column (_("Recent Sessions"), recent_session_columns.visible_name);
1618         recent_session_display.set_headers_visible (false);
1619         recent_session_display.get_selection()->set_mode (SELECTION_BROWSE);
1620         recent_session_display.signal_row_activated().connect (sigc::mem_fun (*this, &ARDOUR_UI::recent_session_row_activated));
1621
1622         scroller->add (recent_session_display);
1623         scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1624
1625         session_selector_window->set_name ("SessionSelectorWindow");
1626         session_selector_window->set_size_request (200, 400);
1627         session_selector_window->get_vbox()->pack_start (*scroller);
1628
1629         recent_session_display.show();
1630         scroller->show();
1631 }
1632
1633 void
1634 ARDOUR_UI::recent_session_row_activated (const TreePath& /*path*/, TreeViewColumn* /*col*/)
1635 {
1636         session_selector_window->response (RESPONSE_ACCEPT);
1637 }
1638
1639 void
1640 ARDOUR_UI::open_recent_session ()
1641 {
1642         bool can_return = (_session != 0);
1643
1644         if (session_selector_window == 0) {
1645                 build_session_selector ();
1646         }
1647
1648         redisplay_recent_sessions ();
1649
1650         while (true) {
1651
1652                 ResponseType r = (ResponseType) session_selector_window->run ();
1653
1654                 switch (r) {
1655                 case RESPONSE_ACCEPT:
1656                         break;
1657                 default:
1658                         if (can_return) {
1659                                 session_selector_window->hide();
1660                                 return;
1661                         } else {
1662                                 exit (1);
1663                         }
1664                 }
1665
1666                 if (recent_session_display.get_selection()->count_selected_rows() == 0) {
1667                         continue;
1668                 }
1669
1670                 session_selector_window->hide();
1671
1672                 Gtk::TreeModel::iterator i = recent_session_display.get_selection()->get_selected();
1673
1674                 if (i == recent_session_model->children().end()) {
1675                         return;
1676                 }
1677
1678                 std::string path = (*i)[recent_session_columns.fullpath];
1679                 std::string state = (*i)[recent_session_columns.visible_name];
1680
1681                 _session_is_new = false;
1682
1683                 if (load_session (path, state) == 0) {
1684                         break;
1685                 }
1686
1687                 can_return = false;
1688         }
1689 }
1690
1691 bool
1692 ARDOUR_UI::check_audioengine ()
1693 {
1694         if (!AudioEngine::instance()->connected()) {
1695                 MessageDialog msg (string_compose (
1696                                            _("%1 is not connected to any audio backend.\n"
1697                                              "You cannot open or close sessions in this condition"),
1698                                            PROGRAM_NAME));
1699                 pop_back_splash (msg);
1700                 msg.run ();
1701                 return false;
1702         }
1703         return true;
1704 }
1705
1706 void
1707 ARDOUR_UI::open_session ()
1708 {
1709         if (!check_audioengine()) {
1710                 return;
1711
1712         }
1713
1714         /* popup selector window */
1715
1716         if (open_session_selector == 0) {
1717
1718                 /* ardour sessions are folders */
1719
1720                 open_session_selector = new Gtk::FileChooserDialog (_("Open Session"), FILE_CHOOSER_ACTION_OPEN);
1721                 open_session_selector->add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
1722                 open_session_selector->add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
1723                 open_session_selector->set_default_response(Gtk::RESPONSE_ACCEPT);
1724
1725                 if (_session) {
1726                         string session_parent_dir = Glib::path_get_dirname(_session->path());
1727                         string::size_type last_dir_sep = session_parent_dir.rfind(G_DIR_SEPARATOR);
1728                         session_parent_dir = session_parent_dir.substr(0, last_dir_sep);
1729                         open_session_selector->set_current_folder(session_parent_dir);
1730                 } else {
1731                         open_session_selector->set_current_folder(Config->get_default_session_parent_dir());
1732                 }
1733
1734                 string default_session_folder = Config->get_default_session_parent_dir();
1735                 try {
1736                         /* add_shortcut_folder throws an exception if the folder being added already has a shortcut */
1737                         open_session_selector->add_shortcut_folder (default_session_folder);
1738                 }
1739                 catch (Glib::Error & e) {
1740                         std::cerr << "open_session_selector->add_shortcut_folder (" << default_session_folder << ") threw Glib::Error " << e.what() << std::endl;
1741                 }
1742
1743                 FileFilter session_filter;
1744                 session_filter.add_pattern (string_compose(X_("*%1"), ARDOUR::statefile_suffix));
1745                 session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
1746                 open_session_selector->add_filter (session_filter);
1747                 open_session_selector->set_filter (session_filter);
1748         }
1749
1750         int response = open_session_selector->run();
1751         open_session_selector->hide ();
1752
1753         switch (response) {
1754         case RESPONSE_ACCEPT:
1755                 break;
1756         default:
1757                 open_session_selector->hide();
1758                 return;
1759         }
1760
1761         open_session_selector->hide();
1762         string session_path = open_session_selector->get_filename();
1763         string path, name;
1764         bool isnew;
1765
1766         if (session_path.length() > 0) {
1767                 if (ARDOUR::find_session (session_path, path, name, isnew) == 0) {
1768                         _session_is_new = isnew;
1769                         load_session (path, name);
1770                 }
1771         }
1772 }
1773
1774
1775 void
1776 ARDOUR_UI::session_add_mixed_track (const ChanCount& input, const ChanCount& output, RouteGroup* route_group,
1777                                     uint32_t how_many, const string& name_template, PluginInfoPtr instrument)
1778 {
1779         list<boost::shared_ptr<MidiTrack> > tracks;
1780
1781         if (_session == 0) {
1782                 warning << _("You cannot add a track without a session already loaded.") << endmsg;
1783                 return;
1784         }
1785
1786         try {
1787                 tracks = _session->new_midi_track (input, output, instrument, ARDOUR::Normal, route_group, how_many, name_template);
1788
1789                 if (tracks.size() != how_many) {
1790                         error << string_compose(P_("could not create %1 new mixed track", "could not create %1 new mixed tracks", how_many), how_many) << endmsg;
1791                 }
1792         }
1793
1794         catch (...) {
1795                 MessageDialog msg (*editor,
1796                                    string_compose (_("There are insufficient ports available\n\
1797 to create a new track or bus.\n\
1798 You should save %1, exit and\n\
1799 restart with more ports."), PROGRAM_NAME));
1800                 msg.run ();
1801         }
1802 }
1803
1804
1805 void
1806 ARDOUR_UI::session_add_midi_route (bool disk, RouteGroup* route_group, uint32_t how_many, const string& name_template, PluginInfoPtr instrument)
1807 {
1808         ChanCount one_midi_channel;
1809         one_midi_channel.set (DataType::MIDI, 1);
1810
1811         if (disk) {
1812                 session_add_mixed_track (one_midi_channel, one_midi_channel, route_group, how_many, name_template, instrument);
1813         }
1814 }
1815
1816 void
1817 ARDOUR_UI::session_add_audio_route (
1818         bool track,
1819         int32_t input_channels,
1820         int32_t output_channels,
1821         ARDOUR::TrackMode mode,
1822         RouteGroup* route_group,
1823         uint32_t how_many,
1824         string const & name_template
1825         )
1826 {
1827         list<boost::shared_ptr<AudioTrack> > tracks;
1828         RouteList routes;
1829
1830         if (_session == 0) {
1831                 warning << _("You cannot add a track or bus without a session already loaded.") << endmsg;
1832                 return;
1833         }
1834
1835         try {
1836                 if (track) {
1837                         tracks = _session->new_audio_track (input_channels, output_channels, mode, route_group, how_many, name_template);
1838
1839                         if (tracks.size() != how_many) {
1840                                 error << string_compose (P_("could not create %1 new audio track", "could not create %1 new audio tracks", how_many), how_many)
1841                                       << endmsg;
1842                         }
1843
1844                 } else {
1845
1846                         routes = _session->new_audio_route (input_channels, output_channels, route_group, how_many, name_template);
1847
1848                         if (routes.size() != how_many) {
1849                                 error << string_compose (P_("could not create %1 new audio bus", "could not create %1 new audio busses", how_many), how_many)
1850                                       << endmsg;
1851                         }
1852                 }
1853         }
1854
1855         catch (...) {
1856                 MessageDialog msg (*editor,
1857                                    string_compose (_("There are insufficient ports available\n\
1858 to create a new track or bus.\n\
1859 You should save %1, exit and\n\
1860 restart with more ports."), PROGRAM_NAME));
1861                 pop_back_splash (msg);
1862                 msg.run ();
1863         }
1864 }
1865
1866 void
1867 ARDOUR_UI::transport_goto_start ()
1868 {
1869         if (_session) {
1870                 _session->goto_start();
1871
1872                 /* force displayed area in editor to start no matter
1873                    what "follow playhead" setting is.
1874                 */
1875
1876                 if (editor) {
1877                         editor->center_screen (_session->current_start_frame ());
1878                 }
1879         }
1880 }
1881
1882 void
1883 ARDOUR_UI::transport_goto_zero ()
1884 {
1885         if (_session) {
1886                 _session->request_locate (0);
1887
1888                 /* force displayed area in editor to start no matter
1889                    what "follow playhead" setting is.
1890                 */
1891
1892                 if (editor) {
1893                         editor->reset_x_origin (0);
1894                 }
1895         }
1896 }
1897
1898 void
1899 ARDOUR_UI::transport_goto_wallclock ()
1900 {
1901         if (_session && editor) {
1902
1903                 time_t now;
1904                 struct tm tmnow;
1905                 framepos_t frames;
1906
1907                 time (&now);
1908                 localtime_r (&now, &tmnow);
1909
1910                 int frame_rate = _session->frame_rate();
1911
1912                 if (frame_rate == 0) {
1913                         /* no frame rate available */
1914                         return;
1915                 }
1916
1917                 frames = tmnow.tm_hour * (60 * 60 * frame_rate);
1918                 frames += tmnow.tm_min * (60 * frame_rate);
1919                 frames += tmnow.tm_sec * frame_rate;
1920
1921                 _session->request_locate (frames, _session->transport_rolling ());
1922
1923                 /* force displayed area in editor to start no matter
1924                    what "follow playhead" setting is.
1925                 */
1926
1927                 if (editor) {
1928                         editor->center_screen (frames);
1929                 }
1930         }
1931 }
1932
1933 void
1934 ARDOUR_UI::transport_goto_end ()
1935 {
1936         if (_session) {
1937                 framepos_t const frame = _session->current_end_frame();
1938                 _session->request_locate (frame);
1939
1940                 /* force displayed area in editor to start no matter
1941                    what "follow playhead" setting is.
1942                 */
1943
1944                 if (editor) {
1945                         editor->center_screen (frame);
1946                 }
1947         }
1948 }
1949
1950 void
1951 ARDOUR_UI::transport_stop ()
1952 {
1953         if (!_session) {
1954                 return;
1955         }
1956
1957         if (_session->is_auditioning()) {
1958                 _session->cancel_audition ();
1959                 return;
1960         }
1961
1962         _session->request_stop (false, true);
1963 }
1964
1965 /** Check if any tracks are record enabled. If none are, record enable all of them.
1966  * @return true if track record-enabled status was changed, false otherwise.
1967  */
1968 bool
1969 ARDOUR_UI::trx_record_enable_all_tracks ()
1970 {
1971         if (!_session) {
1972                 return false;
1973         }
1974
1975         boost::shared_ptr<RouteList> rl = _session->get_tracks ();
1976         bool none_record_enabled = true;
1977
1978         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1979                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*r);
1980                 assert (t);
1981
1982                 if (t->record_enabled()) {
1983                         none_record_enabled = false;
1984                         break;
1985                 }
1986         }
1987
1988         if (none_record_enabled) {
1989                 _session->set_record_enabled (rl, true, Session::rt_cleanup);
1990         }
1991
1992         return none_record_enabled;
1993 }
1994
1995 void
1996 ARDOUR_UI::transport_record (bool roll)
1997 {
1998         if (_session) {
1999                 switch (_session->record_status()) {
2000                 case Session::Disabled:
2001                         if (_session->ntracks() == 0) {
2002                                 MessageDialog msg (*editor, _("Please create one or more tracks before trying to record.\nYou can do this with the \"Add Track or Bus\" option in the Session menu."));
2003                                 msg.run ();
2004                                 return;
2005                         }
2006                         if (Profile->get_trx()) {
2007                                 roll = trx_record_enable_all_tracks ();
2008                         }
2009                         _session->maybe_enable_record ();
2010                         if (roll) {
2011                                 transport_roll ();
2012                         }
2013                         break;
2014                 case Session::Recording:
2015                         if (roll) {
2016                                 _session->request_stop();
2017                         } else {
2018                                 _session->disable_record (false, true);
2019                         }
2020                         break;
2021
2022                 case Session::Enabled:
2023                         _session->disable_record (false, true);
2024                 }
2025         }
2026 }
2027
2028 void
2029 ARDOUR_UI::transport_roll ()
2030 {
2031         if (!_session) {
2032                 return;
2033         }
2034
2035         if (_session->is_auditioning()) {
2036                 return;
2037         }
2038
2039 #if 0
2040         if (_session->config.get_external_sync()) {
2041                 switch (Config->get_sync_source()) {
2042                 case Engine:
2043                         break;
2044                 default:
2045                         /* transport controlled by the master */
2046                         return;
2047                 }
2048         }
2049 #endif
2050
2051         bool rolling = _session->transport_rolling();
2052
2053         if (_session->get_play_loop()) {
2054
2055                 /* If loop playback is not a mode, then we should cancel
2056                    it when this action is requested. If it is a mode
2057                    we just leave it in place.
2058                 */
2059
2060                 if (!Config->get_loop_is_mode()) {
2061                         /* XXX it is not possible to just leave seamless loop and keep
2062                            playing at present (nov 4th 2009)
2063                         */
2064                         if (!Config->get_seamless_loop()) {
2065                                 /* stop loop playback and stop rolling */
2066                                 _session->request_play_loop (false, true);
2067                         } else if (rolling) {
2068                                 /* stop loop playback but keep rolling */
2069                                 _session->request_play_loop (false, false);
2070                         }
2071                 }
2072
2073         } else if (_session->get_play_range () ) {
2074                 /* stop playing a range if we currently are */
2075                 _session->request_play_range (0, true);
2076         }
2077
2078         if (!rolling) {
2079                 _session->request_transport_speed (1.0f);
2080         }
2081 }
2082
2083 bool
2084 ARDOUR_UI::get_smart_mode() const
2085 {
2086         return ( editor->get_smart_mode() );
2087 }
2088
2089
2090 void
2091 ARDOUR_UI::toggle_roll (bool with_abort, bool roll_out_of_bounded_mode)
2092 {
2093
2094         if (!_session) {
2095                 return;
2096         }
2097
2098         if (_session->is_auditioning()) {
2099                 _session->cancel_audition ();
2100                 return;
2101         }
2102
2103         if (_session->config.get_external_sync()) {
2104                 switch (Config->get_sync_source()) {
2105                 case Engine:
2106                         break;
2107                 default:
2108                         /* transport controlled by the master */
2109                         return;
2110                 }
2111         }
2112
2113         bool rolling = _session->transport_rolling();
2114         bool affect_transport = true;
2115
2116         if (rolling && roll_out_of_bounded_mode) {
2117                 /* drop out of loop/range playback but leave transport rolling */
2118                 if (_session->get_play_loop()) {
2119                         if (Config->get_seamless_loop()) {
2120                                 /* the disk buffers contain copies of the loop - we can't
2121                                    just keep playing, so stop the transport. the user
2122                                    can restart as they wish.
2123                                 */
2124                                 affect_transport = true;
2125                         } else {
2126                                 /* disk buffers are normal, so we can keep playing */
2127                                 affect_transport = false;
2128                         }
2129                         _session->request_play_loop (false, affect_transport);
2130                 } else if (_session->get_play_range ()) {
2131                         affect_transport = false;
2132                         _session->request_play_range (0, true);
2133                 }
2134         }
2135
2136         if (affect_transport) {
2137                 if (rolling) {
2138                         _session->request_stop (with_abort, true);
2139                 } else {
2140                         if (ARDOUR_UI::config()->get_follow_edits() && ( editor->get_selection().time.front().start == _session->transport_frame() ) ) {  //if playhead is exactly at the start of a range, we can assume it was placed there by follow_edits
2141                                 _session->request_play_range (&editor->get_selection().time, true);
2142                                 _session->set_requested_return_frame( editor->get_selection().time.front().start );  //force an auto-return here
2143                         }
2144                         _session->request_transport_speed (1.0f);
2145                 }
2146         }
2147 }
2148
2149 void
2150 ARDOUR_UI::toggle_session_auto_loop ()
2151 {
2152         Location * looploc = _session->locations()->auto_loop_location();
2153
2154         if (!_session || !looploc) {
2155                 return;
2156         }
2157
2158         if (_session->get_play_loop()) {
2159
2160                 /* looping enabled, our job is to disable it */
2161
2162                 _session->request_play_loop (false);
2163
2164         } else {
2165
2166                 /* looping not enabled, our job is to enable it.
2167
2168                    loop-is-NOT-mode: this action always starts the transport rolling.
2169                    loop-IS-mode:     this action simply sets the loop play mechanism, but
2170                                         does not start transport.
2171                 */
2172                 if (Config->get_loop_is_mode()) {
2173                         _session->request_play_loop (true, false);
2174                 } else {
2175                         _session->request_play_loop (true, true);
2176                 }
2177         }
2178
2179         //show the loop markers
2180         looploc->set_hidden (false, this);
2181 }
2182
2183 void
2184 ARDOUR_UI::transport_play_selection ()
2185 {
2186         if (!_session) {
2187                 return;
2188         }
2189
2190         editor->play_selection ();
2191 }
2192
2193 void
2194 ARDOUR_UI::transport_play_preroll ()
2195 {
2196         if (!_session) {
2197                 return;
2198         }
2199         editor->play_with_preroll ();
2200 }
2201
2202 void
2203 ARDOUR_UI::transport_rewind (int option)
2204 {
2205         float current_transport_speed;
2206
2207         if (_session) {
2208                 current_transport_speed = _session->transport_speed();
2209
2210                 if (current_transport_speed >= 0.0f) {
2211                         switch (option) {
2212                         case 0:
2213                                 _session->request_transport_speed (-1.0f);
2214                                 break;
2215                         case 1:
2216                                 _session->request_transport_speed (-4.0f);
2217                                 break;
2218                         case -1:
2219                                 _session->request_transport_speed (-0.5f);
2220                                 break;
2221                         }
2222                 } else {
2223                         /* speed up */
2224                         _session->request_transport_speed (current_transport_speed * 1.5f);
2225                 }
2226         }
2227 }
2228
2229 void
2230 ARDOUR_UI::transport_forward (int option)
2231 {
2232         if (!_session) {
2233                 return;
2234         }
2235
2236         float current_transport_speed = _session->transport_speed();
2237
2238         if (current_transport_speed <= 0.0f) {
2239                 switch (option) {
2240                 case 0:
2241                         _session->request_transport_speed (1.0f);
2242                         break;
2243                 case 1:
2244                         _session->request_transport_speed (4.0f);
2245                         break;
2246                 case -1:
2247                         _session->request_transport_speed (0.5f);
2248                         break;
2249                 }
2250         } else {
2251                 /* speed up */
2252                 _session->request_transport_speed (current_transport_speed * 1.5f);
2253         }
2254 }
2255
2256 void
2257 ARDOUR_UI::toggle_record_enable (uint32_t rid)
2258 {
2259         if (!_session) {
2260                 return;
2261         }
2262
2263         boost::shared_ptr<Route> r;
2264
2265         if ((r = _session->route_by_remote_id (rid)) != 0) {
2266
2267                 Track* t;
2268
2269                 if ((t = dynamic_cast<Track*>(r.get())) != 0) {
2270                         t->set_record_enabled (!t->record_enabled(), this);
2271                 }
2272         }
2273 }
2274
2275 void
2276 ARDOUR_UI::map_transport_state ()
2277 {
2278         if (!_session) {
2279                 auto_loop_button.unset_active_state ();
2280                 play_selection_button.unset_active_state ();
2281                 roll_button.unset_active_state ();
2282                 stop_button.set_active_state (Gtkmm2ext::ExplicitActive);
2283                 return;
2284         }
2285
2286         shuttle_box->map_transport_state ();
2287
2288         float sp = _session->transport_speed();
2289
2290         if (sp != 0.0f) {
2291
2292                 /* we're rolling */
2293
2294                 if (_session->get_play_range()) {
2295
2296                         play_selection_button.set_active_state (Gtkmm2ext::ExplicitActive);
2297                         roll_button.unset_active_state ();
2298                         auto_loop_button.unset_active_state ();
2299
2300                 } else if (_session->get_play_loop ()) {
2301
2302                         auto_loop_button.set_active (true);
2303                         play_selection_button.set_active (false);
2304                         if (Config->get_loop_is_mode()) {
2305                                 roll_button.set_active (true);
2306                         } else {
2307                                 roll_button.set_active (false);
2308                         }
2309
2310                 } else {
2311
2312                         roll_button.set_active (true);
2313                         play_selection_button.set_active (false);
2314                         auto_loop_button.set_active (false);
2315                 }
2316
2317                 if (ARDOUR_UI::config()->get_follow_edits()) {
2318                         /* light up both roll and play-selection if they are joined */
2319                         roll_button.set_active (true);
2320                         play_selection_button.set_active (true);
2321                 }
2322
2323                 stop_button.set_active (false);
2324
2325         } else {
2326
2327                 stop_button.set_active (true);
2328                 roll_button.set_active (false);
2329                 play_selection_button.set_active (false);
2330                 if (Config->get_loop_is_mode ()) {
2331                         auto_loop_button.set_active (_session->get_play_loop());
2332                 } else {
2333                         auto_loop_button.set_active (false);
2334                 }
2335                 update_disk_space ();
2336         }
2337 }
2338
2339 void
2340 ARDOUR_UI::blink_handler (bool blink_on)
2341 {
2342         transport_rec_enable_blink (blink_on);
2343         solo_blink (blink_on);
2344         sync_blink (blink_on);
2345         audition_blink (blink_on);
2346         feedback_blink (blink_on);
2347         error_blink (blink_on);
2348 }
2349
2350 void
2351 ARDOUR_UI::update_clocks ()
2352 {
2353         if (!_session) return;
2354
2355         if (editor && !editor->dragging_playhead()) {
2356                 Clock (_session->audible_frame(), false, editor->get_preferred_edit_position()); /* EMIT_SIGNAL */
2357         }
2358 }
2359
2360 void
2361 ARDOUR_UI::start_clocking ()
2362 {
2363         if (ui_config->get_super_rapid_clock_update()) {
2364                 clock_signal_connection = Timers::fps_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2365         } else {
2366                 clock_signal_connection = Timers::rapid_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2367         }
2368 }
2369
2370 void
2371 ARDOUR_UI::stop_clocking ()
2372 {
2373         clock_signal_connection.disconnect ();
2374 }
2375
2376 /** Ask the user for the name of a new snapshot and then take it.
2377  */
2378
2379 void
2380 ARDOUR_UI::snapshot_session (bool switch_to_it)
2381 {
2382         ArdourPrompter prompter (true);
2383         string snapname;
2384
2385         prompter.set_name ("Prompter");
2386         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2387         if (switch_to_it) {
2388                 prompter.set_title (_("Save as..."));
2389                 prompter.set_prompt (_("New session name"));
2390         } else {
2391                 prompter.set_title (_("Take Snapshot"));
2392                 prompter.set_prompt (_("Name of new snapshot"));
2393         }
2394
2395         if (!switch_to_it) {
2396                 char timebuf[128];
2397                 time_t n;
2398                 struct tm local_time;
2399
2400                 time (&n);
2401                 localtime_r (&n, &local_time);
2402                 strftime (timebuf, sizeof(timebuf), "%FT%H.%M.%S", &local_time);
2403                 prompter.set_initial_text (timebuf);
2404         }
2405
2406   again:
2407         switch (prompter.run()) {
2408         case RESPONSE_ACCEPT:
2409         {
2410                 prompter.get_result (snapname);
2411
2412                 bool do_save = (snapname.length() != 0);
2413
2414                 if (do_save) {
2415                         char illegal = Session::session_name_is_legal(snapname);
2416                         if (illegal) {
2417                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2418                                                      "snapshot names may not contain a '%1' character"), illegal));
2419                                 msg.run ();
2420                                 goto again;
2421                         }
2422                 }
2423
2424                 vector<std::string> p;
2425                 get_state_files_in_directory (_session->session_directory().root_path(), p);
2426                 vector<string> n = get_file_names_no_extension (p);
2427                 if (find (n.begin(), n.end(), snapname) != n.end()) {
2428
2429                         ArdourDialog confirm (_("Confirm Snapshot Overwrite"), true);
2430                         Label m (_("A snapshot already exists with that name.  Do you want to overwrite it?"));
2431                         confirm.get_vbox()->pack_start (m, true, true);
2432                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
2433                         confirm.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
2434                         confirm.show_all ();
2435                         switch (confirm.run()) {
2436                         case RESPONSE_CANCEL:
2437                                 do_save = false;
2438                         }
2439                 }
2440
2441                 if (do_save) {
2442                         save_state (snapname, switch_to_it);
2443                 }
2444                 break;
2445         }
2446
2447         default:
2448                 break;
2449         }
2450 }
2451
2452 /** Ask the user for a new session name and then rename the session to it.
2453  */
2454
2455 void
2456 ARDOUR_UI::rename_session ()
2457 {
2458         if (!_session) {
2459                 return;
2460         }
2461
2462         ArdourPrompter prompter (true);
2463         string name;
2464
2465         prompter.set_name ("Prompter");
2466         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2467         prompter.set_title (_("Rename Session"));
2468         prompter.set_prompt (_("New session name"));
2469
2470   again:
2471         switch (prompter.run()) {
2472         case RESPONSE_ACCEPT:
2473         {
2474                 prompter.get_result (name);
2475
2476                 bool do_rename = (name.length() != 0);
2477
2478                 if (do_rename) {
2479                         char illegal = Session::session_name_is_legal (name);
2480
2481                         if (illegal) {
2482                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2483                                                                      "session names may not contain a '%1' character"), illegal));
2484                                 msg.run ();
2485                                 goto again;
2486                         }
2487
2488                         switch (_session->rename (name)) {
2489                         case -1: {
2490                                 MessageDialog msg (_("That name is already in use by another directory/folder. Please try again."));
2491                                 msg.set_position (WIN_POS_MOUSE);
2492                                 msg.run ();
2493                                 goto again;
2494                                 break;
2495                         }
2496                         case 0:
2497                                 break;
2498                         default: {
2499                                 MessageDialog msg (_("Renaming this session failed.\nThings could be seriously messed up at this point"));
2500                                 msg.set_position (WIN_POS_MOUSE);
2501                                 msg.run ();
2502                                 break;
2503                         }
2504                         }
2505                 }
2506
2507                 break;
2508         }
2509
2510         default:
2511                 break;
2512         }
2513 }
2514
2515 void
2516 ARDOUR_UI::save_state (const string & name, bool switch_to_it)
2517 {
2518         XMLNode* node = new XMLNode (X_("UI"));
2519
2520         WM::Manager::instance().add_state (*node);
2521
2522         node->add_child_nocopy (gui_object_state->get_state());
2523
2524         _session->add_extra_xml (*node);
2525
2526         if (export_video_dialog) {
2527                 _session->add_extra_xml (export_video_dialog->get_state());
2528         }
2529
2530         save_state_canfail (name, switch_to_it);
2531 }
2532
2533 int
2534 ARDOUR_UI::save_state_canfail (string name, bool switch_to_it)
2535 {
2536         if (_session) {
2537                 int ret;
2538
2539                 if (name.length() == 0) {
2540                         name = _session->snap_name();
2541                 }
2542
2543                 if ((ret = _session->save_state (name, false, switch_to_it)) != 0) {
2544                         return ret;
2545                 }
2546         }
2547
2548         save_ardour_state (); /* XXX cannot fail? yeah, right ... */
2549         return 0;
2550 }
2551
2552 void
2553 ARDOUR_UI::primary_clock_value_changed ()
2554 {
2555         if (_session) {
2556                 _session->request_locate (primary_clock->current_time ());
2557         }
2558 }
2559
2560 void
2561 ARDOUR_UI::big_clock_value_changed ()
2562 {
2563         if (_session) {
2564                 _session->request_locate (big_clock->current_time ());
2565         }
2566 }
2567
2568 void
2569 ARDOUR_UI::secondary_clock_value_changed ()
2570 {
2571         if (_session) {
2572                 _session->request_locate (secondary_clock->current_time ());
2573         }
2574 }
2575
2576 void
2577 ARDOUR_UI::transport_rec_enable_blink (bool onoff)
2578 {
2579         if (_session == 0) {
2580                 return;
2581         }
2582
2583         if (_session->step_editing()) {
2584                 return;
2585         }
2586
2587         Session::RecordState const r = _session->record_status ();
2588         bool const h = _session->have_rec_enabled_track ();
2589
2590         if (r == Session::Enabled || (r == Session::Recording && !h)) {
2591                 if (onoff) {
2592                         rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2593                 } else {
2594                         rec_button.set_active_state (Gtkmm2ext::Off);
2595                 }
2596         } else if (r == Session::Recording && h) {
2597                 rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2598         } else {
2599                 rec_button.unset_active_state ();
2600         }
2601 }
2602
2603 void
2604 ARDOUR_UI::save_template ()
2605 {
2606         ArdourPrompter prompter (true);
2607         string name;
2608
2609         if (!check_audioengine()) {
2610                 return;
2611         }
2612
2613         prompter.set_name (X_("Prompter"));
2614         prompter.set_title (_("Save Template"));
2615         prompter.set_prompt (_("Name for template:"));
2616         prompter.set_initial_text(_session->name() + _("-template"));
2617         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2618
2619         switch (prompter.run()) {
2620         case RESPONSE_ACCEPT:
2621                 prompter.get_result (name);
2622
2623                 if (name.length()) {
2624                         _session->save_template (name);
2625                 }
2626                 break;
2627
2628         default:
2629                 break;
2630         }
2631 }
2632
2633 void
2634 ARDOUR_UI::edit_metadata ()
2635 {
2636         SessionMetadataEditor dialog;
2637         dialog.set_session (_session);
2638         dialog.grab_focus ();
2639         dialog.run ();
2640 }
2641
2642 void
2643 ARDOUR_UI::import_metadata ()
2644 {
2645         SessionMetadataImporter dialog;
2646         dialog.set_session (_session);
2647         dialog.run ();
2648 }
2649
2650 bool
2651 ARDOUR_UI::ask_about_loading_existing_session (const std::string& session_path)
2652 {
2653         std::string str = string_compose (_("This session\n%1\nalready exists. Do you want to open it?"), session_path);
2654
2655         MessageDialog msg (str,
2656                            false,
2657                            Gtk::MESSAGE_WARNING,
2658                            Gtk::BUTTONS_YES_NO,
2659                            true);
2660
2661
2662         msg.set_name (X_("OpenExistingDialog"));
2663         msg.set_title (_("Open Existing Session"));
2664         msg.set_wmclass (X_("existing_session"), PROGRAM_NAME);
2665         msg.set_position (Gtk::WIN_POS_CENTER);
2666         pop_back_splash (msg);
2667
2668         switch (msg.run()) {
2669         case RESPONSE_YES:
2670                 return true;
2671                 break;
2672         }
2673         return false;
2674 }
2675
2676 int
2677 ARDOUR_UI::build_session_from_dialog (SessionDialog& sd, const std::string& session_path, const std::string& session_name)
2678 {
2679         BusProfile bus_profile;
2680
2681         if (nsm || Profile->get_sae()) {
2682
2683                 bus_profile.master_out_channels = 2;
2684                 bus_profile.input_ac = AutoConnectPhysical;
2685                 bus_profile.output_ac = AutoConnectMaster;
2686                 bus_profile.requested_physical_in = 0; // use all available
2687                 bus_profile.requested_physical_out = 0; // use all available
2688
2689         } else {
2690
2691                 /* get settings from advanced section of NSD */
2692
2693                 if (sd.create_master_bus()) {
2694                         bus_profile.master_out_channels = (uint32_t) sd.master_channel_count();
2695                 } else {
2696                         bus_profile.master_out_channels = 0;
2697                 }
2698
2699                 if (sd.connect_inputs()) {
2700                         bus_profile.input_ac = AutoConnectPhysical;
2701                 } else {
2702                         bus_profile.input_ac = AutoConnectOption (0);
2703                 }
2704
2705                 bus_profile.output_ac = AutoConnectOption (0);
2706
2707                 if (sd.connect_outputs ()) {
2708                         if (sd.connect_outs_to_master()) {
2709                                 bus_profile.output_ac = AutoConnectMaster;
2710                         } else if (sd.connect_outs_to_physical()) {
2711                                 bus_profile.output_ac = AutoConnectPhysical;
2712                         }
2713                 }
2714
2715                 bus_profile.requested_physical_in = (uint32_t) sd.input_limit_count();
2716                 bus_profile.requested_physical_out = (uint32_t) sd.output_limit_count();
2717         }
2718
2719         if (build_session (session_path, session_name, bus_profile)) {
2720                 return -1;
2721         }
2722
2723         return 0;
2724 }
2725
2726 void
2727 ARDOUR_UI::load_from_application_api (const std::string& path)
2728 {
2729         ARDOUR_COMMAND_LINE::session_name = path;
2730
2731         if (Glib::file_test (path, Glib::FILE_TEST_IS_DIR)) {
2732                 /* /path/to/foo => /path/to/foo, foo */
2733                 load_session (path, basename_nosuffix (path));
2734         } else {
2735                 /* /path/to/foo/foo.ardour => /path/to/foo, foo */
2736                 load_session (Glib::path_get_dirname (path), basename_nosuffix (path));
2737         }
2738 }
2739
2740 /** @param quit_on_cancel true if exit() should be called if the user clicks `cancel' in the new session dialog */
2741 int
2742 ARDOUR_UI::get_session_parameters (bool quit_on_cancel, bool should_be_new, string load_template)
2743 {
2744         string session_name;
2745         string session_path;
2746         string template_name;
2747         int ret = -1;
2748         bool likely_new = false;
2749         bool cancel_not_quit;
2750
2751         /* deal with any existing DIRTY session now, rather than later. don't
2752          * treat a non-dirty session this way, so that it stays visible
2753          * as we bring up the new session dialog.
2754          */
2755
2756         if (_session && ARDOUR_UI::instance()->video_timeline) {
2757                 ARDOUR_UI::instance()->video_timeline->sync_session_state();
2758         }
2759
2760         /* if there is already a session, relabel the button
2761            on the SessionDialog so that we don't Quit directly
2762         */
2763         cancel_not_quit = (_session != 0);
2764
2765         if (_session && _session->dirty()) {
2766                 if (unload_session (false)) {
2767                         /* unload cancelled by user */
2768                         return 0;
2769                 }
2770                 ARDOUR_COMMAND_LINE::session_name = "";
2771         }
2772
2773         if (!load_template.empty()) {
2774                 should_be_new = true;
2775                 template_name = load_template;
2776         }
2777
2778         session_name = basename_nosuffix (ARDOUR_COMMAND_LINE::session_name);
2779         session_path = ARDOUR_COMMAND_LINE::session_name;
2780
2781         if (!session_path.empty()) {
2782                 if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_EXISTS)) {
2783                         if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_IS_REGULAR)) {
2784                                 /* session/snapshot file, change path to be dir */
2785                                 session_path = Glib::path_get_dirname (session_path);
2786                         }
2787                 }
2788         }
2789
2790         SessionDialog session_dialog (should_be_new, session_name, session_path, load_template, cancel_not_quit);
2791
2792         while (ret != 0) {
2793
2794                 if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
2795
2796                         /* if they named a specific statefile, use it, otherwise they are
2797                            just giving a session folder, and we want to use it as is
2798                            to find the session.
2799                         */
2800
2801                         string::size_type suffix = ARDOUR_COMMAND_LINE::session_name.find (statefile_suffix);
2802
2803                         if (suffix != string::npos) {
2804                                 session_path = Glib::path_get_dirname (ARDOUR_COMMAND_LINE::session_name);
2805                                 session_name = ARDOUR_COMMAND_LINE::session_name.substr (0, suffix);
2806                                 session_name = Glib::path_get_basename (session_name);
2807                         } else {
2808                                 session_path = ARDOUR_COMMAND_LINE::session_name;
2809                                 session_name = Glib::path_get_basename (ARDOUR_COMMAND_LINE::session_name);
2810                         }
2811                 } else {
2812                         session_path = "";
2813                         session_name = "";
2814                         session_dialog.clear_given ();
2815                 }
2816
2817                 if (should_be_new || session_name.empty()) {
2818                         /* need the dialog to get info from user */
2819
2820                         cerr << "run dialog\n";
2821
2822                         switch (session_dialog.run()) {
2823                         case RESPONSE_ACCEPT:
2824                                 break;
2825                         default:
2826                                 if (quit_on_cancel) {
2827                                         // JE - Currently (July 2014) this section can only get reached if the
2828                                         // user quits from the main 'Session Setup' dialog (i.e. reaching this
2829                                         // point does NOT indicate an abnormal termination). Therefore, let's
2830                                         // behave gracefully (i.e. let's do some cleanup) before we call exit()
2831                                         ARDOUR::cleanup ();
2832                                         pthread_cancel_all ();
2833
2834                                         exit (1);
2835                                 } else {
2836                                         return ret;
2837                                 }
2838                         }
2839
2840                         session_dialog.hide ();
2841                 }
2842
2843                 /* if we run the startup dialog again, offer more than just "new session" */
2844
2845                 should_be_new = false;
2846
2847                 session_name = session_dialog.session_name (likely_new);
2848                 session_path = session_dialog.session_folder ();
2849
2850                 if (nsm) {
2851                         likely_new = true;
2852                 }
2853
2854                 string::size_type suffix = session_name.find (statefile_suffix);
2855
2856                 if (suffix != string::npos) {
2857                         session_name = session_name.substr (0, suffix);
2858                 }
2859
2860                 /* this shouldn't happen, but we catch it just in case it does */
2861
2862                 if (session_name.empty()) {
2863                         continue;
2864                 }
2865
2866                 if (session_dialog.use_session_template()) {
2867                         template_name = session_dialog.session_template_name();
2868                         _session_is_new = true;
2869                 }
2870
2871                 if (session_name[0] == G_DIR_SEPARATOR ||
2872 #ifdef PLATFORM_WINDOWS
2873                     (session_name.length() > 3 && session_name[1] == ':' && session_name[2] == G_DIR_SEPARATOR)
2874 #else
2875                     (session_name.length() > 2 && session_name[0] == '.' && session_name[1] == G_DIR_SEPARATOR) ||
2876                     (session_name.length() > 3 && session_name[0] == '.' && session_name[1] == '.' && session_name[2] == G_DIR_SEPARATOR)
2877 #endif
2878                          )
2879                 {
2880
2881                         /* absolute path or cwd-relative path specified for session name: infer session folder
2882                            from what was given.
2883                         */
2884
2885                         session_path = Glib::path_get_dirname (session_name);
2886                         session_name = Glib::path_get_basename (session_name);
2887
2888                 } else {
2889
2890                         session_path = session_dialog.session_folder();
2891
2892                         char illegal = Session::session_name_is_legal (session_name);
2893
2894                         if (illegal) {
2895                                 MessageDialog msg (session_dialog,
2896                                                    string_compose (_("To ensure compatibility with various systems\n"
2897                                                                      "session names may not contain a '%1' character"),
2898                                                                    illegal));
2899                                 msg.run ();
2900                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2901                                 continue;
2902                         }
2903                 }
2904
2905                 if (Glib::file_test (session_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))) {
2906
2907
2908                         if (likely_new && !nsm) {
2909
2910                                 std::string existing = Glib::build_filename (session_path, session_name);
2911
2912                                 if (!ask_about_loading_existing_session (existing)) {
2913                                         ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2914                                         continue;
2915                                 }
2916                         }
2917
2918                         _session_is_new = false;
2919
2920                 } else {
2921
2922                         if (!likely_new) {
2923                                 pop_back_splash (session_dialog);
2924                                 MessageDialog msg (string_compose (_("There is no existing session at \"%1\""), session_path));
2925                                 msg.run ();
2926                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2927                                 continue;
2928                         }
2929
2930                         char illegal = Session::session_name_is_legal(session_name);
2931
2932                         if (illegal) {
2933                                 pop_back_splash (session_dialog);
2934                                 MessageDialog msg (session_dialog, string_compose(_("To ensure compatibility with various systems\n"
2935                                                                                     "session names may not contain a '%1' character"), illegal));
2936                                 msg.run ();
2937                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2938                                 continue;
2939                         }
2940
2941                         _session_is_new = true;
2942                 }
2943
2944                 if (likely_new && template_name.empty()) {
2945
2946                         ret = build_session_from_dialog (session_dialog, session_path, session_name);
2947
2948                 } else {
2949
2950                         ret = load_session (session_path, session_name, template_name);
2951
2952                         if (ret == -2) {
2953                                 /* not connected to the AudioEngine, so quit to avoid an infinite loop */
2954                                 exit (1);
2955                         }
2956
2957                         if (!ARDOUR_COMMAND_LINE::immediate_save.empty()) {
2958                                 _session->save_state (ARDOUR_COMMAND_LINE::immediate_save, false);
2959                                 exit (1);
2960                         }
2961
2962                         /* clear this to avoid endless attempts to load the
2963                            same session.
2964                         */
2965
2966                         ARDOUR_COMMAND_LINE::session_name = "";
2967                 }
2968         }
2969
2970         return ret;
2971 }
2972
2973 void
2974 ARDOUR_UI::close_session()
2975 {
2976         if (!check_audioengine()) {
2977                 return;
2978         }
2979
2980         if (unload_session (true)) {
2981                 return;
2982         }
2983
2984         ARDOUR_COMMAND_LINE::session_name = "";
2985
2986         if (get_session_parameters (true, false)) {
2987                 exit (1);
2988         }
2989
2990         goto_editor_window ();
2991 }
2992
2993 /** @param snap_name Snapshot name (without .ardour suffix).
2994  *  @return -2 if the load failed because we are not connected to the AudioEngine.
2995  */
2996 int
2997 ARDOUR_UI::load_session (const std::string& path, const std::string& snap_name, std::string mix_template)
2998 {
2999         Session *new_session;
3000         int unload_status;
3001         int retval = -1;
3002
3003         if (_session) {
3004                 unload_status = unload_session ();
3005
3006                 if (unload_status < 0) {
3007                         goto out;
3008                 } else if (unload_status > 0) {
3009                         retval = 0;
3010                         goto out;
3011                 }
3012         }
3013
3014         session_loaded = false;
3015
3016         loading_message (string_compose (_("Please wait while %1 loads your session"), PROGRAM_NAME));
3017
3018         try {
3019                 new_session = new Session (*AudioEngine::instance(), path, snap_name, 0, mix_template);
3020         }
3021
3022         /* this one is special */
3023
3024         catch (AudioEngine::PortRegistrationFailure& err) {
3025
3026                 MessageDialog msg (err.what(),
3027                                    true,
3028                                    Gtk::MESSAGE_INFO,
3029                                    Gtk::BUTTONS_CLOSE);
3030
3031                 msg.set_title (_("Port Registration Error"));
3032                 msg.set_secondary_text (_("Click the Close button to try again."));
3033                 msg.set_position (Gtk::WIN_POS_CENTER);
3034                 pop_back_splash (msg);
3035                 msg.present ();
3036
3037                 int response = msg.run ();
3038
3039                 msg.hide ();
3040
3041                 switch (response) {
3042                 case RESPONSE_CANCEL:
3043                         exit (1);
3044                 default:
3045                         break;
3046                 }
3047                 goto out;
3048         }
3049
3050         catch (...) {
3051
3052                 MessageDialog msg (string_compose(
3053                                            _("Session \"%1 (snapshot %2)\" did not load successfully"),
3054                                            path, snap_name),
3055                                    true,
3056                                    Gtk::MESSAGE_INFO,
3057                                    BUTTONS_OK);
3058
3059                 msg.set_title (_("Loading Error"));
3060                 msg.set_position (Gtk::WIN_POS_CENTER);
3061                 pop_back_splash (msg);
3062                 msg.present ();
3063                 (void) msg.run ();
3064                 msg.hide ();
3065
3066                 goto out;
3067         }
3068
3069         {
3070                 list<string> const u = new_session->unknown_processors ();
3071                 if (!u.empty()) {
3072                         MissingPluginDialog d (_session, u);
3073                         d.run ();
3074                 }
3075         }
3076
3077         if (!new_session->writable()) {
3078                 MessageDialog msg (_("This session has been opened in read-only mode.\n\nYou will not be able to record or save."),
3079                                    true,
3080                                    Gtk::MESSAGE_INFO,
3081                                    BUTTONS_OK);
3082
3083                 msg.set_title (_("Read-only Session"));
3084                 msg.set_position (Gtk::WIN_POS_CENTER);
3085                 pop_back_splash (msg);
3086                 msg.present ();
3087                 (void) msg.run ();
3088                 msg.hide ();
3089         }
3090
3091
3092         /* Now the session been created, add the transport controls */
3093         new_session->add_controllable(roll_controllable);
3094         new_session->add_controllable(stop_controllable);
3095         new_session->add_controllable(goto_start_controllable);
3096         new_session->add_controllable(goto_end_controllable);
3097         new_session->add_controllable(auto_loop_controllable);
3098         new_session->add_controllable(play_selection_controllable);
3099         new_session->add_controllable(rec_controllable);
3100
3101         set_session (new_session);
3102
3103         session_loaded = true;
3104
3105         goto_editor_window ();
3106
3107         if (_session) {
3108                 _session->set_clean ();
3109         }
3110
3111 #ifdef WINDOWS_VST_SUPPORT
3112         fst_stop_threading();
3113 #endif
3114
3115         flush_pending ();
3116
3117 #ifdef WINDOWS_VST_SUPPORT
3118         fst_start_threading();
3119 #endif
3120         retval = 0;
3121
3122   out:
3123         return retval;
3124 }
3125
3126 int
3127 ARDOUR_UI::build_session (const std::string& path, const std::string& snap_name, BusProfile& bus_profile)
3128 {
3129         Session *new_session;
3130         int x;
3131
3132         session_loaded = false;
3133         x = unload_session ();
3134
3135         if (x < 0) {
3136                 return -1;
3137         } else if (x > 0) {
3138                 return 0;
3139         }
3140
3141         _session_is_new = true;
3142
3143         try {
3144                 new_session = new Session (*AudioEngine::instance(), path, snap_name, &bus_profile);
3145         }
3146
3147         catch (...) {
3148
3149                 MessageDialog msg (string_compose(_("Could not create session in \"%1\""), path));
3150                 pop_back_splash (msg);
3151                 msg.run ();
3152                 return -1;
3153         }
3154
3155         /* Give the new session the default GUI state, if such things exist */
3156
3157         XMLNode* n;
3158         n = Config->instant_xml (X_("Editor"));
3159         if (n) {
3160                 n->remove_nodes_and_delete ("Selection"); // no not apply selection to new sessions.
3161                 new_session->add_instant_xml (*n, false);
3162         }
3163         n = Config->instant_xml (X_("Mixer"));
3164         if (n) {
3165                 new_session->add_instant_xml (*n, false);
3166         }
3167
3168         /* Put the playhead at 0 and scroll fully left */
3169         n = new_session->instant_xml (X_("Editor"));
3170         if (n) {
3171                 n->add_property (X_("playhead"), X_("0"));
3172                 n->add_property (X_("left-frame"), X_("0"));
3173         }
3174
3175         set_session (new_session);
3176
3177         session_loaded = true;
3178
3179         new_session->save_state(new_session->name());
3180
3181         return 0;
3182 }
3183
3184 void
3185 ARDOUR_UI::launch_chat ()
3186 {
3187 #ifdef __APPLE__
3188         open_uri("http://webchat.freenode.net/?channels=ardour-osx");
3189 #elif defined PLATFORM_WINDOWS
3190         open_uri("http://webchat.freenode.net/?channels=ardour-windows");
3191 #else
3192         open_uri("http://webchat.freenode.net/?channels=ardour");
3193 #endif
3194 }
3195
3196 void
3197 ARDOUR_UI::launch_manual ()
3198 {
3199         PBD::open_uri (Config->get_tutorial_manual_url());
3200 }
3201
3202 void
3203 ARDOUR_UI::launch_reference ()
3204 {
3205         PBD::open_uri (Config->get_reference_manual_url());
3206 }
3207
3208 void
3209 ARDOUR_UI::launch_tracker ()
3210 {
3211         PBD::open_uri ("http://tracker.ardour.org/bug_report_page.php");
3212 }
3213
3214 void
3215 ARDOUR_UI::launch_subscribe ()
3216 {
3217         PBD::open_uri ("https://community.ardour.org/s/subscribe");
3218 }
3219
3220 void
3221 ARDOUR_UI::launch_cheat_sheet ()
3222 {
3223 #ifdef __APPLE__
3224         PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheat_sheet_osx.pdf");
3225 #else
3226         PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheatsheet.pdf");
3227 #endif
3228 }
3229
3230 void
3231 ARDOUR_UI::launch_website ()
3232 {
3233         PBD::open_uri ("http://ardour.org");
3234 }
3235
3236 void
3237 ARDOUR_UI::launch_website_dev ()
3238 {
3239         PBD::open_uri ("http://ardour.org/development.html");
3240 }
3241
3242 void
3243 ARDOUR_UI::launch_forums ()
3244 {
3245         PBD::open_uri ("https://community.ardour.org/forums");
3246 }
3247
3248 void
3249 ARDOUR_UI::launch_howto_report ()
3250 {
3251         PBD::open_uri ("http://ardour.org/reporting_bugs");
3252 }
3253
3254 void
3255 ARDOUR_UI::loading_message (const std::string& msg)
3256 {
3257         if (ARDOUR_COMMAND_LINE::no_splash) {
3258                 return;
3259         }
3260
3261         if (!splash) {
3262                 show_splash ();
3263         }
3264
3265         splash->message (msg);
3266 }
3267
3268 void
3269 ARDOUR_UI::show_splash ()
3270 {
3271         if (splash == 0) {
3272                 try {
3273                         splash = new Splash;
3274                 } catch (...) {
3275                         return;
3276                 }
3277         }
3278
3279         splash->display ();
3280 }
3281
3282 void
3283 ARDOUR_UI::hide_splash ()
3284 {
3285         delete splash;
3286         splash = 0;
3287 }
3288
3289 void
3290 ARDOUR_UI::display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete)
3291 {
3292         size_t removed;
3293
3294         removed = rep.paths.size();
3295
3296         if (removed == 0) {
3297                 MessageDialog msgd (*editor,
3298                                     _("No files were ready for clean-up"),
3299                                     true,
3300                                     Gtk::MESSAGE_INFO,
3301                                     Gtk::BUTTONS_OK);
3302                 msgd.set_title (_("Clean-up"));
3303                 msgd.set_secondary_text (_("If this seems suprising, \n\
3304 check for any existing snapshots.\n\
3305 These may still include regions that\n\
3306 require some unused files to continue to exist."));
3307
3308                 msgd.run ();
3309                 return;
3310         }
3311
3312         ArdourDialog results (_("Clean-up"), true, false);
3313
3314         struct CleanupResultsModelColumns : public Gtk::TreeModel::ColumnRecord {
3315             CleanupResultsModelColumns() {
3316                     add (visible_name);
3317                     add (fullpath);
3318             }
3319             Gtk::TreeModelColumn<std::string> visible_name;
3320             Gtk::TreeModelColumn<std::string> fullpath;
3321         };
3322
3323
3324         CleanupResultsModelColumns results_columns;
3325         Glib::RefPtr<Gtk::ListStore> results_model;
3326         Gtk::TreeView results_display;
3327
3328         results_model = ListStore::create (results_columns);
3329         results_display.set_model (results_model);
3330         results_display.append_column (list_title, results_columns.visible_name);
3331
3332         results_display.set_name ("CleanupResultsList");
3333         results_display.set_headers_visible (true);
3334         results_display.set_headers_clickable (false);
3335         results_display.set_reorderable (false);
3336
3337         Gtk::ScrolledWindow list_scroller;
3338         Gtk::Label txt;
3339         Gtk::VBox dvbox;
3340         Gtk::HBox dhbox;  // the hbox for the image and text
3341         Gtk::HBox ddhbox; // the hbox we eventually pack into the dialog's vbox
3342         Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_INFO,  Gtk::ICON_SIZE_DIALOG));
3343
3344         dimage->set_alignment(ALIGN_LEFT, ALIGN_TOP);
3345
3346         const string dead_directory = _session->session_directory().dead_path();
3347
3348         /* subst:
3349            %1 - number of files removed
3350            %2 - location of "dead"
3351            %3 - size of files affected
3352            %4 - prefix for "bytes" to produce sensible results (e.g. mega, kilo, giga)
3353         */
3354
3355         const char* bprefix;
3356         double space_adjusted = 0;
3357
3358         if (rep.space < 1000) {
3359                 bprefix = X_("");
3360                 space_adjusted = rep.space;
3361         } else if (rep.space < 1000000) {
3362                 bprefix = _("kilo");
3363                 space_adjusted = floorf((float)rep.space / 1000.0);
3364         } else if (rep.space < 1000000 * 1000) {
3365                 bprefix = _("mega");
3366                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000.0));
3367         } else {
3368                 bprefix = _("giga");
3369                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000 * 1000.0));
3370         }
3371
3372         if (msg_delete) {
3373                 txt.set_markup (string_compose (P_("\
3374 The following file was deleted from %2,\n\
3375 releasing %3 %4bytes of disk space", "\
3376 The following %1 files were deleted from %2,\n\
3377 releasing %3 %4bytes of disk space", removed),
3378                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3379         } else {
3380                 txt.set_markup (string_compose (P_("\
3381 The following file was not in use and \n\
3382 has been moved to: %2\n\n\
3383 After a restart of %5\n\n\
3384 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3385 will release an additional %3 %4bytes of disk space.\n", "\
3386 The following %1 files were not in use and \n\
3387 have been moved to: %2\n\n\
3388 After a restart of %5\n\n\
3389 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3390 will release an additional %3 %4bytes of disk space.\n", removed),
3391                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3392         }
3393
3394         dhbox.pack_start (*dimage, true, false, 5);
3395         dhbox.pack_start (txt, true, false, 5);
3396
3397         for (vector<string>::iterator i = rep.paths.begin(); i != rep.paths.end(); ++i) {
3398                 TreeModel::Row row = *(results_model->append());
3399                 row[results_columns.visible_name] = *i;
3400                 row[results_columns.fullpath] = *i;
3401         }
3402
3403         list_scroller.add (results_display);
3404         list_scroller.set_size_request (-1, 150);
3405         list_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
3406
3407         dvbox.pack_start (dhbox, true, false, 5);
3408         dvbox.pack_start (list_scroller, true, false, 5);
3409         ddhbox.pack_start (dvbox, true, false, 5);
3410
3411         results.get_vbox()->pack_start (ddhbox, true, false, 5);
3412         results.add_button (Stock::CLOSE, RESPONSE_CLOSE);
3413         results.set_default_response (RESPONSE_CLOSE);
3414         results.set_position (Gtk::WIN_POS_MOUSE);
3415
3416         results_display.show();
3417         list_scroller.show();
3418         txt.show();
3419         dvbox.show();
3420         dhbox.show();
3421         ddhbox.show();
3422         dimage->show();
3423
3424         //results.get_vbox()->show();
3425         results.set_resizable (false);
3426
3427         results.run ();
3428
3429 }
3430
3431 void
3432 ARDOUR_UI::cleanup ()
3433 {
3434         if (_session == 0) {
3435                 /* shouldn't happen: menu item is insensitive */
3436                 return;
3437         }
3438
3439
3440         MessageDialog checker (_("Are you sure you want to clean-up?"),
3441                                 true,
3442                                 Gtk::MESSAGE_QUESTION,
3443                                 Gtk::BUTTONS_NONE);
3444
3445         checker.set_title (_("Clean-up"));
3446
3447         checker.set_secondary_text(_("Clean-up is a destructive operation.\n\
3448 ALL undo/redo information will be lost if you clean-up.\n\
3449 Clean-up will move all unused files to a \"dead\" location."));
3450
3451         checker.add_button (Stock::CANCEL, RESPONSE_CANCEL);
3452         checker.add_button (_("Clean-up"), RESPONSE_ACCEPT);
3453         checker.set_default_response (RESPONSE_CANCEL);
3454
3455         checker.set_name (_("CleanupDialog"));
3456         checker.set_wmclass (X_("ardour_cleanup"), PROGRAM_NAME);
3457         checker.set_position (Gtk::WIN_POS_MOUSE);
3458
3459         switch (checker.run()) {
3460         case RESPONSE_ACCEPT:
3461                 break;
3462         default:
3463                 return;
3464         }
3465
3466         ARDOUR::CleanupReport rep;
3467
3468         editor->prepare_for_cleanup ();
3469
3470         /* do not allow flush until a session is reloaded */
3471
3472         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Main"), X_("FlushWastebasket"));
3473         if (act) {
3474                 act->set_sensitive (false);
3475         }
3476
3477         if (_session->cleanup_sources (rep)) {
3478                 editor->finish_cleanup ();
3479                 return;
3480         }
3481
3482         editor->finish_cleanup ();
3483
3484         checker.hide();
3485         display_cleanup_results (rep, _("Cleaned Files"), false);
3486 }
3487
3488 void
3489 ARDOUR_UI::flush_trash ()
3490 {
3491         if (_session == 0) {
3492                 /* shouldn't happen: menu item is insensitive */
3493                 return;
3494         }
3495
3496         ARDOUR::CleanupReport rep;
3497
3498         if (_session->cleanup_trash_sources (rep)) {
3499                 return;
3500         }
3501
3502         display_cleanup_results (rep, _("deleted file"), true);
3503 }
3504
3505 void
3506 ARDOUR_UI::setup_order_hint (AddRouteDialog::InsertAt place)
3507 {
3508         uint32_t order_hint = UINT32_MAX;
3509
3510         if (editor->get_selection().tracks.empty()) {
3511                 return;
3512         }
3513
3514         /*
3515           we want the new routes to have their order keys set starting from
3516           the highest order key in the selection + 1 (if available).
3517         */
3518
3519         if (place == AddRouteDialog::AfterSelection) {
3520                 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.back());
3521                 if (rtav) {
3522                         order_hint = rtav->route()->order_key();
3523                         order_hint++;
3524                 }
3525         } else if (place == AddRouteDialog::BeforeSelection) {
3526                 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.front());
3527                 if (rtav) {
3528                         order_hint = rtav->route()->order_key();
3529                 }
3530         } else if (place == AddRouteDialog::First) {
3531                 order_hint = 0;
3532         } else {
3533                 /* leave order_hint at UINT32_MAX */
3534         }
3535
3536         if (order_hint == UINT32_MAX) {
3537                 /** AddRouteDialog::Last or selection with first/last not a RouteTimeAxisView
3538                  * not setting an order hint will place new routes last.
3539                  */
3540                 return;
3541         }
3542
3543         _session->set_order_hint (order_hint);
3544
3545         /* create a gap in the existing route order keys to accomodate new routes.*/
3546         boost::shared_ptr <RouteList> rd = _session->get_routes();
3547         for (RouteList::iterator ri = rd->begin(); ri != rd->end(); ++ri) {
3548                 boost::shared_ptr<Route> rt (*ri);
3549
3550                 if (rt->is_monitor()) {
3551                         continue;
3552                 }
3553
3554                 if (rt->order_key () >= order_hint) {
3555                         rt->set_order_key (rt->order_key () + add_route_dialog->count());
3556                 }
3557         }
3558 }
3559
3560 void
3561 ARDOUR_UI::add_route (Gtk::Window* /* ignored */)
3562 {
3563         int count;
3564
3565         if (!_session) {
3566                 return;
3567         }
3568
3569         if (add_route_dialog->is_visible()) {
3570                 /* we're already doing this */
3571                 return;
3572         }
3573
3574         ResponseType r = (ResponseType) add_route_dialog->run ();
3575
3576         add_route_dialog->hide();
3577
3578         switch (r) {
3579                 case RESPONSE_ACCEPT:
3580                         break;
3581                 default:
3582                         return;
3583                         break;
3584         }
3585
3586         if ((count = add_route_dialog->count()) <= 0) {
3587                 return;
3588         }
3589
3590         setup_order_hint(add_route_dialog->insert_at());
3591
3592         string template_path = add_route_dialog->track_template();
3593         DisplaySuspender ds;
3594
3595         if (!template_path.empty()) {
3596                 if (add_route_dialog->name_template_is_default())  {
3597                         _session->new_route_from_template (count, template_path, string());
3598                 } else {
3599                         _session->new_route_from_template (count, template_path, add_route_dialog->name_template());
3600                 }
3601                 return;
3602         }
3603
3604         ChanCount input_chan= add_route_dialog->channels ();
3605         ChanCount output_chan;
3606         string name_template = add_route_dialog->name_template ();
3607         PluginInfoPtr instrument = add_route_dialog->requested_instrument ();
3608         RouteGroup* route_group = add_route_dialog->route_group ();
3609         AutoConnectOption oac = Config->get_output_auto_connect();
3610
3611         if (oac & AutoConnectMaster) {
3612                 output_chan.set (DataType::AUDIO, (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan.n_audio()));
3613                 output_chan.set (DataType::MIDI, 0);
3614         } else {
3615                 output_chan = input_chan;
3616         }
3617
3618         /* XXX do something with name template */
3619
3620         switch (add_route_dialog->type_wanted()) {
3621         case AddRouteDialog::AudioTrack:
3622                 session_add_audio_track (input_chan.n_audio(), output_chan.n_audio(), add_route_dialog->mode(), route_group, count, name_template);
3623                 break;
3624         case AddRouteDialog::MidiTrack:
3625                 session_add_midi_track (route_group, count, name_template, instrument);
3626                 break;
3627         case AddRouteDialog::MixedTrack:
3628                 session_add_mixed_track (input_chan, output_chan, route_group, count, name_template, instrument);
3629                 break;
3630         case AddRouteDialog::AudioBus:
3631                 session_add_audio_bus (input_chan.n_audio(), output_chan.n_audio(), route_group, count, name_template);
3632                 break;
3633         }
3634 }
3635
3636 void
3637 ARDOUR_UI::stop_video_server (bool ask_confirm)
3638 {
3639         if (!video_server_process && ask_confirm) {
3640                 warning << string_compose (_("Video-Server was not launched by %1. The request to stop it is ignored."), PROGRAM_NAME) << endmsg;
3641         }
3642         if (video_server_process) {
3643                 if(ask_confirm) {
3644                         ArdourDialog confirm (_("Stop Video-Server"), true);
3645                         Label m (_("Do you really want to stop the Video Server?"));
3646                         confirm.get_vbox()->pack_start (m, true, true);
3647                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
3648                         confirm.add_button (_("Yes, Stop It"), Gtk::RESPONSE_ACCEPT);
3649                         confirm.show_all ();
3650                         if (confirm.run() == RESPONSE_CANCEL) {
3651                                 return;
3652                         }
3653                 }
3654                 delete video_server_process;
3655                 video_server_process =0;
3656         }
3657 }
3658
3659 void
3660 ARDOUR_UI::start_video_server_menu (Gtk::Window* float_window)
3661 {
3662   ARDOUR_UI::start_video_server( float_window, true);
3663 }
3664
3665 bool
3666 ARDOUR_UI::start_video_server (Gtk::Window* float_window, bool popup_msg)
3667 {
3668         if (!_session) {
3669                 return false;
3670         }
3671         if (popup_msg) {
3672                 if (ARDOUR_UI::instance()->video_timeline->check_server()) {
3673                         if (video_server_process) {
3674                                 popup_error(_("The Video Server is already started."));
3675                         } else {
3676                                 popup_error(_("An external Video Server is configured and can be reached. Not starting a new instance."));
3677                         }
3678                 }
3679         }
3680
3681         int firsttime = 0;
3682         while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3683                 if (firsttime++) {
3684                         warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
3685                 }
3686                 VideoServerDialog *video_server_dialog = new VideoServerDialog (_session);
3687                 if (float_window) {
3688                         video_server_dialog->set_transient_for (*float_window);
3689                 }
3690
3691                 if (!Config->get_show_video_server_dialog() && firsttime < 2) {
3692                         video_server_dialog->hide();
3693                 } else {
3694                         ResponseType r = (ResponseType) video_server_dialog->run ();
3695                         video_server_dialog->hide();
3696                         if (r != RESPONSE_ACCEPT) { return false; }
3697                         if (video_server_dialog->show_again()) {
3698                                 Config->set_show_video_server_dialog(false);
3699                         }
3700                 }
3701
3702                 std::string icsd_exec = video_server_dialog->get_exec_path();
3703                 std::string icsd_docroot = video_server_dialog->get_docroot();
3704                 if (icsd_docroot.empty()) {
3705 #ifndef PLATFORM_WINDOWS
3706                         icsd_docroot = X_("/");
3707 #else
3708                         icsd_docroot = X_("C:\\");
3709 #endif
3710                 }
3711
3712                 GStatBuf sb;
3713                 if (g_lstat (icsd_docroot.c_str(), &sb) != 0 || !S_ISDIR(sb.st_mode)) {
3714                         warning << _("Specified docroot is not an existing directory.") << endmsg;
3715                         continue;
3716                 }
3717 #ifndef PLATFORM_WINDOWS
3718                 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
3719                      || (sb.st_mode & (S_IXUSR|S_IXGRP|S_IXOTH)) == 0 ) {
3720                         warning << _("Given Video Server is not an executable file.") << endmsg;
3721                         continue;
3722                 }
3723 #else
3724                 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
3725                      || (sb.st_mode & (S_IXUSR)) == 0 ) {
3726                         warning << _("Given Video Server is not an executable file.") << endmsg;
3727                         continue;
3728                 }
3729 #endif
3730
3731                 char **argp;
3732                 argp=(char**) calloc(9,sizeof(char*));
3733                 argp[0] = strdup(icsd_exec.c_str());
3734                 argp[1] = strdup("-P");
3735                 argp[2] = (char*) calloc(16,sizeof(char)); snprintf(argp[2], 16, "%s", video_server_dialog->get_listenaddr().c_str());
3736                 argp[3] = strdup("-p");
3737                 argp[4] = (char*) calloc(6,sizeof(char)); snprintf(argp[4], 6, "%i", video_server_dialog->get_listenport());
3738                 argp[5] = strdup("-C");
3739                 argp[6] = (char*) calloc(6,sizeof(char)); snprintf(argp[6], 6, "%i", video_server_dialog->get_cachesize());
3740                 argp[7] = strdup(icsd_docroot.c_str());
3741                 argp[8] = 0;
3742                 stop_video_server();
3743
3744                 if (icsd_docroot == X_("/") || icsd_docroot == X_("C:\\")) {
3745                         Config->set_video_advanced_setup(false);
3746                 } else {
3747                         std::ostringstream osstream;
3748                         osstream << "http://localhost:" << video_server_dialog->get_listenport() << "/";
3749                         Config->set_video_server_url(osstream.str());
3750                         Config->set_video_server_docroot(icsd_docroot);
3751                         Config->set_video_advanced_setup(true);
3752                 }
3753
3754                 if (video_server_process) {
3755                         delete video_server_process;
3756                 }
3757
3758                 video_server_process = new ARDOUR::SystemExec(icsd_exec, argp);
3759                 if (video_server_process->start()) {
3760                         warning << _("Cannot launch the video-server") << endmsg;
3761                         continue;
3762                 }
3763                 int timeout = 120; // 6 sec
3764                 while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3765                         Glib::usleep (50000);
3766                         gui_idle_handler();
3767                         if (--timeout <= 0 || !video_server_process->is_running()) break;
3768                 }
3769                 if (timeout <= 0) {
3770                         warning << _("Video-server was started but does not respond to requests...") << endmsg;
3771                 } else {
3772                         if (!ARDOUR_UI::instance()->video_timeline->check_server_docroot()) {
3773                                 delete video_server_process;
3774                                 video_server_process = 0;
3775                         }
3776                 }
3777         }
3778         return true;
3779 }
3780
3781 void
3782 ARDOUR_UI::add_video (Gtk::Window* float_window)
3783 {
3784         if (!_session) {
3785                 return;
3786         }
3787
3788         if (!start_video_server(float_window, false)) {
3789                 warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
3790                 return;
3791         }
3792
3793         if (float_window) {
3794                 add_video_dialog->set_transient_for (*float_window);
3795         }
3796
3797         if (add_video_dialog->is_visible()) {
3798                 /* we're already doing this */
3799                 return;
3800         }
3801
3802         ResponseType r = (ResponseType) add_video_dialog->run ();
3803         add_video_dialog->hide();
3804         if (r != RESPONSE_ACCEPT) { return; }
3805
3806         bool local_file, orig_local_file;
3807         std::string path = add_video_dialog->file_name(local_file);
3808
3809         std::string orig_path = path;
3810         orig_local_file = local_file;
3811
3812         bool auto_set_session_fps = add_video_dialog->auto_set_session_fps();
3813
3814         if (local_file && !Glib::file_test(path, Glib::FILE_TEST_EXISTS)) {
3815                 warning << string_compose(_("could not open %1"), path) << endmsg;
3816                 return;
3817         }
3818         if (!local_file && path.length() == 0) {
3819                 warning << _("no video-file selected") << endmsg;
3820                 return;
3821         }
3822
3823         switch (add_video_dialog->import_option()) {
3824                 case VTL_IMPORT_TRANSCODE:
3825                         {
3826                                 TranscodeVideoDialog *transcode_video_dialog;
3827                                 transcode_video_dialog = new TranscodeVideoDialog (_session, path);
3828                                 ResponseType r = (ResponseType) transcode_video_dialog->run ();
3829                                 transcode_video_dialog->hide();
3830                                 if (r != RESPONSE_ACCEPT) {
3831                                         delete transcode_video_dialog;
3832                                         return;
3833                                 }
3834                                 if (!transcode_video_dialog->get_audiofile().empty()) {
3835                                         editor->embed_audio_from_video(
3836                                                         transcode_video_dialog->get_audiofile(),
3837                                                         video_timeline->get_offset(),
3838                                                         (transcode_video_dialog->import_option() != VTL_IMPORT_NO_VIDEO)
3839                                                         );
3840                                 }
3841                                 switch (transcode_video_dialog->import_option()) {
3842                                         case VTL_IMPORT_TRANSCODED:
3843                                                 path = transcode_video_dialog->get_filename();
3844                                                 local_file = true;
3845                                                 break;
3846                                         case VTL_IMPORT_REFERENCE:
3847                                                 break;
3848                                         default:
3849                                                 delete transcode_video_dialog;
3850                                                 return;
3851                                 }
3852                                 delete transcode_video_dialog;
3853                         }
3854                         break;
3855                 default:
3856                 case VTL_IMPORT_NONE:
3857                         break;
3858         }
3859
3860         /* strip _session->session_directory().video_path() from video file if possible */
3861         if (local_file && !path.compare(0, _session->session_directory().video_path().size(), _session->session_directory().video_path())) {
3862                  path=path.substr(_session->session_directory().video_path().size());
3863                  if (path.at(0) == G_DIR_SEPARATOR) {
3864                          path=path.substr(1);
3865                  }
3866         }
3867
3868         video_timeline->set_update_session_fps(auto_set_session_fps);
3869         if (video_timeline->video_file_info(path, local_file)) {
3870                 XMLNode* node = new XMLNode(X_("Videotimeline"));
3871                 node->add_property (X_("Filename"), path);
3872                 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
3873                 node->add_property (X_("LocalFile"), local_file?X_("1"):X_("0"));
3874                 if (orig_local_file) {
3875                         node->add_property (X_("OriginalVideoFile"), orig_path);
3876                 } else {
3877                         node->remove_property (X_("OriginalVideoFile"));
3878                 }
3879                 _session->add_extra_xml (*node);
3880                 _session->set_dirty ();
3881
3882                 _session->maybe_update_session_range(
3883                         std::max(video_timeline->get_offset(), (ARDOUR::frameoffset_t) 0),
3884                         std::max(video_timeline->get_offset() + video_timeline->get_duration(), (ARDOUR::frameoffset_t) 0));
3885
3886
3887                 if (add_video_dialog->launch_xjadeo() && local_file) {
3888                         editor->set_xjadeo_sensitive(true);
3889                         editor->toggle_xjadeo_proc(1);
3890                 } else {
3891                         editor->toggle_xjadeo_proc(0);
3892                 }
3893                 editor->toggle_ruler_video(true);
3894         }
3895 }
3896
3897 void
3898 ARDOUR_UI::remove_video ()
3899 {
3900         video_timeline->close_session();
3901         editor->toggle_ruler_video(false);
3902
3903         /* reset state */
3904         video_timeline->set_offset_locked(false);
3905         video_timeline->set_offset(0);
3906
3907         /* delete session state */
3908         XMLNode* node = new XMLNode(X_("Videotimeline"));
3909         _session->add_extra_xml(*node);
3910         node = new XMLNode(X_("Videomonitor"));
3911         _session->add_extra_xml(*node);
3912         node = new XMLNode(X_("Videoexport"));
3913         _session->add_extra_xml(*node);
3914         stop_video_server();
3915 }
3916
3917 void
3918 ARDOUR_UI::flush_videotimeline_cache (bool localcacheonly)
3919 {
3920         if (localcacheonly) {
3921                 video_timeline->vmon_update();
3922         } else {
3923                 video_timeline->flush_cache();
3924         }
3925         editor->queue_visual_videotimeline_update();
3926 }
3927
3928 void
3929 ARDOUR_UI::export_video (bool range)
3930 {
3931         if (ARDOUR::Config->get_show_video_export_info()) {
3932                 ExportVideoInfobox infobox (_session);
3933                 Gtk::ResponseType rv = (Gtk::ResponseType) infobox.run();
3934                 if (infobox.show_again()) {
3935                         ARDOUR::Config->set_show_video_export_info(false);
3936                 }
3937                 switch (rv) {
3938                         case GTK_RESPONSE_YES:
3939                                 PBD::open_uri (ARDOUR::Config->get_reference_manual_url() + "/video-timeline/operations/#export");
3940                                 break;
3941                         default:
3942                                 break;
3943                 }
3944         }
3945         export_video_dialog->set_session (_session);
3946         export_video_dialog->apply_state(editor->get_selection().time, range);
3947         export_video_dialog->run ();
3948         export_video_dialog->hide ();
3949 }
3950
3951 XMLNode*
3952 ARDOUR_UI::mixer_settings () const
3953 {
3954         XMLNode* node = 0;
3955
3956         if (_session) {
3957                 node = _session->instant_xml(X_("Mixer"));
3958         } else {
3959                 node = Config->instant_xml(X_("Mixer"));
3960         }
3961
3962         if (!node) {
3963                 node = new XMLNode (X_("Mixer"));
3964         }
3965
3966         return node;
3967 }
3968
3969 XMLNode*
3970 ARDOUR_UI::editor_settings () const
3971 {
3972         XMLNode* node = 0;
3973
3974         if (_session) {
3975                 node = _session->instant_xml(X_("Editor"));
3976         } else {
3977                 node = Config->instant_xml(X_("Editor"));
3978         }
3979
3980         if (!node) {
3981                 if (getenv("ARDOUR_INSTANT_XML_PATH")) {
3982                         node = Config->instant_xml(getenv("ARDOUR_INSTANT_XML_PATH"));
3983                 }
3984         }
3985
3986         if (!node) {
3987                 node = new XMLNode (X_("Editor"));
3988         }
3989
3990         return node;
3991 }
3992
3993 XMLNode*
3994 ARDOUR_UI::keyboard_settings () const
3995 {
3996         XMLNode* node = 0;
3997
3998         node = Config->extra_xml(X_("Keyboard"));
3999
4000         if (!node) {
4001                 node = new XMLNode (X_("Keyboard"));
4002         }
4003
4004         return node;
4005 }
4006
4007 void
4008 ARDOUR_UI::create_xrun_marker (framepos_t where)
4009 {
4010         editor->mouse_add_new_marker (where, false, true);
4011 }
4012
4013 void
4014 ARDOUR_UI::halt_on_xrun_message ()
4015 {
4016         cerr << "HALT on xrun\n";
4017         MessageDialog msg (*editor, _("Recording was stopped because your system could not keep up."));
4018         msg.run ();
4019 }
4020
4021 void
4022 ARDOUR_UI::xrun_handler (framepos_t where)
4023 {
4024         if (!_session) {
4025                 return;
4026         }
4027
4028         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::xrun_handler, where)
4029
4030         if (_session && Config->get_create_xrun_marker() && _session->actively_recording()) {
4031                 create_xrun_marker(where);
4032         }
4033
4034         if (_session && Config->get_stop_recording_on_xrun() && _session->actively_recording()) {
4035                 halt_on_xrun_message ();
4036         }
4037 }
4038
4039 void
4040 ARDOUR_UI::disk_overrun_handler ()
4041 {
4042         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_overrun_handler)
4043
4044         if (!have_disk_speed_dialog_displayed) {
4045                 have_disk_speed_dialog_displayed = true;
4046                 MessageDialog* msg = new MessageDialog (*editor, string_compose (_("\
4047 The disk system on your computer\n\
4048 was not able to keep up with %1.\n\
4049 \n\
4050 Specifically, it failed to write data to disk\n\
4051 quickly enough to keep up with recording.\n"), PROGRAM_NAME));
4052                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4053                 msg->show ();
4054         }
4055 }
4056
4057
4058 /* TODO: this is getting elaborate enough to warrant being split into a dedicated class */
4059 static MessageDialog *scan_dlg = NULL;
4060 static ProgressBar   *scan_pbar = NULL;
4061 static HBox          *scan_tbox = NULL;
4062
4063 void
4064 ARDOUR_UI::cancel_plugin_scan ()
4065 {
4066         PluginManager::instance().cancel_plugin_scan();
4067 }
4068
4069 void
4070 ARDOUR_UI::cancel_plugin_timeout ()
4071 {
4072         PluginManager::instance().cancel_plugin_timeout();
4073         scan_tbox->hide();
4074 }
4075
4076 void
4077 ARDOUR_UI::plugin_scan_timeout (int timeout)
4078 {
4079         if (!scan_dlg || !scan_dlg->is_mapped() || !scan_pbar) {
4080                 return;
4081         }
4082         if (timeout > 0) {
4083                 scan_pbar->set_fraction ((float) timeout / (float) Config->get_vst_scan_timeout());
4084                 scan_tbox->show();
4085         } else {
4086                 scan_tbox->hide();
4087         }
4088         gui_idle_handler();
4089 }
4090
4091 void
4092 ARDOUR_UI::plugin_scan_dialog (std::string type, std::string plugin, bool can_cancel)
4093 {
4094         if (type == X_("closeme") && !(scan_dlg && scan_dlg->is_mapped())) {
4095                 return;
4096         }
4097
4098         const bool cancelled = PluginManager::instance().cancelled();
4099         if (type != X_("closeme") && !ui_config->get_show_plugin_scan_window()) {
4100                 if (cancelled && scan_dlg->is_mapped()) {
4101                         scan_dlg->hide();
4102                         gui_idle_handler();
4103                         return;
4104                 }
4105                 if (cancelled || !can_cancel) {
4106                         return;
4107                 }
4108         }
4109
4110         static Gtk::Button *cancel_button;
4111         static Gtk::Button *timeout_button;
4112         if (!scan_dlg) {
4113                 scan_dlg = new MessageDialog("", false, MESSAGE_INFO, BUTTONS_NONE); // TODO manage
4114                 VBox* vbox = scan_dlg->get_vbox();
4115                 vbox->set_size_request(400,-1);
4116                 scan_dlg->set_title (_("Scanning for plugins"));
4117
4118                 cancel_button = manage(new Gtk::Button(_("Cancel plugin scan")));
4119                 cancel_button->set_name ("EditorGTKButton");
4120                 cancel_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_scan) );
4121                 cancel_button->show();
4122
4123                 scan_dlg->get_vbox()->pack_start ( *cancel_button, PACK_SHRINK);
4124
4125                 scan_tbox = manage( new HBox() );
4126
4127                 timeout_button = manage(new Gtk::Button(_("Stop Timeout")));
4128                 timeout_button->set_name ("EditorGTKButton");
4129                 timeout_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_timeout) );
4130                 timeout_button->show();
4131
4132                 scan_pbar = manage(new ProgressBar());
4133                 scan_pbar->set_orientation(Gtk::PROGRESS_RIGHT_TO_LEFT);
4134                 scan_pbar->set_text(_("Scan Timeout"));
4135                 scan_pbar->show();
4136
4137                 scan_tbox->pack_start (*scan_pbar, PACK_EXPAND_WIDGET, 4);
4138                 scan_tbox->pack_start (*timeout_button, PACK_SHRINK, 4);
4139
4140                 scan_dlg->get_vbox()->pack_start (*scan_tbox, PACK_SHRINK, 4);
4141         }
4142
4143         assert(scan_dlg && scan_tbox && cancel_button);
4144
4145         if (type == X_("closeme")) {
4146                 scan_dlg->hide();
4147         } else {
4148                 scan_dlg->set_message(type + ": " + Glib::path_get_basename(plugin));
4149                 scan_dlg->show();
4150         }
4151         if (!can_cancel || !cancelled) {
4152                 scan_tbox->hide();
4153         }
4154         cancel_button->set_sensitive(can_cancel && !cancelled);
4155
4156         gui_idle_handler();
4157 }
4158
4159 void
4160 ARDOUR_UI::gui_idle_handler ()
4161 {
4162         int timeout = 30;
4163         /* due to idle calls, gtk_events_pending() may always return true */
4164         while (gtk_events_pending() && --timeout) {
4165                 gtk_main_iteration ();
4166         }
4167 }
4168
4169 void
4170 ARDOUR_UI::disk_underrun_handler ()
4171 {
4172         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_underrun_handler)
4173
4174         if (!have_disk_speed_dialog_displayed) {
4175                 have_disk_speed_dialog_displayed = true;
4176                 MessageDialog* msg = new MessageDialog (
4177                         *editor, string_compose (_("The disk system on your computer\n\
4178 was not able to keep up with %1.\n\
4179 \n\
4180 Specifically, it failed to read data from disk\n\
4181 quickly enough to keep up with playback.\n"), PROGRAM_NAME));
4182                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4183                 msg->show ();
4184         }
4185 }
4186
4187 void
4188 ARDOUR_UI::disk_speed_dialog_gone (int /*ignored_response*/, MessageDialog* msg)
4189 {
4190         have_disk_speed_dialog_displayed = false;
4191         delete msg;
4192 }
4193
4194 void
4195 ARDOUR_UI::session_dialog (std::string msg)
4196 {
4197         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::session_dialog, msg)
4198
4199         MessageDialog* d;
4200
4201         if (editor) {
4202                 d = new MessageDialog (*editor, msg, false, MESSAGE_INFO, BUTTONS_OK, true);
4203         } else {
4204                 d = new MessageDialog (msg, false, MESSAGE_INFO, BUTTONS_OK, true);
4205         }
4206
4207         d->show_all ();
4208         d->run ();
4209         delete d;
4210 }
4211
4212 int
4213 ARDOUR_UI::pending_state_dialog ()
4214 {
4215         HBox* hbox = manage (new HBox());
4216         Image* image = manage (new Image (Stock::DIALOG_QUESTION, ICON_SIZE_DIALOG));
4217         ArdourDialog dialog (_("Crash Recovery"), true);
4218         Label  message (string_compose (_("\
4219 This session appears to have been in the\n\
4220 middle of recording when %1 or\n\
4221 the computer was shutdown.\n\
4222 \n\
4223 %1 can recover any captured audio for\n\
4224 you, or it can ignore it. Please decide\n\
4225 what you would like to do.\n"), PROGRAM_NAME));
4226         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4227         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4228         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4229         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4230         dialog.add_button (_("Ignore crash data"), RESPONSE_REJECT);
4231         dialog.add_button (_("Recover from crash"), RESPONSE_ACCEPT);
4232         dialog.set_default_response (RESPONSE_ACCEPT);
4233         dialog.set_position (WIN_POS_CENTER);
4234         message.show();
4235         image->show();
4236         hbox->show();
4237
4238         switch (dialog.run ()) {
4239         case RESPONSE_ACCEPT:
4240                 return 1;
4241         default:
4242                 return 0;
4243         }
4244 }
4245
4246 int
4247 ARDOUR_UI::sr_mismatch_dialog (framecnt_t desired, framecnt_t actual)
4248 {
4249         HBox* hbox = new HBox();
4250         Image* image = new Image (Stock::DIALOG_WARNING, ICON_SIZE_DIALOG);
4251         ArdourDialog dialog (_("Sample Rate Mismatch"), true);
4252         Label  message (string_compose (_("\
4253 This session was created with a sample rate of %1 Hz, but\n\
4254 %2 is currently running at %3 Hz.  If you load this session,\n\
4255 audio may be played at the wrong sample rate.\n"), desired, PROGRAM_NAME, actual));
4256
4257         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4258         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4259         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4260         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4261         dialog.add_button (_("Do not load session"), RESPONSE_REJECT);
4262         dialog.add_button (_("Load session anyway"), RESPONSE_ACCEPT);
4263         dialog.set_default_response (RESPONSE_ACCEPT);
4264         dialog.set_position (WIN_POS_CENTER);
4265         message.show();
4266         image->show();
4267         hbox->show();
4268
4269         switch (dialog.run()) {
4270         case RESPONSE_ACCEPT:
4271                 return 0;
4272         default:
4273                 break;
4274         }
4275
4276         return 1;
4277 }
4278
4279 int
4280 ARDOUR_UI::disconnect_from_engine ()
4281 {
4282         /* drop connection to AudioEngine::Halted so that we don't act
4283          *  as if the engine unexpectedly shut down
4284          */
4285
4286         halt_connection.disconnect ();
4287
4288         if (AudioEngine::instance()->stop ()) {
4289                 MessageDialog msg (*editor, _("Could not disconnect from Audio/MIDI engine"));
4290                 msg.run ();
4291                 return -1;
4292         } else {
4293                 AudioEngine::instance()->Halted.connect_same_thread (halt_connection, boost::bind (&ARDOUR_UI::engine_halted, this, _1, false));
4294         }
4295
4296         update_sample_rate (0);
4297         return 0;
4298 }
4299
4300 int
4301 ARDOUR_UI::reconnect_to_engine ()
4302 {
4303         if (AudioEngine::instance()->start ()) {
4304                 // TODO somehow make this the topmost window (above any dialogs currently visible)
4305                 if (editor) {
4306                         MessageDialog msg (*editor,  _("Could not reconnect to the Audio/MIDI engine"));
4307                         msg.run ();
4308                 } else {
4309                         MessageDialog msg (_("Could not reconnect to the Audio/MIDI engine"));
4310                         msg.run ();
4311                 }
4312                 return -1;
4313         }
4314
4315         update_sample_rate (0);
4316         return 0;
4317 }
4318
4319 void
4320 ARDOUR_UI::use_config ()
4321 {
4322         XMLNode* node = Config->extra_xml (X_("TransportControllables"));
4323         if (node) {
4324                 set_transport_controllable_state (*node);
4325         }
4326 }
4327
4328 void
4329 ARDOUR_UI::update_transport_clocks (framepos_t pos)
4330 {
4331         if (ui_config->get_primary_clock_delta_edit_cursor()) {
4332                 primary_clock->set (pos, false, editor->get_preferred_edit_position());
4333         } else {
4334                 primary_clock->set (pos);
4335         }
4336
4337         if (ui_config->get_secondary_clock_delta_edit_cursor()) {
4338                 secondary_clock->set (pos, false, editor->get_preferred_edit_position());
4339         } else {
4340                 secondary_clock->set (pos);
4341         }
4342
4343         if (big_clock_window) {
4344                 big_clock->set (pos);
4345         }
4346         ARDOUR_UI::instance()->video_timeline->manual_seek_video_monitor(pos);
4347 }
4348
4349 void
4350 ARDOUR_UI::step_edit_status_change (bool yn)
4351 {
4352         // XXX should really store pre-step edit status of things
4353         // we make insensitive
4354
4355         if (yn) {
4356                 rec_button.set_active_state (Gtkmm2ext::ImplicitActive);
4357                 rec_button.set_sensitive (false);
4358         } else {
4359                 rec_button.unset_active_state ();;
4360                 rec_button.set_sensitive (true);
4361         }
4362 }
4363
4364 void
4365 ARDOUR_UI::record_state_changed ()
4366 {
4367         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::record_state_changed);
4368
4369         if (!_session || !big_clock_window) {
4370                 /* why bother - the clock isn't visible */
4371                 return;
4372         }
4373
4374         if (_session->record_status () == Session::Recording && _session->have_rec_enabled_track ()) {
4375                 big_clock->set_active (true);
4376         } else {
4377                 big_clock->set_active (false);
4378         }
4379 }
4380
4381 bool
4382 ARDOUR_UI::first_idle ()
4383 {
4384         if (_session) {
4385                 _session->allow_auto_play (true);
4386         }
4387
4388         if (editor) {
4389                 editor->first_idle();
4390         }
4391
4392         Keyboard::set_can_save_keybindings (true);
4393         return false;
4394 }
4395
4396 void
4397 ARDOUR_UI::store_clock_modes ()
4398 {
4399         XMLNode* node = new XMLNode(X_("ClockModes"));
4400
4401         for (vector<AudioClock*>::iterator x = AudioClock::clocks.begin(); x != AudioClock::clocks.end(); ++x) {
4402                 XMLNode* child = new XMLNode (X_("Clock"));
4403
4404                 child->add_property (X_("name"), (*x)->name());
4405                 child->add_property (X_("mode"), enum_2_string ((*x)->mode()));
4406                 child->add_property (X_("on"), ((*x)->off() ? X_("no") : X_("yes")));
4407
4408                 node->add_child_nocopy (*child);
4409         }
4410
4411         _session->add_extra_xml (*node);
4412         _session->set_dirty ();
4413 }
4414
4415 ARDOUR_UI::TransportControllable::TransportControllable (std::string name, ARDOUR_UI& u, ToggleType tp)
4416         : Controllable (name), ui (u), type(tp)
4417 {
4418
4419 }
4420
4421 void
4422 ARDOUR_UI::TransportControllable::set_value (double val)
4423 {
4424         if (val < 0.5) {
4425                 /* do nothing: these are radio-style actions */
4426                 return;
4427         }
4428
4429         const char *action = 0;
4430
4431         switch (type) {
4432         case Roll:
4433                 action = X_("Roll");
4434                 break;
4435         case Stop:
4436                 action = X_("Stop");
4437                 break;
4438         case GotoStart:
4439                 action = X_("GotoStart");
4440                 break;
4441         case GotoEnd:
4442                 action = X_("GotoEnd");
4443                 break;
4444         case AutoLoop:
4445                 action = X_("Loop");
4446                 break;
4447         case PlaySelection:
4448                 action = X_("PlaySelection");
4449                 break;
4450         case RecordEnable:
4451                 action = X_("Record");
4452                 break;
4453         default:
4454                 break;
4455         }
4456
4457         if (action == 0) {
4458                 return;
4459         }
4460
4461         Glib::RefPtr<Action> act = ActionManager::get_action ("Transport", action);
4462
4463         if (act) {
4464                 act->activate ();
4465         }
4466 }
4467
4468 double
4469 ARDOUR_UI::TransportControllable::get_value (void) const
4470 {
4471         float val = 0.0;
4472
4473         switch (type) {
4474         case Roll:
4475                 break;
4476         case Stop:
4477                 break;
4478         case GotoStart:
4479                 break;
4480         case GotoEnd:
4481                 break;
4482         case AutoLoop:
4483                 break;
4484         case PlaySelection:
4485                 break;
4486         case RecordEnable:
4487                 break;
4488         default:
4489                 break;
4490         }
4491
4492         return val;
4493 }
4494
4495 void
4496 ARDOUR_UI::setup_profile ()
4497 {
4498         if (gdk_screen_width() < 1200 || getenv ("ARDOUR_NARROW_SCREEN")) {
4499                 Profile->set_small_screen ();
4500         }
4501
4502         if (g_getenv ("ARDOUR_SAE")) {
4503                 Profile->set_sae ();
4504                 Profile->set_single_package ();
4505         }
4506
4507         if (g_getenv ("TRX")) {
4508                 Profile->set_trx ();
4509         }
4510
4511         if (g_getenv ("MIXBUS")) {
4512                 Profile->set_mixbus ();
4513         }
4514 }
4515
4516 int
4517 ARDOUR_UI::missing_file (Session*s, std::string str, DataType type)
4518 {
4519         MissingFileDialog dialog (s, str, type);
4520
4521         dialog.show ();
4522         dialog.present ();
4523
4524         int result = dialog.run ();
4525         dialog.hide ();
4526
4527         switch (result) {
4528         case RESPONSE_OK:
4529                 break;
4530         default:
4531                 return 1; // quit entire session load
4532         }
4533
4534         result = dialog.get_action ();
4535
4536         return result;
4537 }
4538
4539 int
4540 ARDOUR_UI::ambiguous_file (std::string file, std::vector<std::string> hits)
4541 {
4542         AmbiguousFileDialog dialog (file, hits);
4543
4544         dialog.show ();
4545         dialog.present ();
4546
4547         dialog.run ();
4548         return dialog.get_which ();
4549 }
4550
4551 /** Allocate our thread-local buffers */
4552 void
4553 ARDOUR_UI::get_process_buffers ()
4554 {
4555         _process_thread->get_buffers ();
4556 }
4557
4558 /** Drop our thread-local buffers */
4559 void
4560 ARDOUR_UI::drop_process_buffers ()
4561 {
4562         _process_thread->drop_buffers ();
4563 }
4564
4565 void
4566 ARDOUR_UI::feedback_detected ()
4567 {
4568         _feedback_exists = true;
4569 }
4570
4571 void
4572 ARDOUR_UI::successful_graph_sort ()
4573 {
4574         _feedback_exists = false;
4575 }
4576
4577 void
4578 ARDOUR_UI::midi_panic ()
4579 {
4580         if (_session) {
4581                 _session->midi_panic();
4582         }
4583 }
4584
4585 void
4586 ARDOUR_UI::session_format_mismatch (std::string xml_path, std::string backup_path)
4587 {
4588         const char* start_big = "<span size=\"x-large\" weight=\"bold\">";
4589         const char* end_big = "</span>";
4590         const char* start_mono = "<tt>";
4591         const char* end_mono = "</tt>";
4592
4593         MessageDialog msg (string_compose (_("%4This is a session from an older version of %3%5\n\n"
4594                                              "%3 has copied the old session file\n\n%6%1%7\n\nto\n\n%6%2%7\n\n"
4595                                              "From now on, use the -2000 version with older versions of %3"),
4596                                            xml_path, backup_path, PROGRAM_NAME,
4597                                            start_big, end_big,
4598                                            start_mono, end_mono), true);
4599
4600         msg.run ();
4601 }
4602
4603
4604 void
4605 ARDOUR_UI::reset_peak_display ()
4606 {
4607         if (!_session || !_session->master_out() || !editor_meter) return;
4608         editor_meter->clear_meters();
4609         editor_meter_max_peak = -INFINITY;
4610         editor_meter_peak_display.set_active_state ( Gtkmm2ext::Off );
4611 }
4612
4613 void
4614 ARDOUR_UI::reset_group_peak_display (RouteGroup* group)
4615 {
4616         if (!_session || !_session->master_out()) return;
4617         if (group == _session->master_out()->route_group()) {
4618                 reset_peak_display ();
4619         }
4620 }
4621
4622 void
4623 ARDOUR_UI::reset_route_peak_display (Route* route)
4624 {
4625         if (!_session || !_session->master_out()) return;
4626         if (_session->master_out().get() == route) {
4627                 reset_peak_display ();
4628         }
4629 }
4630
4631 int
4632 ARDOUR_UI::do_audio_midi_setup (uint32_t desired_sample_rate)
4633 {
4634         audio_midi_setup->set_desired_sample_rate (desired_sample_rate);
4635         audio_midi_setup->set_position (WIN_POS_CENTER);
4636
4637         switch (audio_midi_setup->run()) {
4638         case Gtk::RESPONSE_OK:
4639                 return 0;
4640         case Gtk::RESPONSE_APPLY:
4641                 return 0;
4642         default:
4643                 return -1;
4644         }
4645 }
4646
4647
4648 gint
4649 ARDOUR_UI::transport_numpad_timeout ()
4650 {
4651         _numpad_locate_happening = false;
4652         if (_numpad_timeout_connection.connected() )
4653                 _numpad_timeout_connection.disconnect();
4654         return 1;
4655 }
4656
4657 void
4658 ARDOUR_UI::transport_numpad_decimal ()
4659 {
4660         _numpad_timeout_connection.disconnect();
4661
4662         if (_numpad_locate_happening) {
4663                 if (editor) editor->goto_nth_marker(_pending_locate_num - 1);
4664                 _numpad_locate_happening = false;
4665         } else {
4666                 _pending_locate_num = 0;
4667                 _numpad_locate_happening = true;
4668                 _numpad_timeout_connection = Glib::signal_timeout().connect (mem_fun(*this, &ARDOUR_UI::transport_numpad_timeout), 2*1000);
4669         }
4670 }
4671
4672 void
4673 ARDOUR_UI::transport_numpad_event (int num)
4674 {
4675         if ( _numpad_locate_happening ) {
4676                 _pending_locate_num = _pending_locate_num*10 + num;
4677         } else {
4678                 switch (num) {
4679                         case 0:  toggle_roll(false, false);             break;
4680                         case 1:  transport_rewind(1);                           break;
4681                         case 2:  transport_forward(1);                          break;
4682                         case 3:  transport_record(true);                        break;
4683                         case 4:  toggle_session_auto_loop();            break;
4684                         case 5:  transport_record(false); toggle_session_auto_loop();   break;
4685                         case 6:  toggle_punch();                                        break;
4686                         case 7:  toggle_click();                                break;
4687                         case 8:  toggle_auto_return();                  break;
4688                         case 9:  toggle_follow_edits();         break;
4689                 }
4690         }
4691 }
4692
4693 void
4694 ARDOUR_UI::set_flat_buttons ()
4695 {
4696         CairoWidget::set_flat_buttons( config()->get_flat_buttons() );
4697 }
4698
4699 void
4700 ARDOUR_UI::audioengine_became_silent ()
4701 {
4702         MessageDialog msg (string_compose (_("This is a free/demo copy of %1. It has just switched to silent mode."), PROGRAM_NAME),
4703                            true,
4704                            Gtk::MESSAGE_WARNING,
4705                            Gtk::BUTTONS_NONE,
4706                            true);
4707
4708         msg.set_title (string_compose (_("%1 is now silent"), PROGRAM_NAME));
4709
4710         Gtk::Label pay_label (string_compose (_("Please consider paying for a copy of %1 - you can pay whatever you want."), PROGRAM_NAME));
4711         Gtk::Label subscribe_label (_("Better yet become a subscriber - subscriptions start at US$1 per month."));
4712         Gtk::Button pay_button (_("Pay for a copy (via the web)"));
4713         Gtk::Button subscribe_button (_("Become a subscriber (via the web)"));
4714         Gtk::HBox pay_button_box;
4715         Gtk::HBox subscribe_button_box;
4716
4717         pay_button_box.pack_start (pay_button, true, false);
4718         subscribe_button_box.pack_start (subscribe_button, true, false);
4719
4720         bool (*openuri)(const char*) = PBD::open_uri; /* this forces selection of the const char* variant of PBD::open_uri(), which we need to avoid ambiguity below */
4721
4722         pay_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://ardour.org/download")));
4723         subscribe_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://community.ardour.org/s/subscribe")));
4724
4725         msg.get_vbox()->pack_start (pay_label);
4726         msg.get_vbox()->pack_start (pay_button_box);
4727         msg.get_vbox()->pack_start (subscribe_label);
4728         msg.get_vbox()->pack_start (subscribe_button_box);
4729
4730         msg.get_vbox()->show_all ();
4731
4732         msg.add_button (_("Remain silent"), Gtk::RESPONSE_CANCEL);
4733         msg.add_button (_("Save and quit"), Gtk::RESPONSE_NO);
4734         msg.add_button (_("Give me more time"), Gtk::RESPONSE_YES);
4735
4736         int r = msg.run ();
4737
4738         switch (r) {
4739         case Gtk::RESPONSE_YES:
4740                 AudioEngine::instance()->reset_silence_countdown ();
4741                 break;
4742
4743         case Gtk::RESPONSE_NO:
4744                 /* save and quit */
4745                 save_state_canfail ("");
4746                 exit (0);
4747                 break;
4748
4749         case Gtk::RESPONSE_CANCEL:
4750         default:
4751                 /* don't reset, save session and exit */
4752                 break;
4753         }
4754 }