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