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