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