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