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