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