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