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