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