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