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