further preparations for NSM (#6265)
[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)
185
186         : Gtkmm2ext::UI (PROGRAM_NAME, argcp, argvp)
187         , ui_config (new UIConfiguration)
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
2107         if (!_session) {
2108                 return;
2109         }
2110
2111         if (_session->is_auditioning()) {
2112                 _session->cancel_audition ();
2113                 return;
2114         }
2115
2116         if (_session->config.get_external_sync()) {
2117                 switch (Config->get_sync_source()) {
2118                 case Engine:
2119                         break;
2120                 default:
2121                         /* transport controlled by the master */
2122                         return;
2123                 }
2124         }
2125
2126         bool rolling = _session->transport_rolling();
2127         bool affect_transport = true;
2128
2129         if (rolling && roll_out_of_bounded_mode) {
2130                 /* drop out of loop/range playback but leave transport rolling */
2131                 if (_session->get_play_loop()) {
2132                         if (Config->get_seamless_loop()) {
2133                                 /* the disk buffers contain copies of the loop - we can't
2134                                    just keep playing, so stop the transport. the user
2135                                    can restart as they wish.
2136                                 */
2137                                 affect_transport = true;
2138                         } else {
2139                                 /* disk buffers are normal, so we can keep playing */
2140                                 affect_transport = false;
2141                         }
2142                         _session->request_play_loop (false, affect_transport);
2143                 } else if (_session->get_play_range ()) {
2144                         affect_transport = false;
2145                         _session->request_play_range (0, true);
2146                 }
2147         }
2148
2149         if (affect_transport) {
2150                 if (rolling) {
2151                         _session->request_stop (with_abort, true);
2152                 } else {
2153                         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
2154                                 _session->request_play_range (&editor->get_selection().time, true);
2155                                 _session->set_requested_return_frame( editor->get_selection().time.front().start );  //force an auto-return here
2156                         }
2157                         _session->request_transport_speed (1.0f);
2158                 }
2159         }
2160 }
2161
2162 void
2163 ARDOUR_UI::toggle_session_auto_loop ()
2164 {
2165         Location * looploc = _session->locations()->auto_loop_location();
2166
2167         if (!_session || !looploc) {
2168                 return;
2169         }
2170
2171         if (_session->get_play_loop()) {
2172
2173                 /* looping enabled, our job is to disable it */
2174
2175                 _session->request_play_loop (false);
2176
2177         } else {
2178
2179                 /* looping not enabled, our job is to enable it.
2180
2181                    loop-is-NOT-mode: this action always starts the transport rolling.
2182                    loop-IS-mode:     this action simply sets the loop play mechanism, but
2183                                         does not start transport.
2184                 */
2185                 if (Config->get_loop_is_mode()) {
2186                         _session->request_play_loop (true, false);
2187                 } else {
2188                         _session->request_play_loop (true, true);
2189                 }
2190         }
2191         
2192         //show the loop markers
2193         looploc->set_hidden (false, this);
2194 }
2195
2196 void
2197 ARDOUR_UI::transport_play_selection ()
2198 {
2199         if (!_session) {
2200                 return;
2201         }
2202
2203         editor->play_selection ();
2204 }
2205
2206 void
2207 ARDOUR_UI::transport_play_preroll ()
2208 {
2209         if (!_session) {
2210                 return;
2211         }
2212         editor->play_with_preroll ();
2213 }
2214
2215 void
2216 ARDOUR_UI::transport_rewind (int option)
2217 {
2218         float current_transport_speed;
2219
2220         if (_session) {
2221                 current_transport_speed = _session->transport_speed();
2222
2223                 if (current_transport_speed >= 0.0f) {
2224                         switch (option) {
2225                         case 0:
2226                                 _session->request_transport_speed (-1.0f);
2227                                 break;
2228                         case 1:
2229                                 _session->request_transport_speed (-4.0f);
2230                                 break;
2231                         case -1:
2232                                 _session->request_transport_speed (-0.5f);
2233                                 break;
2234                         }
2235                 } else {
2236                         /* speed up */
2237                         _session->request_transport_speed (current_transport_speed * 1.5f);
2238                 }
2239         }
2240 }
2241
2242 void
2243 ARDOUR_UI::transport_forward (int option)
2244 {
2245         if (!_session) {
2246                 return;
2247         }
2248         
2249         float current_transport_speed = _session->transport_speed();
2250         
2251         if (current_transport_speed <= 0.0f) {
2252                 switch (option) {
2253                 case 0:
2254                         _session->request_transport_speed (1.0f);
2255                         break;
2256                 case 1:
2257                         _session->request_transport_speed (4.0f);
2258                         break;
2259                 case -1:
2260                         _session->request_transport_speed (0.5f);
2261                         break;
2262                 }
2263         } else {
2264                 /* speed up */
2265                 _session->request_transport_speed (current_transport_speed * 1.5f);
2266         }
2267 }
2268
2269 void
2270 ARDOUR_UI::toggle_record_enable (uint32_t rid)
2271 {
2272         if (!_session) {
2273                 return;
2274         }
2275
2276         boost::shared_ptr<Route> r;
2277
2278         if ((r = _session->route_by_remote_id (rid)) != 0) {
2279
2280                 Track* t;
2281
2282                 if ((t = dynamic_cast<Track*>(r.get())) != 0) {
2283                         t->set_record_enabled (!t->record_enabled(), this);
2284                 }
2285         }
2286 }
2287
2288 void
2289 ARDOUR_UI::map_transport_state ()
2290 {
2291         if (!_session) {
2292                 auto_loop_button.unset_active_state ();
2293                 play_selection_button.unset_active_state ();
2294                 roll_button.unset_active_state ();
2295                 stop_button.set_active_state (Gtkmm2ext::ExplicitActive);
2296                 return;
2297         }
2298
2299         shuttle_box->map_transport_state ();
2300
2301         float sp = _session->transport_speed();
2302
2303         if (sp != 0.0f) {
2304
2305                 /* we're rolling */
2306
2307                 if (_session->get_play_range()) {
2308
2309                         play_selection_button.set_active_state (Gtkmm2ext::ExplicitActive);
2310                         roll_button.unset_active_state ();
2311                         auto_loop_button.unset_active_state ();
2312
2313                 } else if (_session->get_play_loop ()) {
2314
2315                         auto_loop_button.set_active (true);
2316                         play_selection_button.set_active (false);
2317                         if (Config->get_loop_is_mode()) {
2318                                 roll_button.set_active (true);
2319                         } else {
2320                                 roll_button.set_active (false);
2321                         }
2322
2323                 } else {
2324
2325                         roll_button.set_active (true);
2326                         play_selection_button.set_active (false);
2327                         auto_loop_button.set_active (false);
2328                 }
2329
2330                 if (ARDOUR_UI::config()->get_follow_edits()) {
2331                         /* light up both roll and play-selection if they are joined */
2332                         roll_button.set_active (true);
2333                         play_selection_button.set_active (true);
2334                 }
2335
2336                 stop_button.set_active (false);
2337
2338         } else {
2339
2340                 stop_button.set_active (true);
2341                 roll_button.set_active (false);
2342                 play_selection_button.set_active (false);
2343                 if (Config->get_loop_is_mode ()) {
2344                         auto_loop_button.set_active (_session->get_play_loop());
2345                 } else {
2346                         auto_loop_button.set_active (false);
2347                 }
2348                 update_disk_space ();
2349         }
2350 }
2351
2352 void
2353 ARDOUR_UI::blink_handler (bool blink_on)
2354 {
2355         transport_rec_enable_blink (blink_on);
2356         solo_blink (blink_on);
2357         sync_blink (blink_on);
2358         audition_blink (blink_on);
2359         feedback_blink (blink_on);
2360         error_blink (blink_on);
2361 }
2362
2363 void
2364 ARDOUR_UI::update_clocks ()
2365 {
2366         if (!_session) return;
2367
2368         if (editor && !editor->dragging_playhead()) {
2369                 Clock (_session->audible_frame(), false, editor->get_preferred_edit_position (EDIT_IGNORE_PHEAD)); /* EMIT_SIGNAL */
2370         }
2371 }
2372
2373 void
2374 ARDOUR_UI::start_clocking ()
2375 {
2376         if (ui_config->get_super_rapid_clock_update()) {
2377                 clock_signal_connection = Timers::fps_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2378         } else {
2379                 clock_signal_connection = Timers::rapid_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2380         }
2381 }
2382
2383 void
2384 ARDOUR_UI::stop_clocking ()
2385 {
2386         clock_signal_connection.disconnect ();
2387 }
2388
2389 bool
2390 ARDOUR_UI::save_as_progress_update (float fraction, int64_t cnt, int64_t total, Gtk::Label* label, Gtk::ProgressBar* bar)
2391 {
2392         char buf[256];
2393
2394         snprintf (buf, sizeof (buf), _("Copied %" PRId64 " of %" PRId64), cnt, total);
2395
2396         label->set_text (buf);
2397         bar->set_fraction (fraction);
2398
2399         /* process events, redraws, etc. */
2400         
2401         while (gtk_events_pending()) {
2402                 gtk_main_iteration ();
2403         }
2404
2405         return true; /* continue with save-as */
2406 }
2407
2408 void
2409 ARDOUR_UI::save_session_as ()
2410 {
2411         if (!_session) {
2412                 return;
2413         }
2414
2415         if (!save_as_dialog) {
2416                 save_as_dialog = new SaveAsDialog;
2417         } else {
2418                 save_as_dialog->clear_name ();
2419         }
2420
2421         int response = save_as_dialog->run ();
2422
2423         save_as_dialog->hide ();
2424         
2425         switch (response) {
2426         case Gtk::RESPONSE_OK:
2427                 break;
2428         default:
2429                 return;
2430         }
2431         
2432         ArdourDialog progress_dialog(_("Save As"), true);
2433         Gtk::Label label;
2434         Gtk::ProgressBar progress_bar;
2435
2436         progress_dialog.get_vbox()->pack_start (label);
2437         progress_dialog.get_vbox()->pack_start (progress_bar);
2438         label.show ();
2439         progress_bar.show ();
2440         
2441         Session::SaveAs sa;
2442
2443         sa.new_parent_folder = save_as_dialog->new_parent_folder ();
2444         sa.new_name = save_as_dialog->new_name ();
2445         sa.switch_to = save_as_dialog->switch_to();
2446         sa.copy_media = save_as_dialog->copy_media();
2447         sa.copy_external = save_as_dialog->copy_external();
2448
2449         /* this signal will be emitted from within this, the calling thread,
2450          * after every file is copied. It provides information on percentage
2451          * complete (in terms of total data to copy), the number of files
2452          * copied so far, and the total number to copy.
2453          */
2454
2455         ScopedConnection c;
2456
2457         sa.Progress.connect_same_thread (c, boost::bind (&ARDOUR_UI::save_as_progress_update, this, _1, _2, _3, &label, &progress_bar));
2458         
2459         progress_dialog.show_all ();
2460         progress_dialog.present ();
2461         
2462         if (_session->save_as (sa)) {
2463                 /* ERROR MESSAGE */
2464                 MessageDialog msg (string_compose (_("Save As failed: %1"), sa.failure_message));
2465                 msg.run ();
2466         }
2467 }
2468
2469 /** Ask the user for the name of a new snapshot and then take it.
2470  */
2471
2472 void
2473 ARDOUR_UI::snapshot_session (bool switch_to_it)
2474 {
2475         ArdourPrompter prompter (true);
2476         string snapname;
2477
2478         prompter.set_name ("Prompter");
2479         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2480         if (switch_to_it) {
2481                 prompter.set_title (_("Save as..."));
2482                 prompter.set_prompt (_("New session name"));
2483         } else {
2484                 prompter.set_title (_("Take Snapshot"));
2485                 prompter.set_prompt (_("Name of new snapshot"));
2486         }
2487
2488         if (!switch_to_it) {
2489                 char timebuf[128];
2490                 time_t n;
2491                 struct tm local_time;
2492
2493                 time (&n);
2494                 localtime_r (&n, &local_time);
2495                 strftime (timebuf, sizeof(timebuf), "%FT%H.%M.%S", &local_time);
2496                 prompter.set_initial_text (timebuf);
2497         }
2498
2499   again:
2500         switch (prompter.run()) {
2501         case RESPONSE_ACCEPT:
2502         {
2503                 prompter.get_result (snapname);
2504
2505                 bool do_save = (snapname.length() != 0);
2506
2507                 if (do_save) {
2508                         char illegal = Session::session_name_is_legal(snapname);
2509                         if (illegal) {
2510                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2511                                                      "snapshot names may not contain a '%1' character"), illegal));
2512                                 msg.run ();
2513                                 goto again;
2514                         }
2515                 }
2516
2517                 vector<std::string> p;
2518                 get_state_files_in_directory (_session->session_directory().root_path(), p);
2519                 vector<string> n = get_file_names_no_extension (p);
2520                 if (find (n.begin(), n.end(), snapname) != n.end()) {
2521
2522                         ArdourDialog confirm (_("Confirm Snapshot Overwrite"), true);
2523                         Label m (_("A snapshot already exists with that name.  Do you want to overwrite it?"));
2524                         confirm.get_vbox()->pack_start (m, true, true);
2525                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
2526                         confirm.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
2527                         confirm.show_all ();
2528                         switch (confirm.run()) {
2529                         case RESPONSE_CANCEL:
2530                                 do_save = false;
2531                         }
2532                 }
2533
2534                 if (do_save) {
2535                         save_state (snapname, switch_to_it);
2536                 }
2537                 break;
2538         }
2539
2540         default:
2541                 break;
2542         }
2543 }
2544
2545 /** Ask the user for a new session name and then rename the session to it.
2546  */
2547
2548 void
2549 ARDOUR_UI::rename_session ()
2550 {
2551         if (!_session) {
2552                 return;
2553         }
2554
2555         ArdourPrompter prompter (true);
2556         string name;
2557
2558         prompter.set_name ("Prompter");
2559         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2560         prompter.set_title (_("Rename Session"));
2561         prompter.set_prompt (_("New session name"));
2562
2563   again:
2564         switch (prompter.run()) {
2565         case RESPONSE_ACCEPT:
2566         {
2567                 prompter.get_result (name);
2568
2569                 bool do_rename = (name.length() != 0);
2570
2571                 if (do_rename) {
2572                         char illegal = Session::session_name_is_legal (name);
2573
2574                         if (illegal) {
2575                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2576                                                                      "session names may not contain a '%1' character"), illegal));
2577                                 msg.run ();
2578                                 goto again;
2579                         }
2580
2581                         switch (_session->rename (name)) {
2582                         case -1: {
2583                                 MessageDialog msg (_("That name is already in use by another directory/folder. Please try again."));
2584                                 msg.set_position (WIN_POS_MOUSE);
2585                                 msg.run ();
2586                                 goto again;
2587                                 break;
2588                         }
2589                         case 0:
2590                                 break;
2591                         default: {
2592                                 MessageDialog msg (_("Renaming this session failed.\nThings could be seriously messed up at this point"));
2593                                 msg.set_position (WIN_POS_MOUSE);
2594                                 msg.run ();
2595                                 break;
2596                         }
2597                         }
2598                 }
2599                 
2600                 break;
2601         }
2602
2603         default:
2604                 break;
2605         }
2606 }
2607
2608 void
2609 ARDOUR_UI::save_state (const string & name, bool switch_to_it)
2610 {
2611         XMLNode* node = new XMLNode (X_("UI"));
2612
2613         WM::Manager::instance().add_state (*node);
2614
2615         node->add_child_nocopy (gui_object_state->get_state());
2616
2617         _session->add_extra_xml (*node);
2618
2619         if (export_video_dialog) {
2620                 _session->add_extra_xml (export_video_dialog->get_state());
2621         }
2622
2623         save_state_canfail (name, switch_to_it);
2624 }
2625
2626 int
2627 ARDOUR_UI::save_state_canfail (string name, bool switch_to_it)
2628 {
2629         if (_session) {
2630                 int ret;
2631
2632                 if (name.length() == 0) {
2633                         name = _session->snap_name();
2634                 }
2635
2636                 if ((ret = _session->save_state (name, false, switch_to_it)) != 0) {
2637                         return ret;
2638                 }
2639         }
2640
2641         save_ardour_state (); /* XXX cannot fail? yeah, right ... */
2642         return 0;
2643 }
2644
2645 void
2646 ARDOUR_UI::primary_clock_value_changed ()
2647 {
2648         if (_session) {
2649                 _session->request_locate (primary_clock->current_time ());
2650         }
2651 }
2652
2653 void
2654 ARDOUR_UI::big_clock_value_changed ()
2655 {
2656         if (_session) {
2657                 _session->request_locate (big_clock->current_time ());
2658         }
2659 }
2660
2661 void
2662 ARDOUR_UI::secondary_clock_value_changed ()
2663 {
2664         if (_session) {
2665                 _session->request_locate (secondary_clock->current_time ());
2666         }
2667 }
2668
2669 void
2670 ARDOUR_UI::transport_rec_enable_blink (bool onoff)
2671 {
2672         if (_session == 0) {
2673                 return;
2674         }
2675
2676         if (_session->step_editing()) {
2677                 return;
2678         }
2679
2680         Session::RecordState const r = _session->record_status ();
2681         bool const h = _session->have_rec_enabled_track ();
2682
2683         if (r == Session::Enabled || (r == Session::Recording && !h)) {
2684                 if (onoff) {
2685                         rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2686                 } else {
2687                         rec_button.set_active_state (Gtkmm2ext::Off);
2688                 }
2689         } else if (r == Session::Recording && h) {
2690                 rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2691         } else {
2692                 rec_button.unset_active_state ();
2693         }
2694 }
2695
2696 void
2697 ARDOUR_UI::save_template ()
2698 {
2699         ArdourPrompter prompter (true);
2700         string name;
2701
2702         if (!check_audioengine()) {
2703                 return;
2704         }
2705
2706         prompter.set_name (X_("Prompter"));
2707         prompter.set_title (_("Save Template"));
2708         prompter.set_prompt (_("Name for template:"));
2709         prompter.set_initial_text(_session->name() + _("-template"));
2710         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2711
2712         switch (prompter.run()) {
2713         case RESPONSE_ACCEPT:
2714                 prompter.get_result (name);
2715
2716                 if (name.length()) {
2717                         _session->save_template (name);
2718                 }
2719                 break;
2720
2721         default:
2722                 break;
2723         }
2724 }
2725
2726 void
2727 ARDOUR_UI::edit_metadata ()
2728 {
2729         SessionMetadataEditor dialog;
2730         dialog.set_session (_session);
2731         dialog.grab_focus ();
2732         dialog.run ();
2733 }
2734
2735 void
2736 ARDOUR_UI::import_metadata ()
2737 {
2738         SessionMetadataImporter dialog;
2739         dialog.set_session (_session);
2740         dialog.run ();
2741 }
2742
2743 bool
2744 ARDOUR_UI::ask_about_loading_existing_session (const std::string& session_path)
2745 {
2746         std::string str = string_compose (_("This session\n%1\nalready exists. Do you want to open it?"), session_path);
2747
2748         MessageDialog msg (str,
2749                            false,
2750                            Gtk::MESSAGE_WARNING,
2751                            Gtk::BUTTONS_YES_NO,
2752                            true);
2753
2754
2755         msg.set_name (X_("OpenExistingDialog"));
2756         msg.set_title (_("Open Existing Session"));
2757         msg.set_wmclass (X_("existing_session"), PROGRAM_NAME);
2758         msg.set_position (Gtk::WIN_POS_CENTER);
2759         pop_back_splash (msg);
2760
2761         switch (msg.run()) {
2762         case RESPONSE_YES:
2763                 return true;
2764                 break;
2765         }
2766         return false;
2767 }
2768
2769 int
2770 ARDOUR_UI::build_session_from_dialog (SessionDialog& sd, const std::string& session_path, const std::string& session_name)
2771 {
2772         BusProfile bus_profile;
2773
2774         if (nsm || Profile->get_sae()) {
2775
2776                 bus_profile.master_out_channels = 2;
2777                 bus_profile.input_ac = AutoConnectPhysical;
2778                 bus_profile.output_ac = AutoConnectMaster;
2779                 bus_profile.requested_physical_in = 0; // use all available
2780                 bus_profile.requested_physical_out = 0; // use all available
2781
2782         } else {
2783
2784                 /* get settings from advanced section of NSD */
2785
2786                 if (sd.create_master_bus()) {
2787                         bus_profile.master_out_channels = (uint32_t) sd.master_channel_count();
2788                 } else {
2789                         bus_profile.master_out_channels = 0;
2790                 }
2791
2792                 if (sd.connect_inputs()) {
2793                         bus_profile.input_ac = AutoConnectPhysical;
2794                 } else {
2795                         bus_profile.input_ac = AutoConnectOption (0);
2796                 }
2797
2798                 bus_profile.output_ac = AutoConnectOption (0);
2799
2800                 if (sd.connect_outputs ()) {
2801                         if (sd.connect_outs_to_master()) {
2802                                 bus_profile.output_ac = AutoConnectMaster;
2803                         } else if (sd.connect_outs_to_physical()) {
2804                                 bus_profile.output_ac = AutoConnectPhysical;
2805                         }
2806                 }
2807
2808                 bus_profile.requested_physical_in = (uint32_t) sd.input_limit_count();
2809                 bus_profile.requested_physical_out = (uint32_t) sd.output_limit_count();
2810         }
2811
2812         if (build_session (session_path, session_name, bus_profile)) {
2813                 return -1;
2814         }
2815
2816         return 0;
2817 }
2818
2819 void
2820 ARDOUR_UI::load_from_application_api (const std::string& path)
2821 {
2822         ARDOUR_COMMAND_LINE::session_name = path;
2823
2824         if (Glib::file_test (path, Glib::FILE_TEST_IS_DIR)) {
2825                 /* /path/to/foo => /path/to/foo, foo */
2826                 load_session (path, basename_nosuffix (path));
2827         } else {
2828                 /* /path/to/foo/foo.ardour => /path/to/foo, foo */
2829                 load_session (Glib::path_get_dirname (path), basename_nosuffix (path));
2830         }
2831 }
2832
2833 /** @param quit_on_cancel true if exit() should be called if the user clicks `cancel' in the new session dialog */
2834 int
2835 ARDOUR_UI::get_session_parameters (bool quit_on_cancel, bool should_be_new, string load_template)
2836 {
2837         string session_name;
2838         string session_path;
2839         string template_name;
2840         int ret = -1;
2841         bool likely_new = false;
2842         bool cancel_not_quit;
2843
2844         /* deal with any existing DIRTY session now, rather than later. don't
2845          * treat a non-dirty session this way, so that it stays visible 
2846          * as we bring up the new session dialog.
2847          */
2848
2849         if (_session && ARDOUR_UI::instance()->video_timeline) {
2850                 ARDOUR_UI::instance()->video_timeline->sync_session_state();
2851         }
2852
2853         /* if there is already a session, relabel the button
2854            on the SessionDialog so that we don't Quit directly
2855         */
2856         cancel_not_quit = (_session != 0);
2857
2858         if (_session && _session->dirty()) {
2859                 if (unload_session (false)) {
2860                         /* unload cancelled by user */
2861                         return 0;
2862                 }
2863                 ARDOUR_COMMAND_LINE::session_name = "";
2864         }
2865
2866         if (!load_template.empty()) {
2867                 should_be_new = true;
2868                 template_name = load_template;
2869         }
2870
2871         session_name = basename_nosuffix (ARDOUR_COMMAND_LINE::session_name);
2872         session_path = ARDOUR_COMMAND_LINE::session_name;
2873         
2874         if (!session_path.empty()) {
2875                 if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_EXISTS)) {
2876                         if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_IS_REGULAR)) {
2877                                 /* session/snapshot file, change path to be dir */
2878                                 session_path = Glib::path_get_dirname (session_path);
2879                         }
2880                 }
2881         }
2882
2883         SessionDialog session_dialog (should_be_new, session_name, session_path, load_template, cancel_not_quit);
2884
2885         while (ret != 0) {
2886
2887                 if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
2888
2889                         /* if they named a specific statefile, use it, otherwise they are
2890                            just giving a session folder, and we want to use it as is
2891                            to find the session.
2892                         */
2893
2894                         string::size_type suffix = ARDOUR_COMMAND_LINE::session_name.find (statefile_suffix);
2895
2896                         if (suffix != string::npos) {
2897                                 session_path = Glib::path_get_dirname (ARDOUR_COMMAND_LINE::session_name);
2898                                 session_name = ARDOUR_COMMAND_LINE::session_name.substr (0, suffix);
2899                                 session_name = Glib::path_get_basename (session_name);
2900                         } else {
2901                                 session_path = ARDOUR_COMMAND_LINE::session_name;
2902                                 session_name = Glib::path_get_basename (ARDOUR_COMMAND_LINE::session_name);
2903                         }
2904                 } else {
2905                         session_path = "";
2906                         session_name = "";
2907                         session_dialog.clear_given ();
2908                 }
2909                 
2910                 if (should_be_new || session_name.empty()) {
2911                         /* need the dialog to get info from user */
2912
2913                         cerr << "run dialog\n";
2914
2915                         switch (session_dialog.run()) {
2916                         case RESPONSE_ACCEPT:
2917                                 break;
2918                         default:
2919                                 if (quit_on_cancel) {
2920                                         // JE - Currently (July 2014) this section can only get reached if the
2921                                         // user quits from the main 'Session Setup' dialog (i.e. reaching this
2922                                         // point does NOT indicate an abnormal termination). Therefore, let's
2923                                         // behave gracefully (i.e. let's do some cleanup) before we call exit()
2924                                         ARDOUR::cleanup ();
2925                                         pthread_cancel_all ();
2926
2927                                         exit (1);
2928                                 } else {
2929                                         return ret;
2930                                 }
2931                         }
2932
2933                         session_dialog.hide ();
2934                 }
2935
2936                 /* if we run the startup dialog again, offer more than just "new session" */
2937                 
2938                 should_be_new = false;
2939                 
2940                 session_name = session_dialog.session_name (likely_new);
2941                 session_path = session_dialog.session_folder ();
2942
2943                 if (nsm) {
2944                         likely_new = true;
2945                 }
2946
2947                 string::size_type suffix = session_name.find (statefile_suffix);
2948                 
2949                 if (suffix != string::npos) {
2950                         session_name = session_name.substr (0, suffix);
2951                 }
2952                 
2953                 /* this shouldn't happen, but we catch it just in case it does */
2954                 
2955                 if (session_name.empty()) {
2956                         continue;
2957                 }
2958                 
2959                 if (session_dialog.use_session_template()) {
2960                         template_name = session_dialog.session_template_name();
2961                         _session_is_new = true;
2962                 }
2963                 
2964                 if (session_name[0] == G_DIR_SEPARATOR ||
2965 #ifdef PLATFORM_WINDOWS
2966                     (session_name.length() > 3 && session_name[1] == ':' && session_name[2] == G_DIR_SEPARATOR)
2967 #else
2968                     (session_name.length() > 2 && session_name[0] == '.' && session_name[1] == G_DIR_SEPARATOR) ||
2969                     (session_name.length() > 3 && session_name[0] == '.' && session_name[1] == '.' && session_name[2] == G_DIR_SEPARATOR)
2970 #endif
2971                          )
2972                 {
2973                         
2974                         /* absolute path or cwd-relative path specified for session name: infer session folder
2975                            from what was given.
2976                         */
2977                         
2978                         session_path = Glib::path_get_dirname (session_name);
2979                         session_name = Glib::path_get_basename (session_name);
2980                         
2981                 } else {
2982
2983                         session_path = session_dialog.session_folder();
2984                         
2985                         char illegal = Session::session_name_is_legal (session_name);
2986                         
2987                         if (illegal) {
2988                                 MessageDialog msg (session_dialog,
2989                                                    string_compose (_("To ensure compatibility with various systems\n"
2990                                                                      "session names may not contain a '%1' character"),
2991                                                                    illegal));
2992                                 msg.run ();
2993                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2994                                 continue;
2995                         }
2996                 }
2997         
2998                 if (Glib::file_test (session_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))) {
2999
3000
3001                         if (likely_new && !nsm) {
3002
3003                                 std::string existing = Glib::build_filename (session_path, session_name);
3004
3005                                 if (!ask_about_loading_existing_session (existing)) {
3006                                         ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
3007                                         continue;
3008                                 }
3009                         }
3010
3011                         _session_is_new = false;
3012
3013                 } else {
3014
3015                         if (!likely_new) {
3016                                 pop_back_splash (session_dialog);
3017                                 MessageDialog msg (string_compose (_("There is no existing session at \"%1\""), session_path));
3018                                 msg.run ();
3019                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
3020                                 continue;
3021                         }
3022
3023                         char illegal = Session::session_name_is_legal(session_name);
3024
3025                         if (illegal) {
3026                                 pop_back_splash (session_dialog);
3027                                 MessageDialog msg (session_dialog, string_compose(_("To ensure compatibility with various systems\n"
3028                                                                                     "session names may not contain a '%1' character"), illegal));
3029                                 msg.run ();
3030                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
3031                                 continue;
3032                         }
3033
3034                         _session_is_new = true;
3035                 }
3036
3037                 if (likely_new && template_name.empty()) {
3038
3039                         ret = build_session_from_dialog (session_dialog, session_path, session_name);
3040
3041                 } else {
3042
3043                         ret = load_session (session_path, session_name, template_name);
3044
3045                         if (ret == -2) {
3046                                 /* not connected to the AudioEngine, so quit to avoid an infinite loop */
3047                                 exit (1);
3048                         }
3049
3050                         if (!ARDOUR_COMMAND_LINE::immediate_save.empty()) {
3051                                 _session->save_state (ARDOUR_COMMAND_LINE::immediate_save, false);
3052                                 exit (1);
3053                         }
3054
3055                         /* clear this to avoid endless attempts to load the
3056                            same session.
3057                         */
3058
3059                         ARDOUR_COMMAND_LINE::session_name = "";
3060                 }
3061         }
3062
3063         return ret;
3064 }
3065
3066 void
3067 ARDOUR_UI::close_session()
3068 {
3069         if (!check_audioengine()) {
3070                 return;
3071         }
3072
3073         if (unload_session (true)) {
3074                 return;
3075         }
3076
3077         ARDOUR_COMMAND_LINE::session_name = "";
3078
3079         if (get_session_parameters (true, false)) {
3080                 exit (1);
3081         }
3082
3083         goto_editor_window ();
3084 }
3085
3086 /** @param snap_name Snapshot name (without .ardour suffix).
3087  *  @return -2 if the load failed because we are not connected to the AudioEngine.
3088  */
3089 int
3090 ARDOUR_UI::load_session (const std::string& path, const std::string& snap_name, std::string mix_template)
3091 {
3092         Session *new_session;
3093         int unload_status;
3094         int retval = -1;
3095
3096         if (_session) {
3097                 unload_status = unload_session ();
3098                 
3099                 if (unload_status < 0) {
3100                         goto out;
3101                 } else if (unload_status > 0) {
3102                         retval = 0;
3103                         goto out;
3104                 }
3105         }
3106
3107         session_loaded = false;
3108
3109         loading_message (string_compose (_("Please wait while %1 loads your session"), PROGRAM_NAME));
3110
3111         try {
3112                 new_session = new Session (*AudioEngine::instance(), path, snap_name, 0, mix_template);
3113         }
3114
3115         /* this one is special */
3116
3117         catch (AudioEngine::PortRegistrationFailure& err) {
3118
3119                 MessageDialog msg (err.what(),
3120                                    true,
3121                                    Gtk::MESSAGE_INFO,
3122                                    Gtk::BUTTONS_CLOSE);
3123
3124                 msg.set_title (_("Port Registration Error"));
3125                 msg.set_secondary_text (_("Click the Close button to try again."));
3126                 msg.set_position (Gtk::WIN_POS_CENTER);
3127                 pop_back_splash (msg);
3128                 msg.present ();
3129
3130                 int response = msg.run ();
3131
3132                 msg.hide ();
3133
3134                 switch (response) {
3135                 case RESPONSE_CANCEL:
3136                         exit (1);
3137                 default:
3138                         break;
3139                 }
3140                 goto out;
3141         }
3142
3143         catch (...) {
3144
3145                 MessageDialog msg (string_compose(
3146                                            _("Session \"%1 (snapshot %2)\" did not load successfully"),
3147                                            path, snap_name),
3148                                    true,
3149                                    Gtk::MESSAGE_INFO,
3150                                    BUTTONS_OK);
3151
3152                 msg.set_title (_("Loading Error"));
3153                 msg.set_position (Gtk::WIN_POS_CENTER);
3154                 pop_back_splash (msg);
3155                 msg.present ();
3156                 (void) msg.run ();
3157                 msg.hide ();
3158
3159                 goto out;
3160         }
3161
3162         {
3163                 list<string> const u = new_session->unknown_processors ();
3164                 if (!u.empty()) {
3165                         MissingPluginDialog d (_session, u);
3166                         d.run ();
3167                 }
3168         }
3169
3170         if (!new_session->writable()) {
3171                 MessageDialog msg (_("This session has been opened in read-only mode.\n\nYou will not be able to record or save."),
3172                                    true,
3173                                    Gtk::MESSAGE_INFO,
3174                                    BUTTONS_OK);
3175
3176                 msg.set_title (_("Read-only Session"));
3177                 msg.set_position (Gtk::WIN_POS_CENTER);
3178                 pop_back_splash (msg);
3179                 msg.present ();
3180                 (void) msg.run ();
3181                 msg.hide ();
3182         }
3183         
3184
3185         /* Now the session been created, add the transport controls */
3186         new_session->add_controllable(roll_controllable);
3187         new_session->add_controllable(stop_controllable);
3188         new_session->add_controllable(goto_start_controllable);
3189         new_session->add_controllable(goto_end_controllable);
3190         new_session->add_controllable(auto_loop_controllable);
3191         new_session->add_controllable(play_selection_controllable);
3192         new_session->add_controllable(rec_controllable);
3193
3194         set_session (new_session);
3195
3196         session_loaded = true;
3197
3198         goto_editor_window ();
3199
3200         if (_session) {
3201                 _session->set_clean ();
3202         }
3203
3204 #ifdef WINDOWS_VST_SUPPORT
3205         fst_stop_threading();
3206 #endif
3207
3208         flush_pending ();
3209
3210 #ifdef WINDOWS_VST_SUPPORT
3211         fst_start_threading();
3212 #endif
3213         retval = 0;
3214
3215   out:
3216         return retval;
3217 }
3218
3219 int
3220 ARDOUR_UI::build_session (const std::string& path, const std::string& snap_name, BusProfile& bus_profile)
3221 {
3222         Session *new_session;
3223         int x;
3224
3225         session_loaded = false;
3226         x = unload_session ();
3227
3228         if (x < 0) {
3229                 return -1;
3230         } else if (x > 0) {
3231                 return 0;
3232         }
3233
3234         _session_is_new = true;
3235
3236         try {
3237                 new_session = new Session (*AudioEngine::instance(), path, snap_name, &bus_profile);
3238         }
3239
3240         catch (...) {
3241
3242                 MessageDialog msg (string_compose(_("Could not create session in \"%1\""), path));
3243                 pop_back_splash (msg);
3244                 msg.run ();
3245                 return -1;
3246         }
3247
3248         /* Give the new session the default GUI state, if such things exist */
3249
3250         XMLNode* n;
3251         n = Config->instant_xml (X_("Editor"));
3252         if (n) {
3253                 n->remove_nodes_and_delete ("Selection"); // no not apply selection to new sessions.
3254                 new_session->add_instant_xml (*n, false);
3255         }
3256         n = Config->instant_xml (X_("Mixer"));
3257         if (n) {
3258                 new_session->add_instant_xml (*n, false);
3259         }
3260
3261         /* Put the playhead at 0 and scroll fully left */
3262         n = new_session->instant_xml (X_("Editor"));
3263         if (n) {
3264                 n->add_property (X_("playhead"), X_("0"));
3265                 n->add_property (X_("left-frame"), X_("0"));
3266         }
3267
3268         set_session (new_session);
3269
3270         session_loaded = true;
3271
3272         new_session->save_state(new_session->name());
3273
3274         return 0;
3275 }
3276
3277 void
3278 ARDOUR_UI::launch_chat ()
3279 {
3280 #ifdef __APPLE__
3281         open_uri("http://webchat.freenode.net/?channels=ardour-osx");
3282 #elif defined PLATFORM_WINDOWS
3283         open_uri("http://webchat.freenode.net/?channels=ardour-windows");
3284 #else
3285         open_uri("http://webchat.freenode.net/?channels=ardour");
3286 #endif
3287 }
3288
3289 void
3290 ARDOUR_UI::launch_manual ()
3291 {
3292         PBD::open_uri (Config->get_tutorial_manual_url());
3293 }
3294
3295 void
3296 ARDOUR_UI::launch_reference ()
3297 {
3298         PBD::open_uri (Config->get_reference_manual_url());
3299 }
3300
3301 void
3302 ARDOUR_UI::launch_tracker ()
3303 {
3304         PBD::open_uri ("http://tracker.ardour.org/bug_report_page.php");
3305 }
3306
3307 void
3308 ARDOUR_UI::launch_subscribe ()
3309 {
3310         PBD::open_uri ("https://community.ardour.org/s/subscribe");
3311 }
3312
3313 void
3314 ARDOUR_UI::launch_cheat_sheet ()
3315 {
3316 #ifdef __APPLE__
3317         PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheat_sheet_osx.pdf");
3318 #else
3319         PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheatsheet.pdf");
3320 #endif
3321 }
3322
3323 void
3324 ARDOUR_UI::launch_website ()
3325 {
3326         PBD::open_uri ("http://ardour.org");
3327 }
3328
3329 void
3330 ARDOUR_UI::launch_website_dev ()
3331 {
3332         PBD::open_uri ("http://ardour.org/development.html");
3333 }
3334
3335 void
3336 ARDOUR_UI::launch_forums ()
3337 {
3338         PBD::open_uri ("https://community.ardour.org/forums");
3339 }
3340
3341 void
3342 ARDOUR_UI::launch_howto_report ()
3343 {
3344         PBD::open_uri ("http://ardour.org/reporting_bugs");
3345 }
3346
3347 void
3348 ARDOUR_UI::loading_message (const std::string& msg)
3349 {
3350         if (ARDOUR_COMMAND_LINE::no_splash) {
3351                 return;
3352         }
3353
3354         if (!splash) {
3355                 show_splash ();
3356         }
3357
3358         splash->message (msg);
3359 }
3360
3361 void
3362 ARDOUR_UI::show_splash ()
3363 {
3364         if (splash == 0) {
3365                 try {
3366                         splash = new Splash;
3367                 } catch (...) {
3368                         return;
3369                 }
3370         }
3371
3372         splash->display ();
3373 }
3374
3375 void
3376 ARDOUR_UI::hide_splash ()
3377 {
3378         delete splash;
3379         splash = 0;
3380 }
3381
3382 void
3383 ARDOUR_UI::display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete)
3384 {
3385         size_t removed;
3386
3387         removed = rep.paths.size();
3388
3389         if (removed == 0) {
3390                 MessageDialog msgd (*editor,
3391                                     _("No files were ready for clean-up"),
3392                                     true,
3393                                     Gtk::MESSAGE_INFO,
3394                                     Gtk::BUTTONS_OK);
3395                 msgd.set_title (_("Clean-up"));
3396                 msgd.set_secondary_text (_("If this seems suprising, \n\
3397 check for any existing snapshots.\n\
3398 These may still include regions that\n\
3399 require some unused files to continue to exist."));
3400
3401                 msgd.run ();
3402                 return;
3403         }
3404
3405         ArdourDialog results (_("Clean-up"), true, false);
3406
3407         struct CleanupResultsModelColumns : public Gtk::TreeModel::ColumnRecord {
3408             CleanupResultsModelColumns() {
3409                     add (visible_name);
3410                     add (fullpath);
3411             }
3412             Gtk::TreeModelColumn<std::string> visible_name;
3413             Gtk::TreeModelColumn<std::string> fullpath;
3414         };
3415
3416
3417         CleanupResultsModelColumns results_columns;
3418         Glib::RefPtr<Gtk::ListStore> results_model;
3419         Gtk::TreeView results_display;
3420
3421         results_model = ListStore::create (results_columns);
3422         results_display.set_model (results_model);
3423         results_display.append_column (list_title, results_columns.visible_name);
3424
3425         results_display.set_name ("CleanupResultsList");
3426         results_display.set_headers_visible (true);
3427         results_display.set_headers_clickable (false);
3428         results_display.set_reorderable (false);
3429
3430         Gtk::ScrolledWindow list_scroller;
3431         Gtk::Label txt;
3432         Gtk::VBox dvbox;
3433         Gtk::HBox dhbox;  // the hbox for the image and text
3434         Gtk::HBox ddhbox; // the hbox we eventually pack into the dialog's vbox
3435         Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_INFO,  Gtk::ICON_SIZE_DIALOG));
3436
3437         dimage->set_alignment(ALIGN_LEFT, ALIGN_TOP);
3438
3439         const string dead_directory = _session->session_directory().dead_path();
3440
3441         /* subst:
3442            %1 - number of files removed
3443            %2 - location of "dead"
3444            %3 - size of files affected
3445            %4 - prefix for "bytes" to produce sensible results (e.g. mega, kilo, giga)
3446         */
3447
3448         const char* bprefix;
3449         double space_adjusted = 0;
3450
3451         if (rep.space < 1000) {
3452                 bprefix = X_("");
3453                 space_adjusted = rep.space;
3454         } else if (rep.space < 1000000) {
3455                 bprefix = _("kilo");
3456                 space_adjusted = floorf((float)rep.space / 1000.0);
3457         } else if (rep.space < 1000000 * 1000) {
3458                 bprefix = _("mega");
3459                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000.0));
3460         } else {
3461                 bprefix = _("giga");
3462                 space_adjusted = floorf((float)rep.space / (1000.0 * 1000 * 1000.0));
3463         }
3464
3465         if (msg_delete) {
3466                 txt.set_markup (string_compose (P_("\
3467 The following file was deleted from %2,\n\
3468 releasing %3 %4bytes of disk space", "\
3469 The following %1 files were deleted from %2,\n\
3470 releasing %3 %4bytes of disk space", removed),
3471                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3472         } else {
3473                 txt.set_markup (string_compose (P_("\
3474 The following file was not in use and \n\
3475 has been moved to: %2\n\n\
3476 After a restart of %5\n\n\
3477 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3478 will release an additional %3 %4bytes of disk space.\n", "\
3479 The following %1 files were not in use and \n\
3480 have been moved to: %2\n\n\
3481 After a restart of %5\n\n\
3482 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3483 will release an additional %3 %4bytes of disk space.\n", removed),
3484                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3485         }
3486
3487         dhbox.pack_start (*dimage, true, false, 5);
3488         dhbox.pack_start (txt, true, false, 5);
3489
3490         for (vector<string>::iterator i = rep.paths.begin(); i != rep.paths.end(); ++i) {
3491                 TreeModel::Row row = *(results_model->append());
3492                 row[results_columns.visible_name] = *i;
3493                 row[results_columns.fullpath] = *i;
3494         }
3495
3496         list_scroller.add (results_display);
3497         list_scroller.set_size_request (-1, 150);
3498         list_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
3499
3500         dvbox.pack_start (dhbox, true, false, 5);
3501         dvbox.pack_start (list_scroller, true, false, 5);
3502         ddhbox.pack_start (dvbox, true, false, 5);
3503
3504         results.get_vbox()->pack_start (ddhbox, true, false, 5);
3505         results.add_button (Stock::CLOSE, RESPONSE_CLOSE);
3506         results.set_default_response (RESPONSE_CLOSE);
3507         results.set_position (Gtk::WIN_POS_MOUSE);
3508
3509         results_display.show();
3510         list_scroller.show();
3511         txt.show();
3512         dvbox.show();
3513         dhbox.show();
3514         ddhbox.show();
3515         dimage->show();
3516
3517         //results.get_vbox()->show();
3518         results.set_resizable (false);
3519
3520         results.run ();
3521
3522 }
3523
3524 void
3525 ARDOUR_UI::cleanup ()
3526 {
3527         if (_session == 0) {
3528                 /* shouldn't happen: menu item is insensitive */
3529                 return;
3530         }
3531
3532
3533         MessageDialog checker (_("Are you sure you want to clean-up?"),
3534                                 true,
3535                                 Gtk::MESSAGE_QUESTION,
3536                                 Gtk::BUTTONS_NONE);
3537
3538         checker.set_title (_("Clean-up"));
3539
3540         checker.set_secondary_text(_("Clean-up is a destructive operation.\n\
3541 ALL undo/redo information will be lost if you clean-up.\n\
3542 Clean-up will move all unused files to a \"dead\" location."));
3543
3544         checker.add_button (Stock::CANCEL, RESPONSE_CANCEL);
3545         checker.add_button (_("Clean-up"), RESPONSE_ACCEPT);
3546         checker.set_default_response (RESPONSE_CANCEL);
3547
3548         checker.set_name (_("CleanupDialog"));
3549         checker.set_wmclass (X_("ardour_cleanup"), PROGRAM_NAME);
3550         checker.set_position (Gtk::WIN_POS_MOUSE);
3551
3552         switch (checker.run()) {
3553         case RESPONSE_ACCEPT:
3554                 break;
3555         default:
3556                 return;
3557         }
3558
3559         ARDOUR::CleanupReport rep;
3560
3561         editor->prepare_for_cleanup ();
3562
3563         /* do not allow flush until a session is reloaded */
3564
3565         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Main"), X_("FlushWastebasket"));
3566         if (act) {
3567                 act->set_sensitive (false);
3568         }
3569
3570         if (_session->cleanup_sources (rep)) {
3571                 editor->finish_cleanup ();
3572                 return;
3573         }
3574
3575         editor->finish_cleanup ();
3576
3577         checker.hide();
3578         display_cleanup_results (rep, _("Cleaned Files"), false);
3579 }
3580
3581 void
3582 ARDOUR_UI::flush_trash ()
3583 {
3584         if (_session == 0) {
3585                 /* shouldn't happen: menu item is insensitive */
3586                 return;
3587         }
3588
3589         ARDOUR::CleanupReport rep;
3590
3591         if (_session->cleanup_trash_sources (rep)) {
3592                 return;
3593         }
3594
3595         display_cleanup_results (rep, _("deleted file"), true);
3596 }
3597
3598 void
3599 ARDOUR_UI::setup_order_hint (AddRouteDialog::InsertAt place)
3600 {
3601         uint32_t order_hint = UINT32_MAX;
3602
3603         if (editor->get_selection().tracks.empty()) {
3604                 return;
3605         }
3606         
3607         /*
3608           we want the new routes to have their order keys set starting from 
3609           the highest order key in the selection + 1 (if available).
3610         */
3611         
3612         if (place == AddRouteDialog::AfterSelection) {
3613                 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.back());
3614                 if (rtav) {
3615                         order_hint = rtav->route()->order_key();
3616                         order_hint++;
3617                 }
3618         } else if (place == AddRouteDialog::BeforeSelection) {
3619                 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.front());
3620                 if (rtav) {
3621                         order_hint = rtav->route()->order_key();
3622                 }
3623         } else if (place == AddRouteDialog::First) {
3624                 order_hint = 0;
3625         } else {
3626                 /* leave order_hint at UINT32_MAX */
3627         }
3628
3629         if (order_hint == UINT32_MAX) {
3630                 /** AddRouteDialog::Last or selection with first/last not a RouteTimeAxisView
3631                  * not setting an order hint will place new routes last.
3632                  */
3633                 return;
3634         }
3635
3636         _session->set_order_hint (order_hint);
3637
3638         /* create a gap in the existing route order keys to accomodate new routes.*/
3639         boost::shared_ptr <RouteList> rd = _session->get_routes();
3640         for (RouteList::iterator ri = rd->begin(); ri != rd->end(); ++ri) {
3641                 boost::shared_ptr<Route> rt (*ri);
3642
3643                 if (rt->is_monitor()) {
3644                         continue;
3645                 }
3646
3647                 if (rt->order_key () >= order_hint) {
3648                         rt->set_order_key (rt->order_key () + add_route_dialog->count());
3649                 }
3650         }
3651 }
3652
3653 void
3654 ARDOUR_UI::add_route (Gtk::Window* /* ignored */)
3655 {
3656         int count;
3657
3658         if (!_session) {
3659                 return;
3660         }
3661
3662         if (add_route_dialog->is_visible()) {
3663                 /* we're already doing this */
3664                 return;
3665         }
3666
3667         ResponseType r = (ResponseType) add_route_dialog->run ();
3668
3669         add_route_dialog->hide();
3670
3671         switch (r) {
3672                 case RESPONSE_ACCEPT:
3673                         break;
3674                 default:
3675                         return;
3676                         break;
3677         }
3678
3679         if ((count = add_route_dialog->count()) <= 0) {
3680                 return;
3681         }
3682
3683         setup_order_hint(add_route_dialog->insert_at());
3684
3685         string template_path = add_route_dialog->track_template();
3686         DisplaySuspender ds;
3687
3688         if (!template_path.empty()) {
3689                 if (add_route_dialog->name_template_is_default())  {
3690                         _session->new_route_from_template (count, template_path, string());
3691                 } else {
3692                         _session->new_route_from_template (count, template_path, add_route_dialog->name_template());
3693                 }
3694                 return;
3695         }
3696
3697         ChanCount input_chan= add_route_dialog->channels ();
3698         ChanCount output_chan;
3699         string name_template = add_route_dialog->name_template ();
3700         PluginInfoPtr instrument = add_route_dialog->requested_instrument ();
3701         RouteGroup* route_group = add_route_dialog->route_group ();
3702         AutoConnectOption oac = Config->get_output_auto_connect();
3703
3704         if (oac & AutoConnectMaster) {
3705                 output_chan.set (DataType::AUDIO, (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan.n_audio()));
3706                 output_chan.set (DataType::MIDI, 0);
3707         } else {
3708                 output_chan = input_chan;
3709         }
3710
3711         /* XXX do something with name template */
3712
3713         switch (add_route_dialog->type_wanted()) {
3714         case AddRouteDialog::AudioTrack:
3715                 session_add_audio_track (input_chan.n_audio(), output_chan.n_audio(), add_route_dialog->mode(), route_group, count, name_template);
3716                 break;
3717         case AddRouteDialog::MidiTrack:
3718                 session_add_midi_track (route_group, count, name_template, instrument);
3719                 break;
3720         case AddRouteDialog::MixedTrack:
3721                 session_add_mixed_track (input_chan, output_chan, route_group, count, name_template, instrument);
3722                 break;
3723         case AddRouteDialog::AudioBus:
3724                 session_add_audio_bus (input_chan.n_audio(), output_chan.n_audio(), route_group, count, name_template);
3725                 break;
3726         }
3727 }
3728
3729 void
3730 ARDOUR_UI::stop_video_server (bool ask_confirm)
3731 {
3732         if (!video_server_process && ask_confirm) {
3733                 warning << string_compose (_("Video-Server was not launched by %1. The request to stop it is ignored."), PROGRAM_NAME) << endmsg;
3734         }
3735         if (video_server_process) {
3736                 if(ask_confirm) {
3737                         ArdourDialog confirm (_("Stop Video-Server"), true);
3738                         Label m (_("Do you really want to stop the Video Server?"));
3739                         confirm.get_vbox()->pack_start (m, true, true);
3740                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
3741                         confirm.add_button (_("Yes, Stop It"), Gtk::RESPONSE_ACCEPT);
3742                         confirm.show_all ();
3743                         if (confirm.run() == RESPONSE_CANCEL) {
3744                                 return;
3745                         }
3746                 }
3747                 delete video_server_process;
3748                 video_server_process =0;
3749         }
3750 }
3751
3752 void
3753 ARDOUR_UI::start_video_server_menu (Gtk::Window* float_window)
3754 {
3755   ARDOUR_UI::start_video_server( float_window, true);
3756 }
3757
3758 bool
3759 ARDOUR_UI::start_video_server (Gtk::Window* float_window, bool popup_msg)
3760 {
3761         if (!_session) {
3762                 return false;
3763         }
3764         if (popup_msg) {
3765                 if (ARDOUR_UI::instance()->video_timeline->check_server()) {
3766                         if (video_server_process) {
3767                                 popup_error(_("The Video Server is already started."));
3768                         } else {
3769                                 popup_error(_("An external Video Server is configured and can be reached. Not starting a new instance."));
3770                         }
3771                 }
3772         }
3773
3774         int firsttime = 0;
3775         while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3776                 if (firsttime++) {
3777                         warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
3778                 }
3779                 VideoServerDialog *video_server_dialog = new VideoServerDialog (_session);
3780                 if (float_window) {
3781                         video_server_dialog->set_transient_for (*float_window);
3782                 }
3783
3784                 if (!Config->get_show_video_server_dialog() && firsttime < 2) {
3785                         video_server_dialog->hide();
3786                 } else {
3787                         ResponseType r = (ResponseType) video_server_dialog->run ();
3788                         video_server_dialog->hide();
3789                         if (r != RESPONSE_ACCEPT) { return false; }
3790                         if (video_server_dialog->show_again()) {
3791                                 Config->set_show_video_server_dialog(false);
3792                         }
3793                 }
3794
3795                 std::string icsd_exec = video_server_dialog->get_exec_path();
3796                 std::string icsd_docroot = video_server_dialog->get_docroot();
3797                 if (icsd_docroot.empty()) {
3798 #ifndef PLATFORM_WINDOWS
3799                         icsd_docroot = X_("/");
3800 #else
3801                         icsd_docroot = X_("C:\\");
3802 #endif
3803                 }
3804
3805                 GStatBuf sb;
3806                 if (g_lstat (icsd_docroot.c_str(), &sb) != 0 || !S_ISDIR(sb.st_mode)) {
3807                         warning << _("Specified docroot is not an existing directory.") << endmsg;
3808                         continue;
3809                 }
3810 #ifndef PLATFORM_WINDOWS
3811                 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
3812                      || (sb.st_mode & (S_IXUSR|S_IXGRP|S_IXOTH)) == 0 ) {
3813                         warning << _("Given Video Server is not an executable file.") << endmsg;
3814                         continue;
3815                 }
3816 #else
3817                 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
3818                      || (sb.st_mode & (S_IXUSR)) == 0 ) {
3819                         warning << _("Given Video Server is not an executable file.") << endmsg;
3820                         continue;
3821                 }
3822 #endif
3823
3824                 char **argp;
3825                 argp=(char**) calloc(9,sizeof(char*));
3826                 argp[0] = strdup(icsd_exec.c_str());
3827                 argp[1] = strdup("-P");
3828                 argp[2] = (char*) calloc(16,sizeof(char)); snprintf(argp[2], 16, "%s", video_server_dialog->get_listenaddr().c_str());
3829                 argp[3] = strdup("-p");
3830                 argp[4] = (char*) calloc(6,sizeof(char)); snprintf(argp[4], 6, "%i", video_server_dialog->get_listenport());
3831                 argp[5] = strdup("-C");
3832                 argp[6] = (char*) calloc(6,sizeof(char)); snprintf(argp[6], 6, "%i", video_server_dialog->get_cachesize());
3833                 argp[7] = strdup(icsd_docroot.c_str());
3834                 argp[8] = 0;
3835                 stop_video_server();
3836
3837                 if (icsd_docroot == X_("/") || icsd_docroot == X_("C:\\")) {
3838                         Config->set_video_advanced_setup(false);
3839                 } else {
3840                         std::ostringstream osstream;
3841                         osstream << "http://localhost:" << video_server_dialog->get_listenport() << "/";
3842                         Config->set_video_server_url(osstream.str());
3843                         Config->set_video_server_docroot(icsd_docroot);
3844                         Config->set_video_advanced_setup(true);
3845                 }
3846
3847                 if (video_server_process) {
3848                         delete video_server_process;
3849                 }
3850
3851                 video_server_process = new ARDOUR::SystemExec(icsd_exec, argp);
3852                 if (video_server_process->start()) {
3853                         warning << _("Cannot launch the video-server") << endmsg;
3854                         continue;
3855                 }
3856                 int timeout = 120; // 6 sec
3857                 while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3858                         Glib::usleep (50000);
3859                         gui_idle_handler();
3860                         if (--timeout <= 0 || !video_server_process->is_running()) break;
3861                 }
3862                 if (timeout <= 0) {
3863                         warning << _("Video-server was started but does not respond to requests...") << endmsg;
3864                 } else {
3865                         if (!ARDOUR_UI::instance()->video_timeline->check_server_docroot()) {
3866                                 delete video_server_process;
3867                                 video_server_process = 0;
3868                         }
3869                 }
3870         }
3871         return true;
3872 }
3873
3874 void
3875 ARDOUR_UI::add_video (Gtk::Window* float_window)
3876 {
3877         if (!_session) {
3878                 return;
3879         }
3880
3881         if (!start_video_server(float_window, false)) {
3882                 warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
3883                 return;
3884         }
3885
3886         if (float_window) {
3887                 add_video_dialog->set_transient_for (*float_window);
3888         }
3889
3890         if (add_video_dialog->is_visible()) {
3891                 /* we're already doing this */
3892                 return;
3893         }
3894
3895         ResponseType r = (ResponseType) add_video_dialog->run ();
3896         add_video_dialog->hide();
3897         if (r != RESPONSE_ACCEPT) { return; }
3898
3899         bool local_file, orig_local_file;
3900         std::string path = add_video_dialog->file_name(local_file);
3901
3902         std::string orig_path = path;
3903         orig_local_file = local_file;
3904
3905         bool auto_set_session_fps = add_video_dialog->auto_set_session_fps();
3906
3907         if (local_file && !Glib::file_test(path, Glib::FILE_TEST_EXISTS)) {
3908                 warning << string_compose(_("could not open %1"), path) << endmsg;
3909                 return;
3910         }
3911         if (!local_file && path.length() == 0) {
3912                 warning << _("no video-file selected") << endmsg;
3913                 return;
3914         }
3915
3916         switch (add_video_dialog->import_option()) {
3917                 case VTL_IMPORT_TRANSCODE:
3918                         {
3919                                 TranscodeVideoDialog *transcode_video_dialog;
3920                                 transcode_video_dialog = new TranscodeVideoDialog (_session, path);
3921                                 ResponseType r = (ResponseType) transcode_video_dialog->run ();
3922                                 transcode_video_dialog->hide();
3923                                 if (r != RESPONSE_ACCEPT) {
3924                                         delete transcode_video_dialog;
3925                                         return;
3926                                 }
3927                                 if (!transcode_video_dialog->get_audiofile().empty()) {
3928                                         editor->embed_audio_from_video(
3929                                                         transcode_video_dialog->get_audiofile(),
3930                                                         video_timeline->get_offset(),
3931                                                         (transcode_video_dialog->import_option() != VTL_IMPORT_NO_VIDEO)
3932                                                         );
3933                                 }
3934                                 switch (transcode_video_dialog->import_option()) {
3935                                         case VTL_IMPORT_TRANSCODED:
3936                                                 path = transcode_video_dialog->get_filename();
3937                                                 local_file = true;
3938                                                 break;
3939                                         case VTL_IMPORT_REFERENCE:
3940                                                 break;
3941                                         default:
3942                                                 delete transcode_video_dialog;
3943                                                 return;
3944                                 }
3945                                 delete transcode_video_dialog;
3946                         }
3947                         break;
3948                 default:
3949                 case VTL_IMPORT_NONE:
3950                         break;
3951         }
3952
3953         /* strip _session->session_directory().video_path() from video file if possible */
3954         if (local_file && !path.compare(0, _session->session_directory().video_path().size(), _session->session_directory().video_path())) {
3955                  path=path.substr(_session->session_directory().video_path().size());
3956                  if (path.at(0) == G_DIR_SEPARATOR) {
3957                          path=path.substr(1);
3958                  }
3959         }
3960
3961         video_timeline->set_update_session_fps(auto_set_session_fps);
3962         if (video_timeline->video_file_info(path, local_file)) {
3963                 XMLNode* node = new XMLNode(X_("Videotimeline"));
3964                 node->add_property (X_("Filename"), path);
3965                 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
3966                 node->add_property (X_("LocalFile"), local_file?X_("1"):X_("0"));
3967                 if (orig_local_file) {
3968                         node->add_property (X_("OriginalVideoFile"), orig_path);
3969                 } else {
3970                         node->remove_property (X_("OriginalVideoFile"));
3971                 }
3972                 _session->add_extra_xml (*node);
3973                 _session->set_dirty ();
3974
3975                 _session->maybe_update_session_range(
3976                         std::max(video_timeline->get_offset(), (ARDOUR::frameoffset_t) 0),
3977                         std::max(video_timeline->get_offset() + video_timeline->get_duration(), (ARDOUR::frameoffset_t) 0));
3978
3979
3980                 if (add_video_dialog->launch_xjadeo() && local_file) {
3981                         editor->set_xjadeo_sensitive(true);
3982                         editor->toggle_xjadeo_proc(1);
3983                 } else {
3984                         editor->toggle_xjadeo_proc(0);
3985                 }
3986                 editor->toggle_ruler_video(true);
3987         }
3988 }
3989
3990 void
3991 ARDOUR_UI::remove_video ()
3992 {
3993         video_timeline->close_session();
3994         editor->toggle_ruler_video(false);
3995
3996         /* reset state */
3997         video_timeline->set_offset_locked(false);
3998         video_timeline->set_offset(0);
3999
4000         /* delete session state */
4001         XMLNode* node = new XMLNode(X_("Videotimeline"));
4002         _session->add_extra_xml(*node);
4003         node = new XMLNode(X_("Videomonitor"));
4004         _session->add_extra_xml(*node);
4005         node = new XMLNode(X_("Videoexport"));
4006         _session->add_extra_xml(*node);
4007         stop_video_server();
4008 }
4009
4010 void
4011 ARDOUR_UI::flush_videotimeline_cache (bool localcacheonly)
4012 {
4013         if (localcacheonly) {
4014                 video_timeline->vmon_update();
4015         } else {
4016                 video_timeline->flush_cache();
4017         }
4018         editor->queue_visual_videotimeline_update();
4019 }
4020
4021 void
4022 ARDOUR_UI::export_video (bool range)
4023 {
4024         if (ARDOUR::Config->get_show_video_export_info()) {
4025                 ExportVideoInfobox infobox (_session);
4026                 Gtk::ResponseType rv = (Gtk::ResponseType) infobox.run();
4027                 if (infobox.show_again()) {
4028                         ARDOUR::Config->set_show_video_export_info(false);
4029                 }
4030                 switch (rv) {
4031                         case GTK_RESPONSE_YES:
4032                                 PBD::open_uri (ARDOUR::Config->get_reference_manual_url() + "/video-timeline/operations/#export");
4033                                 break;
4034                         default:
4035                                 break;
4036                 }
4037         }
4038         export_video_dialog->set_session (_session);
4039         export_video_dialog->apply_state(editor->get_selection().time, range);
4040         export_video_dialog->run ();
4041         export_video_dialog->hide ();
4042 }
4043
4044 XMLNode*
4045 ARDOUR_UI::mixer_settings () const
4046 {
4047         XMLNode* node = 0;
4048
4049         if (_session) {
4050                 node = _session->instant_xml(X_("Mixer"));
4051         } else {
4052                 node = Config->instant_xml(X_("Mixer"));
4053         }
4054
4055         if (!node) {
4056                 node = new XMLNode (X_("Mixer"));
4057         }
4058
4059         return node;
4060 }
4061
4062 XMLNode*
4063 ARDOUR_UI::editor_settings () const
4064 {
4065         XMLNode* node = 0;
4066
4067         if (_session) {
4068                 node = _session->instant_xml(X_("Editor"));
4069         } else {
4070                 node = Config->instant_xml(X_("Editor"));
4071         }
4072
4073         if (!node) {
4074                 if (getenv("ARDOUR_INSTANT_XML_PATH")) {
4075                         node = Config->instant_xml(getenv("ARDOUR_INSTANT_XML_PATH"));
4076                 }
4077         }
4078
4079         if (!node) {
4080                 node = new XMLNode (X_("Editor"));
4081         }
4082
4083         return node;
4084 }
4085
4086 XMLNode*
4087 ARDOUR_UI::keyboard_settings () const
4088 {
4089         XMLNode* node = 0;
4090
4091         node = Config->extra_xml(X_("Keyboard"));
4092
4093         if (!node) {
4094                 node = new XMLNode (X_("Keyboard"));
4095         }
4096
4097         return node;
4098 }
4099
4100 void
4101 ARDOUR_UI::create_xrun_marker (framepos_t where)
4102 {
4103         if (_session) {
4104                 Location *location = new Location (*_session, where, where, _("xrun"), Location::IsMark);
4105                 _session->locations()->add (location);
4106         }
4107 }
4108
4109 void
4110 ARDOUR_UI::halt_on_xrun_message ()
4111 {
4112         cerr << "HALT on xrun\n";
4113         MessageDialog msg (*editor, _("Recording was stopped because your system could not keep up."));
4114         msg.run ();
4115 }
4116
4117 void
4118 ARDOUR_UI::xrun_handler (framepos_t where)
4119 {
4120         if (!_session) {
4121                 return;
4122         }
4123
4124         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::xrun_handler, where)
4125
4126         if (_session && Config->get_create_xrun_marker() && _session->actively_recording()) {
4127                 create_xrun_marker(where);
4128         }
4129
4130         if (_session && Config->get_stop_recording_on_xrun() && _session->actively_recording()) {
4131                 halt_on_xrun_message ();
4132         }
4133 }
4134
4135 void
4136 ARDOUR_UI::disk_overrun_handler ()
4137 {
4138         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_overrun_handler)
4139
4140         if (!have_disk_speed_dialog_displayed) {
4141                 have_disk_speed_dialog_displayed = true;
4142                 MessageDialog* msg = new MessageDialog (*editor, string_compose (_("\
4143 The disk system on your computer\n\
4144 was not able to keep up with %1.\n\
4145 \n\
4146 Specifically, it failed to write data to disk\n\
4147 quickly enough to keep up with recording.\n"), PROGRAM_NAME));
4148                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4149                 msg->show ();
4150         }
4151 }
4152
4153
4154 /* TODO: this is getting elaborate enough to warrant being split into a dedicated class */
4155 static MessageDialog *scan_dlg = NULL;
4156 static ProgressBar   *scan_pbar = NULL;
4157 static HBox          *scan_tbox = NULL;
4158
4159 void
4160 ARDOUR_UI::cancel_plugin_scan ()
4161 {
4162         PluginManager::instance().cancel_plugin_scan();
4163 }
4164
4165 void
4166 ARDOUR_UI::cancel_plugin_timeout ()
4167 {
4168         PluginManager::instance().cancel_plugin_timeout();
4169         scan_tbox->hide();
4170 }
4171
4172 void
4173 ARDOUR_UI::plugin_scan_timeout (int timeout)
4174 {
4175         if (!scan_dlg || !scan_dlg->is_mapped() || !scan_pbar) {
4176                 return;
4177         }
4178         if (timeout > 0) {
4179                 scan_pbar->set_fraction ((float) timeout / (float) Config->get_vst_scan_timeout());
4180                 scan_tbox->show();
4181         } else {
4182                 scan_tbox->hide();
4183         }
4184         gui_idle_handler();
4185 }
4186
4187 void
4188 ARDOUR_UI::plugin_scan_dialog (std::string type, std::string plugin, bool can_cancel)
4189 {
4190         if (type == X_("closeme") && !(scan_dlg && scan_dlg->is_mapped())) {
4191                 return;
4192         }
4193
4194         const bool cancelled = PluginManager::instance().cancelled();
4195         if (type != X_("closeme") && !ui_config->get_show_plugin_scan_window()) {
4196                 if (cancelled && scan_dlg->is_mapped()) {
4197                         scan_dlg->hide();
4198                         gui_idle_handler();
4199                         return;
4200                 }
4201                 if (cancelled || !can_cancel) {
4202                         return;
4203                 }
4204         }
4205
4206         static Gtk::Button *cancel_button;
4207         static Gtk::Button *timeout_button;
4208         if (!scan_dlg) {
4209                 scan_dlg = new MessageDialog("", false, MESSAGE_INFO, BUTTONS_NONE); // TODO manage
4210                 VBox* vbox = scan_dlg->get_vbox();
4211                 vbox->set_size_request(400,-1);
4212                 scan_dlg->set_title (_("Scanning for plugins"));
4213
4214                 cancel_button = manage(new Gtk::Button(_("Cancel plugin scan")));
4215                 cancel_button->set_name ("EditorGTKButton");
4216                 cancel_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_scan) );
4217                 cancel_button->show();
4218
4219                 scan_dlg->get_vbox()->pack_start ( *cancel_button, PACK_SHRINK);
4220
4221                 scan_tbox = manage( new HBox() );
4222
4223                 timeout_button = manage(new Gtk::Button(_("Stop Timeout")));
4224                 timeout_button->set_name ("EditorGTKButton");
4225                 timeout_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_timeout) );
4226                 timeout_button->show();
4227
4228                 scan_pbar = manage(new ProgressBar());
4229                 scan_pbar->set_orientation(Gtk::PROGRESS_RIGHT_TO_LEFT);
4230                 scan_pbar->set_text(_("Scan Timeout"));
4231                 scan_pbar->show();
4232
4233                 scan_tbox->pack_start (*scan_pbar, PACK_EXPAND_WIDGET, 4);
4234                 scan_tbox->pack_start (*timeout_button, PACK_SHRINK, 4);
4235
4236                 scan_dlg->get_vbox()->pack_start (*scan_tbox, PACK_SHRINK, 4);
4237         }
4238
4239         assert(scan_dlg && scan_tbox && cancel_button);
4240
4241         if (type == X_("closeme")) {
4242                 scan_dlg->hide();
4243         } else {
4244                 scan_dlg->set_message(type + ": " + Glib::path_get_basename(plugin));
4245                 scan_dlg->show();
4246         }
4247         if (!can_cancel || !cancelled) {
4248                 scan_tbox->hide();
4249         }
4250         cancel_button->set_sensitive(can_cancel && !cancelled);
4251
4252         gui_idle_handler();
4253 }
4254
4255 void
4256 ARDOUR_UI::gui_idle_handler ()
4257 {
4258         int timeout = 30;
4259         /* due to idle calls, gtk_events_pending() may always return true */
4260         while (gtk_events_pending() && --timeout) {
4261                 gtk_main_iteration ();
4262         }
4263 }
4264
4265 void
4266 ARDOUR_UI::disk_underrun_handler ()
4267 {
4268         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_underrun_handler)
4269
4270         if (!have_disk_speed_dialog_displayed) {
4271                 have_disk_speed_dialog_displayed = true;
4272                 MessageDialog* msg = new MessageDialog (
4273                         *editor, string_compose (_("The disk system on your computer\n\
4274 was not able to keep up with %1.\n\
4275 \n\
4276 Specifically, it failed to read data from disk\n\
4277 quickly enough to keep up with playback.\n"), PROGRAM_NAME));
4278                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4279                 msg->show ();
4280         }
4281 }
4282
4283 void
4284 ARDOUR_UI::disk_speed_dialog_gone (int /*ignored_response*/, MessageDialog* msg)
4285 {
4286         have_disk_speed_dialog_displayed = false;
4287         delete msg;
4288 }
4289
4290 void
4291 ARDOUR_UI::session_dialog (std::string msg)
4292 {
4293         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::session_dialog, msg)
4294
4295         MessageDialog* d;
4296
4297         if (editor) {
4298                 d = new MessageDialog (*editor, msg, false, MESSAGE_INFO, BUTTONS_OK, true);
4299         } else {
4300                 d = new MessageDialog (msg, false, MESSAGE_INFO, BUTTONS_OK, true);
4301         }
4302
4303         d->show_all ();
4304         d->run ();
4305         delete d;
4306 }
4307
4308 int
4309 ARDOUR_UI::pending_state_dialog ()
4310 {
4311         HBox* hbox = manage (new HBox());
4312         Image* image = manage (new Image (Stock::DIALOG_QUESTION, ICON_SIZE_DIALOG));
4313         ArdourDialog dialog (_("Crash Recovery"), true);
4314         Label  message (string_compose (_("\
4315 This session appears to have been in the\n\
4316 middle of recording when %1 or\n\
4317 the computer was shutdown.\n\
4318 \n\
4319 %1 can recover any captured audio for\n\
4320 you, or it can ignore it. Please decide\n\
4321 what you would like to do.\n"), PROGRAM_NAME));
4322         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4323         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4324         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4325         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4326         dialog.add_button (_("Ignore crash data"), RESPONSE_REJECT);
4327         dialog.add_button (_("Recover from crash"), RESPONSE_ACCEPT);
4328         dialog.set_default_response (RESPONSE_ACCEPT);
4329         dialog.set_position (WIN_POS_CENTER);
4330         message.show();
4331         image->show();
4332         hbox->show();
4333
4334         switch (dialog.run ()) {
4335         case RESPONSE_ACCEPT:
4336                 return 1;
4337         default:
4338                 return 0;
4339         }
4340 }
4341
4342 int
4343 ARDOUR_UI::sr_mismatch_dialog (framecnt_t desired, framecnt_t actual)
4344 {
4345         HBox* hbox = new HBox();
4346         Image* image = new Image (Stock::DIALOG_WARNING, ICON_SIZE_DIALOG);
4347         ArdourDialog dialog (_("Sample Rate Mismatch"), true);
4348         Label  message (string_compose (_("\
4349 This session was created with a sample rate of %1 Hz, but\n\
4350 %2 is currently running at %3 Hz.  If you load this session,\n\
4351 audio may be played at the wrong sample rate.\n"), desired, PROGRAM_NAME, actual));
4352
4353         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4354         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4355         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4356         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4357         dialog.add_button (_("Do not load session"), RESPONSE_REJECT);
4358         dialog.add_button (_("Load session anyway"), RESPONSE_ACCEPT);
4359         dialog.set_default_response (RESPONSE_ACCEPT);
4360         dialog.set_position (WIN_POS_CENTER);
4361         message.show();
4362         image->show();
4363         hbox->show();
4364
4365         switch (dialog.run()) {
4366         case RESPONSE_ACCEPT:
4367                 return 0;
4368         default:
4369                 break;
4370         }
4371
4372         return 1;
4373 }
4374
4375 int
4376 ARDOUR_UI::disconnect_from_engine ()
4377 {
4378         /* drop connection to AudioEngine::Halted so that we don't act
4379          *  as if the engine unexpectedly shut down
4380          */
4381
4382         halt_connection.disconnect ();
4383         
4384         if (AudioEngine::instance()->stop ()) {
4385                 MessageDialog msg (*editor, _("Could not disconnect from Audio/MIDI engine"));
4386                 msg.run ();
4387                 return -1;
4388         } else {
4389                 AudioEngine::instance()->Halted.connect_same_thread (halt_connection, boost::bind (&ARDOUR_UI::engine_halted, this, _1, false));
4390         }
4391         
4392         update_sample_rate (0);
4393         return 0;
4394 }
4395
4396 int
4397 ARDOUR_UI::reconnect_to_engine ()
4398 {
4399         if (AudioEngine::instance()->start ()) {
4400                 // TODO somehow make this the topmost window (above any dialogs currently visible)
4401                 if (editor) {
4402                         MessageDialog msg (*editor,  _("Could not reconnect to the Audio/MIDI engine"));
4403                         msg.run ();
4404                 } else {
4405                         MessageDialog msg (_("Could not reconnect to the Audio/MIDI engine"));
4406                         msg.run ();
4407                 }
4408                 return -1;
4409         }
4410         
4411         update_sample_rate (0);
4412         return 0;
4413 }
4414
4415 void
4416 ARDOUR_UI::use_config ()
4417 {
4418         XMLNode* node = Config->extra_xml (X_("TransportControllables"));
4419         if (node) {
4420                 set_transport_controllable_state (*node);
4421         }
4422 }
4423
4424 void
4425 ARDOUR_UI::update_transport_clocks (framepos_t pos)
4426 {
4427         if (ui_config->get_primary_clock_delta_edit_cursor()) {
4428                 primary_clock->set (pos, false, editor->get_preferred_edit_position (EDIT_IGNORE_PHEAD));
4429         } else {
4430                 primary_clock->set (pos);
4431         }
4432
4433         if (ui_config->get_secondary_clock_delta_edit_cursor()) {
4434                 secondary_clock->set (pos, false, editor->get_preferred_edit_position (EDIT_IGNORE_PHEAD));
4435         } else {
4436                 secondary_clock->set (pos);
4437         }
4438
4439         if (big_clock_window) {
4440                 big_clock->set (pos);
4441         }
4442         ARDOUR_UI::instance()->video_timeline->manual_seek_video_monitor(pos);
4443 }
4444
4445 void
4446 ARDOUR_UI::step_edit_status_change (bool yn)
4447 {
4448         // XXX should really store pre-step edit status of things
4449         // we make insensitive
4450
4451         if (yn) {
4452                 rec_button.set_active_state (Gtkmm2ext::ImplicitActive);
4453                 rec_button.set_sensitive (false);
4454         } else {
4455                 rec_button.unset_active_state ();;
4456                 rec_button.set_sensitive (true);
4457         }
4458 }
4459
4460 void
4461 ARDOUR_UI::record_state_changed ()
4462 {
4463         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::record_state_changed);
4464
4465         if (!_session || !big_clock_window) {
4466                 /* why bother - the clock isn't visible */
4467                 return;
4468         }
4469
4470         if (_session->record_status () == Session::Recording && _session->have_rec_enabled_track ()) {
4471                 big_clock->set_active (true);
4472         } else {
4473                 big_clock->set_active (false);
4474         }
4475 }
4476
4477 bool
4478 ARDOUR_UI::first_idle ()
4479 {
4480         if (_session) {
4481                 _session->allow_auto_play (true);
4482         }
4483
4484         if (editor) {
4485                 editor->first_idle();
4486         }
4487
4488         Keyboard::set_can_save_keybindings (true);
4489         return false;
4490 }
4491
4492 void
4493 ARDOUR_UI::store_clock_modes ()
4494 {
4495         XMLNode* node = new XMLNode(X_("ClockModes"));
4496
4497         for (vector<AudioClock*>::iterator x = AudioClock::clocks.begin(); x != AudioClock::clocks.end(); ++x) {
4498                 XMLNode* child = new XMLNode (X_("Clock"));
4499                 
4500                 child->add_property (X_("name"), (*x)->name());
4501                 child->add_property (X_("mode"), enum_2_string ((*x)->mode()));
4502                 child->add_property (X_("on"), ((*x)->off() ? X_("no") : X_("yes")));
4503
4504                 node->add_child_nocopy (*child);
4505         }
4506
4507         _session->add_extra_xml (*node);
4508         _session->set_dirty ();
4509 }
4510
4511 ARDOUR_UI::TransportControllable::TransportControllable (std::string name, ARDOUR_UI& u, ToggleType tp)
4512         : Controllable (name), ui (u), type(tp)
4513 {
4514
4515 }
4516
4517 void
4518 ARDOUR_UI::TransportControllable::set_value (double val)
4519 {
4520         if (val < 0.5) {
4521                 /* do nothing: these are radio-style actions */
4522                 return;
4523         }
4524
4525         const char *action = 0;
4526
4527         switch (type) {
4528         case Roll:
4529                 action = X_("Roll");
4530                 break;
4531         case Stop:
4532                 action = X_("Stop");
4533                 break;
4534         case GotoStart:
4535                 action = X_("GotoStart");
4536                 break;
4537         case GotoEnd:
4538                 action = X_("GotoEnd");
4539                 break;
4540         case AutoLoop:
4541                 action = X_("Loop");
4542                 break;
4543         case PlaySelection:
4544                 action = X_("PlaySelection");
4545                 break;
4546         case RecordEnable:
4547                 action = X_("Record");
4548                 break;
4549         default:
4550                 break;
4551         }
4552
4553         if (action == 0) {
4554                 return;
4555         }
4556
4557         Glib::RefPtr<Action> act = ActionManager::get_action ("Transport", action);
4558
4559         if (act) {
4560                 act->activate ();
4561         }
4562 }
4563
4564 double
4565 ARDOUR_UI::TransportControllable::get_value (void) const
4566 {
4567         float val = 0.0;
4568
4569         switch (type) {
4570         case Roll:
4571                 break;
4572         case Stop:
4573                 break;
4574         case GotoStart:
4575                 break;
4576         case GotoEnd:
4577                 break;
4578         case AutoLoop:
4579                 break;
4580         case PlaySelection:
4581                 break;
4582         case RecordEnable:
4583                 break;
4584         default:
4585                 break;
4586         }
4587
4588         return val;
4589 }
4590
4591 void
4592 ARDOUR_UI::setup_profile ()
4593 {
4594         if (gdk_screen_width() < 1200 || getenv ("ARDOUR_NARROW_SCREEN")) {
4595                 Profile->set_small_screen ();
4596         }
4597
4598         if (g_getenv ("ARDOUR_SAE")) {
4599                 Profile->set_sae ();
4600                 Profile->set_single_package ();
4601         }
4602
4603         if (g_getenv ("TRX")) {
4604                 Profile->set_trx ();
4605         }
4606
4607         if (g_getenv ("MIXBUS")) {
4608                 Profile->set_mixbus ();
4609         }
4610 }
4611
4612 int
4613 ARDOUR_UI::missing_file (Session*s, std::string str, DataType type)
4614 {
4615         MissingFileDialog dialog (s, str, type);
4616
4617         dialog.show ();
4618         dialog.present ();
4619
4620         int result = dialog.run ();
4621         dialog.hide ();
4622
4623         switch (result) {
4624         case RESPONSE_OK:
4625                 break;
4626         default:
4627                 return 1; // quit entire session load
4628         }
4629
4630         result = dialog.get_action ();
4631
4632         return result;
4633 }
4634
4635 int
4636 ARDOUR_UI::ambiguous_file (std::string file, std::vector<std::string> hits)
4637 {
4638         AmbiguousFileDialog dialog (file, hits);
4639
4640         dialog.show ();
4641         dialog.present ();
4642
4643         dialog.run ();
4644         return dialog.get_which ();
4645 }
4646
4647 /** Allocate our thread-local buffers */
4648 void
4649 ARDOUR_UI::get_process_buffers ()
4650 {
4651         _process_thread->get_buffers ();
4652 }
4653
4654 /** Drop our thread-local buffers */
4655 void
4656 ARDOUR_UI::drop_process_buffers ()
4657 {
4658         _process_thread->drop_buffers ();
4659 }
4660
4661 void
4662 ARDOUR_UI::feedback_detected ()
4663 {
4664         _feedback_exists = true;
4665 }
4666
4667 void
4668 ARDOUR_UI::successful_graph_sort ()
4669 {
4670         _feedback_exists = false;
4671 }
4672
4673 void
4674 ARDOUR_UI::midi_panic ()
4675 {
4676         if (_session) {
4677                 _session->midi_panic();
4678         }
4679 }
4680
4681 void
4682 ARDOUR_UI::session_format_mismatch (std::string xml_path, std::string backup_path)
4683 {
4684         const char* start_big = "<span size=\"x-large\" weight=\"bold\">";
4685         const char* end_big = "</span>";
4686         const char* start_mono = "<tt>";
4687         const char* end_mono = "</tt>";
4688
4689         MessageDialog msg (string_compose (_("%4This is a session from an older version of %3%5\n\n"
4690                                              "%3 has copied the old session file\n\n%6%1%7\n\nto\n\n%6%2%7\n\n"
4691                                              "From now on, use the -2000 version with older versions of %3"),
4692                                            xml_path, backup_path, PROGRAM_NAME,
4693                                            start_big, end_big,
4694                                            start_mono, end_mono), true);
4695
4696         msg.run ();
4697 }
4698
4699
4700 void
4701 ARDOUR_UI::reset_peak_display ()
4702 {
4703         if (!_session || !_session->master_out() || !editor_meter) return;
4704         editor_meter->clear_meters();
4705         editor_meter_max_peak = -INFINITY;
4706         editor_meter_peak_display.set_active_state ( Gtkmm2ext::Off );
4707 }
4708
4709 void
4710 ARDOUR_UI::reset_group_peak_display (RouteGroup* group)
4711 {
4712         if (!_session || !_session->master_out()) return;
4713         if (group == _session->master_out()->route_group()) {
4714                 reset_peak_display ();
4715         }
4716 }
4717
4718 void
4719 ARDOUR_UI::reset_route_peak_display (Route* route)
4720 {
4721         if (!_session || !_session->master_out()) return;
4722         if (_session->master_out().get() == route) {
4723                 reset_peak_display ();
4724         }
4725 }
4726
4727 int
4728 ARDOUR_UI::do_audio_midi_setup (uint32_t desired_sample_rate)
4729 {
4730         audio_midi_setup->set_desired_sample_rate (desired_sample_rate);
4731         audio_midi_setup->set_position (WIN_POS_CENTER);
4732
4733         switch (audio_midi_setup->run()) {
4734         case Gtk::RESPONSE_OK:
4735                 return 0;
4736         case Gtk::RESPONSE_APPLY:
4737                 return 0;
4738         default:
4739                 return -1;
4740         }
4741 }
4742
4743
4744 gint
4745 ARDOUR_UI::transport_numpad_timeout ()
4746 {
4747         _numpad_locate_happening = false;
4748         if (_numpad_timeout_connection.connected() )
4749                 _numpad_timeout_connection.disconnect();
4750         return 1;
4751 }
4752
4753 void
4754 ARDOUR_UI::transport_numpad_decimal ()
4755 {
4756         _numpad_timeout_connection.disconnect();
4757
4758         if (_numpad_locate_happening) {
4759                 if (editor) editor->goto_nth_marker(_pending_locate_num - 1);
4760                 _numpad_locate_happening = false;
4761         } else {
4762                 _pending_locate_num = 0;
4763                 _numpad_locate_happening = true;
4764                 _numpad_timeout_connection = Glib::signal_timeout().connect (mem_fun(*this, &ARDOUR_UI::transport_numpad_timeout), 2*1000);
4765         }
4766 }
4767
4768 void
4769 ARDOUR_UI::transport_numpad_event (int num)
4770 {
4771         if ( _numpad_locate_happening ) {
4772                 _pending_locate_num = _pending_locate_num*10 + num;
4773         } else {
4774                 switch (num) {          
4775                         case 0:  toggle_roll(false, false);             break;
4776                         case 1:  transport_rewind(1);                           break;
4777                         case 2:  transport_forward(1);                          break;
4778                         case 3:  transport_record(true);                        break;
4779                         case 4:  toggle_session_auto_loop();            break;
4780                         case 5:  transport_record(false); toggle_session_auto_loop();   break;
4781                         case 6:  toggle_punch();                                        break;
4782                         case 7:  toggle_click();                                break;
4783                         case 8:  toggle_auto_return();                  break;
4784                         case 9:  toggle_follow_edits();         break;
4785                 }
4786         }
4787 }
4788
4789 void
4790 ARDOUR_UI::set_flat_buttons ()
4791 {
4792         CairoWidget::set_flat_buttons( config()->get_flat_buttons() );
4793 }
4794
4795 void
4796 ARDOUR_UI::audioengine_became_silent ()
4797 {
4798         MessageDialog msg (string_compose (_("This is a free/demo copy of %1. It has just switched to silent mode."), PROGRAM_NAME),
4799                            true,
4800                            Gtk::MESSAGE_WARNING,
4801                            Gtk::BUTTONS_NONE,
4802                            true);
4803
4804         msg.set_title (string_compose (_("%1 is now silent"), PROGRAM_NAME));
4805
4806         Gtk::Label pay_label (string_compose (_("Please consider paying for a copy of %1 - you can pay whatever you want."), PROGRAM_NAME));
4807         Gtk::Label subscribe_label (_("Better yet become a subscriber - subscriptions start at US$1 per month."));
4808         Gtk::Button pay_button (_("Pay for a copy (via the web)"));
4809         Gtk::Button subscribe_button (_("Become a subscriber (via the web)"));
4810         Gtk::HBox pay_button_box;
4811         Gtk::HBox subscribe_button_box;
4812
4813         pay_button_box.pack_start (pay_button, true, false);
4814         subscribe_button_box.pack_start (subscribe_button, true, false);
4815
4816         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 */
4817         
4818         pay_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://ardour.org/download")));
4819         subscribe_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://community.ardour.org/s/subscribe")));
4820         
4821         msg.get_vbox()->pack_start (pay_label);
4822         msg.get_vbox()->pack_start (pay_button_box);
4823         msg.get_vbox()->pack_start (subscribe_label);
4824         msg.get_vbox()->pack_start (subscribe_button_box);
4825
4826         msg.get_vbox()->show_all ();
4827         
4828         msg.add_button (_("Remain silent"), Gtk::RESPONSE_CANCEL);
4829         msg.add_button (_("Save and quit"), Gtk::RESPONSE_NO);
4830         msg.add_button (_("Give me more time"), Gtk::RESPONSE_YES);
4831         
4832         int r = msg.run ();
4833
4834         switch (r) {
4835         case Gtk::RESPONSE_YES:
4836                 AudioEngine::instance()->reset_silence_countdown ();
4837                 break;
4838
4839         case Gtk::RESPONSE_NO:
4840                 /* save and quit */
4841                 save_state_canfail ("");
4842                 exit (0);
4843                 break;
4844
4845         case Gtk::RESPONSE_CANCEL:
4846         default:
4847                 /* don't reset, save session and exit */
4848                 break;
4849         }
4850 }