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