gtk2_ardour/ardour_ui.cc

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