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