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