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