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