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