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