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