gtk2_ardour/ardour_ui.cc

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