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