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