gtk2_ardour/ardour_ui.cc

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