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