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 /** Ask the user for the name of a new snapshot and then take it.
2371  */
2372
2373 void
2374 ARDOUR_UI::snapshot_session (bool switch_to_it)
2375 {
2376         ArdourPrompter prompter (true);
2377         string snapname;
2378
2379         prompter.set_name ("Prompter");
2380         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2381         if (switch_to_it) {
2382                 prompter.set_title (_("Save as..."));
2383                 prompter.set_prompt (_("New session name"));
2384         } else {
2385                 prompter.set_title (_("Take Snapshot"));
2386                 prompter.set_prompt (_("Name of new snapshot"));
2387         }
2388
2389         if (!switch_to_it) {
2390                 char timebuf[128];
2391                 time_t n;
2392                 struct tm local_time;
2393
2394                 time (&n);
2395                 localtime_r (&n, &local_time);
2396                 strftime (timebuf, sizeof(timebuf), "%FT%H.%M.%S", &local_time);
2397                 prompter.set_initial_text (timebuf);
2398         }
2399
2400   again:
2401         switch (prompter.run()) {
2402         case RESPONSE_ACCEPT:
2403         {
2404                 prompter.get_result (snapname);
2405
2406                 bool do_save = (snapname.length() != 0);
2407
2408                 if (do_save) {
2409                         char illegal = Session::session_name_is_legal(snapname);
2410                         if (illegal) {
2411                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2412                                                      "snapshot names may not contain a '%1' character"), illegal));
2413                                 msg.run ();
2414                                 goto again;
2415                         }
2416                 }
2417
2418                 vector<std::string> p;
2419                 get_state_files_in_directory (_session->session_directory().root_path(), p);
2420                 vector<string> n = get_file_names_no_extension (p);
2421                 if (find (n.begin(), n.end(), snapname) != n.end()) {
2422
2423                         ArdourDialog confirm (_("Confirm Snapshot Overwrite"), true);
2424                         Label m (_("A snapshot already exists with that name.  Do you want to overwrite it?"));
2425                         confirm.get_vbox()->pack_start (m, true, true);
2426                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
2427                         confirm.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
2428                         confirm.show_all ();
2429                         switch (confirm.run()) {
2430                         case RESPONSE_CANCEL:
2431                                 do_save = false;
2432                         }
2433                 }
2434
2435                 if (do_save) {
2436                         save_state (snapname, switch_to_it);
2437                 }
2438                 break;
2439         }
2440
2441         default:
2442                 break;
2443         }
2444 }
2445
2446 /** Ask the user for a new session name and then rename the session to it.
2447  */
2448
2449 void
2450 ARDOUR_UI::rename_session ()
2451 {
2452         if (!_session) {
2453                 return;
2454         }
2455
2456         ArdourPrompter prompter (true);
2457         string name;
2458
2459         prompter.set_name ("Prompter");
2460         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2461         prompter.set_title (_("Rename Session"));
2462         prompter.set_prompt (_("New session name"));
2463
2464   again:
2465         switch (prompter.run()) {
2466         case RESPONSE_ACCEPT:
2467         {
2468                 prompter.get_result (name);
2469
2470                 bool do_rename = (name.length() != 0);
2471
2472                 if (do_rename) {
2473                         char illegal = Session::session_name_is_legal (name);
2474
2475                         if (illegal) {
2476                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2477                                                                      "session names may not contain a '%1' character"), illegal));
2478                                 msg.run ();
2479                                 goto again;
2480                         }
2481
2482                         switch (_session->rename (name)) {
2483                         case -1: {
2484                                 MessageDialog msg (_("That name is already in use by another directory/folder. Please try again."));
2485                                 msg.set_position (WIN_POS_MOUSE);
2486                                 msg.run ();
2487                                 goto again;
2488                                 break;
2489                         }
2490                         case 0:
2491                                 break;
2492                         default: {
2493                                 MessageDialog msg (_("Renaming this session failed.\nThings could be seriously messed up at this point"));
2494                                 msg.set_position (WIN_POS_MOUSE);
2495                                 msg.run ();
2496                                 break;
2497                         }
2498                         }
2499                 }
2500
2501                 break;
2502         }
2503
2504         default:
2505                 break;
2506         }
2507 }
2508
2509 void
2510 ARDOUR_UI::save_state (const string & name, bool switch_to_it)
2511 {
2512         XMLNode* node = new XMLNode (X_("UI"));
2513
2514         WM::Manager::instance().add_state (*node);
2515
2516         node->add_child_nocopy (gui_object_state->get_state());
2517
2518         _session->add_extra_xml (*node);
2519
2520         if (export_video_dialog) {
2521                 _session->add_extra_xml (export_video_dialog->get_state());
2522         }
2523
2524         save_state_canfail (name, switch_to_it);
2525 }
2526
2527 int
2528 ARDOUR_UI::save_state_canfail (string name, bool switch_to_it)
2529 {
2530         if (_session) {
2531                 int ret;
2532
2533                 if (name.length() == 0) {
2534                         name = _session->snap_name();
2535                 }
2536
2537                 if ((ret = _session->save_state (name, false, switch_to_it)) != 0) {
2538                         return ret;
2539                 }
2540         }
2541
2542         save_ardour_state (); /* XXX cannot fail? yeah, right ... */
2543         return 0;
2544 }
2545
2546 void
2547 ARDOUR_UI::primary_clock_value_changed ()
2548 {
2549         if (_session) {
2550                 _session->request_locate (primary_clock->current_time ());
2551         }
2552 }
2553
2554 void
2555 ARDOUR_UI::big_clock_value_changed ()
2556 {
2557         if (_session) {
2558                 _session->request_locate (big_clock->current_time ());
2559         }
2560 }
2561
2562 void
2563 ARDOUR_UI::secondary_clock_value_changed ()
2564 {
2565         if (_session) {
2566                 _session->request_locate (secondary_clock->current_time ());
2567         }
2568 }
2569
2570 void
2571 ARDOUR_UI::transport_rec_enable_blink (bool onoff)
2572 {
2573         if (_session == 0) {
2574                 return;
2575         }
2576
2577         if (_session->step_editing()) {
2578                 return;
2579         }
2580
2581         Session::RecordState const r = _session->record_status ();
2582         bool const h = _session->have_rec_enabled_track ();
2583
2584         if (r == Session::Enabled || (r == Session::Recording && !h)) {
2585                 if (onoff) {
2586                         rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2587                 } else {
2588                         rec_button.set_active_state (Gtkmm2ext::Off);
2589                 }
2590         } else if (r == Session::Recording && h) {
2591                 rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2592         } else {
2593                 rec_button.unset_active_state ();
2594         }
2595 }
2596
2597 void
2598 ARDOUR_UI::save_template ()
2599 {
2600         ArdourPrompter prompter (true);
2601         string name;
2602
2603         if (!check_audioengine()) {
2604                 return;
2605         }
2606
2607         prompter.set_name (X_("Prompter"));
2608         prompter.set_title (_("Save Template"));
2609         prompter.set_prompt (_("Name for template:"));
2610         prompter.set_initial_text(_session->name() + _("-template"));
2611         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2612
2613         switch (prompter.run()) {
2614         case RESPONSE_ACCEPT:
2615                 prompter.get_result (name);
2616
2617                 if (name.length()) {
2618                         _session->save_template (name);
2619                 }
2620                 break;
2621
2622         default:
2623                 break;
2624         }
2625 }
2626
2627 void
2628 ARDOUR_UI::edit_metadata ()
2629 {
2630         SessionMetadataEditor dialog;
2631         dialog.set_session (_session);
2632         dialog.grab_focus ();
2633         dialog.run ();
2634 }
2635
2636 void
2637 ARDOUR_UI::import_metadata ()
2638 {
2639         SessionMetadataImporter dialog;
2640         dialog.set_session (_session);
2641         dialog.run ();
2642 }
2643
2644 bool
2645 ARDOUR_UI::ask_about_loading_existing_session (const std::string& session_path)
2646 {
2647         std::string str = string_compose (_("This session\n%1\nalready exists. Do you want to open it?"), session_path);
2648
2649         MessageDialog msg (str,
2650                            false,
2651                            Gtk::MESSAGE_WARNING,
2652                            Gtk::BUTTONS_YES_NO,
2653                            true);
2654
2655
2656         msg.set_name (X_("OpenExistingDialog"));
2657         msg.set_title (_("Open Existing Session"));
2658         msg.set_wmclass (X_("existing_session"), PROGRAM_NAME);
2659         msg.set_position (Gtk::WIN_POS_CENTER);
2660         pop_back_splash (msg);
2661
2662         switch (msg.run()) {
2663         case RESPONSE_YES:
2664                 return true;
2665                 break;
2666         }
2667         return false;
2668 }
2669
2670 int
2671 ARDOUR_UI::build_session_from_dialog (SessionDialog& sd, const std::string& session_path, const std::string& session_name)
2672 {
2673         BusProfile bus_profile;
2674
2675         if (nsm || Profile->get_sae()) {
2676
2677                 bus_profile.master_out_channels = 2;
2678                 bus_profile.input_ac = AutoConnectPhysical;
2679                 bus_profile.output_ac = AutoConnectMaster;
2680                 bus_profile.requested_physical_in = 0; // use all available
2681                 bus_profile.requested_physical_out = 0; // use all available
2682
2683         } else {
2684
2685                 /* get settings from advanced section of NSD */
2686
2687                 if (sd.create_master_bus()) {
2688                         bus_profile.master_out_channels = (uint32_t) sd.master_channel_count();
2689                 } else {
2690                         bus_profile.master_out_channels = 0;
2691                 }
2692
2693                 if (sd.connect_inputs()) {
2694                         bus_profile.input_ac = AutoConnectPhysical;
2695                 } else {
2696                         bus_profile.input_ac = AutoConnectOption (0);
2697                 }
2698
2699                 bus_profile.output_ac = AutoConnectOption (0);
2700
2701                 if (sd.connect_outputs ()) {
2702                         if (sd.connect_outs_to_master()) {
2703                                 bus_profile.output_ac = AutoConnectMaster;
2704                         } else if (sd.connect_outs_to_physical()) {
2705                                 bus_profile.output_ac = AutoConnectPhysical;
2706                         }
2707                 }
2708
2709                 bus_profile.requested_physical_in = (uint32_t) sd.input_limit_count();
2710                 bus_profile.requested_physical_out = (uint32_t) sd.output_limit_count();
2711         }
2712
2713         if (build_session (session_path, session_name, bus_profile)) {
2714                 return -1;
2715         }
2716
2717         return 0;
2718 }
2719
2720 void
2721 ARDOUR_UI::load_from_application_api (const std::string& path)
2722 {
2723         ARDOUR_COMMAND_LINE::session_name = path;
2724
2725         if (Glib::file_test (path, Glib::FILE_TEST_IS_DIR)) {
2726                 /* /path/to/foo => /path/to/foo, foo */
2727                 load_session (path, basename_nosuffix (path));
2728         } else {
2729                 /* /path/to/foo/foo.ardour => /path/to/foo, foo */
2730                 load_session (Glib::path_get_dirname (path), basename_nosuffix (path));
2731         }
2732 }
2733
2734 /** @param quit_on_cancel true if exit() should be called if the user clicks `cancel' in the new session dialog */
2735 int
2736 ARDOUR_UI::get_session_parameters (bool quit_on_cancel, bool should_be_new, string load_template)
2737 {
2738         string session_name;
2739         string session_path;
2740         string template_name;
2741         int ret = -1;
2742         bool likely_new = false;
2743         bool cancel_not_quit;
2744
2745         /* deal with any existing DIRTY session now, rather than later. don't
2746          * treat a non-dirty session this way, so that it stays visible
2747          * as we bring up the new session dialog.
2748          */
2749
2750         if (_session && ARDOUR_UI::instance()->video_timeline) {
2751                 ARDOUR_UI::instance()->video_timeline->sync_session_state();
2752         }
2753
2754         /* if there is already a session, relabel the button
2755            on the SessionDialog so that we don't Quit directly
2756         */
2757         cancel_not_quit = (_session != 0);
2758
2759         if (_session && _session->dirty()) {
2760                 if (unload_session (false)) {
2761                         /* unload cancelled by user */
2762                         return 0;
2763                 }
2764                 ARDOUR_COMMAND_LINE::session_name = "";
2765         }
2766
2767         if (!load_template.empty()) {
2768                 should_be_new = true;
2769                 template_name = load_template;
2770         }
2771
2772         session_name = basename_nosuffix (ARDOUR_COMMAND_LINE::session_name);
2773         session_path = ARDOUR_COMMAND_LINE::session_name;
2774
2775         if (!session_path.empty()) {
2776                 if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_EXISTS)) {
2777                         if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_IS_REGULAR)) {
2778                                 /* session/snapshot file, change path to be dir */
2779                                 session_path = Glib::path_get_dirname (session_path);
2780                         }
2781                 }
2782         }
2783
2784         SessionDialog session_dialog (should_be_new, session_name, session_path, load_template, cancel_not_quit);
2785
2786         while (ret != 0) {
2787
2788                 if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
2789
2790                         /* if they named a specific statefile, use it, otherwise they are
2791                            just giving a session folder, and we want to use it as is
2792                            to find the session.
2793                         */
2794
2795                         string::size_type suffix = ARDOUR_COMMAND_LINE::session_name.find (statefile_suffix);
2796
2797                         if (suffix != string::npos) {
2798                                 session_path = Glib::path_get_dirname (ARDOUR_COMMAND_LINE::session_name);
2799                                 session_name = ARDOUR_COMMAND_LINE::session_name.substr (0, suffix);
2800                                 session_name = Glib::path_get_basename (session_name);
2801                         } else {
2802                                 session_path = ARDOUR_COMMAND_LINE::session_name;
2803                                 session_name = Glib::path_get_basename (ARDOUR_COMMAND_LINE::session_name);
2804                         }
2805                 } else {
2806                         session_path = "";
2807                         session_name = "";
2808                         session_dialog.clear_given ();
2809                 }
2810
2811                 if (should_be_new || session_name.empty()) {
2812                         /* need the dialog to get info from user */
2813
2814                         cerr << "run dialog\n";
2815
2816                         switch (session_dialog.run()) {
2817                         case RESPONSE_ACCEPT:
2818                                 break;
2819                         default:
2820                                 if (quit_on_cancel) {
2821                                         // JE - Currently (July 2014) this section can only get reached if the
2822                                         // user quits from the main 'Session Setup' dialog (i.e. reaching this
2823                                         // point does NOT indicate an abnormal termination). Therefore, let's
2824                                         // behave gracefully (i.e. let's do some cleanup) before we call exit()
2825                                         ARDOUR::cleanup ();
2826                                         pthread_cancel_all ();
2827
2828                                         exit (1);
2829                                 } else {
2830                                         return ret;
2831                                 }
2832                         }
2833
2834                         session_dialog.hide ();
2835                 }
2836
2837                 /* if we run the startup dialog again, offer more than just "new session" */
2838
2839                 should_be_new = false;
2840
2841                 session_name = session_dialog.session_name (likely_new);
2842                 session_path = session_dialog.session_folder ();
2843
2844                 if (nsm) {
2845                         likely_new = true;
2846                 }
2847
2848                 string::size_type suffix = session_name.find (statefile_suffix);
2849
2850                 if (suffix != string::npos) {
2851                         session_name = session_name.substr (0, suffix);
2852                 }
2853
2854                 /* this shouldn't happen, but we catch it just in case it does */
2855
2856                 if (session_name.empty()) {
2857                         continue;
2858                 }
2859
2860                 if (session_dialog.use_session_template()) {
2861                         template_name = session_dialog.session_template_name();
2862                         _session_is_new = true;
2863                 }
2864
2865                 if (session_name[0] == G_DIR_SEPARATOR ||
2866 #ifdef PLATFORM_WINDOWS
2867                     (session_name.length() > 3 && session_name[1] == ':' && session_name[2] == G_DIR_SEPARATOR)
2868 #else
2869                     (session_name.length() > 2 && session_name[0] == '.' && session_name[1] == G_DIR_SEPARATOR) ||
2870                     (session_name.length() > 3 && session_name[0] == '.' && session_name[1] == '.' && session_name[2] == G_DIR_SEPARATOR)
2871 #endif
2872                          )
2873                 {
2874
2875                         /* absolute path or cwd-relative path specified for session name: infer session folder
2876                            from what was given.
2877                         */
2878
2879                         session_path = Glib::path_get_dirname (session_name);
2880                         session_name = Glib::path_get_basename (session_name);
2881
2882                 } else {
2883
2884                         session_path = session_dialog.session_folder();
2885
2886                         char illegal = Session::session_name_is_legal (session_name);
2887
2888                         if (illegal) {
2889                                 MessageDialog msg (session_dialog,
2890                                                    string_compose (_("To ensure compatibility with various systems\n"
2891                                                                      "session names may not contain a '%1' character"),
2892                                                                    illegal));
2893                                 msg.run ();
2894                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2895                                 continue;
2896                         }
2897                 }
2898
2899                 if (Glib::file_test (session_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))) {
2900
2901
2902                         if (likely_new && !nsm) {
2903
2904                                 std::string existing = Glib::build_filename (session_path, session_name);
2905
2906                                 if (!ask_about_loading_existing_session (existing)) {
2907                                         ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2908                                         continue;
2909                                 }
2910                         }
2911
2912                         _session_is_new = false;
2913
2914                 } else {
2915
2916                         if (!likely_new) {
2917                                 pop_back_splash (session_dialog);
2918                                 MessageDialog msg (string_compose (_("There is no existing session at \"%1\""), session_path));
2919                                 msg.run ();
2920                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2921                                 continue;
2922                         }
2923
2924                         char illegal = Session::session_name_is_legal(session_name);
2925
2926                         if (illegal) {
2927                                 pop_back_splash (session_dialog);
2928                                 MessageDialog msg (session_dialog, string_compose(_("To ensure compatibility with various systems\n"
2929                                                                                     "session names may not contain a '%1' character"), illegal));
2930                                 msg.run ();
2931                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2932                                 continue;
2933                         }
2934
2935                         _session_is_new = true;
2936                 }
2937
2938                 if (likely_new && template_name.empty()) {
2939
2940                         ret = build_session_from_dialog (session_dialog, session_path, session_name);
2941
2942                 } else {
2943
2944                         ret = load_session (session_path, session_name, template_name);
2945
2946                         if (ret == -2) {
2947                                 /* not connected to the AudioEngine, so quit to avoid an infinite loop */
2948                                 exit (1);
2949                         }
2950
2951                         if (!ARDOUR_COMMAND_LINE::immediate_save.empty()) {
2952                                 _session->save_state (ARDOUR_COMMAND_LINE::immediate_save, false);
2953                                 exit (1);
2954                         }
2955
2956                         /* clear this to avoid endless attempts to load the
2957                            same session.
2958                         */
2959
2960                         ARDOUR_COMMAND_LINE::session_name = "";
2961                 }
2962         }
2963
2964         return ret;
2965 }
2966
2967 void
2968 ARDOUR_UI::close_session()
2969 {
2970         if (!check_audioengine()) {
2971                 return;
2972         }
2973
2974         if (unload_session (true)) {
2975                 return;
2976         }
2977
2978         ARDOUR_COMMAND_LINE::session_name = "";
2979
2980         if (get_session_parameters (true, false)) {
2981                 exit (1);
2982         }
2983
2984         goto_editor_window ();
2985 }
2986
2987 /** @param snap_name Snapshot name (without .ardour suffix).
2988  *  @return -2 if the load failed because we are not connected to the AudioEngine.
2989  */
2990 int
2991 ARDOUR_UI::load_session (const std::string& path, const std::string& snap_name, std::string mix_template)
2992 {
2993         Session *new_session;
2994         int unload_status;
2995         int retval = -1;
2996
2997         if (_session) {
2998                 unload_status = unload_session ();
2999
3000                 if (unload_status < 0) {
3001                         goto out;
3002                 } else if (unload_status > 0) {
3003                         retval = 0;
3004                         goto out;
3005                 }
3006         }
3007
3008         session_loaded = false;
3009
3010         loading_message (string_compose (_("Please wait while %1 loads your session"), PROGRAM_NAME));
3011
3012         try {
3013                 new_session = new Session (*AudioEngine::instance(), path, snap_name, 0, mix_template);
3014         }
3015
3016         /* this one is special */
3017
3018         catch (AudioEngine::PortRegistrationFailure& err) {
3019
3020                 MessageDialog msg (err.what(),
3021                                    true,
3022                                    Gtk::MESSAGE_INFO,
3023                                    Gtk::BUTTONS_CLOSE);
3024
3025                 msg.set_title (_("Port Registration Error"));
3026                 msg.set_secondary_text (_("Click the Close button to try again."));
3027                 msg.set_position (Gtk::WIN_POS_CENTER);
3028                 pop_back_splash (msg);
3029                 msg.present ();
3030
3031                 int response = msg.run ();
3032
3033                 msg.hide ();
3034
3035                 switch (response) {
3036                 case RESPONSE_CANCEL:
3037                         exit (1);
3038                 default:
3039                         break;
3040                 }
3041                 goto out;
3042         }
3043
3044         catch (...) {
3045
3046                 MessageDialog msg (string_compose(
3047                                            _("Session \"%1 (snapshot %2)\" did not load successfully"),
3048                                            path, snap_name),
3049                                    true,
3050                                    Gtk::MESSAGE_INFO,
3051                                    BUTTONS_OK);
3052
3053                 msg.set_title (_("Loading Error"));
3054                 msg.set_position (Gtk::WIN_POS_CENTER);
3055                 pop_back_splash (msg);
3056                 msg.present ();
3057                 (void) msg.run ();
3058                 msg.hide ();
3059
3060                 goto out;
3061         }
3062
3063         {
3064                 list<string> const u = new_session->unknown_processors ();
3065                 if (!u.empty()) {
3066                         MissingPluginDialog d (_session, u);
3067                         d.run ();
3068                 }
3069         }
3070
3071         if (!new_session->writable()) {
3072                 MessageDialog msg (_("This session has been opened in read-only mode.\n\nYou will not be able to record or save."),
3073                                    true,
3074                                    Gtk::MESSAGE_INFO,
3075                                    BUTTONS_OK);
3076
3077                 msg.set_title (_("Read-only Session"));
3078                 msg.set_position (Gtk::WIN_POS_CENTER);
3079                 pop_back_splash (msg);
3080                 msg.present ();
3081                 (void) msg.run ();
3082                 msg.hide ();
3083         }
3084
3085
3086         /* Now the session been created, add the transport controls */
3087         new_session->add_controllable(roll_controllable);
3088         new_session->add_controllable(stop_controllable);
3089         new_session->add_controllable(goto_start_controllable);
3090         new_session->add_controllable(goto_end_controllable);
3091         new_session->add_controllable(auto_loop_controllable);
3092         new_session->add_controllable(play_selection_controllable);
3093         new_session->add_controllable(rec_controllable);
3094
3095         set_session (new_session);
3096
3097         session_loaded = true;
3098
3099         goto_editor_window ();
3100
3101         if (_session) {
3102                 _session->set_clean ();
3103         }
3104
3105 #ifdef WINDOWS_VST_SUPPORT
3106         fst_stop_threading();
3107 #endif
3108
3109         flush_pending ();
3110
3111 #ifdef WINDOWS_VST_SUPPORT
3112         fst_start_threading();
3113 #endif
3114         retval = 0;
3115
3116   out:
3117         return retval;
3118 }
3119
3120 int
3121 ARDOUR_UI::build_session (const std::string& path, const std::string& snap_name, BusProfile& bus_profile)
3122 {
3123         Session *new_session;
3124         int x;
3125
3126         session_loaded = false;
3127         x = unload_session ();
3128
3129         if (x < 0) {
3130                 return -1;
3131         } else if (x > 0) {
3132                 return 0;
3133         }
3134
3135         _session_is_new = true;
3136
3137         try {
3138                 new_session = new Session (*AudioEngine::instance(), path, snap_name, &bus_profile);
3139         }
3140
3141         catch (...) {
3142
3143                 MessageDialog msg (string_compose(_("Could not create session in \"%1\""), path));
3144                 pop_back_splash (msg);
3145                 msg.run ();
3146                 return -1;
3147         }
3148
3149         /* Give the new session the default GUI state, if such things exist */
3150
3151         XMLNode* n;
3152         n = Config->instant_xml (X_("Editor"));
3153         if (n) {
3154                 n->remove_nodes_and_delete ("Selection"); // no not apply selection to new sessions.
3155                 new_session->add_instant_xml (*n, false);
3156         }
3157         n = Config->instant_xml (X_("Mixer"));
3158         if (n) {
3159                 new_session->add_instant_xml (*n, false);
3160         }
3161
3162         /* Put the playhead at 0 and scroll fully left */
3163         n = new_session->instant_xml (X_("Editor"));
3164         if (n) {
3165                 n->add_property (X_("playhead"), X_("0"));
3166                 n->add_property (X_("left-frame"), X_("0"));
3167         }
3168
3169         set_session (new_session);
3170
3171         session_loaded = true;
3172
3173         new_session->save_state(new_session->name());
3174
3175         return 0;
3176 }
3177
3178 void
3179 ARDOUR_UI::launch_chat ()
3180 {
3181 #ifdef __APPLE__
3182         open_uri("http://webchat.freenode.net/?channels=ardour-osx");
3183 #elif defined PLATFORM_WINDOWS
3184         open_uri("http://webchat.freenode.net/?channels=ardour-windows");
3185 #else
3186         open_uri("http://webchat.freenode.net/?channels=ardour");
3187 #endif
3188 }
3189
3190 void
3191 ARDOUR_UI::launch_manual ()
3192 {
3193         PBD::open_uri (Config->get_tutorial_manual_url());
3194 }
3195
3196 void
3197 ARDOUR_UI::launch_reference ()
3198 {
3199         PBD::open_uri (Config->get_reference_manual_url());
3200 }
3201
3202 void
3203 ARDOUR_UI::launch_tracker ()
3204 {
3205         PBD::open_uri ("http://tracker.ardour.org/bug_report_page.php");
3206 }
3207
3208 void
3209 ARDOUR_UI::launch_subscribe ()
3210 {
3211         PBD::open_uri ("https://community.ardour.org/s/subscribe");
3212 }
3213
3214 void
3215 ARDOUR_UI::launch_cheat_sheet ()
3216 {
3217 #ifdef __APPLE__
3218         PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheat_sheet_osx.pdf");
3219 #else
3220         PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheatsheet.pdf");
3221 #endif
3222 }
3223
3224 void
3225 ARDOUR_UI::launch_website ()
3226 {
3227         PBD::open_uri ("http://ardour.org");
3228 }
3229
3230 void
3231 ARDOUR_UI::launch_website_dev ()
3232 {
3233         PBD::open_uri ("http://ardour.org/development.html");
3234 }
3235
3236 void
3237 ARDOUR_UI::launch_forums ()
3238 {
3239         PBD::open_uri ("https://community.ardour.org/forums");
3240 }
3241
3242 void
3243 ARDOUR_UI::launch_howto_report ()
3244 {
3245         PBD::open_uri ("http://ardour.org/reporting_bugs");
3246 }
3247
3248 void
3249 ARDOUR_UI::loading_message (const std::string& msg)
3250 {
3251         if (ARDOUR_COMMAND_LINE::no_splash) {
3252                 return;
3253         }
3254
3255         if (!splash) {
3256                 show_splash ();
3257         }
3258
3259         splash->message (msg);
3260 }
3261
3262 void
3263 ARDOUR_UI::show_splash ()
3264 {
3265         if (splash == 0) {
3266                 try {
3267                         splash = new Splash;
3268                 } catch (...) {
3269                         return;
3270                 }
3271         }
3272
3273         splash->display ();
3274 }
3275
3276 void
3277 ARDOUR_UI::hide_splash ()
3278 {
3279         delete splash;
3280         splash = 0;
3281 }
3282
3283 void
3284 ARDOUR_UI::display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete)
3285 {
3286         size_t removed;
3287
3288         removed = rep.paths.size();
3289
3290         if (removed == 0) {
3291                 MessageDialog msgd (*editor,
3292                                     _("No files were ready for clean-up"),
3293                                     true,
3294                                     Gtk::MESSAGE_INFO,
3295                                     Gtk::BUTTONS_OK);
3296                 msgd.set_title (_("Clean-up"));
3297                 msgd.set_secondary_text (_("If this seems suprising, \n\
3298 check for any existing snapshots.\n\
3299 These may still include regions that\n\
3300 require some unused files to continue to exist."));
3301
3302                 msgd.run ();
3303                 return;
3304         }
3305
3306         ArdourDialog results (_("Clean-up"), true, false);
3307
3308         struct CleanupResultsModelColumns : public Gtk::TreeModel::ColumnRecord {
3309             CleanupResultsModelColumns() {
3310                     add (visible_name);
3311                     add (fullpath);
3312             }
3313             Gtk::TreeModelColumn<std::string> visible_name;
3314             Gtk::TreeModelColumn<std::string> fullpath;
3315         };
3316
3317
3318         CleanupResultsModelColumns results_columns;
3319         Glib::RefPtr<Gtk::ListStore> results_model;
3320         Gtk::TreeView results_display;
3321
3322         results_model = ListStore::create (results_columns);
3323         results_display.set_model (results_model);
3324         results_display.append_column (list_title, results_columns.visible_name);
3325
3326         results_display.set_name ("CleanupResultsList");
3327         results_display.set_headers_visible (true);
3328         results_display.set_headers_clickable (false);
3329         results_display.set_reorderable (false);
3330
3331         Gtk::ScrolledWindow list_scroller;
3332         Gtk::Label txt;
3333         Gtk::VBox dvbox;
3334         Gtk::HBox dhbox;  // the hbox for the image and text
3335         Gtk::HBox ddhbox; // the hbox we eventually pack into the dialog's vbox
3336         Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_INFO,  Gtk::ICON_SIZE_DIALOG));
3337
3338         dimage->set_alignment(ALIGN_LEFT, ALIGN_TOP);
3339
3340         const string dead_directory = _session->session_directory().dead_path();
3341
3342         /* subst:
3343            %1 - number of files removed
3344            %2 - location of "dead"
3345            %3 - size of files affected
3346            %4 - prefix for "bytes" to produce sensible results (e.g. mega, kilo, giga)
3347         */
3348
3349         const char* bprefix;
3350         double space_adjusted = 0;
3351
3352         if (rep.space < 1000) {
3353                 bprefix = X_("");
3354                 space_adjusted = rep.space;
3355         } else if (rep.space < 1000000) {
3356                 bprefix = _("kilo");
3357                 space_adjusted = floorf((float)rep.space / 1000.0);
3358         } else if (rep.space < 1000000 * 1000) {
3359                 bprefix = _("mega");
3360                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000.0));
3361         } else {
3362                 bprefix = _("giga");
3363                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000 * 1000.0));
3364         }
3365
3366         if (msg_delete) {
3367                 txt.set_markup (string_compose (P_("\
3368 The following file was deleted from %2,\n\
3369 releasing %3 %4bytes of disk space", "\
3370 The following %1 files were deleted from %2,\n\
3371 releasing %3 %4bytes of disk space", removed),
3372                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3373         } else {
3374                 txt.set_markup (string_compose (P_("\
3375 The following file was not in use and \n\
3376 has been moved to: %2\n\n\
3377 After a restart of %5\n\n\
3378 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3379 will release an additional %3 %4bytes of disk space.\n", "\
3380 The following %1 files were not in use and \n\
3381 have been moved to: %2\n\n\
3382 After a restart of %5\n\n\
3383 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3384 will release an additional %3 %4bytes of disk space.\n", removed),
3385                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3386         }
3387
3388         dhbox.pack_start (*dimage, true, false, 5);
3389         dhbox.pack_start (txt, true, false, 5);
3390
3391         for (vector<string>::iterator i = rep.paths.begin(); i != rep.paths.end(); ++i) {
3392                 TreeModel::Row row = *(results_model->append());
3393                 row[results_columns.visible_name] = *i;
3394                 row[results_columns.fullpath] = *i;
3395         }
3396
3397         list_scroller.add (results_display);
3398         list_scroller.set_size_request (-1, 150);
3399         list_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
3400
3401         dvbox.pack_start (dhbox, true, false, 5);
3402         dvbox.pack_start (list_scroller, true, false, 5);
3403         ddhbox.pack_start (dvbox, true, false, 5);
3404
3405         results.get_vbox()->pack_start (ddhbox, true, false, 5);
3406         results.add_button (Stock::CLOSE, RESPONSE_CLOSE);
3407         results.set_default_response (RESPONSE_CLOSE);
3408         results.set_position (Gtk::WIN_POS_MOUSE);
3409
3410         results_display.show();
3411         list_scroller.show();
3412         txt.show();
3413         dvbox.show();
3414         dhbox.show();
3415         ddhbox.show();
3416         dimage->show();
3417
3418         //results.get_vbox()->show();
3419         results.set_resizable (false);
3420
3421         results.run ();
3422
3423 }
3424
3425 void
3426 ARDOUR_UI::cleanup ()
3427 {
3428         if (_session == 0) {
3429                 /* shouldn't happen: menu item is insensitive */
3430                 return;
3431         }
3432
3433
3434         MessageDialog checker (_("Are you sure you want to clean-up?"),
3435                                 true,
3436                                 Gtk::MESSAGE_QUESTION,
3437                                 Gtk::BUTTONS_NONE);
3438
3439         checker.set_title (_("Clean-up"));
3440
3441         checker.set_secondary_text(_("Clean-up is a destructive operation.\n\
3442 ALL undo/redo information will be lost if you clean-up.\n\
3443 Clean-up will move all unused files to a \"dead\" location."));
3444
3445         checker.add_button (Stock::CANCEL, RESPONSE_CANCEL);
3446         checker.add_button (_("Clean-up"), RESPONSE_ACCEPT);
3447         checker.set_default_response (RESPONSE_CANCEL);
3448
3449         checker.set_name (_("CleanupDialog"));
3450         checker.set_wmclass (X_("ardour_cleanup"), PROGRAM_NAME);
3451         checker.set_position (Gtk::WIN_POS_MOUSE);
3452
3453         switch (checker.run()) {
3454         case RESPONSE_ACCEPT:
3455                 break;
3456         default:
3457                 return;
3458         }
3459
3460         ARDOUR::CleanupReport rep;
3461
3462         editor->prepare_for_cleanup ();
3463
3464         /* do not allow flush until a session is reloaded */
3465
3466         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Main"), X_("FlushWastebasket"));
3467         if (act) {
3468                 act->set_sensitive (false);
3469         }
3470
3471         if (_session->cleanup_sources (rep)) {
3472                 editor->finish_cleanup ();
3473                 return;
3474         }
3475
3476         editor->finish_cleanup ();
3477
3478         checker.hide();
3479         display_cleanup_results (rep, _("Cleaned Files"), false);
3480 }
3481
3482 void
3483 ARDOUR_UI::flush_trash ()
3484 {
3485         if (_session == 0) {
3486                 /* shouldn't happen: menu item is insensitive */
3487                 return;
3488         }
3489
3490         ARDOUR::CleanupReport rep;
3491
3492         if (_session->cleanup_trash_sources (rep)) {
3493                 return;
3494         }
3495
3496         display_cleanup_results (rep, _("deleted file"), true);
3497 }
3498
3499 void
3500 ARDOUR_UI::setup_order_hint (AddRouteDialog::InsertAt place)
3501 {
3502         uint32_t order_hint = 0;
3503
3504         /*
3505           we want the new routes to have their order keys set starting from
3506           the highest order key in the selection + 1 (if available).
3507         */
3508         if (place == AddRouteDialog::MixerSelection) {
3509                 for (RouteUISelection::iterator s = mixer->selection().routes.begin(); s != mixer->selection().routes.end(); ++s) {
3510                         if ((*s)->route()->order_key() > order_hint) {
3511                                 order_hint = (*s)->route()->order_key();
3512                         }
3513                 }
3514
3515                 if (!mixer->selection().routes.empty()) {
3516                         order_hint++;
3517                 } else {
3518                         return;
3519                 }
3520
3521         } else if (place == AddRouteDialog::EditorSelection){
3522                 for (TrackSelection::iterator s = editor->get_selection().tracks.begin(); s != editor->get_selection().tracks.end(); ++s) {
3523                         RouteTimeAxisView* tav = dynamic_cast<RouteTimeAxisView*> (*s);
3524                         if (tav && tav->route() && tav->route()->order_key() > order_hint) {
3525                                 order_hint = tav->route()->order_key();
3526                         }
3527                 }
3528
3529                 if (!editor->get_selection().tracks.empty()) {
3530                         order_hint++;
3531                 } else {
3532                         return;
3533                 }
3534
3535         } else if (place == AddRouteDialog::First) {
3536                 order_hint = 0;
3537         } else {
3538                 /** AddRouteDialog::Last
3539                  * not setting an order hint will place new routes last.
3540                  */
3541                 return;
3542         }
3543
3544         _session->set_order_hint (order_hint);
3545
3546         /* create a gap in the existing route order keys to accomodate new routes.*/
3547         boost::shared_ptr <RouteList> rd = _session->get_routes();
3548         for (RouteList::iterator ri = rd->begin(); ri != rd->end(); ++ri) {
3549                 boost::shared_ptr<Route> rt (*ri);
3550
3551                 if (rt->is_monitor()) {
3552                         continue;
3553                 }
3554
3555                 if (rt->order_key () >= order_hint) {
3556                         rt->set_order_key (rt->order_key () + add_route_dialog->count());
3557                 }
3558         }
3559 }
3560
3561 void
3562 ARDOUR_UI::add_route (Gtk::Window* /* ignored */)
3563 {
3564         int count;
3565
3566         if (!_session) {
3567                 return;
3568         }
3569
3570         if (add_route_dialog->is_visible()) {
3571                 /* we're already doing this */
3572                 return;
3573         }
3574
3575         ResponseType r = (ResponseType) add_route_dialog->run ();
3576
3577         add_route_dialog->hide();
3578
3579         switch (r) {
3580                 case RESPONSE_ACCEPT:
3581                         break;
3582                 default:
3583                         return;
3584                         break;
3585         }
3586
3587         if ((count = add_route_dialog->count()) <= 0) {
3588                 return;
3589         }
3590
3591         setup_order_hint(add_route_dialog->insert_at());
3592
3593         string template_path = add_route_dialog->track_template();
3594         DisplaySuspender ds;
3595
3596         if (!template_path.empty()) {
3597                 if (add_route_dialog->name_template_is_default())  {
3598                         _session->new_route_from_template (count, template_path, string());
3599                 } else {
3600                         _session->new_route_from_template (count, template_path, add_route_dialog->name_template());
3601                 }
3602                 return;
3603         }
3604
3605         ChanCount input_chan= add_route_dialog->channels ();
3606         ChanCount output_chan;
3607         string name_template = add_route_dialog->name_template ();
3608         PluginInfoPtr instrument = add_route_dialog->requested_instrument ();
3609         RouteGroup* route_group = add_route_dialog->route_group ();
3610         AutoConnectOption oac = Config->get_output_auto_connect();
3611
3612         if (oac & AutoConnectMaster) {
3613                 output_chan.set (DataType::AUDIO, (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan.n_audio()));
3614                 output_chan.set (DataType::MIDI, 0);
3615         } else {
3616                 output_chan = input_chan;
3617         }
3618
3619         /* XXX do something with name template */
3620
3621         switch (add_route_dialog->type_wanted()) {
3622         case AddRouteDialog::AudioTrack:
3623                 session_add_audio_track (input_chan.n_audio(), output_chan.n_audio(), add_route_dialog->mode(), route_group, count, name_template);
3624                 break;
3625         case AddRouteDialog::MidiTrack:
3626                 session_add_midi_track (route_group, count, name_template, instrument);
3627                 break;
3628         case AddRouteDialog::MixedTrack:
3629                 session_add_mixed_track (input_chan, output_chan, route_group, count, name_template, instrument);
3630                 break;
3631         case AddRouteDialog::AudioBus:
3632                 session_add_audio_bus (input_chan.n_audio(), output_chan.n_audio(), route_group, count, name_template);
3633                 break;
3634         }
3635 }
3636
3637 void
3638 ARDOUR_UI::stop_video_server (bool ask_confirm)
3639 {
3640         if (!video_server_process && ask_confirm) {
3641                 warning << string_compose (_("Video-Server was not launched by %1. The request to stop it is ignored."), PROGRAM_NAME) << endmsg;
3642         }
3643         if (video_server_process) {
3644                 if(ask_confirm) {
3645                         ArdourDialog confirm (_("Stop Video-Server"), true);
3646                         Label m (_("Do you really want to stop the Video Server?"));
3647                         confirm.get_vbox()->pack_start (m, true, true);
3648                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
3649                         confirm.add_button (_("Yes, Stop It"), Gtk::RESPONSE_ACCEPT);
3650                         confirm.show_all ();
3651                         if (confirm.run() == RESPONSE_CANCEL) {
3652                                 return;
3653                         }
3654                 }
3655                 delete video_server_process;
3656                 video_server_process =0;
3657         }
3658 }
3659
3660 void
3661 ARDOUR_UI::start_video_server_menu (Gtk::Window* float_window)
3662 {
3663   ARDOUR_UI::start_video_server( float_window, true);
3664 }
3665
3666 bool
3667 ARDOUR_UI::start_video_server (Gtk::Window* float_window, bool popup_msg)
3668 {
3669         if (!_session) {
3670                 return false;
3671         }
3672         if (popup_msg) {
3673                 if (ARDOUR_UI::instance()->video_timeline->check_server()) {
3674                         if (video_server_process) {
3675                                 popup_error(_("The Video Server is already started."));
3676                         } else {
3677                                 popup_error(_("An external Video Server is configured and can be reached. Not starting a new instance."));
3678                         }
3679                 }
3680         }
3681
3682         int firsttime = 0;
3683         while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3684                 if (firsttime++) {
3685                         warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
3686                 }
3687                 VideoServerDialog *video_server_dialog = new VideoServerDialog (_session);
3688                 if (float_window) {
3689                         video_server_dialog->set_transient_for (*float_window);
3690                 }
3691
3692                 if (!Config->get_show_video_server_dialog() && firsttime < 2) {
3693                         video_server_dialog->hide();
3694                 } else {
3695                         ResponseType r = (ResponseType) video_server_dialog->run ();
3696                         video_server_dialog->hide();
3697                         if (r != RESPONSE_ACCEPT) { return false; }
3698                         if (video_server_dialog->show_again()) {
3699                                 Config->set_show_video_server_dialog(false);
3700                         }
3701                 }
3702
3703                 std::string icsd_exec = video_server_dialog->get_exec_path();
3704                 std::string icsd_docroot = video_server_dialog->get_docroot();
3705                 if (icsd_docroot.empty()) {
3706 #ifndef PLATFORM_WINDOWS
3707                         icsd_docroot = X_("/");
3708 #else
3709                         icsd_docroot = X_("C:\\");
3710 #endif
3711                 }
3712
3713                 GStatBuf sb;
3714                 if (g_lstat (icsd_docroot.c_str(), &sb) != 0 || !S_ISDIR(sb.st_mode)) {
3715                         warning << _("Specified docroot is not an existing directory.") << endmsg;
3716                         continue;
3717                 }
3718 #ifndef PLATFORM_WINDOWS
3719                 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
3720                      || (sb.st_mode & (S_IXUSR|S_IXGRP|S_IXOTH)) == 0 ) {
3721                         warning << _("Given Video Server is not an executable file.") << endmsg;
3722                         continue;
3723                 }
3724 #else
3725                 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
3726                      || (sb.st_mode & (S_IXUSR)) == 0 ) {
3727                         warning << _("Given Video Server is not an executable file.") << endmsg;
3728                         continue;
3729                 }
3730 #endif
3731
3732                 char **argp;
3733                 argp=(char**) calloc(9,sizeof(char*));
3734                 argp[0] = strdup(icsd_exec.c_str());
3735                 argp[1] = strdup("-P");
3736                 argp[2] = (char*) calloc(16,sizeof(char)); snprintf(argp[2], 16, "%s", video_server_dialog->get_listenaddr().c_str());
3737                 argp[3] = strdup("-p");
3738                 argp[4] = (char*) calloc(6,sizeof(char)); snprintf(argp[4], 6, "%i", video_server_dialog->get_listenport());
3739                 argp[5] = strdup("-C");
3740                 argp[6] = (char*) calloc(6,sizeof(char)); snprintf(argp[6], 6, "%i", video_server_dialog->get_cachesize());
3741                 argp[7] = strdup(icsd_docroot.c_str());
3742                 argp[8] = 0;
3743                 stop_video_server();
3744
3745                 if (icsd_docroot == X_("/") || icsd_docroot == X_("C:\\")) {
3746                         Config->set_video_advanced_setup(false);
3747                 } else {
3748                         std::ostringstream osstream;
3749                         osstream << "http://localhost:" << video_server_dialog->get_listenport() << "/";
3750                         Config->set_video_server_url(osstream.str());
3751                         Config->set_video_server_docroot(icsd_docroot);
3752                         Config->set_video_advanced_setup(true);
3753                 }
3754
3755                 if (video_server_process) {
3756                         delete video_server_process;
3757                 }
3758
3759                 video_server_process = new ARDOUR::SystemExec(icsd_exec, argp);
3760                 if (video_server_process->start()) {
3761                         warning << _("Cannot launch the video-server") << endmsg;
3762                         continue;
3763                 }
3764                 int timeout = 120; // 6 sec
3765                 while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3766                         Glib::usleep (50000);
3767                         gui_idle_handler();
3768                         if (--timeout <= 0 || !video_server_process->is_running()) break;
3769                 }
3770                 if (timeout <= 0) {
3771                         warning << _("Video-server was started but does not respond to requests...") << endmsg;
3772                 } else {
3773                         if (!ARDOUR_UI::instance()->video_timeline->check_server_docroot()) {
3774                                 delete video_server_process;
3775                                 video_server_process = 0;
3776                         }
3777                 }
3778         }
3779         return true;
3780 }
3781
3782 void
3783 ARDOUR_UI::add_video (Gtk::Window* float_window)
3784 {
3785         if (!_session) {
3786                 return;
3787         }
3788
3789         if (!start_video_server(float_window, false)) {
3790                 warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
3791                 return;
3792         }
3793
3794         if (float_window) {
3795                 add_video_dialog->set_transient_for (*float_window);
3796         }
3797
3798         if (add_video_dialog->is_visible()) {
3799                 /* we're already doing this */
3800                 return;
3801         }
3802
3803         ResponseType r = (ResponseType) add_video_dialog->run ();
3804         add_video_dialog->hide();
3805         if (r != RESPONSE_ACCEPT) { return; }
3806
3807         bool local_file, orig_local_file;
3808         std::string path = add_video_dialog->file_name(local_file);
3809
3810         std::string orig_path = path;
3811         orig_local_file = local_file;
3812
3813         bool auto_set_session_fps = add_video_dialog->auto_set_session_fps();
3814
3815         if (local_file && !Glib::file_test(path, Glib::FILE_TEST_EXISTS)) {
3816                 warning << string_compose(_("could not open %1"), path) << endmsg;
3817                 return;
3818         }
3819         if (!local_file && path.length() == 0) {
3820                 warning << _("no video-file selected") << endmsg;
3821                 return;
3822         }
3823
3824         switch (add_video_dialog->import_option()) {
3825                 case VTL_IMPORT_TRANSCODE:
3826                         {
3827                                 TranscodeVideoDialog *transcode_video_dialog;
3828                                 transcode_video_dialog = new TranscodeVideoDialog (_session, path);
3829                                 ResponseType r = (ResponseType) transcode_video_dialog->run ();
3830                                 transcode_video_dialog->hide();
3831                                 if (r != RESPONSE_ACCEPT) {
3832                                         delete transcode_video_dialog;
3833                                         return;
3834                                 }
3835                                 if (!transcode_video_dialog->get_audiofile().empty()) {
3836                                         editor->embed_audio_from_video(
3837                                                         transcode_video_dialog->get_audiofile(),
3838                                                         video_timeline->get_offset(),
3839                                                         (transcode_video_dialog->import_option() != VTL_IMPORT_NO_VIDEO)
3840                                                         );
3841                                 }
3842                                 switch (transcode_video_dialog->import_option()) {
3843                                         case VTL_IMPORT_TRANSCODED:
3844                                                 path = transcode_video_dialog->get_filename();
3845                                                 local_file = true;
3846                                                 break;
3847                                         case VTL_IMPORT_REFERENCE:
3848                                                 break;
3849                                         default:
3850                                                 delete transcode_video_dialog;
3851                                                 return;
3852                                 }
3853                                 delete transcode_video_dialog;
3854                         }
3855                         break;
3856                 default:
3857                 case VTL_IMPORT_NONE:
3858                         break;
3859         }
3860
3861         /* strip _session->session_directory().video_path() from video file if possible */
3862         if (local_file && !path.compare(0, _session->session_directory().video_path().size(), _session->session_directory().video_path())) {
3863                  path=path.substr(_session->session_directory().video_path().size());
3864                  if (path.at(0) == G_DIR_SEPARATOR) {
3865                          path=path.substr(1);
3866                  }
3867         }
3868
3869         video_timeline->set_update_session_fps(auto_set_session_fps);
3870         if (video_timeline->video_file_info(path, local_file)) {
3871                 XMLNode* node = new XMLNode(X_("Videotimeline"));
3872                 node->add_property (X_("Filename"), path);
3873                 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
3874                 node->add_property (X_("LocalFile"), local_file?X_("1"):X_("0"));
3875                 if (orig_local_file) {
3876                         node->add_property (X_("OriginalVideoFile"), orig_path);
3877                 } else {
3878                         node->remove_property (X_("OriginalVideoFile"));
3879                 }
3880                 _session->add_extra_xml (*node);
3881                 _session->set_dirty ();
3882
3883                 _session->maybe_update_session_range(
3884                         std::max(video_timeline->get_offset(), (ARDOUR::frameoffset_t) 0),
3885                         std::max(video_timeline->get_offset() + video_timeline->get_duration(), (ARDOUR::frameoffset_t) 0));
3886
3887
3888                 if (add_video_dialog->launch_xjadeo() && local_file) {
3889                         editor->set_xjadeo_sensitive(true);
3890                         editor->toggle_xjadeo_proc(1);
3891                 } else {
3892                         editor->toggle_xjadeo_proc(0);
3893                 }
3894                 editor->toggle_ruler_video(true);
3895         }
3896 }
3897
3898 void
3899 ARDOUR_UI::remove_video ()
3900 {
3901         video_timeline->close_session();
3902         editor->toggle_ruler_video(false);
3903
3904         /* reset state */
3905         video_timeline->set_offset_locked(false);
3906         video_timeline->set_offset(0);
3907
3908         /* delete session state */
3909         XMLNode* node = new XMLNode(X_("Videotimeline"));
3910         _session->add_extra_xml(*node);
3911         node = new XMLNode(X_("Videomonitor"));
3912         _session->add_extra_xml(*node);
3913         node = new XMLNode(X_("Videoexport"));
3914         _session->add_extra_xml(*node);
3915         stop_video_server();
3916 }
3917
3918 void
3919 ARDOUR_UI::flush_videotimeline_cache (bool localcacheonly)
3920 {
3921         if (localcacheonly) {
3922                 video_timeline->vmon_update();
3923         } else {
3924                 video_timeline->flush_cache();
3925         }
3926         editor->queue_visual_videotimeline_update();
3927 }
3928
3929 void
3930 ARDOUR_UI::export_video (bool range)
3931 {
3932         if (ARDOUR::Config->get_show_video_export_info()) {
3933                 ExportVideoInfobox infobox (_session);
3934                 Gtk::ResponseType rv = (Gtk::ResponseType) infobox.run();
3935                 if (infobox.show_again()) {
3936                         ARDOUR::Config->set_show_video_export_info(false);
3937                 }
3938                 switch (rv) {
3939                         case GTK_RESPONSE_YES:
3940                                 PBD::open_uri (ARDOUR::Config->get_reference_manual_url() + "/video-timeline/operations/#export");
3941                                 break;
3942                         default:
3943                                 break;
3944                 }
3945         }
3946         export_video_dialog->set_session (_session);
3947         export_video_dialog->apply_state(editor->get_selection().time, range);
3948         export_video_dialog->run ();
3949         export_video_dialog->hide ();
3950 }
3951
3952 XMLNode*
3953 ARDOUR_UI::mixer_settings () const
3954 {
3955         XMLNode* node = 0;
3956
3957         if (_session) {
3958                 node = _session->instant_xml(X_("Mixer"));
3959         } else {
3960                 node = Config->instant_xml(X_("Mixer"));
3961         }
3962
3963         if (!node) {
3964                 node = new XMLNode (X_("Mixer"));
3965         }
3966
3967         return node;
3968 }
3969
3970 XMLNode*
3971 ARDOUR_UI::editor_settings () const
3972 {
3973         XMLNode* node = 0;
3974
3975         if (_session) {
3976                 node = _session->instant_xml(X_("Editor"));
3977         } else {
3978                 node = Config->instant_xml(X_("Editor"));
3979         }
3980
3981         if (!node) {
3982                 if (getenv("ARDOUR_INSTANT_XML_PATH")) {
3983                         node = Config->instant_xml(getenv("ARDOUR_INSTANT_XML_PATH"));
3984                 }
3985         }
3986
3987         if (!node) {
3988                 node = new XMLNode (X_("Editor"));
3989         }
3990
3991         return node;
3992 }
3993
3994 XMLNode*
3995 ARDOUR_UI::keyboard_settings () const
3996 {
3997         XMLNode* node = 0;
3998
3999         node = Config->extra_xml(X_("Keyboard"));
4000
4001         if (!node) {
4002                 node = new XMLNode (X_("Keyboard"));
4003         }
4004
4005         return node;
4006 }
4007
4008 void
4009 ARDOUR_UI::create_xrun_marker (framepos_t where)
4010 {
4011         editor->mouse_add_new_marker (where, false, true);
4012 }
4013
4014 void
4015 ARDOUR_UI::halt_on_xrun_message ()
4016 {
4017         cerr << "HALT on xrun\n";
4018         MessageDialog msg (*editor, _("Recording was stopped because your system could not keep up."));
4019         msg.run ();
4020 }
4021
4022 void
4023 ARDOUR_UI::xrun_handler (framepos_t where)
4024 {
4025         if (!_session) {
4026                 return;
4027         }
4028
4029         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::xrun_handler, where)
4030
4031         if (_session && Config->get_create_xrun_marker() && _session->actively_recording()) {
4032                 create_xrun_marker(where);
4033         }
4034
4035         if (_session && Config->get_stop_recording_on_xrun() && _session->actively_recording()) {
4036                 halt_on_xrun_message ();
4037         }
4038 }
4039
4040 void
4041 ARDOUR_UI::disk_overrun_handler ()
4042 {
4043         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_overrun_handler)
4044
4045         if (!have_disk_speed_dialog_displayed) {
4046                 have_disk_speed_dialog_displayed = true;
4047                 MessageDialog* msg = new MessageDialog (*editor, string_compose (_("\
4048 The disk system on your computer\n\
4049 was not able to keep up with %1.\n\
4050 \n\
4051 Specifically, it failed to write data to disk\n\
4052 quickly enough to keep up with recording.\n"), PROGRAM_NAME));
4053                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4054                 msg->show ();
4055         }
4056 }
4057
4058
4059 /* TODO: this is getting elaborate enough to warrant being split into a dedicated class */
4060 static MessageDialog *scan_dlg = NULL;
4061 static ProgressBar   *scan_pbar = NULL;
4062 static HBox          *scan_tbox = NULL;
4063
4064 void
4065 ARDOUR_UI::cancel_plugin_scan ()
4066 {
4067         PluginManager::instance().cancel_plugin_scan();
4068 }
4069
4070 void
4071 ARDOUR_UI::cancel_plugin_timeout ()
4072 {
4073         PluginManager::instance().cancel_plugin_timeout();
4074         scan_tbox->hide();
4075 }
4076
4077 void
4078 ARDOUR_UI::plugin_scan_timeout (int timeout)
4079 {
4080         if (!scan_dlg || !scan_dlg->is_mapped() || !scan_pbar) {
4081                 return;
4082         }
4083         if (timeout > 0) {
4084                 scan_pbar->set_fraction ((float) timeout / (float) Config->get_vst_scan_timeout());
4085                 scan_tbox->show();
4086         } else {
4087                 scan_tbox->hide();
4088         }
4089         gui_idle_handler();
4090 }
4091
4092 void
4093 ARDOUR_UI::plugin_scan_dialog (std::string type, std::string plugin, bool can_cancel)
4094 {
4095         if (type == X_("closeme") && !(scan_dlg && scan_dlg->is_mapped())) {
4096                 return;
4097         }
4098
4099         const bool cancelled = PluginManager::instance().cancelled();
4100         if (type != X_("closeme") && !ui_config->get_show_plugin_scan_window()) {
4101                 if (cancelled && scan_dlg->is_mapped()) {
4102                         scan_dlg->hide();
4103                         gui_idle_handler();
4104                         return;
4105                 }
4106                 if (cancelled || !can_cancel) {
4107                         return;
4108                 }
4109         }
4110
4111         static Gtk::Button *cancel_button;
4112         static Gtk::Button *timeout_button;
4113         if (!scan_dlg) {
4114                 scan_dlg = new MessageDialog("", false, MESSAGE_INFO, BUTTONS_NONE); // TODO manage
4115                 VBox* vbox = scan_dlg->get_vbox();
4116                 vbox->set_size_request(400,-1);
4117                 scan_dlg->set_title (_("Scanning for plugins"));
4118
4119                 cancel_button = manage(new Gtk::Button(_("Cancel plugin scan")));
4120                 cancel_button->set_name ("EditorGTKButton");
4121                 cancel_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_scan) );
4122                 cancel_button->show();
4123
4124                 scan_dlg->get_vbox()->pack_start ( *cancel_button, PACK_SHRINK);
4125
4126                 scan_tbox = manage( new HBox() );
4127
4128                 timeout_button = manage(new Gtk::Button(_("Stop Timeout")));
4129                 timeout_button->set_name ("EditorGTKButton");
4130                 timeout_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_timeout) );
4131                 timeout_button->show();
4132
4133                 scan_pbar = manage(new ProgressBar());
4134                 scan_pbar->set_orientation(Gtk::PROGRESS_RIGHT_TO_LEFT);
4135                 scan_pbar->set_text(_("Scan Timeout"));
4136                 scan_pbar->show();
4137
4138                 scan_tbox->pack_start (*scan_pbar, PACK_EXPAND_WIDGET, 4);
4139                 scan_tbox->pack_start (*timeout_button, PACK_SHRINK, 4);
4140
4141                 scan_dlg->get_vbox()->pack_start (*scan_tbox, PACK_SHRINK, 4);
4142         }
4143
4144         assert(scan_dlg && scan_tbox && cancel_button);
4145
4146         if (type == X_("closeme")) {
4147                 scan_dlg->hide();
4148         } else {
4149                 scan_dlg->set_message(type + ": " + Glib::path_get_basename(plugin));
4150                 scan_dlg->show();
4151         }
4152         if (!can_cancel || !cancelled) {
4153                 scan_tbox->hide();
4154         }
4155         cancel_button->set_sensitive(can_cancel && !cancelled);
4156
4157         gui_idle_handler();
4158 }
4159
4160 void
4161 ARDOUR_UI::gui_idle_handler ()
4162 {
4163         int timeout = 30;
4164         /* due to idle calls, gtk_events_pending() may always return true */
4165         while (gtk_events_pending() && --timeout) {
4166                 gtk_main_iteration ();
4167         }
4168 }
4169
4170 void
4171 ARDOUR_UI::disk_underrun_handler ()
4172 {
4173         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_underrun_handler)
4174
4175         if (!have_disk_speed_dialog_displayed) {
4176                 have_disk_speed_dialog_displayed = true;
4177                 MessageDialog* msg = new MessageDialog (
4178                         *editor, string_compose (_("The disk system on your computer\n\
4179 was not able to keep up with %1.\n\
4180 \n\
4181 Specifically, it failed to read data from disk\n\
4182 quickly enough to keep up with playback.\n"), PROGRAM_NAME));
4183                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4184                 msg->show ();
4185         }
4186 }
4187
4188 void
4189 ARDOUR_UI::disk_speed_dialog_gone (int /*ignored_response*/, MessageDialog* msg)
4190 {
4191         have_disk_speed_dialog_displayed = false;
4192         delete msg;
4193 }
4194
4195 void
4196 ARDOUR_UI::session_dialog (std::string msg)
4197 {
4198         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::session_dialog, msg)
4199
4200         MessageDialog* d;
4201
4202         if (editor) {
4203                 d = new MessageDialog (*editor, msg, false, MESSAGE_INFO, BUTTONS_OK, true);
4204         } else {
4205                 d = new MessageDialog (msg, false, MESSAGE_INFO, BUTTONS_OK, true);
4206         }
4207
4208         d->show_all ();
4209         d->run ();
4210         delete d;
4211 }
4212
4213 int
4214 ARDOUR_UI::pending_state_dialog ()
4215 {
4216         HBox* hbox = manage (new HBox());
4217         Image* image = manage (new Image (Stock::DIALOG_QUESTION, ICON_SIZE_DIALOG));
4218         ArdourDialog dialog (_("Crash Recovery"), true);
4219         Label  message (string_compose (_("\
4220 This session appears to have been in the\n\
4221 middle of recording when %1 or\n\
4222 the computer was shutdown.\n\
4223 \n\
4224 %1 can recover any captured audio for\n\
4225 you, or it can ignore it. Please decide\n\
4226 what you would like to do.\n"), PROGRAM_NAME));
4227         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4228         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4229         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4230         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4231         dialog.add_button (_("Ignore crash data"), RESPONSE_REJECT);
4232         dialog.add_button (_("Recover from crash"), RESPONSE_ACCEPT);
4233         dialog.set_default_response (RESPONSE_ACCEPT);
4234         dialog.set_position (WIN_POS_CENTER);
4235         message.show();
4236         image->show();
4237         hbox->show();
4238
4239         switch (dialog.run ()) {
4240         case RESPONSE_ACCEPT:
4241                 return 1;
4242         default:
4243                 return 0;
4244         }
4245 }
4246
4247 int
4248 ARDOUR_UI::sr_mismatch_dialog (framecnt_t desired, framecnt_t actual)
4249 {
4250         HBox* hbox = new HBox();
4251         Image* image = new Image (Stock::DIALOG_WARNING, ICON_SIZE_DIALOG);
4252         ArdourDialog dialog (_("Sample Rate Mismatch"), true);
4253         Label  message (string_compose (_("\
4254 This session was created with a sample rate of %1 Hz, but\n\
4255 %2 is currently running at %3 Hz.  If you load this session,\n\
4256 audio may be played at the wrong sample rate.\n"), desired, PROGRAM_NAME, actual));
4257
4258         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4259         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4260         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4261         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4262         dialog.add_button (_("Do not load session"), RESPONSE_REJECT);
4263         dialog.add_button (_("Load session anyway"), RESPONSE_ACCEPT);
4264         dialog.set_default_response (RESPONSE_ACCEPT);
4265         dialog.set_position (WIN_POS_CENTER);
4266         message.show();
4267         image->show();
4268         hbox->show();
4269
4270         switch (dialog.run()) {
4271         case RESPONSE_ACCEPT:
4272                 return 0;
4273         default:
4274                 break;
4275         }
4276
4277         return 1;
4278 }
4279
4280 int
4281 ARDOUR_UI::disconnect_from_engine ()
4282 {
4283         /* drop connection to AudioEngine::Halted so that we don't act
4284          *  as if the engine unexpectedly shut down
4285          */
4286
4287         halt_connection.disconnect ();
4288
4289         if (AudioEngine::instance()->stop ()) {
4290                 MessageDialog msg (*editor, _("Could not disconnect from Audio/MIDI engine"));
4291                 msg.run ();
4292                 return -1;
4293         } else {
4294                 AudioEngine::instance()->Halted.connect_same_thread (halt_connection, boost::bind (&ARDOUR_UI::engine_halted, this, _1, false));
4295         }
4296
4297         update_sample_rate (0);
4298         return 0;
4299 }
4300
4301 int
4302 ARDOUR_UI::reconnect_to_engine ()
4303 {
4304         if (AudioEngine::instance()->start ()) {
4305                 // TODO somehow make this the topmost window (above any dialogs currently visible)
4306                 if (editor) {
4307                         MessageDialog msg (*editor,  _("Could not reconnect to the Audio/MIDI engine"));
4308                         msg.run ();
4309                 } else {
4310                         MessageDialog msg (_("Could not reconnect to the Audio/MIDI engine"));
4311                         msg.run ();
4312                 }
4313                 return -1;
4314         }
4315
4316         update_sample_rate (0);
4317         return 0;
4318 }
4319
4320 void
4321 ARDOUR_UI::use_config ()
4322 {
4323         XMLNode* node = Config->extra_xml (X_("TransportControllables"));
4324         if (node) {
4325                 set_transport_controllable_state (*node);
4326         }
4327 }
4328
4329 void
4330 ARDOUR_UI::update_transport_clocks (framepos_t pos)
4331 {
4332         if (ui_config->get_primary_clock_delta_edit_cursor()) {
4333                 primary_clock->set (pos, false, editor->get_preferred_edit_position());
4334         } else {
4335                 primary_clock->set (pos);
4336         }
4337
4338         if (ui_config->get_secondary_clock_delta_edit_cursor()) {
4339                 secondary_clock->set (pos, false, editor->get_preferred_edit_position());
4340         } else {
4341                 secondary_clock->set (pos);
4342         }
4343
4344         if (big_clock_window) {
4345                 big_clock->set (pos);
4346         }
4347         ARDOUR_UI::instance()->video_timeline->manual_seek_video_monitor(pos);
4348 }
4349
4350 void
4351 ARDOUR_UI::step_edit_status_change (bool yn)
4352 {
4353         // XXX should really store pre-step edit status of things
4354         // we make insensitive
4355
4356         if (yn) {
4357                 rec_button.set_active_state (Gtkmm2ext::ImplicitActive);
4358                 rec_button.set_sensitive (false);
4359         } else {
4360                 rec_button.unset_active_state ();;
4361                 rec_button.set_sensitive (true);
4362         }
4363 }
4364
4365 void
4366 ARDOUR_UI::record_state_changed ()
4367 {
4368         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::record_state_changed);
4369
4370         if (!_session || !big_clock_window) {
4371                 /* why bother - the clock isn't visible */
4372                 return;
4373         }
4374
4375         if (_session->record_status () == Session::Recording && _session->have_rec_enabled_track ()) {
4376                 big_clock->set_active (true);
4377         } else {
4378                 big_clock->set_active (false);
4379         }
4380 }
4381
4382 bool
4383 ARDOUR_UI::first_idle ()
4384 {
4385         if (_session) {
4386                 _session->allow_auto_play (true);
4387         }
4388
4389         if (editor) {
4390                 editor->first_idle();
4391         }
4392
4393         Keyboard::set_can_save_keybindings (true);
4394         return false;
4395 }
4396
4397 void
4398 ARDOUR_UI::store_clock_modes ()
4399 {
4400         XMLNode* node = new XMLNode(X_("ClockModes"));
4401
4402         for (vector<AudioClock*>::iterator x = AudioClock::clocks.begin(); x != AudioClock::clocks.end(); ++x) {
4403                 XMLNode* child = new XMLNode (X_("Clock"));
4404
4405                 child->add_property (X_("name"), (*x)->name());
4406                 child->add_property (X_("mode"), enum_2_string ((*x)->mode()));
4407                 child->add_property (X_("on"), ((*x)->off() ? X_("no") : X_("yes")));
4408
4409                 node->add_child_nocopy (*child);
4410         }
4411
4412         _session->add_extra_xml (*node);
4413         _session->set_dirty ();
4414 }
4415
4416 ARDOUR_UI::TransportControllable::TransportControllable (std::string name, ARDOUR_UI& u, ToggleType tp)
4417         : Controllable (name), ui (u), type(tp)
4418 {
4419
4420 }
4421
4422 void
4423 ARDOUR_UI::TransportControllable::set_value (double val)
4424 {
4425         if (val < 0.5) {
4426                 /* do nothing: these are radio-style actions */
4427                 return;
4428         }
4429
4430         const char *action = 0;
4431
4432         switch (type) {
4433         case Roll:
4434                 action = X_("Roll");
4435                 break;
4436         case Stop:
4437                 action = X_("Stop");
4438                 break;
4439         case GotoStart:
4440                 action = X_("GotoStart");
4441                 break;
4442         case GotoEnd:
4443                 action = X_("GotoEnd");
4444                 break;
4445         case AutoLoop:
4446                 action = X_("Loop");
4447                 break;
4448         case PlaySelection:
4449                 action = X_("PlaySelection");
4450                 break;
4451         case RecordEnable:
4452                 action = X_("Record");
4453                 break;
4454         default:
4455                 break;
4456         }
4457
4458         if (action == 0) {
4459                 return;
4460         }
4461
4462         Glib::RefPtr<Action> act = ActionManager::get_action ("Transport", action);
4463
4464         if (act) {
4465                 act->activate ();
4466         }
4467 }
4468
4469 double
4470 ARDOUR_UI::TransportControllable::get_value (void) const
4471 {
4472         float val = 0.0;
4473
4474         switch (type) {
4475         case Roll:
4476                 break;
4477         case Stop:
4478                 break;
4479         case GotoStart:
4480                 break;
4481         case GotoEnd:
4482                 break;
4483         case AutoLoop:
4484                 break;
4485         case PlaySelection:
4486                 break;
4487         case RecordEnable:
4488                 break;
4489         default:
4490                 break;
4491         }
4492
4493         return val;
4494 }
4495
4496 void
4497 ARDOUR_UI::setup_profile ()
4498 {
4499         if (gdk_screen_width() < 1200 || getenv ("ARDOUR_NARROW_SCREEN")) {
4500                 Profile->set_small_screen ();
4501         }
4502
4503         if (g_getenv ("ARDOUR_SAE")) {
4504                 Profile->set_sae ();
4505                 Profile->set_single_package ();
4506         }
4507
4508         if (g_getenv ("TRX")) {
4509                 Profile->set_trx ();
4510         }
4511
4512         if (g_getenv ("MIXBUS")) {
4513                 Profile->set_mixbus ();
4514         }
4515 }
4516
4517 int
4518 ARDOUR_UI::missing_file (Session*s, std::string str, DataType type)
4519 {
4520         MissingFileDialog dialog (s, str, type);
4521
4522         dialog.show ();
4523         dialog.present ();
4524
4525         int result = dialog.run ();
4526         dialog.hide ();
4527
4528         switch (result) {
4529         case RESPONSE_OK:
4530                 break;
4531         default:
4532                 return 1; // quit entire session load
4533         }
4534
4535         result = dialog.get_action ();
4536
4537         return result;
4538 }
4539
4540 int
4541 ARDOUR_UI::ambiguous_file (std::string file, std::vector<std::string> hits)
4542 {
4543         AmbiguousFileDialog dialog (file, hits);
4544
4545         dialog.show ();
4546         dialog.present ();
4547
4548         dialog.run ();
4549         return dialog.get_which ();
4550 }
4551
4552 /** Allocate our thread-local buffers */
4553 void
4554 ARDOUR_UI::get_process_buffers ()
4555 {
4556         _process_thread->get_buffers ();
4557 }
4558
4559 /** Drop our thread-local buffers */
4560 void
4561 ARDOUR_UI::drop_process_buffers ()
4562 {
4563         _process_thread->drop_buffers ();
4564 }
4565
4566 void
4567 ARDOUR_UI::feedback_detected ()
4568 {
4569         _feedback_exists = true;
4570 }
4571
4572 void
4573 ARDOUR_UI::successful_graph_sort ()
4574 {
4575         _feedback_exists = false;
4576 }
4577
4578 void
4579 ARDOUR_UI::midi_panic ()
4580 {
4581         if (_session) {
4582                 _session->midi_panic();
4583         }
4584 }
4585
4586 void
4587 ARDOUR_UI::session_format_mismatch (std::string xml_path, std::string backup_path)
4588 {
4589         const char* start_big = "<span size=\"x-large\" weight=\"bold\">";
4590         const char* end_big = "</span>";
4591         const char* start_mono = "<tt>";
4592         const char* end_mono = "</tt>";
4593
4594         MessageDialog msg (string_compose (_("%4This is a session from an older version of %3%5\n\n"
4595                                              "%3 has copied the old session file\n\n%6%1%7\n\nto\n\n%6%2%7\n\n"
4596                                              "From now on, use the -2000 version with older versions of %3"),
4597                                            xml_path, backup_path, PROGRAM_NAME,
4598                                            start_big, end_big,
4599                                            start_mono, end_mono), true);
4600
4601         msg.run ();
4602 }
4603
4604
4605 void
4606 ARDOUR_UI::reset_peak_display ()
4607 {
4608         if (!_session || !_session->master_out() || !editor_meter) return;
4609         editor_meter->clear_meters();
4610         editor_meter_max_peak = -INFINITY;
4611         editor_meter_peak_display.set_active_state ( Gtkmm2ext::Off );
4612 }
4613
4614 void
4615 ARDOUR_UI::reset_group_peak_display (RouteGroup* group)
4616 {
4617         if (!_session || !_session->master_out()) return;
4618         if (group == _session->master_out()->route_group()) {
4619                 reset_peak_display ();
4620         }
4621 }
4622
4623 void
4624 ARDOUR_UI::reset_route_peak_display (Route* route)
4625 {
4626         if (!_session || !_session->master_out()) return;
4627         if (_session->master_out().get() == route) {
4628                 reset_peak_display ();
4629         }
4630 }
4631
4632 int
4633 ARDOUR_UI::do_audio_midi_setup (uint32_t desired_sample_rate)
4634 {
4635         audio_midi_setup->set_desired_sample_rate (desired_sample_rate);
4636         audio_midi_setup->set_position (WIN_POS_CENTER);
4637
4638         switch (audio_midi_setup->run()) {
4639         case Gtk::RESPONSE_OK:
4640                 return 0;
4641         case Gtk::RESPONSE_APPLY:
4642                 return 0;
4643         default:
4644                 return -1;
4645         }
4646 }
4647
4648
4649 gint
4650 ARDOUR_UI::transport_numpad_timeout ()
4651 {
4652         _numpad_locate_happening = false;
4653         if (_numpad_timeout_connection.connected() )
4654                 _numpad_timeout_connection.disconnect();
4655         return 1;
4656 }
4657
4658 void
4659 ARDOUR_UI::transport_numpad_decimal ()
4660 {
4661         _numpad_timeout_connection.disconnect();
4662
4663         if (_numpad_locate_happening) {
4664                 if (editor) editor->goto_nth_marker(_pending_locate_num - 1);
4665                 _numpad_locate_happening = false;
4666         } else {
4667                 _pending_locate_num = 0;
4668                 _numpad_locate_happening = true;
4669                 _numpad_timeout_connection = Glib::signal_timeout().connect (mem_fun(*this, &ARDOUR_UI::transport_numpad_timeout), 2*1000);
4670         }
4671 }
4672
4673 void
4674 ARDOUR_UI::transport_numpad_event (int num)
4675 {
4676         if ( _numpad_locate_happening ) {
4677                 _pending_locate_num = _pending_locate_num*10 + num;
4678         } else {
4679                 switch (num) {
4680                         case 0:  toggle_roll(false, false);             break;
4681                         case 1:  transport_rewind(1);                           break;
4682                         case 2:  transport_forward(1);                          break;
4683                         case 3:  transport_record(true);                        break;
4684                         case 4:  toggle_session_auto_loop();            break;
4685                         case 5:  transport_record(false); toggle_session_auto_loop();   break;
4686                         case 6:  toggle_punch();                                        break;
4687                         case 7:  toggle_click();                                break;
4688                         case 8:  toggle_auto_return();                  break;
4689                         case 9:  toggle_follow_edits();         break;
4690                 }
4691         }
4692 }
4693
4694 void
4695 ARDOUR_UI::set_flat_buttons ()
4696 {
4697         CairoWidget::set_flat_buttons( config()->get_flat_buttons() );
4698 }
4699
4700 void
4701 ARDOUR_UI::audioengine_became_silent ()
4702 {
4703         MessageDialog msg (string_compose (_("This is a free/demo copy of %1. It has just switched to silent mode."), PROGRAM_NAME),
4704                            true,
4705                            Gtk::MESSAGE_WARNING,
4706                            Gtk::BUTTONS_NONE,
4707                            true);
4708
4709         msg.set_title (string_compose (_("%1 is now silent"), PROGRAM_NAME));
4710
4711         Gtk::Label pay_label (string_compose (_("Please consider paying for a copy of %1 - you can pay whatever you want."), PROGRAM_NAME));
4712         Gtk::Label subscribe_label (_("Better yet become a subscriber - subscriptions start at US$1 per month."));
4713         Gtk::Button pay_button (_("Pay for a copy (via the web)"));
4714         Gtk::Button subscribe_button (_("Become a subscriber (via the web)"));
4715         Gtk::HBox pay_button_box;
4716         Gtk::HBox subscribe_button_box;
4717
4718         pay_button_box.pack_start (pay_button, true, false);
4719         subscribe_button_box.pack_start (subscribe_button, true, false);
4720
4721         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 */
4722
4723         pay_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://ardour.org/download")));
4724         subscribe_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://community.ardour.org/s/subscribe")));
4725
4726         msg.get_vbox()->pack_start (pay_label);
4727         msg.get_vbox()->pack_start (pay_button_box);
4728         msg.get_vbox()->pack_start (subscribe_label);
4729         msg.get_vbox()->pack_start (subscribe_button_box);
4730
4731         msg.get_vbox()->show_all ();
4732
4733         msg.add_button (_("Remain silent"), Gtk::RESPONSE_CANCEL);
4734         msg.add_button (_("Save and quit"), Gtk::RESPONSE_NO);
4735         msg.add_button (_("Give me more time"), Gtk::RESPONSE_YES);
4736
4737         int r = msg.run ();
4738
4739         switch (r) {
4740         case Gtk::RESPONSE_YES:
4741                 AudioEngine::instance()->reset_silence_countdown ();
4742                 break;
4743
4744         case Gtk::RESPONSE_NO:
4745                 /* save and quit */
4746                 save_state_canfail ("");
4747                 exit (0);
4748                 break;
4749
4750         case Gtk::RESPONSE_CANCEL:
4751         default:
4752                 /* don't reset, save session and exit */
4753                 break;
4754         }
4755 }