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