gtk2_ardour/ardour_ui.cc

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