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