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