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