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