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