gtk2_ardour/ardour_ui.cc

   1 /*
   2  * Copyright (C) 2005-2007 Doug McLain <doug@nostar.net>
   3  * Copyright (C) 2005-2017 Tim Mayberry <mojofunk@gmail.com>
   4  * Copyright (C) 2005-2019 Paul Davis <paul@linuxaudiosystems.com>
   5  * Copyright (C) 2005 Karsten Wiese <fzuuzf@googlemail.com>
   6  * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
   7  * Copyright (C) 2006-2015 David Robillard <d@drobilla.net>
   8  * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
   9  * Copyright (C) 2008-2010 Sakari Bergen <sakari.bergen@beatwaves.net>
  10  * Copyright (C) 2012-2019 Robin Gareus <robin@gareus.org>
  11  * Copyright (C) 2013-2015 Colin Fletcher <colin.m.fletcher@googlemail.com>
  12  * Copyright (C) 2013-2016 John Emmas <john@creativepost.co.uk>
  13  * Copyright (C) 2013-2016 Nick Mainsbridge <mainsbridge@gmail.com>
  14  * Copyright (C) 2014-2018 Ben Loftis <ben@harrisonconsoles.com>
  15  * Copyright (C) 2015 André Nusser <andre.nusser@googlemail.com>
  16  * Copyright (C) 2016-2018 Len Ovens <len@ovenwerks.net>
  17  * Copyright (C) 2017 Johannes Mueller <github@johannes-mueller.org>
  18  *
  19  * This program is free software; you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation; either version 2 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License along
  30  * with this program; if not, write to the Free Software Foundation, Inc.,
  31  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  32  */
  33
  34 #ifdef WAF_BUILD
  35 #include "gtk2ardour-config.h"
  36 #include "gtk2ardour-version.h"
  37 #endif
  38
  39 #include <algorithm>
  40 #include <cmath>
  41 #include <iostream>
  42 #include <cerrno>
  43
  44 #include <stdarg.h>
  45
  46 #ifndef PLATFORM_WINDOWS
  47 #include <sys/resource.h>
  48 #endif
  49
  50 #ifdef __FreeBSD__
  51 #include <sys/types.h>
  52 #include <sys/sysctl.h>
  53 #endif
  54
  55 #include <stdint.h>
  56 #include <fcntl.h>
  57 #include <signal.h>
  58 #include <unistd.h>
  59 #include <time.h>
  60
  61 #include <glib.h>
  62 #include "pbd/gstdio_compat.h"
  63
  64 #include <gtkmm/accelmap.h>
  65 #include <gtkmm/messagedialog.h>
  66 #include <gtkmm/stock.h>
  67 #include <gtkmm/uimanager.h>
  68
  69 #include "pbd/error.h"
  70 #include "pbd/basename.h"
  71 #include "pbd/compose.h"
  72 #include "pbd/convert.h"
  73 #include "pbd/failed_constructor.h"
  74 #include "pbd/file_archive.h"
  75 #include "pbd/enumwriter.h"
  76 #include "pbd/memento_command.h"
  77 #include "pbd/openuri.h"
  78 #include "pbd/stl_delete.h"
  79 #include "pbd/types_convert.h"
  80 #include "pbd/unwind.h"
  81 #include "pbd/file_utils.h"
  82 #include "pbd/localtime_r.h"
  83 #include "pbd/pthread_utils.h"
  84 #include "pbd/replace_all.h"
  85 #include "pbd/scoped_file_descriptor.h"
  86 #include "pbd/xml++.h"
  87
  88 #include "gtkmm2ext/application.h"
  89 #include "gtkmm2ext/bindings.h"
  90 #include "gtkmm2ext/gtk_ui.h"
  91 #include "gtkmm2ext/utils.h"
  92 #include "gtkmm2ext/window_title.h"
  93
  94 #include "widgets/fastmeter.h"
  95 #include "widgets/prompter.h"
  96 #include "widgets/tooltips.h"
  97
  98 #include "ardour/ardour.h"
  99 #include "ardour/audio_backend.h"
 100 #include "ardour/audio_track.h"
 101 #include "ardour/audioengine.h"
 102 #include "ardour/audiofilesource.h"
 103 #include "ardour/automation_watch.h"
 104 #include "ardour/disk_reader.h"
 105 #include "ardour/disk_writer.h"
 106 #include "ardour/filename_extensions.h"
 107 #include "ardour/filesystem_paths.h"
 108 #include "ardour/ltc_file_reader.h"
 109 #include "ardour/monitor_control.h"
 110 #include "ardour/midi_track.h"
 111 #include "ardour/port.h"
 112 #include "ardour/plugin_manager.h"
 113 #include "ardour/process_thread.h"
 114 #include "ardour/profile.h"
 115 #include "ardour/recent_sessions.h"
 116 #include "ardour/record_enable_control.h"
 117 #include "ardour/revision.h"
 118 #include "ardour/session_directory.h"
 119 #include "ardour/session_route.h"
 120 #include "ardour/session_state_utils.h"
 121 #include "ardour/session_utils.h"
 122 #include "ardour/source_factory.h"
 123 #include "ardour/transport_master.h"
 124 #include "ardour/transport_master_manager.h"
 125 #include "ardour/system_exec.h"
 126 #include "ardour/track.h"
 127 #include "ardour/vca_manager.h"
 128 #include "ardour/utils.h"
 129
 130 #include "LuaBridge/LuaBridge.h"
 131
 132 #ifdef WINDOWS_VST_SUPPORT
 133 #include <fst.h>
 134 #endif
 135 #ifdef AUDIOUNIT_SUPPORT
 136 #include "ardour/audio_unit.h"
 137 #endif
 138
 139 // fix for OSX (nsm.h has a check function, AU/Apple defines check)
 140 #ifdef check
 141 #undef check
 142 #endif
 143
 144 #include "temporal/time.h"
 145
 146 typedef uint64_t microseconds_t;
 147
 148 #include "about.h"
 149 #include "editing.h"
 150 #include "enums_convert.h"
 151 #include "actions.h"
 152 #include "add_route_dialog.h"
 153 #include "ambiguous_file_dialog.h"
 154 #include "ardour_message.h"
 155 #include "ardour_ui.h"
 156 #include "audio_clock.h"
 157 #include "audio_region_view.h"
 158 #include "big_clock_window.h"
 159 #include "big_transport_window.h"
 160 #include "bundle_manager.h"
 161 #include "duplicate_routes_dialog.h"
 162 #include "debug.h"
 163 #include "engine_dialog.h"
 164 #include "export_video_dialog.h"
 165 #include "export_video_infobox.h"
 166 #include "gain_meter.h"
 167 #include "global_port_matrix.h"
 168 #include "gui_object.h"
 169 #include "gui_thread.h"
 170 #include "idleometer.h"
 171 #include "keyboard.h"
 172 #include "keyeditor.h"
 173 #include "location_ui.h"
 174 #include "lua_script_manager.h"
 175 #include "luawindow.h"
 176 #include "main_clock.h"
 177 #include "missing_file_dialog.h"
 178 #include "missing_plugin_dialog.h"
 179 #include "mixer_ui.h"
 180 #include "meterbridge.h"
 181 #include "meter_patterns.h"
 182 #include "mouse_cursors.h"
 183 #include "nsm.h"
 184 #include "opts.h"
 185 #include "pingback.h"
 186 #include "plugin_dspload_window.h"
 187 #include "processor_box.h"
 188 #include "public_editor.h"
 189 #include "rc_option_editor.h"
 190 #include "route_time_axis.h"
 191 #include "route_params_ui.h"
 192 #include "save_as_dialog.h"
 193 #include "save_template_dialog.h"
 194 #include "script_selector.h"
 195 #include "session_archive_dialog.h"
 196 #include "session_dialog.h"
 197 #include "session_metadata_dialog.h"
 198 #include "session_option_editor.h"
 199 #include "speaker_dialog.h"
 200 #include "splash.h"
 201 #include "template_dialog.h"
 202 #include "time_axis_view_item.h"
 203 #include "time_info_box.h"
 204 #include "timers.h"
 205 #include "transport_masters_dialog.h"
 206 #include "utils.h"
 207 #include "utils_videotl.h"
 208 #include "video_server_dialog.h"
 209 #include "virtual_keyboard_window.h"
 210 #include "add_video_dialog.h"
 211 #include "transcode_video_dialog.h"
 212
 213 #include "pbd/i18n.h"
 214
 215 using namespace ARDOUR;
 216 using namespace ARDOUR_UI_UTILS;
 217 using namespace PBD;
 218 using namespace Gtkmm2ext;
 219 using namespace ArdourWidgets;
 220 using namespace Gtk;
 221 using namespace std;
 222 using namespace Editing;
 223
 224 ARDOUR_UI *ARDOUR_UI::theArdourUI = 0;
 225
 226 sigc::signal<void, samplepos_t> ARDOUR_UI::Clock;
 227 sigc::signal<void> ARDOUR_UI::CloseAllDialogs;
 228
 229 static bool
 230 ask_about_configuration_copy (string const & old_dir, string const & new_dir, int version)
 231 {
 232         ArdourMessageDialog msg (string_compose (
 233                                   _("%1 %2.x has discovered configuration files from %1 %3.x.\n\n"
 234                                     "Would you like these files to be copied and used for %1 %2.x?\n\n"
 235                                     "(This will require you to restart %1.)"),
 236                                      PROGRAM_NAME, PROGRAM_VERSION, version),
 237                                  false, /* no markup */
 238                                  Gtk::MESSAGE_INFO,
 239                                  Gtk::BUTTONS_YES_NO,
 240                                  true /* modal, though it hardly matters since it is the only window */
 241         );
 242
 243         msg.set_default_response (Gtk::RESPONSE_YES);
 244         msg.show_all ();
 245
 246         return (msg.run() == Gtk::RESPONSE_YES);
 247 }
 248
 249 static void
 250 libxml_generic_error_func (void* /* parsing_context*/,
 251                            const char* msg,
 252                            ...)
 253 {
 254         va_list ap;
 255         char buf[2048];
 256
 257         va_start (ap, msg);
 258         vsnprintf (buf, sizeof (buf), msg, ap);
 259         error << buf << endmsg;
 260         va_end (ap);
 261 }
 262
 263 static void
 264 libxml_structured_error_func (void* /* parsing_context*/,
 265                               xmlErrorPtr err)
 266 {
 267         string msg;
 268
 269         if (err->message)
 270                 msg = err->message;
 271
 272         replace_all (msg, "\n", "");
 273
 274         if (!msg.empty()) {
 275                 if (err->file && err->line) {
 276                         error << X_("XML error: ") << msg << " in " << err->file << " at line " << err->line;
 277
 278                         if (err->int2) {
 279                                 error << ':' << err->int2;
 280                         }
 281
 282                         error << endmsg;
 283                 } else {
 284                         error << X_("XML error: ") << msg << endmsg;
 285                 }
 286         }
 287 }
 288
 289
 290 ARDOUR_UI::ARDOUR_UI (int *argcp, char **argvp[], const char* localedir)
 291         : Gtkmm2ext::UI (PROGRAM_NAME, X_("gui"), argcp, argvp)
 292         , session_load_in_progress (false)
 293         , gui_object_state (new GUIObjectState)
 294         , primary_clock   (new MainClock (X_("primary"),   X_("transport"), true ))
 295         , secondary_clock (new MainClock (X_("secondary"), X_("secondary"), false))
 296         , big_clock (new AudioClock (X_("bigclock"), false, "big", true, true, false, false))
 297         , video_timeline(0)
 298         , ignore_dual_punch (false)
 299         , main_window_visibility (0)
 300         , editor (0)
 301         , mixer (0)
 302         , nsm (0)
 303         , _was_dirty (false)
 304         , _mixer_on_top (false)
 305         , _shared_popup_menu (0)
 306         , startup_fsm (0)
 307         , secondary_clock_spacer (0)
 308         , auto_input_button (ArdourButton::led_default_elements)
 309         , latency_disable_button (ArdourButton::led_default_elements)
 310         , time_info_box (0)
 311         , auto_return_button (ArdourButton::led_default_elements)
 312         , follow_edits_button (ArdourButton::led_default_elements)
 313         , auditioning_alert_button (_("Audition"))
 314         , solo_alert_button (_("Solo"))
 315         , feedback_alert_button (_("Feedback"))
 316         , error_alert_button ( ArdourButton::just_led_default_elements )
 317         , editor_meter_peak_display()
 318         , editor_meter(0)
 319         , _numpad_locate_happening (false)
 320         , _session_is_new (false)
 321         , last_key_press_time (0)
 322         , save_as_dialog (0)
 323         , meterbridge (0)
 324         , luawindow (0)
 325         , rc_option_editor (0)
 326         , speaker_config_window (X_("speaker-config"), _("Speaker Configuration"))
 327         , add_route_dialog (X_("add-routes"), _("Add Tracks/Busses"))
 328         , about (X_("about"), _("About"))
 329         , location_ui (X_("locations"), S_("Ranges|Locations"))
 330         , route_params (X_("inspector"), _("Tracks and Busses"))
 331         , audio_midi_setup (X_("audio-midi-setup"), _("Audio/MIDI Setup"))
 332         , export_video_dialog (X_("video-export"), _("Video Export Dialog"))
 333         , lua_script_window (X_("script-manager"), _("Script Manager"))
 334         , idleometer (X_("idle-o-meter"), _("Idle'o'Meter"))
 335         , plugin_dsp_load_window (X_("plugin-dsp-load"), _("Plugin DSP Load"))
 336         , transport_masters_window (X_("transport-masters"), _("Transport Masters"))
 337         , session_option_editor (X_("session-options-editor"), _("Properties"), boost::bind (&ARDOUR_UI::create_session_option_editor, this))
 338         , add_video_dialog (X_("add-video"), _("Add Video"), boost::bind (&ARDOUR_UI::create_add_video_dialog, this))
 339         , bundle_manager (X_("bundle-manager"), _("Bundle Manager"), boost::bind (&ARDOUR_UI::create_bundle_manager, this))
 340         , big_clock_window (X_("big-clock"), _("Big Clock"), boost::bind (&ARDOUR_UI::create_big_clock_window, this))
 341         , big_transport_window (X_("big-transport"), _("Transport Controls"), boost::bind (&ARDOUR_UI::create_big_transport_window, this))
 342         , virtual_keyboard_window (X_("virtual-keyboard"), _("Virtual Keyboard"), boost::bind (&ARDOUR_UI::create_virtual_keyboard_window, this))
 343         , audio_port_matrix (X_("audio-connection-manager"), _("Audio Connections"), boost::bind (&ARDOUR_UI::create_global_port_matrix, this, ARDOUR::DataType::AUDIO))
 344         , midi_port_matrix (X_("midi-connection-manager"), _("MIDI Connections"), boost::bind (&ARDOUR_UI::create_global_port_matrix, this, ARDOUR::DataType::MIDI))
 345         , key_editor (X_("key-editor"), _("Keyboard Shortcuts"), boost::bind (&ARDOUR_UI::create_key_editor, this))
 346         , video_server_process (0)
 347         , have_configure_timeout (false)
 348         , last_configure_time (0)
 349         , last_peak_grab (0)
 350         , have_disk_speed_dialog_displayed (false)
 351         , _status_bar_visibility (X_("status-bar"))
 352         , _feedback_exists (false)
 353         , _log_not_acknowledged (LogLevelNone)
 354         , duplicate_routes_dialog (0)
 355         , editor_visibility_button (S_("Window|Editor"))
 356         , mixer_visibility_button (S_("Window|Mixer"))
 357         , prefs_visibility_button (S_("Window|Preferences"))
 358 {
 359         Gtkmm2ext::init (localedir);
 360
 361         UIConfiguration::instance().post_gui_init ();
 362
 363         if (ARDOUR::handle_old_configuration_files (boost::bind (ask_about_configuration_copy, _1, _2, _3))) {
 364                 {
 365                         /* "touch" the been-here-before path now that config has been migrated */
 366                         PBD::ScopedFileDescriptor fout (g_open (been_here_before_path ().c_str(), O_CREAT|O_TRUNC|O_RDWR, 0666));
 367                 }
 368                 ArdourMessageDialog msg (string_compose (_("Your configuration files were copied. You can now restart %1."), PROGRAM_NAME), true);
 369                 msg.run ();
 370                 /* configuration was modified, exit immediately */
 371                 _exit (EXIT_SUCCESS);
 372         }
 373
 374
 375         if (theArdourUI == 0) {
 376                 theArdourUI = this;
 377         }
 378
 379         /* track main window visibility */
 380
 381         main_window_visibility = new VisibilityTracker (_main_window);
 382
 383         /* stop libxml from spewing to stdout/stderr */
 384
 385         xmlSetGenericErrorFunc (this, libxml_generic_error_func);
 386         xmlSetStructuredErrorFunc (this, libxml_structured_error_func);
 387
 388         /* Set this up early */
 389
 390         ActionManager::init ();
 391
 392         /* we like keyboards */
 393
 394         keyboard = new ArdourKeyboard(*this);
 395
 396         XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
 397         if (node) {
 398                 keyboard->set_state (*node, Stateful::loading_state_version);
 399         }
 400
 401         /* actions do not need to be defined when we load keybindings. They
 402          * will be lazily discovered. But bindings do need to exist when we
 403          * create windows/tabs with their own binding sets.
 404          */
 405
 406         keyboard->setup_keybindings ();
 407
 408         if ((global_bindings = Bindings::get_bindings (X_("Global"))) == 0) {
 409                 error << _("Global keybindings are missing") << endmsg;
 410         }
 411
 412         install_actions ();
 413
 414         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &ARDOUR_UI::parameter_changed));
 415         boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
 416         UIConfiguration::instance().map_parameters (pc);
 417
 418         transport_ctrl.setup (this);
 419
 420         ARDOUR::DiskWriter::Overrun.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::disk_overrun_handler, this), gui_context());
 421         ARDOUR::DiskReader::Underrun.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::disk_underrun_handler, this), gui_context());
 422
 423         ARDOUR::Session::VersionMismatch.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::session_format_mismatch, this, _1, _2), gui_context());
 424
 425         /* handle dialog requests */
 426
 427         ARDOUR::Session::Dialog.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::session_dialog, this, _1), gui_context());
 428
 429         /* handle pending state with a dialog (PROBLEM: needs to return a value and thus cannot be x-thread) */
 430
 431         ARDOUR::Session::AskAboutPendingState.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::pending_state_dialog, this));
 432
 433         /* handle sr mismatch with a dialog (PROBLEM: needs to return a value and thus cannot be x-thread) */
 434
 435         ARDOUR::Session::AskAboutSampleRateMismatch.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::sr_mismatch_dialog, this, _1, _2));
 436
 437         /* handle sr mismatch with a dialog - cross-thread from engine */
 438         ARDOUR::Session::NotifyAboutSampleRateMismatch.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::sr_mismatch_message, this, _1, _2), gui_context ());
 439
 440         /* handle requests to quit (coming from JACK session) */
 441
 442         ARDOUR::Session::Quit.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::finish, this), gui_context ());
 443
 444         /* tell the user about feedback */
 445
 446         ARDOUR::Session::FeedbackDetected.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::feedback_detected, this), gui_context ());
 447         ARDOUR::Session::SuccessfulGraphSort.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::successful_graph_sort, this), gui_context ());
 448
 449         /* indicate global latency compensation en/disable */
 450         ARDOUR::Latent::DisableSwitchChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::latency_switch_changed, this), gui_context ());
 451
 452         /* handle requests to deal with missing files */
 453
 454         ARDOUR::Session::MissingFile.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::missing_file, this, _1, _2, _3));
 455
 456         /* and ambiguous files */
 457
 458         ARDOUR::FileSource::AmbiguousFileName.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::ambiguous_file, this, _1, _2));
 459
 460         ARDOUR::GUIIdle.connect (forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::gui_idle_handler, this), gui_context());
 461
 462         Config->ParameterChanged.connect ( forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::set_flat_buttons, this), gui_context() );
 463         set_flat_buttons();
 464
 465         theme_changed.connect (sigc::mem_fun(*this, &ARDOUR_UI::on_theme_changed));
 466         UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &ARDOUR_UI::on_theme_changed));
 467         UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &ARDOUR_UI::on_theme_changed));
 468
 469         /* lets get this party started */
 470
 471         setup_gtk_ardour_enums ();
 472         setup_profile ();
 473
 474         SessionEvent::create_per_thread_pool ("GUI", 4096);
 475
 476         UIConfiguration::instance().reset_dpi ();
 477
 478         TimeAxisViewItem::set_constant_heights ();
 479
 480         /* The following must happen after ARDOUR::init() so that Config is set up */
 481
 482         const XMLNode* ui_xml = Config->extra_xml (X_("UI"));
 483
 484         if (ui_xml) {
 485                 key_editor.set_state (*ui_xml, 0);
 486                 session_option_editor.set_state (*ui_xml, 0);
 487                 speaker_config_window.set_state (*ui_xml, 0);
 488                 about.set_state (*ui_xml, 0);
 489                 add_route_dialog.set_state (*ui_xml, 0);
 490                 add_video_dialog.set_state (*ui_xml, 0);
 491                 route_params.set_state (*ui_xml, 0);
 492                 bundle_manager.set_state (*ui_xml, 0);
 493                 location_ui.set_state (*ui_xml, 0);
 494                 big_clock_window.set_state (*ui_xml, 0);
 495                 big_transport_window.set_state (*ui_xml, 0);
 496                 virtual_keyboard_window.set_state (*ui_xml, 0);
 497                 audio_port_matrix.set_state (*ui_xml, 0);
 498                 midi_port_matrix.set_state (*ui_xml, 0);
 499                 export_video_dialog.set_state (*ui_xml, 0);
 500                 lua_script_window.set_state (*ui_xml, 0);
 501                 idleometer.set_state (*ui_xml, 0);
 502                 plugin_dsp_load_window.set_state (*ui_xml, 0);
 503                 transport_masters_window.set_state (*ui_xml, 0);
 504         }
 505
 506         /* Separate windows */
 507
 508         WM::Manager::instance().register_window (&key_editor);
 509         WM::Manager::instance().register_window (&session_option_editor);
 510         WM::Manager::instance().register_window (&speaker_config_window);
 511         WM::Manager::instance().register_window (&about);
 512         WM::Manager::instance().register_window (&add_route_dialog);
 513         WM::Manager::instance().register_window (&add_video_dialog);
 514         WM::Manager::instance().register_window (&route_params);
 515         WM::Manager::instance().register_window (&audio_midi_setup);
 516         WM::Manager::instance().register_window (&export_video_dialog);
 517         WM::Manager::instance().register_window (&lua_script_window);
 518         WM::Manager::instance().register_window (&bundle_manager);
 519         WM::Manager::instance().register_window (&location_ui);
 520         WM::Manager::instance().register_window (&big_clock_window);
 521         WM::Manager::instance().register_window (&big_transport_window);
 522         WM::Manager::instance().register_window (&virtual_keyboard_window);
 523         WM::Manager::instance().register_window (&audio_port_matrix);
 524         WM::Manager::instance().register_window (&midi_port_matrix);
 525         WM::Manager::instance().register_window (&idleometer);
 526         WM::Manager::instance().register_window (&plugin_dsp_load_window);
 527         WM::Manager::instance().register_window (&transport_masters_window);
 528
 529         /* do not retain position for add route dialog */
 530         add_route_dialog.set_state_mask (WindowProxy::Size);
 531
 532         /* Trigger setting up the color scheme and loading the GTK RC file */
 533
 534         UIConfiguration::instance().load_rc_file (false);
 535
 536         _process_thread = new ProcessThread ();
 537
 538         ARDOUR::Port::set_connecting_blocked (ARDOUR_COMMAND_LINE::no_connect_ports);
 539 }
 540
 541 GlobalPortMatrixWindow*
 542 ARDOUR_UI::create_global_port_matrix (ARDOUR::DataType type)
 543 {
 544         if (!_session) {
 545                 return 0;
 546         }
 547         return new GlobalPortMatrixWindow (_session, type);
 548 }
 549
 550 void
 551 ARDOUR_UI::attach_to_engine ()
 552 {
 553         AudioEngine::instance()->Running.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_running, this, _1), gui_context());
 554         engine_running (0);
 555 }
 556
 557 void
 558 ARDOUR_UI::engine_stopped ()
 559 {
 560         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::engine_stopped)
 561         ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, false);
 562         ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, true);
 563         update_sample_rate (0);
 564         update_cpu_load ();
 565 }
 566
 567 void
 568 ARDOUR_UI::engine_running (uint32_t cnt)
 569 {
 570         if (cnt == 0) {
 571                 post_engine();
 572         }
 573
 574         if (_session) {
 575                 _session->reset_xrun_count ();
 576         }
 577         update_disk_space ();
 578         update_cpu_load ();
 579         update_sample_rate (AudioEngine::instance()->sample_rate());
 580         update_timecode_format ();
 581         update_peak_thread_work ();
 582         ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, true);
 583         ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, false);
 584 }
 585
 586 void
 587 ARDOUR_UI::engine_halted (const char* reason, bool free_reason)
 588 {
 589         if (!Gtkmm2ext::UI::instance()->caller_is_ui_thread()) {
 590                 /* we can't rely on the original string continuing to exist when we are called
 591                    again in the GUI thread, so make a copy and note that we need to
 592                    free it later.
 593                 */
 594                 char *copy = strdup (reason);
 595                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_halted, this, copy, true));
 596                 return;
 597         }
 598
 599         ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, false);
 600         ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, true);
 601
 602         update_sample_rate (0);
 603
 604         string msgstr;
 605
 606         /* if the reason is a non-empty string, it means that the backend was shutdown
 607            rather than just Ardour.
 608         */
 609
 610         if (strlen (reason)) {
 611                 msgstr = string_compose (_("The audio backend was shutdown because:\n\n%1"), reason);
 612         } else {
 613                 msgstr = string_compose (_("\
 614 The audio backend has either been shutdown or it\n\
 615 disconnected %1 because %1\n\
 616 was not fast enough. Try to restart\n\
 617 the audio backend and save the session."), PROGRAM_NAME);
 618         }
 619
 620         ArdourMessageDialog msg (_main_window, msgstr);
 621         msg.run ();
 622
 623         if (free_reason) {
 624                 free (const_cast<char*> (reason));
 625         }
 626 }
 627
 628 void
 629 ARDOUR_UI::post_engine ()
 630 {
 631         /* Things to be done once (and once ONLY) after we have a backend running in the AudioEngine
 632          */
 633 #ifdef AUDIOUNIT_SUPPORT
 634         std::string au_msg;
 635         if (AUPluginInfo::au_get_crashlog(au_msg)) {
 636                 popup_error(_("Audio Unit Plugin Scan Failed. Automatic AU scanning has been disabled. Please see the log window for further details."));
 637                 error << _("Audio Unit Plugin Scan Failed:") << endmsg;
 638                 info << au_msg << endmsg;
 639         }
 640 #endif
 641
 642         /* connect to important signals */
 643
 644         AudioEngine::instance()->Stopped.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_stopped, this), gui_context());
 645         AudioEngine::instance()->SampleRateChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::update_sample_rate, this, _1), gui_context());
 646         AudioEngine::instance()->BufferSizeChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::update_sample_rate, this, _1), gui_context());
 647         AudioEngine::instance()->Halted.connect_same_thread (halt_connection, boost::bind (&ARDOUR_UI::engine_halted, this, _1, false));
 648         AudioEngine::instance()->BecameSilent.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::audioengine_became_silent, this), gui_context());
 649
 650         if (setup_windows ()) {
 651                 throw failed_constructor ();
 652         }
 653
 654         transport_ctrl.map_actions ();
 655
 656         /* Do this after setup_windows (), as that's when the _status_bar_visibility is created */
 657         XMLNode* n = Config->extra_xml (X_("UI"));
 658         if (n) {
 659                 _status_bar_visibility.set_state (*n);
 660         }
 661
 662         check_memory_locking();
 663
 664         /* this is the first point at which all the possible actions are
 665          * available, because some of the available actions are dependent on
 666          * aspects of the engine/backend.
 667          */
 668
 669         if (ARDOUR_COMMAND_LINE::show_key_actions) {
 670                 stringstream sstr;
 671                 Bindings::save_all_bindings_as_html (sstr);
 672
 673                 if (sstr.str().empty()) {
 674                         return;
 675                 }
 676                 gchar* file_name;
 677                 GError *err = NULL;
 678                 gint fd;
 679
 680                 if ((fd = g_file_open_tmp ("akprintXXXXXX.html", &file_name, &err)) < 0) {
 681                         if (err) {
 682                                 error << string_compose (_("Could not open temporary file to print bindings (%1)"), err->message) << endmsg;
 683                                 g_error_free (err);
 684                         }
 685                         return;
 686                 }
 687
 688 #ifdef PLATFORM_WINDOWS
 689                 ::close (fd);
 690 #endif
 691
 692                 err = NULL;
 693
 694                 if (!g_file_set_contents (file_name, sstr.str().c_str(), sstr.str().size(), &err)) {
 695 #ifndef PLATFORM_WINDOWS
 696                         ::close (fd);
 697 #endif
 698                         g_unlink (file_name);
 699                         if (err) {
 700                                 error << string_compose (_("Could not save bindings to file (%1)"), err->message) << endmsg;
 701                                 g_error_free (err);
 702                         }
 703                         return;
 704                 }
 705
 706 #ifndef PLATFORM_WINDOWS
 707                 ::close (fd);
 708 #endif
 709
 710                 PBD::open_uri (string_compose ("file:///%1", file_name));
 711
 712                 halt_connection.disconnect ();
 713                 AudioEngine::instance()->stop ();
 714                 exit (EXIT_SUCCESS);
 715
 716         }
 717
 718         if (ARDOUR_COMMAND_LINE::show_actions) {
 719
 720
 721                 vector<string> paths;
 722                 vector<string> labels;
 723                 vector<string> tooltips;
 724                 vector<string> keys;
 725                 vector<Glib::RefPtr<Gtk::Action> > actions;
 726                 string ver_in = revision;
 727                 string ver = ver_in.substr(0, ver_in.find("-"));
 728
 729                 stringstream output;
 730                 output << "\n<h2>Menu actions</h2>" << endl;
 731                 output << "<p>\n  Every single menu item in " << PROGRAM_NAME << "'s GUI is accessible by control" << endl;
 732                 output << "  surfaces or scripts.\n</p>\n" << endl;
 733                 output << "<p>\n  The list below shows all available values of <em>action-name</em> as of" << endl;
 734                 output << "  " << PROGRAM_NAME << " " << ver << ". You can get the current list at any" << endl;
 735                 output << "  time by running " << PROGRAM_NAME << " with the -A flag.\n</p>\n" << endl;
 736                 output << "<table class=\"dl\">\n  <thead>" << endl;
 737                 output << "      <tr><th>Action Name</th><th>Menu Name</th></tr>" << endl;
 738                 output << "  </thead>\n  <tbody>" << endl;
 739
 740                 ActionManager::get_all_actions (paths, labels, tooltips, keys, actions);
 741
 742                 vector<string>::iterator p;
 743                 vector<string>::iterator l;
 744
 745                 for (p = paths.begin(), l = labels.begin(); p != paths.end(); ++p, ++l) {
 746                         output << " <tr><th><kbd class=\"osc\">" << *p << "</kbd></th><td>" << *l << "</td></tr>" << endl;
 747                 }
 748                 output << "  </tbody>\n  </table>" << endl;
 749
 750                 // output this mess to a browser for easiest X-platform use
 751                 // it is not pretty HTML, but it works and it's main purpose
 752                 // is to create raw html to fit in Ardour's manual with no editing
 753                 gchar* file_name;
 754                 GError *err = NULL;
 755                 gint fd;
 756
 757                 if ((fd = g_file_open_tmp ("list-of-menu-actionsXXXXXX.html", &file_name, &err)) < 0) {
 758                         if (err) {
 759                                 error << string_compose (_("Could not open temporary file to print bindings (%1)"), err->message) << endmsg;
 760                                 g_error_free (err);
 761                         }
 762                         return;
 763                 }
 764
 765 #ifdef PLATFORM_WINDOWS
 766                 ::close (fd);
 767 #endif
 768
 769                 err = NULL;
 770
 771                 if (!g_file_set_contents (file_name, output.str().c_str(), output.str().size(), &err)) {
 772 #ifndef PLATFORM_WINDOWS
 773                         ::close (fd);
 774 #endif
 775                         g_unlink (file_name);
 776                         if (err) {
 777                                 error << string_compose (_("Could not save bindings to file (%1)"), err->message) << endmsg;
 778                                 g_error_free (err);
 779                         }
 780                         return;
 781                 }
 782
 783 #ifndef PLATFORM_WINDOWS
 784                 ::close (fd);
 785 #endif
 786
 787                 PBD::open_uri (string_compose ("file:///%1", file_name));
 788
 789                 halt_connection.disconnect ();
 790                 AudioEngine::instance()->stop ();
 791                 exit (EXIT_SUCCESS);
 792         }
 793
 794         /* this being a GUI and all, we want peakfiles */
 795
 796         AudioFileSource::set_build_peakfiles (true);
 797         AudioFileSource::set_build_missing_peakfiles (true);
 798
 799         /* set default clock modes */
 800
 801         primary_clock->set_mode (AudioClock::Timecode);
 802         secondary_clock->set_mode (AudioClock::BBT);
 803
 804         /* start the time-of-day-clock */
 805
 806 #ifndef __APPLE__
 807         /* OS X provides a nearly-always visible wallclock, so don't be stupid */
 808         update_wall_clock ();
 809         Glib::signal_timeout().connect_seconds (sigc::mem_fun(*this, &ARDOUR_UI::update_wall_clock), 1);
 810 #endif
 811
 812         {
 813                 DisplaySuspender ds;
 814                 Config->ParameterChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::parameter_changed, this, _1), gui_context());
 815                 boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
 816                 Config->map_parameters (pc);
 817
 818                 UIConfiguration::instance().map_parameters (pc);
 819         }
 820 }
 821
 822 ARDOUR_UI::~ARDOUR_UI ()
 823 {
 824         UIConfiguration::instance().save_state();
 825
 826         ARDOUR_UI_UTILS::inhibit_screensaver (false);
 827
 828         stop_video_server();
 829
 830         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
 831                 // don't bother at 'real' exit. the OS cleans up for us.
 832                 delete big_clock; big_clock = 0;
 833                 delete primary_clock; primary_clock = 0;
 834                 delete secondary_clock; secondary_clock = 0;
 835                 delete _process_thread; _process_thread = 0;
 836                 delete time_info_box; time_info_box = 0;
 837                 delete meterbridge; meterbridge = 0;
 838                 delete luawindow; luawindow = 0;
 839                 delete editor; editor = 0;
 840                 delete mixer; mixer = 0;
 841                 delete rc_option_editor; rc_option_editor = 0; // failed to wrap object warning
 842                 delete nsm; nsm = 0;
 843                 delete gui_object_state; gui_object_state = 0;
 844                 delete _shared_popup_menu ; _shared_popup_menu = 0;
 845                 delete main_window_visibility;
 846                 FastMeter::flush_pattern_cache ();
 847                 ArdourFader::flush_pattern_cache ();
 848         }
 849
 850 #ifndef NDEBUG
 851         /* Small trick to flush main-thread event pool.
 852          * Other thread-pools are destroyed at pthread_exit(),
 853          * but tmain thread termination is too late to trigger Pool::~Pool()
 854          */
 855         SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Clear, SessionEvent::Immediate, 0, 0); // get the pool reference, values don't matter since the event is never queued.
 856         delete ev->event_pool();
 857 #endif
 858 }
 859
 860 gint
 861 ARDOUR_UI::configure_timeout ()
 862 {
 863         if (last_configure_time == 0) {
 864                 /* no configure events yet */
 865                 return true;
 866         }
 867
 868         /* force a gap of 0.5 seconds since the last configure event
 869          */
 870
 871         if (get_microseconds() - last_configure_time < 500000) {
 872                 return true;
 873         } else {
 874                 have_configure_timeout = false;
 875                 save_ardour_state ();
 876                 return false;
 877         }
 878 }
 879
 880 gboolean
 881 ARDOUR_UI::configure_handler (GdkEventConfigure* /*conf*/)
 882 {
 883         if (have_configure_timeout) {
 884                 last_configure_time = get_microseconds();
 885         } else {
 886                 Glib::signal_timeout().connect (sigc::mem_fun(*this, &ARDOUR_UI::configure_timeout), 100);
 887                 have_configure_timeout = true;
 888         }
 889
 890         return FALSE;
 891 }
 892
 893 void
 894 ARDOUR_UI::set_transport_controllable_state (const XMLNode& node)
 895 {
 896         std::string str;
 897
 898         if (node.get_property ("roll", str)){
 899                 roll_controllable->set_id (str);
 900         }
 901         if (node.get_property ("stop", str)) {
 902                 stop_controllable->set_id (str);
 903         }
 904         if (node.get_property ("goto-start", str)) {
 905                 goto_start_controllable->set_id (str);
 906         }
 907         if (node.get_property ("goto-end", str)) {
 908                 goto_end_controllable->set_id (str);
 909         }
 910         if (node.get_property ("auto-loop", str)) {
 911                 auto_loop_controllable->set_id (str);
 912         }
 913         if (node.get_property ("play-selection", str)) {
 914                 play_selection_controllable->set_id (str);
 915         }
 916         if (node.get_property ("rec", str)) {
 917                 rec_controllable->set_id (str);
 918         }
 919         if (node.get_property ("shuttle", str)) {
 920                 shuttle_box.controllable()->set_id (str);
 921         }
 922 }
 923
 924 XMLNode&
 925 ARDOUR_UI::get_transport_controllable_state ()
 926 {
 927         XMLNode* node = new XMLNode(X_("TransportControllables"));
 928
 929         node->set_property (X_("roll"), roll_controllable->id());
 930         node->set_property (X_("stop"), stop_controllable->id());
 931         node->set_property (X_("goto-start"), goto_start_controllable->id());
 932         node->set_property (X_("goto-end"), goto_end_controllable->id());
 933         node->set_property (X_("auto-loop"), auto_loop_controllable->id());
 934         node->set_property (X_("play-selection"), play_selection_controllable->id());
 935         node->set_property (X_("rec"), rec_controllable->id());
 936         node->set_property (X_("shuttle"), shuttle_box.controllable()->id());
 937
 938         return *node;
 939 }
 940
 941 void
 942 ARDOUR_UI::session_dirty_changed ()
 943 {
 944         update_autosave ();
 945         update_title ();
 946 }
 947
 948 void
 949 ARDOUR_UI::update_autosave ()
 950 {
 951         if (_session && _session->dirty()) {
 952                 if (_autosave_connection.connected()) {
 953                         _autosave_connection.disconnect();
 954                 }
 955
 956                 _autosave_connection = Glib::signal_timeout().connect (sigc::mem_fun (*this, &ARDOUR_UI::autosave_session),
 957                                 Config->get_periodic_safety_backup_interval() * 1000);
 958
 959         } else {
 960                 if (_autosave_connection.connected()) {
 961                         _autosave_connection.disconnect();
 962                 }
 963         }
 964 }
 965
 966 void
 967 ARDOUR_UI::queue_finish ()
 968 {
 969         Glib::signal_idle().connect (mem_fun (*this, &ARDOUR_UI::idle_finish));
 970 }
 971
 972 bool
 973 ARDOUR_UI::idle_finish ()
 974 {
 975         finish ();
 976         return false; /* do not call again */
 977 }
 978
 979 void
 980 ARDOUR_UI::finish()
 981 {
 982         if (_session) {
 983                 ARDOUR_UI::instance()->video_timeline->sync_session_state();
 984
 985                 if (_session->dirty()) {
 986                         vector<string> actions;
 987                         actions.push_back (_("Don't quit"));
 988                         actions.push_back (_("Just quit"));
 989                         actions.push_back (_("Save and quit"));
 990                         switch (ask_about_saving_session(actions)) {
 991                         case -1:
 992                                 return;
 993                                 break;
 994                         case 1:
 995                                 /* use the default name */
 996                                 if (save_state_canfail ("")) {
 997                                         /* failed - don't quit */
 998                                         ArdourMessageDialog msg (_main_window,
 999                                                            string_compose (_("\
1000 %1 was unable to save your session.\n\n\
1001 If you still wish to quit, please use the\n\n\
1002 \"Just quit\" option."), PROGRAM_NAME));
1003                                         msg.run ();
1004                                         return;
1005                                 }
1006                                 break;
1007                         case 0:
1008                                 break;
1009                         }
1010                 }
1011
1012                 second_connection.disconnect ();
1013                 point_one_second_connection.disconnect ();
1014                 point_zero_something_second_connection.disconnect();
1015                 fps_connection.disconnect();
1016         }
1017
1018         delete ARDOUR_UI::instance()->video_timeline;
1019         ARDOUR_UI::instance()->video_timeline = NULL;
1020         stop_video_server();
1021
1022         /* Save state before deleting the session, as that causes some
1023            windows to be destroyed before their visible state can be
1024            saved.
1025         */
1026         save_ardour_state ();
1027
1028         if (key_editor.get (false)) {
1029                 key_editor->disconnect ();
1030         }
1031
1032         close_all_dialogs ();
1033
1034         if (_session) {
1035                 _session->set_clean ();
1036                 delete _session;
1037                 _session = 0;
1038         }
1039
1040         halt_connection.disconnect ();
1041         AudioEngine::instance()->stop ();
1042 #ifdef WINDOWS_VST_SUPPORT
1043         fst_stop_threading();
1044 #endif
1045         quit ();
1046 }
1047
1048 void
1049 ARDOUR_UI::every_second ()
1050 {
1051         update_cpu_load ();
1052         update_disk_space ();
1053         update_timecode_format ();
1054         update_peak_thread_work ();
1055
1056         if (nsm && nsm->is_active ()) {
1057                 nsm->check ();
1058
1059                 if (!_was_dirty && _session->dirty ()) {
1060                         nsm->is_dirty ();
1061                         _was_dirty = true;
1062                 }
1063                 else if (_was_dirty && !_session->dirty ()){
1064                         nsm->is_clean ();
1065                         _was_dirty = false;
1066                 }
1067         }
1068 }
1069
1070 void
1071 ARDOUR_UI::every_point_one_seconds ()
1072 {
1073         if (editor) editor->build_region_boundary_cache();
1074 }
1075
1076 void
1077 ARDOUR_UI::every_point_zero_something_seconds ()
1078 {
1079         // august 2007: actual update frequency: 25Hz (40ms), not 100Hz
1080
1081         if (editor_meter && UIConfiguration::instance().get_show_editor_meter() && editor_meter_peak_display.is_mapped ()) {
1082                 float mpeak = editor_meter->update_meters();
1083                 if (mpeak > editor_meter_max_peak) {
1084                         if (mpeak >= UIConfiguration::instance().get_meter_peak()) {
1085                                 editor_meter_peak_display.set_active_state ( Gtkmm2ext::ExplicitActive );
1086                         }
1087                 }
1088         }
1089 }
1090
1091 void
1092 ARDOUR_UI::set_fps_timeout_connection ()
1093 {
1094         unsigned int interval = 40;
1095         if (!_session) return;
1096         if (_session->timecode_frames_per_second() != 0) {
1097                 /* ideally we'll use a select() to sleep and not accumulate
1098                  * idle time to provide a regular periodic signal.
1099                  * See linux_vst_gui_support.cc 'elapsed_time_ms'.
1100                  * However, that'll require a dedicated thread and cross-thread
1101                  * signals to the GUI Thread..
1102                  */
1103                 interval = floor(500. /* update twice per FPS, since Glib::signal_timeout is very irregular */
1104                                 * _session->sample_rate() / _session->nominal_sample_rate()
1105                                 / _session->timecode_frames_per_second()
1106                                 );
1107 #ifdef PLATFORM_WINDOWS
1108                 // the smallest windows scheduler time-slice is ~15ms.
1109                 // periodic GUI timeouts shorter than that will cause
1110                 // WaitForSingleObject to spinlock (100% of one CPU Core)
1111                 // and gtk never enters idle mode.
1112                 // also changing timeBeginPeriod(1) does not affect that in
1113                 // any beneficial way, so we just limit the max rate for now.
1114                 interval = std::max(30u, interval); // at most ~33Hz.
1115 #else
1116                 interval = std::max(8u, interval); // at most 120Hz.
1117 #endif
1118         }
1119         fps_connection.disconnect();
1120         Timers::set_fps_interval (interval);
1121 }
1122
1123 void
1124 ARDOUR_UI::update_sample_rate (samplecnt_t)
1125 {
1126         char buf[64];
1127
1128         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::update_sample_rate, ignored)
1129
1130         if (!AudioEngine::instance()->running()) {
1131
1132                 snprintf (buf, sizeof (buf), "%s", _("Audio: <span foreground=\"red\">none</span>"));
1133
1134         } else {
1135
1136                 samplecnt_t rate = AudioEngine::instance()->sample_rate();
1137
1138                 if (rate == 0) {
1139                         /* no sample rate available */
1140                         snprintf (buf, sizeof (buf), "%s", _("Audio: <span foreground=\"red\">none</span>"));
1141                 } else {
1142
1143                         if (fmod (rate, 1000.0) != 0.0) {
1144                                 snprintf (buf, sizeof (buf), _("Audio: <span foreground=\"green\">%.1f kHz / %4.1f ms</span>"),
1145                                           (float) rate / 1000.0f,
1146                                           (AudioEngine::instance()->usecs_per_cycle() / 1000.0f));
1147                         } else {
1148                                 snprintf (buf, sizeof (buf), _("Audio: <span foreground=\"green\">%" PRId64 " kHz / %4.1f ms</span>"),
1149                                           rate/1000,
1150                                           (AudioEngine::instance()->usecs_per_cycle() / 1000.0f));
1151                         }
1152                 }
1153         }
1154         sample_rate_label.set_markup (buf);
1155 }
1156
1157 void
1158 ARDOUR_UI::update_format ()
1159 {
1160         if (!_session) {
1161                 format_label.set_text ("");
1162                 return;
1163         }
1164
1165         stringstream s;
1166         s << _("File:") << X_(" <span foreground=\"green\">");
1167
1168         switch (_session->config.get_native_file_header_format ()) {
1169         case BWF:
1170                 s << _("BWF");
1171                 break;
1172         case WAVE:
1173                 s << _("WAV");
1174                 break;
1175         case WAVE64:
1176                 s << _("WAV64");
1177                 break;
1178         case CAF:
1179                 s << _("CAF");
1180                 break;
1181         case AIFF:
1182                 s << _("AIFF");
1183                 break;
1184         case iXML:
1185                 s << _("iXML");
1186                 break;
1187         case RF64:
1188                 s << _("RF64");
1189                 break;
1190         case RF64_WAV:
1191                 s << _("RF64/WAV");
1192                 break;
1193         case MBWF:
1194                 s << _("MBWF");
1195                 break;
1196         case FLAC:
1197                 s << _("FLAC");
1198                 break;
1199         }
1200
1201         s << " ";
1202
1203         switch (_session->config.get_native_file_data_format ()) {
1204         case FormatFloat:
1205                 s << _("32-float");
1206                 break;
1207         case FormatInt24:
1208                 s << _("24-int");
1209                 break;
1210         case FormatInt16:
1211                 s << _("16-int");
1212                 break;
1213         }
1214
1215         s << X_("</span>");
1216
1217         format_label.set_markup (s.str ());
1218 }
1219
1220 void
1221 ARDOUR_UI::update_cpu_load ()
1222 {
1223         const unsigned int x = _session ? _session->get_xrun_count () : 0;
1224         double const c = AudioEngine::instance()->get_dsp_load ();
1225
1226         const char* const bg = c > 90 ? " background=\"red\"" : "";
1227
1228         char buf[64];
1229         if (x > 9999) {
1230                 snprintf (buf, sizeof (buf), "DSP: <span%s>%.0f%%</span> (>10k)", bg, c);
1231         } else if (x > 0) {
1232                 snprintf (buf, sizeof (buf), "DSP: <span%s>%.0f%%</span> (%d)", bg, c, x);
1233         } else {
1234                 snprintf (buf, sizeof (buf), "DSP: <span%s>%.0f%%</span>", bg, c);
1235         }
1236
1237         dsp_load_label.set_markup (buf);
1238
1239         if (x > 9999) {
1240                 snprintf (buf, sizeof (buf), _("DSP: %.1f%% X: >10k\n%s"), c, _("Shift+Click to clear xruns."));
1241         } else if (x > 0) {
1242                 snprintf (buf, sizeof (buf), _("DSP: %.1f%% X: %u\n%s"), c, x, _("Shift+Click to clear xruns."));
1243         } else {
1244                 snprintf (buf, sizeof (buf), _("DSP: %.1f%%"), c);
1245         }
1246
1247         ArdourWidgets::set_tooltip (dsp_load_label, buf);
1248 }
1249
1250 void
1251 ARDOUR_UI::update_peak_thread_work ()
1252 {
1253         char buf[64];
1254         const int c = SourceFactory::peak_work_queue_length ();
1255         if (c > 0) {
1256                 snprintf (buf, sizeof (buf), _("PkBld: <span foreground=\"%s\">%d</span>"), c >= 2 ? X_("red") : X_("green"), c);
1257                 peak_thread_work_label.set_markup (buf);
1258         } else {
1259                 peak_thread_work_label.set_markup (X_(""));
1260         }
1261 }
1262
1263 void
1264 ARDOUR_UI::count_recenabled_streams (Route& route)
1265 {
1266         Track* track = dynamic_cast<Track*>(&route);
1267         if (track && track->rec_enable_control()->get_value()) {
1268                 rec_enabled_streams += track->n_inputs().n_total();
1269         }
1270 }
1271
1272 void
1273 ARDOUR_UI::format_disk_space_label (float remain_sec)
1274 {
1275         if (remain_sec < 0) {
1276                 disk_space_label.set_text (_("N/A"));
1277                 ArdourWidgets::set_tooltip (disk_space_label, _("Unknown"));
1278                 return;
1279         }
1280
1281         char buf[64];
1282
1283         int sec = floor (remain_sec);
1284         int hrs  = sec / 3600;
1285         int mins = (sec / 60) % 60;
1286         int secs = sec % 60;
1287         snprintf (buf, sizeof(buf), _("%02dh:%02dm:%02ds"), hrs, mins, secs);
1288         ArdourWidgets::set_tooltip (disk_space_label, buf);
1289
1290         if (remain_sec > 86400) {
1291                 disk_space_label.set_text (_("Rec: >24h"));
1292                 return;
1293         } else if (remain_sec > 32400 /* 9 hours */) {
1294                 snprintf (buf, sizeof (buf), "Rec: %.0fh", remain_sec / 3600.f);
1295         } else if (remain_sec > 5940 /* 99 mins */) {
1296                 snprintf (buf, sizeof (buf), "Rec: %.1fh", remain_sec / 3600.f);
1297         } else {
1298                 snprintf (buf, sizeof (buf), "Rec: %.0fm", remain_sec / 60.f);
1299         }
1300         disk_space_label.set_text (buf);
1301
1302 }
1303
1304 void
1305 ARDOUR_UI::update_disk_space()
1306 {
1307         if (_session == 0) {
1308                 format_disk_space_label (-1);
1309                 return;
1310         }
1311
1312         boost::optional<samplecnt_t> opt_samples = _session->available_capture_duration();
1313         samplecnt_t fr = _session->sample_rate();
1314
1315         if (fr == 0) {
1316                 /* skip update - no SR available */
1317                 format_disk_space_label (-1);
1318                 return;
1319         }
1320
1321         if (!opt_samples) {
1322                 /* Available space is unknown */
1323                 format_disk_space_label (-1);
1324         } else if (opt_samples.value_or (0) == max_samplecnt) {
1325                 format_disk_space_label (max_samplecnt);
1326         } else {
1327                 rec_enabled_streams = 0;
1328                 _session->foreach_route (this, &ARDOUR_UI::count_recenabled_streams, false);
1329
1330                 samplecnt_t samples = opt_samples.value_or (0);
1331
1332                 if (rec_enabled_streams) {
1333                         samples /= rec_enabled_streams;
1334                 }
1335
1336                 format_disk_space_label (samples / (float)fr);
1337         }
1338
1339 }
1340
1341 void
1342 ARDOUR_UI::update_timecode_format ()
1343 {
1344         char buf[64];
1345
1346         if (_session) {
1347                 bool matching;
1348                 boost::shared_ptr<TimecodeTransportMaster> tcmaster;
1349                 boost::shared_ptr<TransportMaster> tm = TransportMasterManager::instance().current();
1350
1351                 if ((tm->type() == LTC || tm->type() == MTC) && (tcmaster = boost::dynamic_pointer_cast<TimecodeTransportMaster>(tm)) != 0 && tm->locked()) {
1352                         matching = (tcmaster->apparent_timecode_format() == _session->config.get_timecode_format());
1353                 } else {
1354                         matching = true;
1355                 }
1356
1357
1358                 snprintf (buf, sizeof (buf), S_("Timecode|TC: <span foreground=\"%s\">%s</span>"),
1359                           matching ? X_("green") : X_("red"),
1360                           Timecode::timecode_format_name (_session->config.get_timecode_format()).c_str());
1361         } else {
1362                 snprintf (buf, sizeof (buf), "TC: n/a");
1363         }
1364
1365         timecode_format_label.set_markup (buf);
1366 }
1367
1368 gint
1369 ARDOUR_UI::update_wall_clock ()
1370 {
1371         time_t now;
1372         struct tm *tm_now;
1373         static int last_min = -1;
1374
1375         time (&now);
1376         tm_now = localtime (&now);
1377         if (last_min != tm_now->tm_min) {
1378                 char buf[16];
1379                 sprintf (buf, "%02d:%02d", tm_now->tm_hour, tm_now->tm_min);
1380                 wall_clock_label.set_text (buf);
1381                 last_min = tm_now->tm_min;
1382         }
1383
1384         return TRUE;
1385 }
1386
1387 void
1388 ARDOUR_UI::session_add_mixed_track (
1389                 const ChanCount& input,
1390                 const ChanCount& output,
1391                 RouteGroup* route_group,
1392                 uint32_t how_many,
1393                 const string& name_template,
1394                 bool strict_io,
1395                 PluginInfoPtr instrument,
1396                 Plugin::PresetRecord* pset,
1397                 ARDOUR::PresentationInfo::order_t order)
1398 {
1399         assert (_session);
1400
1401         if (Profile->get_mixbus ()) {
1402                 strict_io = true;
1403         }
1404
1405         try {
1406                 list<boost::shared_ptr<MidiTrack> > tracks;
1407                 tracks = _session->new_midi_track (input, output, strict_io, instrument, pset, route_group, how_many, name_template, order, ARDOUR::Normal);
1408
1409                 if (tracks.size() != how_many) {
1410                         error << string_compose(P_("could not create %1 new mixed track", "could not create %1 new mixed tracks", how_many), how_many) << endmsg;
1411                 }
1412         }
1413
1414         catch (...) {
1415                 display_insufficient_ports_message ();
1416                 return;
1417         }
1418 }
1419
1420 void
1421 ARDOUR_UI::session_add_midi_bus (
1422                 RouteGroup* route_group,
1423                 uint32_t how_many,
1424                 const string& name_template,
1425                 bool strict_io,
1426                 PluginInfoPtr instrument,
1427                 Plugin::PresetRecord* pset,
1428                 ARDOUR::PresentationInfo::order_t order)
1429 {
1430         if (_session == 0) {
1431                 warning << _("You cannot add a track without a session already loaded.") << endmsg;
1432                 return;
1433         }
1434
1435         if (Profile->get_mixbus ()) {
1436                 strict_io = true;
1437         }
1438
1439         try {
1440                 RouteList routes;
1441                 routes = _session->new_midi_route (route_group, how_many, name_template, strict_io, instrument, pset, PresentationInfo::MidiBus, order);
1442                 if (routes.size() != how_many) {
1443                         error << string_compose(P_("could not create %1 new Midi Bus", "could not create %1 new Midi Busses", how_many), how_many) << endmsg;
1444                 }
1445
1446         }
1447         catch (...) {
1448                 display_insufficient_ports_message ();
1449                 return;
1450         }
1451 }
1452
1453 void
1454 ARDOUR_UI::session_add_midi_route (
1455                 bool disk,
1456                 RouteGroup* route_group,
1457                 uint32_t how_many,
1458                 const string& name_template,
1459                 bool strict_io,
1460                 PluginInfoPtr instrument,
1461                 Plugin::PresetRecord* pset,
1462                 ARDOUR::PresentationInfo::order_t order)
1463 {
1464         ChanCount one_midi_channel;
1465         one_midi_channel.set (DataType::MIDI, 1);
1466
1467         if (disk) {
1468                 session_add_mixed_track (one_midi_channel, one_midi_channel, route_group, how_many, name_template, strict_io, instrument, pset, order);
1469         } else {
1470                 session_add_midi_bus (route_group, how_many, name_template, strict_io, instrument, pset, order);
1471         }
1472 }
1473
1474 void
1475 ARDOUR_UI::session_add_audio_route (
1476         bool track,
1477         int32_t input_channels,
1478         int32_t output_channels,
1479         ARDOUR::TrackMode mode,
1480         RouteGroup* route_group,
1481         uint32_t how_many,
1482         string const & name_template,
1483         bool strict_io,
1484         ARDOUR::PresentationInfo::order_t order)
1485 {
1486         list<boost::shared_ptr<AudioTrack> > tracks;
1487         RouteList routes;
1488
1489         assert (_session);
1490
1491         try {
1492                 if (track) {
1493                         tracks = _session->new_audio_track (input_channels, output_channels, route_group, how_many, name_template, order, mode);
1494
1495                         if (tracks.size() != how_many) {
1496                                 error << string_compose (P_("could not create %1 new audio track", "could not create %1 new audio tracks", how_many), how_many)
1497                                       << endmsg;
1498                         }
1499
1500                 } else {
1501
1502                         routes = _session->new_audio_route (input_channels, output_channels, route_group, how_many, name_template, PresentationInfo::AudioBus, order);
1503
1504                         if (routes.size() != how_many) {
1505                                 error << string_compose (P_("could not create %1 new audio bus", "could not create %1 new audio busses", how_many), how_many)
1506                                       << endmsg;
1507                         }
1508                 }
1509         }
1510
1511         catch (...) {
1512                 display_insufficient_ports_message ();
1513                 return;
1514         }
1515
1516         if (strict_io) {
1517                 for (list<boost::shared_ptr<AudioTrack> >::iterator i = tracks.begin(); i != tracks.end(); ++i) {
1518                         (*i)->set_strict_io (true);
1519                 }
1520                 for (RouteList::iterator i = routes.begin(); i != routes.end(); ++i) {
1521                         (*i)->set_strict_io (true);
1522                 }
1523         }
1524 }
1525
1526 void
1527 ARDOUR_UI::session_add_foldback_bus (int32_t channels, uint32_t how_many, string const & name_template)
1528 {
1529         RouteList routes;
1530
1531         assert (_session);
1532
1533         try {
1534                 routes = _session->new_audio_route (channels, channels, 0, how_many, name_template, PresentationInfo::FoldbackBus, -1);
1535
1536                 if (routes.size() != how_many) {
1537                         error << string_compose (P_("could not create %1 new foldback bus", "could not create %1 new foldback busses", how_many), how_many)
1538                               << endmsg;
1539                 }
1540         }
1541
1542         catch (...) {
1543                 display_insufficient_ports_message ();
1544                 return;
1545         }
1546 }
1547
1548 void
1549 ARDOUR_UI::display_insufficient_ports_message ()
1550 {
1551         ArdourMessageDialog msg (_main_window,
1552                         string_compose (_("There are insufficient ports available\n\
1553 to create a new track or bus.\n\
1554 You should save %1, exit and\n\
1555 restart with more ports."), PROGRAM_NAME));
1556         msg.run ();
1557 }
1558
1559 void
1560 ARDOUR_UI::transport_goto_start ()
1561 {
1562         if (_session) {
1563                 _session->goto_start ();
1564
1565                 /* force displayed area in editor to start no matter
1566                    what "follow playhead" setting is.
1567                 */
1568
1569                 if (editor) {
1570                         editor->center_screen (_session->current_start_sample ());
1571                 }
1572         }
1573 }
1574
1575 void
1576 ARDOUR_UI::transport_goto_zero ()
1577 {
1578         if (_session) {
1579                 _session->request_locate (0);
1580
1581                 /* force displayed area in editor to start no matter
1582                    what "follow playhead" setting is.
1583                 */
1584
1585                 if (editor) {
1586                         editor->reset_x_origin (0);
1587                 }
1588         }
1589 }
1590
1591 void
1592 ARDOUR_UI::transport_goto_wallclock ()
1593 {
1594         if (_session && editor) {
1595
1596                 time_t now;
1597                 struct tm tmnow;
1598                 samplepos_t samples;
1599
1600                 time (&now);
1601                 localtime_r (&now, &tmnow);
1602
1603                 samplecnt_t sample_rate = _session->sample_rate();
1604
1605                 if (sample_rate == 0) {
1606                         /* no frame rate available */
1607                         return;
1608                 }
1609
1610                 samples = tmnow.tm_hour * (60 * 60 * sample_rate);
1611                 samples += tmnow.tm_min * (60 * sample_rate);
1612                 samples += tmnow.tm_sec * sample_rate;
1613
1614                 _session->request_locate (samples, _session->transport_rolling ());
1615
1616                 /* force displayed area in editor to start no matter
1617                    what "follow playhead" setting is.
1618                 */
1619
1620                 if (editor) {
1621                         editor->center_screen (samples);
1622                 }
1623         }
1624 }
1625
1626 void
1627 ARDOUR_UI::transport_goto_end ()
1628 {
1629         if (_session) {
1630                 samplepos_t const sample = _session->current_end_sample();
1631                 _session->request_locate (sample);
1632
1633                 /* force displayed area in editor to start no matter
1634                    what "follow playhead" setting is.
1635                 */
1636
1637                 if (editor) {
1638                         editor->center_screen (sample);
1639                 }
1640         }
1641 }
1642
1643 void
1644 ARDOUR_UI::transport_stop ()
1645 {
1646         if (!_session) {
1647                 return;
1648         }
1649
1650         if (_session->is_auditioning()) {
1651                 _session->cancel_audition ();
1652                 return;
1653         }
1654
1655         _session->request_stop (false, true);
1656 }
1657
1658 /** Check if any tracks are record enabled. If none are, record enable all of them.
1659  * @return true if track record-enabled status was changed, false otherwise.
1660  */
1661 bool
1662 ARDOUR_UI::trx_record_enable_all_tracks ()
1663 {
1664         if (!_session) {
1665                 return false;
1666         }
1667
1668         boost::shared_ptr<RouteList> rl = _session->get_tracks ();
1669         bool none_record_enabled = true;
1670
1671         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1672                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*r);
1673                 assert (t);
1674
1675                 if (t->rec_enable_control()->get_value()) {
1676                         none_record_enabled = false;
1677                         break;
1678                 }
1679         }
1680
1681         if (none_record_enabled) {
1682                 _session->set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), 1.0, Controllable::NoGroup);
1683         }
1684
1685         return none_record_enabled;
1686 }
1687
1688 void
1689 ARDOUR_UI::transport_record (bool roll)
1690 {
1691         if (_session) {
1692                 switch (_session->record_status()) {
1693                 case Session::Disabled:
1694                         if (_session->ntracks() == 0) {
1695                                 ArdourMessageDialog msg (_main_window, _("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."));
1696                                 msg.run ();
1697                                 return;
1698                         }
1699                         _session->maybe_enable_record ();
1700                         if (roll) {
1701                                 transport_roll ();
1702                         }
1703                         break;
1704                 case Session::Recording:
1705                         if (roll) {
1706                                 _session->request_stop();
1707                         } else {
1708                                 _session->disable_record (false, true);
1709                         }
1710                         break;
1711
1712                 case Session::Enabled:
1713                         if (roll) {
1714                                 transport_roll();
1715                         } else {
1716                                 _session->disable_record (false, true);
1717                         }
1718                 }
1719         }
1720 }
1721
1722 void
1723 ARDOUR_UI::transport_roll ()
1724 {
1725         if (!_session) {
1726                 return;
1727         }
1728
1729         if (_session->is_auditioning()) {
1730                 return;
1731         }
1732
1733         if (_session->config.get_external_sync()) {
1734                 switch (TransportMasterManager::instance().current()->type()) {
1735                 case Engine:
1736                         break;
1737                 default:
1738                         /* transport controlled by the master */
1739                         return;
1740                 }
1741         }
1742
1743         bool rolling = _session->transport_rolling();
1744
1745         if (_session->get_play_loop()) {
1746
1747                 /* If loop playback is not a mode, then we should cancel
1748                    it when this action is requested. If it is a mode
1749                    we just leave it in place.
1750                 */
1751
1752                 if (!Config->get_loop_is_mode()) {
1753                         /* stop loop playback but keep transport state */
1754                         _session->request_play_loop (false, false);
1755                 }
1756
1757         } else if (_session->get_play_range () ) {
1758                 /* stop playing a range if we currently are */
1759                 _session->request_play_range (0, true);
1760         }
1761
1762         if (!rolling) {
1763                 _session->request_transport_speed (1.0f);
1764         }
1765 }
1766
1767 bool
1768 ARDOUR_UI::get_smart_mode() const
1769 {
1770         return ( editor->get_smart_mode() );
1771 }
1772
1773
1774 void
1775 ARDOUR_UI::toggle_roll (bool with_abort, bool roll_out_of_bounded_mode)
1776 {
1777         if (!_session) {
1778                 return;
1779         }
1780
1781         if (_session->is_auditioning()) {
1782                 _session->cancel_audition ();
1783                 return;
1784         }
1785
1786         if (_session->config.get_external_sync()) {
1787                 switch (TransportMasterManager::instance().current()->type()) {
1788                 case Engine:
1789                         break;
1790                 default:
1791                         /* transport controlled by the master */
1792                         return;
1793                 }
1794         }
1795
1796         bool rolling = _session->transport_rolling();
1797
1798         if (rolling) {
1799
1800                 if (roll_out_of_bounded_mode) {
1801                         /* drop out of loop/range playback but leave transport rolling */
1802
1803                         if (_session->get_play_loop()) {
1804
1805                                 if (_session->actively_recording()) {
1806                                         /* actually stop transport because
1807                                            otherwise the captured data will make
1808                                            no sense.
1809                                         */
1810                                         _session->request_play_loop (false, true);
1811
1812                                 } else {
1813                                         _session->request_play_loop (false, false);
1814                                 }
1815
1816                         } else if (_session->get_play_range ()) {
1817
1818                                 _session->request_cancel_play_range ();
1819                         }
1820
1821                 } else {
1822                         _session->request_stop (with_abort, true);
1823                 }
1824
1825         } else { /* not rolling */
1826
1827                 if (with_abort) { /* with_abort == true means the command was intended to stop transport, not start. */
1828                         return;
1829                 }
1830
1831                 if (_session->get_play_loop() && Config->get_loop_is_mode()) {
1832                         _session->request_locate (_session->locations()->auto_loop_location()->start(), true);
1833                 } else {
1834                         if (UIConfiguration::instance().get_follow_edits()) {
1835                                 list<AudioRange>& range = editor->get_selection().time;
1836                                 if (range.front().start == _session->transport_sample()) { // if playhead is exactly at the start of a range, we assume it was placed there by follow_edits
1837                                         _session->request_play_range (&range, true);
1838                                         _session->set_requested_return_sample (range.front().start);  //force an auto-return here
1839                                 }
1840                         }
1841                         _session->request_transport_speed (1.0f);
1842                 }
1843         }
1844 }
1845
1846 void
1847 ARDOUR_UI::toggle_session_auto_loop ()
1848 {
1849         if (!_session) {
1850                 return;
1851         }
1852
1853         Location * looploc = _session->locations()->auto_loop_location();
1854
1855         if (!looploc) {
1856                 return;
1857         }
1858
1859         if (_session->get_play_loop()) {
1860
1861                 /* looping enabled, our job is to disable it */
1862
1863                 _session->request_play_loop (false);
1864
1865         } else {
1866
1867                 /* looping not enabled, our job is to enable it.
1868
1869                    loop-is-NOT-mode: this action always starts the transport rolling.
1870                    loop-IS-mode:     this action simply sets the loop play mechanism, but
1871                                         does not start transport.
1872                 */
1873                 if (Config->get_loop_is_mode()) {
1874                         _session->request_play_loop (true, false);
1875                 } else {
1876                         _session->request_play_loop (true, true);
1877                 }
1878         }
1879
1880         //show the loop markers
1881         looploc->set_hidden (false, this);
1882 }
1883
1884 void
1885 ARDOUR_UI::transport_play_selection ()
1886 {
1887         if (!_session) {
1888                 return;
1889         }
1890
1891         editor->play_selection ();
1892 }
1893
1894 void
1895 ARDOUR_UI::transport_play_preroll ()
1896 {
1897         if (!_session) {
1898                 return;
1899         }
1900         editor->play_with_preroll ();
1901 }
1902
1903 void
1904 ARDOUR_UI::transport_rec_preroll ()
1905 {
1906         if (!_session) {
1907                 return;
1908         }
1909         editor->rec_with_preroll ();
1910 }
1911
1912 void
1913 ARDOUR_UI::transport_rec_count_in ()
1914 {
1915         if (!_session) {
1916                 return;
1917         }
1918         editor->rec_with_count_in ();
1919 }
1920
1921 void
1922 ARDOUR_UI::transport_rewind (int option)
1923 {
1924         float current_transport_speed;
1925
1926         if (_session) {
1927                 current_transport_speed = _session->transport_speed();
1928
1929                 if (current_transport_speed >= 0.0f) {
1930                         switch (option) {
1931                         case 0:
1932                                 _session->request_transport_speed (-1.0f);
1933                                 break;
1934                         case 1:
1935                                 _session->request_transport_speed (-4.0f);
1936                                 break;
1937                         case -1:
1938                                 _session->request_transport_speed (-0.5f);
1939                                 break;
1940                         }
1941                 } else {
1942                         /* speed up */
1943                         _session->request_transport_speed (current_transport_speed * 1.5f);
1944                 }
1945         }
1946 }
1947
1948 void
1949 ARDOUR_UI::transport_forward (int option)
1950 {
1951         if (!_session) {
1952                 return;
1953         }
1954
1955         float current_transport_speed = _session->transport_speed();
1956
1957         if (current_transport_speed <= 0.0f) {
1958                 switch (option) {
1959                 case 0:
1960                         _session->request_transport_speed (1.0f);
1961                         break;
1962                 case 1:
1963                         _session->request_transport_speed (4.0f);
1964                         break;
1965                 case -1:
1966                         _session->request_transport_speed (0.5f);
1967                         break;
1968                 }
1969         } else {
1970                 /* speed up */
1971                 _session->request_transport_speed (current_transport_speed * 1.5f);
1972         }
1973 }
1974
1975 void
1976 ARDOUR_UI::toggle_record_enable (uint16_t rid)
1977 {
1978         if (!_session) {
1979                 return;
1980         }
1981
1982         boost::shared_ptr<Route> r;
1983
1984         if ((r = _session->get_remote_nth_route (rid)) != 0) {
1985
1986                 boost::shared_ptr<Track> t;
1987
1988                 if ((t = boost::dynamic_pointer_cast<Track>(r)) != 0) {
1989                         t->rec_enable_control()->set_value (!t->rec_enable_control()->get_value(), Controllable::UseGroup);
1990                 }
1991         }
1992 }
1993
1994 void
1995 ARDOUR_UI::map_transport_state ()
1996 {
1997         if (!_session) {
1998                 layered_button.set_sensitive (false);
1999                 if (UIConfiguration::instance().get_screen_saver_mode () == InhibitWhileRecording) {
2000                         inhibit_screensaver (false);
2001                 }
2002                 return;
2003         }
2004
2005         shuttle_box.map_transport_state ();
2006
2007         float sp = _session->transport_speed();
2008
2009         if (sp != 0.0f) {
2010                 layered_button.set_sensitive (!_session->actively_recording ());
2011         } else {
2012                 layered_button.set_sensitive (true);
2013                 update_disk_space ();
2014         }
2015         if (UIConfiguration::instance().get_screen_saver_mode () == InhibitWhileRecording) {
2016                 inhibit_screensaver (_session->actively_recording ());
2017         }
2018 }
2019
2020 void
2021 ARDOUR_UI::blink_handler (bool blink_on)
2022 {
2023         sync_blink (blink_on);
2024
2025         if (!UIConfiguration::instance().get_blink_alert_indicators()) {
2026                 blink_on = true;
2027         }
2028         error_blink (blink_on);
2029         solo_blink (blink_on);
2030         audition_blink (blink_on);
2031         feedback_blink (blink_on);
2032 }
2033
2034 void
2035 ARDOUR_UI::update_clocks ()
2036 {
2037         if (!_session) return;
2038
2039         if (editor && !editor->dragging_playhead()) {
2040                 Clock (_session->audible_sample()); /* EMIT_SIGNAL */
2041         }
2042 }
2043
2044 void
2045 ARDOUR_UI::start_clocking ()
2046 {
2047         if (UIConfiguration::instance().get_super_rapid_clock_update()) {
2048                 clock_signal_connection = Timers::fps_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2049         } else {
2050                 clock_signal_connection = Timers::rapid_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2051         }
2052 }
2053
2054 void
2055 ARDOUR_UI::stop_clocking ()
2056 {
2057         clock_signal_connection.disconnect ();
2058 }
2059
2060 void
2061 ARDOUR_UI::save_state (const string & name, bool switch_to_it)
2062 {
2063         if (!_session || _session->deletion_in_progress()) {
2064                 return;
2065         }
2066
2067         XMLNode* node = new XMLNode (X_("UI"));
2068
2069         WM::Manager::instance().add_state (*node);
2070
2071         node->add_child_nocopy (gui_object_state->get_state());
2072
2073         _session->add_extra_xml (*node);
2074
2075         if (export_video_dialog) {
2076                 _session->add_extra_xml (export_video_dialog->get_state());
2077         }
2078
2079         save_state_canfail (name, switch_to_it);
2080 }
2081
2082 int
2083 ARDOUR_UI::save_state_canfail (string name, bool switch_to_it)
2084 {
2085         if (_session) {
2086                 int ret;
2087
2088                 if ((ret = _session->save_state (name, false, switch_to_it)) != 0) {
2089                         return ret;
2090                 }
2091         }
2092
2093         save_ardour_state (); /* XXX cannot fail? yeah, right ... */
2094         return 0;
2095 }
2096
2097 void
2098 ARDOUR_UI::primary_clock_value_changed ()
2099 {
2100         if (_session) {
2101                 _session->request_locate (primary_clock->current_time ());
2102         }
2103 }
2104
2105 void
2106 ARDOUR_UI::big_clock_value_changed ()
2107 {
2108         if (_session) {
2109                 _session->request_locate (big_clock->current_time ());
2110         }
2111 }
2112
2113 void
2114 ARDOUR_UI::secondary_clock_value_changed ()
2115 {
2116         if (_session) {
2117                 _session->request_locate (secondary_clock->current_time ());
2118         }
2119 }
2120 void
2121 ARDOUR_UI::save_template_dialog_response (int response, SaveTemplateDialog* d)
2122 {
2123         if (response == RESPONSE_ACCEPT) {
2124                 const string name = d->get_template_name ();
2125                 const string desc = d->get_description ();
2126
2127                 int failed = _session->save_template (name, desc);
2128
2129                 if (failed == -2) { /* file already exists. */
2130                         bool overwrite = overwrite_file_dialog (*d,
2131                                                                 _("Confirm Template Overwrite"),
2132                                                                 _("A template already exists with that name. Do you want to overwrite it?"));
2133
2134                         if (overwrite) {
2135                                 _session->save_template (name, desc, true);
2136                         }
2137                         else {
2138                                 d->show ();
2139                                 return;
2140                         }
2141                 }
2142         }
2143         delete d;
2144 }
2145
2146 void
2147 ARDOUR_UI::save_template ()
2148 {
2149         if (!check_audioengine (_main_window)) {
2150                 return;
2151         }
2152
2153         const std::string desc = SessionMetadata::Metadata()->description ();
2154         SaveTemplateDialog* d = new SaveTemplateDialog (_session->name (), desc);
2155         d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::save_template_dialog_response), d));
2156         d->show ();
2157 }
2158
2159 void ARDOUR_UI::manage_templates ()
2160 {
2161         TemplateDialog td;
2162         td.run();
2163 }
2164
2165 void
2166 ARDOUR_UI::edit_metadata ()
2167 {
2168         SessionMetadataEditor dialog;
2169         dialog.set_session (_session);
2170         dialog.grab_focus ();
2171         dialog.run ();
2172 }
2173
2174 void
2175 ARDOUR_UI::import_metadata ()
2176 {
2177         SessionMetadataImporter dialog;
2178         dialog.set_session (_session);
2179         dialog.run ();
2180 }
2181
2182 static void _lua_print (std::string s) {
2183 #ifndef NDEBUG
2184         std::cout << "LuaInstance: " << s << "\n";
2185 #endif
2186         PBD::info << "LuaInstance: " << s << endmsg;
2187 }
2188
2189 std::map<std::string, std::string>
2190 ARDOUR_UI::route_setup_info (const std::string& script_path)
2191 {
2192         std::map<std::string, std::string> rv;
2193
2194         if (!Glib::file_test (script_path, Glib::FILE_TEST_EXISTS | Glib::FILE_TEST_IS_REGULAR)) {
2195                 return rv;
2196         }
2197
2198         LuaState lua;
2199         lua.Print.connect (&_lua_print);
2200         lua.sandbox (true);
2201
2202         lua_State* L = lua.getState();
2203         LuaInstance::register_classes (L);
2204         LuaBindings::set_session (L, _session);
2205         luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
2206         lua_setglobal (L, "Editor");
2207
2208         lua.do_command ("function ardour () end");
2209         lua.do_file (script_path);
2210
2211         try {
2212                 luabridge::LuaRef fn = luabridge::getGlobal (L, "route_setup");
2213                 if (!fn.isFunction ()) {
2214                         return rv;
2215                 }
2216                 luabridge::LuaRef rs = fn ();
2217                 if (!rs.isTable ()) {
2218                         return rv;
2219                 }
2220                 for (luabridge::Iterator i(rs); !i.isNil (); ++i) {
2221                         if (!i.key().isString()) {
2222                                 continue;
2223                         }
2224                         std::string key = i.key().tostring();
2225                         if (i.value().isString() || i.value().isNumber() || i.value().isBoolean()) {
2226                                 rv[key] = i.value().tostring();
2227                         }
2228                 }
2229         } catch (luabridge::LuaException const& e) {
2230                 cerr << "LuaException:" << e.what () << endl;
2231         } catch (...) { }
2232         return rv;
2233 }
2234
2235 void
2236 ARDOUR_UI::meta_route_setup (const std::string& script_path)
2237 {
2238         if (!Glib::file_test (script_path, Glib::FILE_TEST_EXISTS | Glib::FILE_TEST_IS_REGULAR)) {
2239                 return;
2240         }
2241         assert (add_route_dialog);
2242
2243         int count;
2244         if ((count = add_route_dialog->count()) <= 0) {
2245                 return;
2246         }
2247
2248         LuaState lua;
2249         lua.Print.connect (&_lua_print);
2250         lua.sandbox (true);
2251
2252         lua_State* L = lua.getState();
2253         LuaInstance::register_classes (L);
2254         LuaBindings::set_session (L, _session);
2255         luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
2256         lua_setglobal (L, "Editor");
2257
2258         lua.do_command ("function ardour () end");
2259         lua.do_file (script_path);
2260
2261         luabridge::LuaRef args (luabridge::newTable (L));
2262
2263         args["name"]       = add_route_dialog->name_template ();
2264         args["insert_at"]  = translate_order (add_route_dialog->insert_at());
2265         args["group"]      = add_route_dialog->route_group ();
2266         args["strict_io"]  = add_route_dialog->use_strict_io ();
2267         args["instrument"] = add_route_dialog->requested_instrument ();
2268         args["track_mode"] = add_route_dialog->mode ();
2269         args["channels"]   = add_route_dialog->channel_count ();
2270         args["how_many"]   = count;
2271
2272         try {
2273                 luabridge::LuaRef fn = luabridge::getGlobal (L, "factory");
2274                 if (fn.isFunction()) {
2275                         fn (args)();
2276                 }
2277         } catch (luabridge::LuaException const& e) {
2278                 cerr << "LuaException:" << e.what () << endl;
2279         } catch (...) {
2280                 display_insufficient_ports_message ();
2281         }
2282 }
2283
2284 void
2285 ARDOUR_UI::meta_session_setup (const std::string& script_path)
2286 {
2287         if (!Glib::file_test (script_path, Glib::FILE_TEST_EXISTS | Glib::FILE_TEST_IS_REGULAR)) {
2288                 return;
2289         }
2290
2291         LuaState lua;
2292         lua.Print.connect (&_lua_print);
2293         lua.sandbox (true);
2294
2295         lua_State* L = lua.getState();
2296         LuaInstance::register_classes (L);
2297         LuaBindings::set_session (L, _session);
2298         luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
2299         lua_setglobal (L, "Editor");
2300
2301         lua.do_command ("function ardour () end");
2302         lua.do_file (script_path);
2303
2304         try {
2305                 luabridge::LuaRef fn = luabridge::getGlobal (L, "factory");
2306                 if (fn.isFunction()) {
2307                         fn ()();
2308                 }
2309         } catch (luabridge::LuaException const& e) {
2310                 cerr << "LuaException:" << e.what () << endl;
2311         } catch (...) {
2312                 display_insufficient_ports_message ();
2313         }
2314 }
2315
2316 void
2317 ARDOUR_UI::display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete)
2318 {
2319         size_t removed;
2320
2321         removed = rep.paths.size();
2322
2323         if (removed == 0) {
2324                 ArdourMessageDialog msgd (_main_window,
2325                                           _("No files were ready for clean-up"),
2326                                           true,
2327                                           Gtk::MESSAGE_INFO,
2328                                           Gtk::BUTTONS_OK);
2329                 msgd.set_title (_("Clean-up"));
2330                 msgd.set_secondary_text (_("If this seems surprising, \n\
2331 check for any existing snapshots.\n\
2332 These may still include regions that\n\
2333 require some unused files to continue to exist."));
2334
2335                 msgd.run ();
2336                 return;
2337         }
2338
2339         ArdourDialog results (_("Clean-up"), true, false);
2340
2341         struct CleanupResultsModelColumns : public Gtk::TreeModel::ColumnRecord {
2342                 CleanupResultsModelColumns() {
2343                         add (visible_name);
2344                         add (fullpath);
2345                 }
2346                 Gtk::TreeModelColumn<std::string> visible_name;
2347                 Gtk::TreeModelColumn<std::string> fullpath;
2348         };
2349
2350
2351         CleanupResultsModelColumns results_columns;
2352         Glib::RefPtr<Gtk::ListStore> results_model;
2353         Gtk::TreeView results_display;
2354
2355         results_model = ListStore::create (results_columns);
2356         results_display.set_model (results_model);
2357         results_display.append_column (list_title, results_columns.visible_name);
2358
2359         results_display.set_name ("CleanupResultsList");
2360         results_display.set_headers_visible (true);
2361         results_display.set_headers_clickable (false);
2362         results_display.set_reorderable (false);
2363
2364         Gtk::ScrolledWindow list_scroller;
2365         Gtk::Label txt;
2366         Gtk::VBox dvbox;
2367         Gtk::HBox dhbox;  // the hbox for the image and text
2368         Gtk::HBox ddhbox; // the hbox we eventually pack into the dialog's vbox
2369         Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_INFO,  Gtk::ICON_SIZE_DIALOG));
2370
2371         dimage->set_alignment(ALIGN_LEFT, ALIGN_TOP);
2372
2373         const string dead_directory = _session->session_directory().dead_path();
2374
2375         /* subst:
2376            %1 - number of files removed
2377            %2 - location of "dead"
2378            %3 - size of files affected
2379            %4 - prefix for "bytes" to produce sensible results (e.g. mega, kilo, giga)
2380         */
2381
2382         const char* bprefix;
2383         double space_adjusted = 0;
2384
2385         if (rep.space < 1000) {
2386                 bprefix = X_("");
2387                 space_adjusted = rep.space;
2388         } else if (rep.space < 1000000) {
2389                 bprefix = _("kilo");
2390                 space_adjusted = floorf((float)rep.space / 1000.0);
2391         } else if (rep.space < 1000000 * 1000) {
2392                 bprefix = _("mega");
2393                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000.0));
2394         } else {
2395                 bprefix = _("giga");
2396                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000 * 1000.0));
2397         }
2398
2399         if (msg_delete) {
2400                 txt.set_markup (string_compose (P_("\
2401 The following file was deleted from %2,\n\
2402 releasing %3 %4bytes of disk space", "\
2403 The following %1 files were deleted from %2,\n\
2404 releasing %3 %4bytes of disk space", removed),
2405                                         removed, Gtkmm2ext::markup_escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
2406         } else {
2407                 txt.set_markup (string_compose (P_("\
2408 The following file was not in use and \n\
2409 has been moved to: %2\n\n\
2410 After a restart of %5\n\n\
2411 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
2412 will release an additional %3 %4bytes of disk space.\n", "\
2413 The following %1 files were not in use and \n\
2414 have been moved to: %2\n\n\
2415 After a restart of %5\n\n\
2416 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
2417 will release an additional %3 %4bytes of disk space.\n", removed),
2418                                         removed, Gtkmm2ext::markup_escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
2419         }
2420
2421         dhbox.pack_start (*dimage, true, false, 5);
2422         dhbox.pack_start (txt, true, false, 5);
2423
2424         for (vector<string>::iterator i = rep.paths.begin(); i != rep.paths.end(); ++i) {
2425                 TreeModel::Row row = *(results_model->append());
2426                 row[results_columns.visible_name] = *i;
2427                 row[results_columns.fullpath] = *i;
2428         }
2429
2430         list_scroller.add (results_display);
2431         list_scroller.set_size_request (-1, 150);
2432         list_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
2433
2434         dvbox.pack_start (dhbox, true, false, 5);
2435         dvbox.pack_start (list_scroller, true, false, 5);
2436         ddhbox.pack_start (dvbox, true, false, 5);
2437
2438         results.get_vbox()->pack_start (ddhbox, true, false, 5);
2439         results.add_button (Stock::CLOSE, RESPONSE_CLOSE);
2440         results.set_default_response (RESPONSE_CLOSE);
2441         results.set_position (Gtk::WIN_POS_MOUSE);
2442
2443         results_display.show();
2444         list_scroller.show();
2445         txt.show();
2446         dvbox.show();
2447         dhbox.show();
2448         ddhbox.show();
2449         dimage->show();
2450
2451         //results.get_vbox()->show();
2452         results.set_resizable (false);
2453
2454         results.run ();
2455
2456 }
2457
2458 void
2459 ARDOUR_UI::cleanup ()
2460 {
2461         if (_session == 0) {
2462                 /* shouldn't happen: menu item is insensitive */
2463                 return;
2464         }
2465
2466
2467         ArdourMessageDialog checker (_("Are you sure you want to clean-up?"),
2468                                      true,
2469                                      Gtk::MESSAGE_QUESTION,
2470                                      Gtk::BUTTONS_NONE);
2471
2472         checker.set_title (_("Clean-up"));
2473
2474         checker.set_secondary_text(_("Clean-up is a destructive operation.\n\
2475 ALL undo/redo information will be lost if you clean-up.\n\
2476 Clean-up will move all unused files to a \"dead\" location."));
2477
2478         checker.add_button (Stock::CANCEL, RESPONSE_CANCEL);
2479         checker.add_button (_("Clean-up"), RESPONSE_ACCEPT);
2480         checker.set_default_response (RESPONSE_CANCEL);
2481
2482         checker.set_name (_("CleanupDialog"));
2483         checker.set_wmclass (X_("ardour_cleanup"), PROGRAM_NAME);
2484         checker.set_position (Gtk::WIN_POS_MOUSE);
2485
2486         switch (checker.run()) {
2487         case RESPONSE_ACCEPT:
2488                 break;
2489         default:
2490                 return;
2491         }
2492         checker.hide();
2493
2494         ARDOUR::CleanupReport rep;
2495
2496         editor->prepare_for_cleanup ();
2497
2498         /* do not allow flush until a session is reloaded */
2499         ActionManager::get_action (X_("Main"), X_("FlushWastebasket"))->set_sensitive (false);
2500
2501         if (_session->cleanup_sources (rep)) {
2502                 editor->finish_cleanup ();
2503                 return;
2504         }
2505
2506         editor->finish_cleanup ();
2507
2508         display_cleanup_results (rep, _("Cleaned Files"), false);
2509 }
2510
2511 void
2512 ARDOUR_UI::flush_trash ()
2513 {
2514         if (_session == 0) {
2515                 /* shouldn't happen: menu item is insensitive */
2516                 return;
2517         }
2518
2519         ARDOUR::CleanupReport rep;
2520
2521         if (_session->cleanup_trash_sources (rep)) {
2522                 return;
2523         }
2524
2525         display_cleanup_results (rep, _("deleted file"), true);
2526 }
2527
2528 void
2529 ARDOUR_UI::cleanup_peakfiles ()
2530 {
2531         if (_session == 0) {
2532                 /* shouldn't happen: menu item is insensitive */
2533                 return;
2534         }
2535
2536         if (! _session->can_cleanup_peakfiles ()) {
2537                 return;
2538         }
2539
2540         // get all region-views in this session
2541         RegionSelection rs;
2542         TrackViewList empty;
2543         empty.clear();
2544         editor->get_regions_after(rs, (samplepos_t) 0, empty);
2545         std::list<RegionView*> views = rs.by_layer();
2546
2547         // remove displayed audio-region-views waveforms
2548         for (list<RegionView*>::iterator i = views.begin(); i != views.end(); ++i) {
2549                 AudioRegionView* arv = dynamic_cast<AudioRegionView*> (*i);
2550                 if (!arv) { continue ; }
2551                 arv->delete_waves();
2552         }
2553
2554         // cleanup peak files:
2555         // - stop pending peakfile threads
2556         // - close peakfiles if any
2557         // - remove peak dir in session
2558         // - setup peakfiles (background thread)
2559         _session->cleanup_peakfiles ();
2560
2561         // re-add waves to ARV
2562         for (list<RegionView*>::iterator i = views.begin(); i != views.end(); ++i) {
2563                 AudioRegionView* arv = dynamic_cast<AudioRegionView*> (*i);
2564                 if (!arv) { continue ; }
2565                 arv->create_waves();
2566         }
2567 }
2568
2569 PresentationInfo::order_t
2570 ARDOUR_UI::translate_order (RouteDialogs::InsertAt place)
2571 {
2572         if (editor->get_selection().tracks.empty()) {
2573                 return place == RouteDialogs::First ? 0 : PresentationInfo::max_order;
2574         }
2575
2576         PresentationInfo::order_t order_hint = PresentationInfo::max_order;
2577
2578         /*
2579           we want the new routes to have their order keys set starting from
2580           the highest order key in the selection + 1 (if available).
2581         */
2582
2583         if (place == RouteDialogs::AfterSelection) {
2584                 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.back());
2585                 if (rtav) {
2586                         order_hint = rtav->route()->presentation_info().order();
2587                         order_hint++;
2588                 }
2589         } else if (place == RouteDialogs::BeforeSelection) {
2590                 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.front());
2591                 if (rtav) {
2592                         order_hint = rtav->route()->presentation_info().order();
2593                 }
2594         } else if (place == RouteDialogs::First) {
2595                 order_hint = 0;
2596         } else {
2597                 /* leave order_hint at max_order */
2598         }
2599
2600         return order_hint;
2601 }
2602
2603 void
2604 ARDOUR_UI::start_duplicate_routes ()
2605 {
2606         if (!duplicate_routes_dialog) {
2607                 duplicate_routes_dialog = new DuplicateRouteDialog;
2608         }
2609
2610         if (duplicate_routes_dialog->restart (_session)) {
2611                 return;
2612         }
2613
2614         duplicate_routes_dialog->present ();
2615 }
2616
2617 void
2618 ARDOUR_UI::add_route ()
2619 {
2620         if (!add_route_dialog.get (false)) {
2621                 add_route_dialog->signal_response().connect (sigc::mem_fun (*this, &ARDOUR_UI::add_route_dialog_response));
2622         }
2623
2624         if (!_session) {
2625                 return;
2626         }
2627
2628         if (add_route_dialog->is_visible()) {
2629                 /* we're already doing this */
2630                 return;
2631         }
2632
2633         add_route_dialog->set_position (WIN_POS_MOUSE);
2634         add_route_dialog->present();
2635 }
2636
2637 void
2638 ARDOUR_UI::add_route_dialog_response (int r)
2639 {
2640         if (!_session) {
2641                 warning << _("You cannot add tracks or busses without a session already loaded.") << endmsg;
2642                 return;
2643         }
2644
2645         if (!AudioEngine::instance()->running ()) {
2646                 switch (r) {
2647                         case AddRouteDialog::Add:
2648                         case AddRouteDialog::AddAndClose:
2649                                 break;
2650                         default:
2651                                 return;
2652                 }
2653                 add_route_dialog->ArdourDialog::on_response (r);
2654                 ARDOUR_UI_UTILS::engine_is_running ();
2655                 return;
2656         }
2657
2658         int count;
2659
2660         switch (r) {
2661         case AddRouteDialog::Add:
2662                 add_route_dialog->reset_name_edited ();
2663                 break;
2664         case AddRouteDialog::AddAndClose:
2665                 add_route_dialog->ArdourDialog::on_response (r);
2666                 break;
2667         default:
2668                 add_route_dialog->ArdourDialog::on_response (r);
2669                 return;
2670         }
2671
2672         std::string template_path = add_route_dialog->get_template_path();
2673         if (!template_path.empty() && template_path.substr (0, 11) == "urn:ardour:") {
2674                 meta_route_setup (template_path.substr (11));
2675                 return;
2676         }
2677
2678         if ((count = add_route_dialog->count()) <= 0) {
2679                 return;
2680         }
2681
2682         PresentationInfo::order_t order = translate_order (add_route_dialog->insert_at());
2683         const string name_template = add_route_dialog->name_template ();
2684         DisplaySuspender ds;
2685
2686         if (!template_path.empty ()) {
2687                 if (add_route_dialog->name_template_is_default ()) {
2688                         _session->new_route_from_template (count, order, template_path, string ());
2689                 } else {
2690                         _session->new_route_from_template (count, order, template_path, name_template);
2691                 }
2692                 return;
2693         }
2694
2695         ChanCount input_chan= add_route_dialog->channels ();
2696         ChanCount output_chan;
2697         PluginInfoPtr instrument = add_route_dialog->requested_instrument ();
2698         RouteGroup* route_group = add_route_dialog->route_group ();
2699         AutoConnectOption oac = Config->get_output_auto_connect();
2700         bool strict_io = add_route_dialog->use_strict_io ();
2701
2702         if (oac & AutoConnectMaster) {
2703                 output_chan.set (DataType::AUDIO, (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan.n_audio()));
2704                 output_chan.set (DataType::MIDI, 0);
2705         } else {
2706                 output_chan = input_chan;
2707         }
2708
2709         /* XXX do something with name template */
2710
2711         Session::ProcessorChangeBlocker pcb (_session);
2712
2713         switch (add_route_dialog->type_wanted()) {
2714         case AddRouteDialog::AudioTrack:
2715                 session_add_audio_route (true, input_chan.n_audio(), output_chan.n_audio(), add_route_dialog->mode(), route_group, count, name_template, strict_io, order);
2716                 break;
2717         case AddRouteDialog::MidiTrack:
2718                 session_add_midi_route (true, route_group, count, name_template, strict_io, instrument, 0, order);
2719                 break;
2720         case AddRouteDialog::MixedTrack:
2721                 session_add_mixed_track (input_chan, output_chan, route_group, count, name_template, strict_io, instrument, 0, order);
2722                 break;
2723         case AddRouteDialog::AudioBus:
2724                 session_add_audio_route (false, input_chan.n_audio(), output_chan.n_audio(), ARDOUR::Normal, route_group, count, name_template, strict_io, order);
2725                 break;
2726         case AddRouteDialog::MidiBus:
2727                 session_add_midi_bus (route_group, count, name_template, strict_io, instrument, 0, order);
2728                 break;
2729         case AddRouteDialog::VCAMaster:
2730                 _session->vca_manager().create_vca (count, name_template);
2731                 break;
2732         case AddRouteDialog::FoldbackBus:
2733                 session_add_foldback_bus (input_chan.n_audio(), count, name_template);
2734                 ActionManager::get_toggle_action (X_("Mixer"), X_("ToggleFoldbackStrip"))->set_active (true);
2735                 break;
2736         }
2737 }
2738
2739 void
2740 ARDOUR_UI::disk_overrun_handler ()
2741 {
2742         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_overrun_handler)
2743
2744         if (!have_disk_speed_dialog_displayed) {
2745                 have_disk_speed_dialog_displayed = true;
2746                 ArdourMessageDialog* msg = new ArdourMessageDialog (_main_window, string_compose (_("\
2747 The disk system on your computer\n\
2748 was not able to keep up with %1.\n\
2749 \n\
2750 Specifically, it failed to write data to disk\n\
2751 quickly enough to keep up with recording.\n"), PROGRAM_NAME));
2752                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
2753                 msg->show ();
2754         }
2755 }
2756
2757 void
2758 ARDOUR_UI::gui_idle_handler ()
2759 {
2760         int timeout = 30;
2761         /* due to idle calls, gtk_events_pending() may always return true */
2762         while (gtk_events_pending() && --timeout) {
2763                 gtk_main_iteration ();
2764         }
2765 }
2766
2767 void
2768 ARDOUR_UI::disk_underrun_handler ()
2769 {
2770         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_underrun_handler)
2771
2772         if (!have_disk_speed_dialog_displayed) {
2773                 have_disk_speed_dialog_displayed = true;
2774                 ArdourMessageDialog* msg = new ArdourMessageDialog (
2775                         _main_window, string_compose (_("The disk system on your computer\n\
2776 was not able to keep up with %1.\n\
2777 \n\
2778 Specifically, it failed to read data from disk\n\
2779 quickly enough to keep up with playback.\n"), PROGRAM_NAME));
2780                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
2781                 msg->show ();
2782         }
2783 }
2784
2785 void
2786 ARDOUR_UI::disk_speed_dialog_gone (int /*ignored_response*/, MessageDialog* msg)
2787 {
2788         have_disk_speed_dialog_displayed = false;
2789         delete msg;
2790 }
2791
2792 void
2793 ARDOUR_UI::session_dialog (std::string msg)
2794 {
2795         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::session_dialog, msg)
2796         ArdourMessageDialog d (msg, false, MESSAGE_INFO, BUTTONS_OK, true);
2797         d.run ();
2798 }
2799
2800 int
2801 ARDOUR_UI::pending_state_dialog ()
2802 {
2803         HBox* hbox = manage (new HBox());
2804         Image* image = manage (new Image (Stock::DIALOG_QUESTION, ICON_SIZE_DIALOG));
2805         ArdourDialog dialog (_("Crash Recovery"), true);
2806         Label  message (string_compose (_("\
2807 This session appears to have been in the\n\
2808 middle of recording when %1 or\n\
2809 the computer was shutdown.\n\
2810 \n\
2811 %1 can recover any captured audio for\n\
2812 you, or it can ignore it. Please decide\n\
2813 what you would like to do.\n"), PROGRAM_NAME));
2814         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
2815         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
2816         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
2817         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
2818         dialog.add_button (_("Ignore crash data"), RESPONSE_REJECT);
2819         dialog.add_button (_("Recover from crash"), RESPONSE_ACCEPT);
2820         dialog.set_default_response (RESPONSE_ACCEPT);
2821         dialog.set_position (WIN_POS_CENTER);
2822         message.show();
2823         image->show();
2824         hbox->show();
2825
2826         switch (dialog.run ()) {
2827         case RESPONSE_ACCEPT:
2828                 return 1;
2829         default:
2830                 return 0;
2831         }
2832 }
2833
2834 void
2835 ARDOUR_UI::store_clock_modes ()
2836 {
2837         if (session_load_in_progress) {
2838                 /* Do not overwrite clock modes while loading them (with a session) */
2839                 return;
2840         }
2841
2842         XMLNode* node = new XMLNode(X_("ClockModes"));
2843
2844         for (vector<AudioClock*>::iterator x = AudioClock::clocks.begin(); x != AudioClock::clocks.end(); ++x) {
2845                 XMLNode* child = new XMLNode (X_("Clock"));
2846
2847                 child->set_property (X_("name"), (*x)->name());
2848                 child->set_property (X_("mode"), (*x)->mode());
2849                 child->set_property (X_("on"), (*x)->on());
2850
2851                 node->add_child_nocopy (*child);
2852         }
2853
2854         _session->add_extra_xml (*node);
2855         _session->set_dirty ();
2856 }
2857
2858 /** Allocate our thread-local buffers */
2859 void
2860 ARDOUR_UI::get_process_buffers ()
2861 {
2862         _process_thread->get_buffers ();
2863 }
2864
2865 /** Drop our thread-local buffers */
2866 void
2867 ARDOUR_UI::drop_process_buffers ()
2868 {
2869         _process_thread->drop_buffers ();
2870 }
2871
2872 void
2873 ARDOUR_UI::feedback_detected ()
2874 {
2875         _feedback_exists = true;
2876 }
2877
2878 void
2879 ARDOUR_UI::successful_graph_sort ()
2880 {
2881         _feedback_exists = false;
2882 }
2883
2884 void
2885 ARDOUR_UI::midi_panic ()
2886 {
2887         if (_session) {
2888                 _session->midi_panic();
2889         }
2890 }
2891
2892 void
2893 ARDOUR_UI::reset_peak_display ()
2894 {
2895         if (!_session || !_session->master_out() || !editor_meter) return;
2896         editor_meter->clear_meters();
2897         editor_meter_max_peak = -INFINITY;
2898         editor_meter_peak_display.set_active_state ( Gtkmm2ext::Off );
2899 }
2900
2901 void
2902 ARDOUR_UI::reset_group_peak_display (RouteGroup* group)
2903 {
2904         if (!_session || !_session->master_out()) return;
2905         if (group == _session->master_out()->route_group()) {
2906                 reset_peak_display ();
2907         }
2908 }
2909
2910 void
2911 ARDOUR_UI::reset_route_peak_display (Route* route)
2912 {
2913         if (!_session || !_session->master_out()) return;
2914         if (_session->master_out().get() == route) {
2915                 reset_peak_display ();
2916         }
2917 }
2918
2919 void
2920 ARDOUR_UI::hide_application ()
2921 {
2922         Application::instance ()-> hide ();
2923 }
2924
2925 void
2926 ARDOUR_UI::setup_toplevel_window (Gtk::Window& window, const string& name, void* owner)
2927 {
2928         /* icons, titles, WM stuff */
2929
2930         static list<Glib::RefPtr<Gdk::Pixbuf> > window_icons;
2931
2932         if (window_icons.empty()) {
2933                 Glib::RefPtr<Gdk::Pixbuf> icon;
2934                 if ((icon = ::get_icon (PROGRAM_NAME "-icon_16px"))) {
2935                         window_icons.push_back (icon);
2936                 }
2937                 if ((icon = ::get_icon (PROGRAM_NAME "-icon_22px"))) {
2938                         window_icons.push_back (icon);
2939                 }
2940                 if ((icon = ::get_icon (PROGRAM_NAME "-icon_32px"))) {
2941                         window_icons.push_back (icon);
2942                 }
2943                 if ((icon = ::get_icon (PROGRAM_NAME "-icon_48px"))) {
2944                         window_icons.push_back (icon);
2945                 }
2946         }
2947
2948         if (!window_icons.empty()) {
2949                 window.set_default_icon_list (window_icons);
2950         }
2951
2952         Gtkmm2ext::WindowTitle title (Glib::get_application_name());
2953
2954         if (!name.empty()) {
2955                 title += name;
2956         }
2957
2958         window.set_title (title.get_string());
2959         window.set_wmclass (string_compose (X_("%1_%1"), downcase (std::string(PROGRAM_NAME)), downcase (name)), PROGRAM_NAME);
2960
2961         window.set_flags (CAN_FOCUS);
2962         window.add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
2963
2964         /* This is a hack to ensure that GTK-accelerators continue to
2965          * work. Once we switch over to entirely native bindings, this will be
2966          * unnecessary and should be removed
2967          */
2968         window.add_accel_group (ActionManager::ui_manager->get_accel_group());
2969
2970         window.signal_configure_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::configure_handler));
2971         window.signal_window_state_event().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::tabbed_window_state_event_handler), owner));
2972         window.signal_key_press_event().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::key_event_handler), &window), false);
2973         window.signal_key_release_event().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::key_event_handler), &window), false);
2974 }