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