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