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