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