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