Fix portability of Session::source_search_path
[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));
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_zero_something_second_connection.disconnect();
907         }
908
909         delete ARDOUR_UI::instance()->video_timeline;
910         ARDOUR_UI::instance()->video_timeline = NULL;
911         stop_video_server();
912
913         /* Save state before deleting the session, as that causes some
914            windows to be destroyed before their visible state can be
915            saved.
916         */
917         save_ardour_state ();
918
919         close_all_dialogs ();
920
921         loading_message (string_compose (_("Please wait while %1 cleans up..."), PROGRAM_NAME));
922
923         if (_session) {
924                 // _session->set_deletion_in_progress ();
925                 _session->set_clean ();
926                 _session->remove_pending_capture_state ();
927                 delete _session;
928                 _session = 0;
929         }
930
931         engine->stop (true);
932         quit ();
933 }
934
935 int
936 ARDOUR_UI::ask_about_saving_session (const vector<string>& actions)
937 {
938         ArdourDialog window (_("Unsaved Session"));
939         Gtk::HBox dhbox;  // the hbox for the image and text
940         Gtk::Label  prompt_label;
941         Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_WARNING,  Gtk::ICON_SIZE_DIALOG));
942
943         string msg;
944
945         assert (actions.size() >= 3);
946
947         window.add_button (actions[0], RESPONSE_REJECT);
948         window.add_button (actions[1], RESPONSE_APPLY);
949         window.add_button (actions[2], RESPONSE_ACCEPT);
950
951         window.set_default_response (RESPONSE_ACCEPT);
952
953         Gtk::Button noquit_button (msg);
954         noquit_button.set_name ("EditorGTKButton");
955
956         string prompt;
957
958         if (_session->snap_name() == _session->name()) {
959                 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?"),
960                                         _session->snap_name());
961         } else {
962                 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?"),
963                                         _session->snap_name());
964         }
965
966         prompt_label.set_text (prompt);
967         prompt_label.set_name (X_("PrompterLabel"));
968         prompt_label.set_alignment(ALIGN_LEFT, ALIGN_TOP);
969
970         dimage->set_alignment(ALIGN_CENTER, ALIGN_TOP);
971         dhbox.set_homogeneous (false);
972         dhbox.pack_start (*dimage, false, false, 5);
973         dhbox.pack_start (prompt_label, true, false, 5);
974         window.get_vbox()->pack_start (dhbox);
975
976         window.set_name (_("Prompter"));
977         window.set_modal (true);
978         window.set_resizable (false);
979
980         dhbox.show();
981         prompt_label.show();
982         dimage->show();
983         window.show();
984         window.set_keep_above (true);
985         window.present ();
986
987         ResponseType r = (ResponseType) window.run();
988
989         window.hide ();
990
991         switch (r) {
992         case RESPONSE_ACCEPT: // save and get out of here
993                 return 1;
994         case RESPONSE_APPLY:  // get out of here
995                 return 0;
996         default:
997                 break;
998         }
999
1000         return -1;
1001 }
1002
1003
1004 gint
1005 ARDOUR_UI::every_second ()
1006 {
1007         update_cpu_load ();
1008         update_buffer_load ();
1009         update_disk_space ();
1010         update_timecode_format ();
1011
1012         if (nsm && nsm->is_active ()) {
1013                 nsm->check ();
1014
1015                 if (!_was_dirty && _session->dirty ()) {
1016                         nsm->is_dirty ();
1017                         _was_dirty = true;
1018                 }
1019                 else if (_was_dirty && !_session->dirty ()){
1020                         nsm->is_clean ();
1021                         _was_dirty = false;
1022                 }
1023         }
1024         return TRUE;
1025 }
1026
1027 gint
1028 ARDOUR_UI::every_point_one_seconds ()
1029 {
1030         shuttle_box->update_speed_display ();
1031         RapidScreenUpdate(); /* EMIT_SIGNAL */
1032         return TRUE;
1033 }
1034
1035 gint
1036 ARDOUR_UI::every_point_zero_something_seconds ()
1037 {
1038         // august 2007: actual update frequency: 25Hz (40ms), not 100Hz
1039
1040         SuperRapidScreenUpdate(); /* EMIT_SIGNAL */
1041         return TRUE;
1042 }
1043
1044 void
1045 ARDOUR_UI::update_sample_rate (framecnt_t)
1046 {
1047         char buf[64];
1048
1049         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::update_sample_rate, ignored)
1050
1051         if (!engine->connected()) {
1052
1053                 snprintf (buf, sizeof (buf), "%s", _("disconnected"));
1054
1055         } else {
1056
1057                 framecnt_t rate = engine->frame_rate();
1058
1059                 if (fmod (rate, 1000.0) != 0.0) {
1060                         snprintf (buf, sizeof (buf), _("JACK: <span foreground=\"green\">%.1f kHz / %4.1f ms</span>"),
1061                                   (float) rate/1000.0f,
1062                                   (engine->frames_per_cycle() / (float) rate) * 1000.0f);
1063                 } else {
1064                         snprintf (buf, sizeof (buf), _("JACK: <span foreground=\"green\">%" PRId64 " kHz / %4.1f ms</span>"),
1065                                   rate/1000,
1066                                   (engine->frames_per_cycle() / (float) rate) * 1000.0f);
1067                 }
1068         }
1069
1070         sample_rate_label.set_markup (buf);
1071 }
1072
1073 void
1074 ARDOUR_UI::update_format ()
1075 {
1076         if (!_session) {
1077                 format_label.set_text ("");
1078                 return;
1079         }
1080
1081         stringstream s;
1082         s << _("File:") << X_(" <span foreground=\"green\">");
1083
1084         switch (_session->config.get_native_file_header_format ()) {
1085         case BWF:
1086                 s << _("BWF");
1087                 break;
1088         case WAVE:
1089                 s << _("WAV");
1090                 break;
1091         case WAVE64:
1092                 s << _("WAV64");
1093                 break;
1094         case CAF:
1095                 s << _("CAF");
1096                 break;
1097         case AIFF:
1098                 s << _("AIFF");
1099                 break;
1100         case iXML:
1101                 s << _("iXML");
1102                 break;
1103         case RF64:
1104                 s << _("RF64");
1105                 break;
1106         }
1107
1108         s << " ";
1109         
1110         switch (_session->config.get_native_file_data_format ()) {
1111         case FormatFloat:
1112                 s << _("32-float");
1113                 break;
1114         case FormatInt24:
1115                 s << _("24-int");
1116                 break;
1117         case FormatInt16:
1118                 s << _("16-int");
1119                 break;
1120         }
1121
1122         s << X_("</span>");
1123
1124         format_label.set_markup (s.str ());
1125 }
1126
1127 void
1128 ARDOUR_UI::update_cpu_load ()
1129 {
1130         char buf[64];
1131
1132         /* If this text is changed, the set_size_request_to_display_given_text call in ARDOUR_UI::resize_text_widgets
1133            should also be changed.
1134         */
1135
1136         float const c = engine->get_cpu_load ();
1137         snprintf (buf, sizeof (buf), _("DSP: <span foreground=\"%s\">%5.1f%%</span>"), c >= 90 ? X_("red") : X_("green"), c);
1138         cpu_load_label.set_markup (buf);
1139 }
1140
1141 void
1142 ARDOUR_UI::update_buffer_load ()
1143 {
1144         char buf[256];
1145
1146         uint32_t const playback = _session ? _session->playback_load () : 100;
1147         uint32_t const capture = _session ? _session->capture_load () : 100;
1148
1149         /* If this text is changed, the set_size_request_to_display_given_text call in ARDOUR_UI::resize_text_widgets
1150            should also be changed.
1151         */
1152         
1153         if (_session) {
1154                 snprintf (
1155                         buf, sizeof (buf),
1156                         _("Buffers: <span foreground=\"green\">p:</span><span foreground=\"%s\">%" PRIu32 "%%</span> "
1157                                    "<span foreground=\"green\">c:</span><span foreground=\"%s\">%" PRIu32 "%%</span>"),
1158                         playback <= 5 ? X_("red") : X_("green"),
1159                         playback,
1160                         capture <= 5 ? X_("red") : X_("green"),
1161                         capture
1162                         );
1163
1164                 buffer_load_label.set_markup (buf);
1165         } else {
1166                 buffer_load_label.set_text ("");
1167         }
1168 }
1169
1170 void
1171 ARDOUR_UI::count_recenabled_streams (Route& route)
1172 {
1173         Track* track = dynamic_cast<Track*>(&route);
1174         if (track && track->record_enabled()) {
1175                 rec_enabled_streams += track->n_inputs().n_total();
1176         }
1177 }
1178
1179 void
1180 ARDOUR_UI::update_disk_space()
1181 {
1182         if (_session == 0) {
1183                 return;
1184         }
1185
1186         boost::optional<framecnt_t> opt_frames = _session->available_capture_duration();
1187         char buf[64];
1188         framecnt_t fr = _session->frame_rate();
1189
1190         if (!opt_frames) {
1191                 /* Available space is unknown */
1192                 snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">Unknown</span>"));
1193         } else if (opt_frames.get_value_or (0) == max_framecnt) {
1194                 snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">24hrs+</span>"));
1195         } else {
1196                 rec_enabled_streams = 0;
1197                 _session->foreach_route (this, &ARDOUR_UI::count_recenabled_streams);
1198
1199                 framecnt_t frames = opt_frames.get_value_or (0);
1200
1201                 if (rec_enabled_streams) {
1202                         frames /= rec_enabled_streams;
1203                 }
1204
1205                 int hrs;
1206                 int mins;
1207                 int secs;
1208
1209                 hrs  = frames / (fr * 3600);
1210
1211                 if (hrs > 24) {
1212                         snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">&gt;24 hrs</span>"));
1213                 } else {
1214                         frames -= hrs * fr * 3600;
1215                         mins = frames / (fr * 60);
1216                         frames -= mins * fr * 60;
1217                         secs = frames / fr;
1218                         
1219                         bool const low = (hrs == 0 && mins <= 30);
1220                         
1221                         snprintf (
1222                                 buf, sizeof(buf),
1223                                 _("Disk: <span foreground=\"%s\">%02dh:%02dm:%02ds</span>"),
1224                                 low ? X_("red") : X_("green"),
1225                                 hrs, mins, secs
1226                                 );
1227                 }
1228         }
1229
1230         disk_space_label.set_markup (buf);
1231 }
1232
1233 void
1234 ARDOUR_UI::update_timecode_format ()
1235 {
1236         char buf[64];
1237
1238         if (_session) {
1239                 bool matching;
1240                 TimecodeSlave* tcslave;
1241                 SyncSource sync_src = Config->get_sync_source();
1242
1243                 if ((sync_src == LTC || sync_src == MTC) && (tcslave = dynamic_cast<TimecodeSlave*>(_session->slave())) != 0) {
1244                         matching = (tcslave->apparent_timecode_format() == _session->config.get_timecode_format());
1245                 } else {
1246                         matching = true;
1247                 }
1248                         
1249                 snprintf (buf, sizeof (buf), S_("Timecode|TC: <span foreground=\"%s\">%s</span>"),
1250                           matching ? X_("green") : X_("red"),
1251                           Timecode::timecode_format_name (_session->config.get_timecode_format()).c_str());
1252         } else {
1253                 snprintf (buf, sizeof (buf), "TC: n/a");
1254         }
1255
1256         timecode_format_label.set_markup (buf);
1257 }       
1258
1259 gint
1260 ARDOUR_UI::update_wall_clock ()
1261 {
1262         time_t now;
1263         struct tm *tm_now;
1264         static int last_min = -1;
1265
1266         time (&now);
1267         tm_now = localtime (&now);
1268         if (last_min != tm_now->tm_min) {
1269                 char buf[16];
1270                 sprintf (buf, "%02d:%02d", tm_now->tm_hour, tm_now->tm_min);
1271                 wall_clock_label.set_text (buf);
1272                 last_min = tm_now->tm_min;
1273         }
1274
1275         return TRUE;
1276 }
1277
1278 void
1279 ARDOUR_UI::redisplay_recent_sessions ()
1280 {
1281         std::vector<std::string> session_directories;
1282         RecentSessionsSorter cmp;
1283
1284         recent_session_display.set_model (Glib::RefPtr<TreeModel>(0));
1285         recent_session_model->clear ();
1286
1287         ARDOUR::RecentSessions rs;
1288         ARDOUR::read_recent_sessions (rs);
1289
1290         if (rs.empty()) {
1291                 recent_session_display.set_model (recent_session_model);
1292                 return;
1293         }
1294
1295         // sort them alphabetically
1296         sort (rs.begin(), rs.end(), cmp);
1297
1298         for (ARDOUR::RecentSessions::iterator i = rs.begin(); i != rs.end(); ++i) {
1299                 session_directories.push_back ((*i).second);
1300         }
1301
1302         for (vector<std::string>::const_iterator i = session_directories.begin();
1303                         i != session_directories.end(); ++i)
1304         {
1305                 std::vector<std::string> state_file_paths;
1306
1307                 // now get available states for this session
1308
1309                 get_state_files_in_directory (*i, state_file_paths);
1310
1311                 vector<string*>* states;
1312                 vector<const gchar*> item;
1313                 string fullpath = *i;
1314
1315                 /* remove any trailing / */
1316
1317                 if (fullpath[fullpath.length() - 1] == '/') {
1318                         fullpath = fullpath.substr (0, fullpath.length() - 1);
1319                 }
1320
1321                 /* check whether session still exists */
1322                 if (!Glib::file_test(fullpath.c_str(), Glib::FILE_TEST_EXISTS)) {
1323                         /* session doesn't exist */
1324                         continue;
1325                 }
1326
1327                 /* now get available states for this session */
1328
1329                 if ((states = Session::possible_states (fullpath)) == 0) {
1330                         /* no state file? */
1331                         continue;
1332                 }
1333
1334                 std::vector<string> state_file_names(get_file_names_no_extension (state_file_paths));
1335
1336                 Gtk::TreeModel::Row row = *(recent_session_model->append());
1337
1338                 row[recent_session_columns.visible_name] = Glib::path_get_basename (fullpath);
1339                 row[recent_session_columns.fullpath] = fullpath;
1340                 row[recent_session_columns.tip] = Glib::Markup::escape_text (fullpath);
1341
1342                 if (state_file_names.size() > 1) {
1343
1344                         // add the children
1345
1346                         for (std::vector<std::string>::iterator i2 = state_file_names.begin();
1347                                         i2 != state_file_names.end(); ++i2)
1348                         {
1349
1350                                 Gtk::TreeModel::Row child_row = *(recent_session_model->append (row.children()));
1351
1352                                 child_row[recent_session_columns.visible_name] = *i2;
1353                                 child_row[recent_session_columns.fullpath] = fullpath;
1354                                 child_row[recent_session_columns.tip] = Glib::Markup::escape_text (fullpath);
1355                         }
1356                 }
1357         }
1358
1359         recent_session_display.set_tooltip_column(1); // recent_session_columns.tip
1360         recent_session_display.set_model (recent_session_model);
1361 }
1362
1363 void
1364 ARDOUR_UI::build_session_selector ()
1365 {
1366         session_selector_window = new ArdourDialog (_("Recent Sessions"));
1367
1368         Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow);
1369
1370         session_selector_window->add_button (Stock::CANCEL, RESPONSE_CANCEL);
1371         session_selector_window->add_button (Stock::OPEN, RESPONSE_ACCEPT);
1372         session_selector_window->set_default_response (RESPONSE_ACCEPT);
1373         recent_session_model = TreeStore::create (recent_session_columns);
1374         recent_session_display.set_model (recent_session_model);
1375         recent_session_display.append_column (_("Recent Sessions"), recent_session_columns.visible_name);
1376         recent_session_display.set_headers_visible (false);
1377         recent_session_display.get_selection()->set_mode (SELECTION_BROWSE);
1378         recent_session_display.signal_row_activated().connect (sigc::mem_fun (*this, &ARDOUR_UI::recent_session_row_activated));
1379
1380         scroller->add (recent_session_display);
1381         scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1382
1383         session_selector_window->set_name ("SessionSelectorWindow");
1384         session_selector_window->set_size_request (200, 400);
1385         session_selector_window->get_vbox()->pack_start (*scroller);
1386
1387         recent_session_display.show();
1388         scroller->show();
1389 }
1390
1391 void
1392 ARDOUR_UI::recent_session_row_activated (const TreePath& /*path*/, TreeViewColumn* /*col*/)
1393 {
1394         session_selector_window->response (RESPONSE_ACCEPT);
1395 }
1396
1397 void
1398 ARDOUR_UI::open_recent_session ()
1399 {
1400         bool can_return = (_session != 0);
1401
1402         if (session_selector_window == 0) {
1403                 build_session_selector ();
1404         }
1405
1406         redisplay_recent_sessions ();
1407
1408         while (true) {
1409
1410                 ResponseType r = (ResponseType) session_selector_window->run ();
1411
1412                 switch (r) {
1413                 case RESPONSE_ACCEPT:
1414                         break;
1415                 default:
1416                         if (can_return) {
1417                                 session_selector_window->hide();
1418                                 return;
1419                         } else {
1420                                 exit (1);
1421                         }
1422                 }
1423
1424                 if (recent_session_display.get_selection()->count_selected_rows() == 0) {
1425                         continue;
1426                 }
1427
1428                 session_selector_window->hide();
1429
1430                 Gtk::TreeModel::iterator i = recent_session_display.get_selection()->get_selected();
1431
1432                 if (i == recent_session_model->children().end()) {
1433                         return;
1434                 }
1435
1436                 std::string path = (*i)[recent_session_columns.fullpath];
1437                 std::string state = (*i)[recent_session_columns.visible_name];
1438
1439                 _session_is_new = false;
1440
1441                 if (load_session (path, state) == 0) {
1442                         break;
1443                 }
1444
1445                 can_return = false;
1446         }
1447 }
1448
1449 bool
1450 ARDOUR_UI::check_audioengine ()
1451 {
1452         if (engine) {
1453                 if (!engine->connected()) {
1454                         MessageDialog msg (string_compose (
1455                                                    _("%1 is not connected to JACK\n"
1456                                                      "You cannot open or close sessions in this condition"),
1457                                                    PROGRAM_NAME));
1458                         pop_back_splash (msg);
1459                         msg.run ();
1460                         return false;
1461                 }
1462                 return true;
1463         } else {
1464                 return false;
1465         }
1466 }
1467
1468 void
1469 ARDOUR_UI::open_session ()
1470 {
1471         if (!check_audioengine()) {
1472                 return;
1473
1474         }
1475
1476         /* popup selector window */
1477
1478         if (open_session_selector == 0) {
1479
1480                 /* ardour sessions are folders */
1481
1482                 open_session_selector = new Gtk::FileChooserDialog (_("Open Session"), FILE_CHOOSER_ACTION_OPEN);
1483                 open_session_selector->add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
1484                 open_session_selector->add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
1485                 open_session_selector->set_default_response(Gtk::RESPONSE_ACCEPT);
1486                 
1487                 if (_session) {
1488                         string session_parent_dir = Glib::path_get_dirname(_session->path());
1489                         string::size_type last_dir_sep = session_parent_dir.rfind(G_DIR_SEPARATOR);
1490                         session_parent_dir = session_parent_dir.substr(0, last_dir_sep);
1491                         open_session_selector->set_current_folder(session_parent_dir);
1492                 } else {
1493                         open_session_selector->set_current_folder(Config->get_default_session_parent_dir());
1494                 }
1495
1496                 open_session_selector->add_shortcut_folder (Config->get_default_session_parent_dir());
1497
1498                 FileFilter session_filter;
1499                 session_filter.add_pattern ("*.ardour");
1500                 session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
1501                 open_session_selector->add_filter (session_filter);
1502                 open_session_selector->set_filter (session_filter);
1503         }
1504
1505         int response = open_session_selector->run();
1506         open_session_selector->hide ();
1507
1508         switch (response) {
1509         case RESPONSE_ACCEPT:
1510                 break;
1511         default:
1512                 open_session_selector->hide();
1513                 return;
1514         }
1515
1516         open_session_selector->hide();
1517         string session_path = open_session_selector->get_filename();
1518         string path, name;
1519         bool isnew;
1520
1521         if (session_path.length() > 0) {
1522                 if (ARDOUR::find_session (session_path, path, name, isnew) == 0) {
1523                         _session_is_new = isnew;
1524                         load_session (path, name);
1525                 }
1526         }
1527 }
1528
1529
1530 void
1531 ARDOUR_UI::session_add_mixed_track (const ChanCount& input, const ChanCount& output, RouteGroup* route_group, 
1532                                     uint32_t how_many, const string& name_template, PluginInfoPtr instrument)
1533 {
1534         list<boost::shared_ptr<MidiTrack> > tracks;
1535
1536         if (_session == 0) {
1537                 warning << _("You cannot add a track without a session already loaded.") << endmsg;
1538                 return;
1539         }
1540
1541         try {
1542                 tracks = _session->new_midi_track (input, output, instrument, ARDOUR::Normal, route_group, how_many, name_template);
1543                 
1544                 if (tracks.size() != how_many) {
1545                         error << string_compose(P_("could not create %1 new mixed track", "could not create %1 new mixed tracks", how_many), how_many) << endmsg;
1546                 }
1547         }
1548
1549         catch (...) {
1550                 MessageDialog msg (*editor,
1551                                    string_compose (_("There are insufficient JACK ports available\n\
1552 to create a new track or bus.\n\
1553 You should save %1, exit and\n\
1554 restart JACK with more ports."), PROGRAM_NAME));
1555                 msg.run ();
1556         }
1557 }
1558         
1559
1560 void
1561 ARDOUR_UI::session_add_midi_route (bool disk, RouteGroup* route_group, uint32_t how_many, const string& name_template, PluginInfoPtr instrument)
1562 {
1563         ChanCount one_midi_channel;
1564         one_midi_channel.set (DataType::MIDI, 1);
1565
1566         if (disk) {
1567                 session_add_mixed_track (one_midi_channel, one_midi_channel, route_group, how_many, name_template, instrument);
1568         }
1569 }
1570
1571 void
1572 ARDOUR_UI::session_add_audio_route (
1573         bool track,
1574         int32_t input_channels,
1575         int32_t output_channels,
1576         ARDOUR::TrackMode mode,
1577         RouteGroup* route_group,
1578         uint32_t how_many,
1579         string const & name_template
1580         )
1581 {
1582         list<boost::shared_ptr<AudioTrack> > tracks;
1583         RouteList routes;
1584
1585         if (_session == 0) {
1586                 warning << _("You cannot add a track or bus without a session already loaded.") << endmsg;
1587                 return;
1588         }
1589
1590         try {
1591                 if (track) {
1592                         tracks = _session->new_audio_track (input_channels, output_channels, mode, route_group, how_many, name_template);
1593
1594                         if (tracks.size() != how_many) {
1595                                 error << string_compose (P_("could not create %1 new audio track", "could not create %1 new audio tracks", how_many), how_many) 
1596                                       << endmsg;
1597                         }
1598
1599                 } else {
1600
1601                         routes = _session->new_audio_route (input_channels, output_channels, route_group, how_many, name_template);
1602
1603                         if (routes.size() != how_many) {
1604                                 error << string_compose (P_("could not create %1 new audio bus", "could not create %1 new audio busses", how_many), how_many)
1605                                       << endmsg;
1606                         }
1607                 }
1608         }
1609
1610         catch (...) {
1611                 MessageDialog msg (*editor,
1612                                    string_compose (_("There are insufficient JACK ports available\n\
1613 to create a new track or bus.\n\
1614 You should save %1, exit and\n\
1615 restart JACK with more ports."), PROGRAM_NAME));
1616                 pop_back_splash (msg);
1617                 msg.run ();
1618         }
1619 }
1620
1621 void
1622 ARDOUR_UI::transport_goto_start ()
1623 {
1624         if (_session) {
1625                 _session->goto_start();
1626
1627                 /* force displayed area in editor to start no matter
1628                    what "follow playhead" setting is.
1629                 */
1630
1631                 if (editor) {
1632                         editor->center_screen (_session->current_start_frame ());
1633                 }
1634         }
1635 }
1636
1637 void
1638 ARDOUR_UI::transport_goto_zero ()
1639 {
1640         if (_session) {
1641                 _session->request_locate (0);
1642
1643                 /* force displayed area in editor to start no matter
1644                    what "follow playhead" setting is.
1645                 */
1646
1647                 if (editor) {
1648                         editor->reset_x_origin (0);
1649                 }
1650         }
1651 }
1652
1653 void
1654 ARDOUR_UI::transport_goto_wallclock ()
1655 {
1656         if (_session && editor) {
1657
1658                 time_t now;
1659                 struct tm tmnow;
1660                 framepos_t frames;
1661
1662                 time (&now);
1663                 localtime_r (&now, &tmnow);
1664
1665                 frames = tmnow.tm_hour * (60 * 60 * _session->frame_rate());
1666                 frames += tmnow.tm_min * (60 * _session->frame_rate());
1667                 frames += tmnow.tm_sec * _session->frame_rate();
1668
1669                 _session->request_locate (frames, _session->transport_rolling ());
1670
1671                 /* force displayed area in editor to start no matter
1672                    what "follow playhead" setting is.
1673                 */
1674
1675                 if (editor) {
1676                         editor->center_screen (frames);
1677                 }
1678         }
1679 }
1680
1681 void
1682 ARDOUR_UI::transport_goto_end ()
1683 {
1684         if (_session) {
1685                 framepos_t const frame = _session->current_end_frame();
1686                 _session->request_locate (frame);
1687
1688                 /* force displayed area in editor to start no matter
1689                    what "follow playhead" setting is.
1690                 */
1691
1692                 if (editor) {
1693                         editor->center_screen (frame);
1694                 }
1695         }
1696 }
1697
1698 void
1699 ARDOUR_UI::transport_stop ()
1700 {
1701         if (!_session) {
1702                 return;
1703         }
1704
1705         if (_session->is_auditioning()) {
1706                 _session->cancel_audition ();
1707                 return;
1708         }
1709
1710         _session->request_stop (false, true);
1711 }
1712
1713 void
1714 ARDOUR_UI::transport_record (bool roll)
1715 {
1716
1717         if (_session) {
1718                 switch (_session->record_status()) {
1719                 case Session::Disabled:
1720                         if (_session->ntracks() == 0) {
1721                                 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."));
1722                                 msg.run ();
1723                                 return;
1724                         }
1725                         _session->maybe_enable_record ();
1726                         if (roll) {
1727                                 transport_roll ();
1728                         }
1729                         break;
1730                 case Session::Recording:
1731                         if (roll) {
1732                                 _session->request_stop();
1733                         } else {
1734                                 _session->disable_record (false, true);
1735                         }
1736                         break;
1737
1738                 case Session::Enabled:
1739                         _session->disable_record (false, true);
1740                 }
1741         }
1742 }
1743
1744 void
1745 ARDOUR_UI::transport_roll ()
1746 {
1747         if (!_session) {
1748                 return;
1749         }
1750
1751         if (_session->is_auditioning()) {
1752                 return;
1753         }
1754
1755 #if 0
1756         if (_session->config.get_external_sync()) {
1757                 switch (Config->get_sync_source()) {
1758                 case JACK:
1759                         break;
1760                 default:
1761                         /* transport controlled by the master */
1762                         return;
1763                 }
1764         }
1765 #endif
1766
1767         bool rolling = _session->transport_rolling();
1768
1769         if (_session->get_play_loop()) {
1770                 /* XXX it is not possible to just leave seamless loop and keep
1771                    playing at present (nov 4th 2009)
1772                 */
1773                 if (!Config->get_seamless_loop()) {
1774                         _session->request_play_loop (false, true);
1775                 }
1776         } else if (_session->get_play_range () && !Config->get_always_play_range()) {
1777                 /* stop playing a range if we currently are */
1778                 _session->request_play_range (0, true);
1779         }
1780
1781         if (!rolling) {
1782                 _session->request_transport_speed (1.0f);
1783         }
1784 }
1785
1786 bool
1787 ARDOUR_UI::get_smart_mode() const
1788 {
1789         return ( editor->get_smart_mode() );
1790 }
1791
1792
1793 void
1794 ARDOUR_UI::toggle_roll (bool with_abort, bool roll_out_of_bounded_mode)
1795 {
1796
1797         if (!_session) {
1798                 return;
1799         }
1800
1801         if (_session->is_auditioning()) {
1802                 _session->cancel_audition ();
1803                 return;
1804         }
1805
1806         if (_session->config.get_external_sync()) {
1807                 switch (Config->get_sync_source()) {
1808                 case JACK:
1809                         break;
1810                 default:
1811                         /* transport controlled by the master */
1812                         return;
1813                 }
1814         }
1815
1816         bool rolling = _session->transport_rolling();
1817         bool affect_transport = true;
1818
1819         if (rolling && roll_out_of_bounded_mode) {
1820                 /* drop out of loop/range playback but leave transport rolling */
1821                 if (_session->get_play_loop()) {
1822                         if (Config->get_seamless_loop()) {
1823                                 /* the disk buffers contain copies of the loop - we can't
1824                                    just keep playing, so stop the transport. the user
1825                                    can restart as they wish.
1826                                 */
1827                                 affect_transport = true;
1828                         } else {
1829                                 /* disk buffers are normal, so we can keep playing */
1830                                 affect_transport = false;
1831                         }
1832                         _session->request_play_loop (false, true);
1833                 } else if (_session->get_play_range ()) {
1834                         affect_transport = false;
1835                         _session->request_play_range (0, true);
1836                 }
1837         }
1838
1839         if (affect_transport) {
1840                 if (rolling) {
1841                         _session->request_stop (with_abort, true);
1842                 } else {
1843                         if ( Config->get_always_play_range() ) {
1844                                 _session->request_play_range (&editor->get_selection().time, true);
1845                         }
1846
1847                         _session->request_transport_speed (1.0f);
1848                 }
1849         }
1850 }
1851
1852 void
1853 ARDOUR_UI::toggle_session_auto_loop ()
1854 {
1855         Location * looploc = _session->locations()->auto_loop_location();
1856
1857         if (!_session || !looploc) {
1858                 return;
1859         }
1860
1861         if (_session->get_play_loop()) {
1862
1863                 if (_session->transport_rolling()) {
1864
1865                         _session->request_locate (looploc->start(), true);
1866                         _session->request_play_loop (false);
1867
1868                 } else {
1869                         _session->request_play_loop (false);
1870                 }
1871         } else {
1872                 _session->request_play_loop (true);
1873         }
1874         
1875         //show the loop markers
1876         looploc->set_hidden (false, this);
1877 }
1878
1879 void
1880 ARDOUR_UI::transport_play_selection ()
1881 {
1882         if (!_session) {
1883                 return;
1884         }
1885
1886         editor->play_selection ();
1887 }
1888
1889 void
1890 ARDOUR_UI::transport_play_preroll ()
1891 {
1892         if (!_session) {
1893                 return;
1894         }
1895         editor->play_with_preroll ();
1896 }
1897
1898 void
1899 ARDOUR_UI::transport_rewind (int option)
1900 {
1901         float current_transport_speed;
1902
1903         if (_session) {
1904                 current_transport_speed = _session->transport_speed();
1905
1906                 if (current_transport_speed >= 0.0f) {
1907                         switch (option) {
1908                         case 0:
1909                                 _session->request_transport_speed (-1.0f);
1910                                 break;
1911                         case 1:
1912                                 _session->request_transport_speed (-4.0f);
1913                                 break;
1914                         case -1:
1915                                 _session->request_transport_speed (-0.5f);
1916                                 break;
1917                         }
1918                 } else {
1919                         /* speed up */
1920                         _session->request_transport_speed (current_transport_speed * 1.5f);
1921                 }
1922         }
1923 }
1924
1925 void
1926 ARDOUR_UI::transport_forward (int option)
1927 {
1928         if (!_session) {
1929                 return;
1930         }
1931         
1932         float current_transport_speed = _session->transport_speed();
1933         
1934         if (current_transport_speed <= 0.0f) {
1935                 switch (option) {
1936                 case 0:
1937                         _session->request_transport_speed (1.0f);
1938                         break;
1939                 case 1:
1940                         _session->request_transport_speed (4.0f);
1941                         break;
1942                 case -1:
1943                         _session->request_transport_speed (0.5f);
1944                         break;
1945                 }
1946         } else {
1947                 /* speed up */
1948                 _session->request_transport_speed (current_transport_speed * 1.5f);
1949         }
1950 }
1951
1952 void
1953 ARDOUR_UI::toggle_record_enable (uint32_t rid)
1954 {
1955         if (!_session) {
1956                 return;
1957         }
1958
1959         boost::shared_ptr<Route> r;
1960
1961         if ((r = _session->route_by_remote_id (rid)) != 0) {
1962
1963                 Track* t;
1964
1965                 if ((t = dynamic_cast<Track*>(r.get())) != 0) {
1966                         t->set_record_enabled (!t->record_enabled(), this);
1967                 }
1968         }
1969 }
1970
1971 void
1972 ARDOUR_UI::map_transport_state ()
1973 {
1974         if (!_session) {
1975                 auto_loop_button.unset_active_state ();
1976                 play_selection_button.unset_active_state ();
1977                 roll_button.unset_active_state ();
1978                 stop_button.set_active_state (Gtkmm2ext::ExplicitActive);
1979                 return;
1980         }
1981
1982         shuttle_box->map_transport_state ();
1983
1984         float sp = _session->transport_speed();
1985
1986         if (sp != 0.0f) {
1987
1988                 /* we're rolling */
1989
1990                 if (_session->get_play_range()) {
1991
1992                         play_selection_button.set_active_state (Gtkmm2ext::ExplicitActive);
1993                         roll_button.unset_active_state ();
1994                         auto_loop_button.unset_active_state ();
1995
1996                 } else if (_session->get_play_loop ()) {
1997
1998                         auto_loop_button.set_active (true);
1999                         play_selection_button.set_active (false);
2000                         roll_button.set_active (false);
2001
2002                 } else {
2003
2004                         roll_button.set_active (true);
2005                         play_selection_button.set_active (false);
2006                         auto_loop_button.set_active (false);
2007                 }
2008
2009                 if (Config->get_always_play_range()) {
2010                         /* light up both roll and play-selection if they are joined */
2011                         roll_button.set_active (true);
2012                         play_selection_button.set_active (true);
2013                 }
2014
2015                 stop_button.set_active (false);
2016
2017         } else {
2018
2019                 stop_button.set_active (true);
2020                 roll_button.set_active (false);
2021                 play_selection_button.set_active (false);
2022                 auto_loop_button.set_active (false);
2023                 update_disk_space ();
2024         }
2025 }
2026
2027 void
2028 ARDOUR_UI::engine_stopped ()
2029 {
2030         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::engine_stopped)
2031         ActionManager::set_sensitive (ActionManager::jack_sensitive_actions, false);
2032         ActionManager::set_sensitive (ActionManager::jack_opposite_sensitive_actions, true);
2033 }
2034
2035 void
2036 ARDOUR_UI::engine_running ()
2037 {
2038         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::engine_running)
2039         ActionManager::set_sensitive (ActionManager::jack_sensitive_actions, true);
2040         ActionManager::set_sensitive (ActionManager::jack_opposite_sensitive_actions, false);
2041
2042         Glib::RefPtr<Action> action;
2043         const char* action_name = 0;
2044
2045         switch (engine->frames_per_cycle()) {
2046         case 32:
2047                 action_name = X_("JACKLatency32");
2048                 break;
2049         case 64:
2050                 action_name = X_("JACKLatency64");
2051                 break;
2052         case 128:
2053                 action_name = X_("JACKLatency128");
2054                 break;
2055         case 512:
2056                 action_name = X_("JACKLatency512");
2057                 break;
2058         case 1024:
2059                 action_name = X_("JACKLatency1024");
2060                 break;
2061         case 2048:
2062                 action_name = X_("JACKLatency2048");
2063                 break;
2064         case 4096:
2065                 action_name = X_("JACKLatency4096");
2066                 break;
2067         case 8192:
2068                 action_name = X_("JACKLatency8192");
2069                 break;
2070         default:
2071                 /* XXX can we do anything useful ? */
2072                 break;
2073         }
2074
2075         if (action_name) {
2076
2077                 action = ActionManager::get_action (X_("JACK"), action_name);
2078
2079                 if (action) {
2080                         Glib::RefPtr<RadioAction> ract = Glib::RefPtr<RadioAction>::cast_dynamic (action);
2081                         ract->set_active ();
2082                 }
2083         }
2084 }
2085
2086 void
2087 ARDOUR_UI::engine_halted (const char* reason, bool free_reason)
2088 {
2089         if (!Gtkmm2ext::UI::instance()->caller_is_ui_thread()) {
2090                 /* we can't rely on the original string continuing to exist when we are called
2091                    again in the GUI thread, so make a copy and note that we need to
2092                    free it later.
2093                 */
2094                 char *copy = strdup (reason);
2095                 Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&ARDOUR_UI::engine_halted, this, copy, true));
2096                 return;
2097         }
2098
2099         ActionManager::set_sensitive (ActionManager::jack_sensitive_actions, false);
2100         ActionManager::set_sensitive (ActionManager::jack_opposite_sensitive_actions, true);
2101
2102         update_sample_rate (0);
2103
2104         string msgstr;
2105
2106         /* if the reason is a non-empty string, it means that the backend was shutdown
2107            rather than just Ardour.
2108         */
2109
2110         if (strlen (reason)) {
2111                 msgstr = string_compose (_("The audio backend (JACK) was shutdown because:\n\n%1"), reason);
2112         } else {
2113                 msgstr = string_compose (_("\
2114 JACK has either been shutdown or it\n\
2115 disconnected %1 because %1\n\
2116 was not fast enough. Try to restart\n\
2117 JACK, reconnect and save the session."), PROGRAM_NAME);
2118         }
2119
2120         MessageDialog msg (*editor, msgstr);
2121         pop_back_splash (msg);
2122         msg.set_keep_above (true);
2123         msg.run ();
2124         
2125         if (free_reason) {
2126                 free (const_cast<char*> (reason));
2127         }
2128 }
2129
2130 int32_t
2131 ARDOUR_UI::do_engine_start ()
2132 {
2133         try {
2134                 engine->start();
2135         }
2136
2137         catch (...) {
2138                 engine->stop ();
2139                 error << _("Unable to start the session running")
2140                       << endmsg;
2141                 unload_session ();
2142                 return -2;
2143         }
2144
2145         return 0;
2146 }
2147
2148 void
2149 ARDOUR_UI::update_clocks ()
2150 {
2151         if (!editor || !editor->dragging_playhead()) {
2152                 Clock (_session->audible_frame(), false, editor->get_preferred_edit_position()); /* EMIT_SIGNAL */
2153         }
2154 }
2155
2156 void
2157 ARDOUR_UI::start_clocking ()
2158 {
2159         if (Config->get_super_rapid_clock_update()) {
2160                 clock_signal_connection = SuperRapidScreenUpdate.connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2161         } else {
2162                 clock_signal_connection = RapidScreenUpdate.connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2163         }
2164 }
2165
2166 void
2167 ARDOUR_UI::stop_clocking ()
2168 {
2169         clock_signal_connection.disconnect ();
2170 }
2171
2172 gint
2173 ARDOUR_UI::_blink (void *arg)
2174 {
2175         ((ARDOUR_UI *) arg)->blink ();
2176         return TRUE;
2177 }
2178
2179 void
2180 ARDOUR_UI::blink ()
2181 {
2182         Blink (blink_on = !blink_on); /* EMIT_SIGNAL */
2183 }
2184
2185 void
2186 ARDOUR_UI::start_blinking ()
2187 {
2188         /* Start the blink signal. Everybody with a blinking widget
2189            uses Blink to drive the widget's state.
2190         */
2191
2192         if (blink_timeout_tag < 0) {
2193                 blink_on = false;
2194                 blink_timeout_tag = g_timeout_add (240, _blink, this);
2195         }
2196 }
2197
2198 void
2199 ARDOUR_UI::stop_blinking ()
2200 {
2201         if (blink_timeout_tag >= 0) {
2202                 g_source_remove (blink_timeout_tag);
2203                 blink_timeout_tag = -1;
2204         }
2205 }
2206
2207
2208 /** Ask the user for the name of a new snapshot and then take it.
2209  */
2210
2211 void
2212 ARDOUR_UI::snapshot_session (bool switch_to_it)
2213 {
2214         ArdourPrompter prompter (true);
2215         string snapname;
2216
2217         prompter.set_name ("Prompter");
2218         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2219         prompter.set_title (_("Take Snapshot"));
2220         prompter.set_prompt (_("Name of new snapshot"));
2221
2222         if (!switch_to_it) {
2223                 char timebuf[128];
2224                 time_t n;
2225                 struct tm local_time;
2226
2227                 time (&n);
2228                 localtime_r (&n, &local_time);
2229                 strftime (timebuf, sizeof(timebuf), "%FT%H.%M.%S", &local_time);
2230                 prompter.set_initial_text (timebuf);
2231         }
2232
2233   again:
2234         switch (prompter.run()) {
2235         case RESPONSE_ACCEPT:
2236         {
2237                 prompter.get_result (snapname);
2238
2239                 bool do_save = (snapname.length() != 0);
2240
2241                 if (do_save) {
2242                         char illegal = Session::session_name_is_legal(snapname);
2243                         if (illegal) {
2244                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2245                                                      "snapshot names may not contain a '%1' character"), illegal));
2246                                 msg.run ();
2247                                 goto again;
2248                         }
2249                 }
2250
2251                 vector<std::string> p;
2252                 get_state_files_in_directory (_session->session_directory().root_path(), p);
2253                 vector<string> n = get_file_names_no_extension (p);
2254                 if (find (n.begin(), n.end(), snapname) != n.end()) {
2255
2256                         ArdourDialog confirm (_("Confirm Snapshot Overwrite"), true);
2257                         Label m (_("A snapshot already exists with that name.  Do you want to overwrite it?"));
2258                         confirm.get_vbox()->pack_start (m, true, true);
2259                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
2260                         confirm.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
2261                         confirm.show_all ();
2262                         switch (confirm.run()) {
2263                         case RESPONSE_CANCEL:
2264                                 do_save = false;
2265                         }
2266                 }
2267
2268                 if (do_save) {
2269                         save_state (snapname, switch_to_it);
2270                 }
2271                 break;
2272         }
2273
2274         default:
2275                 break;
2276         }
2277 }
2278
2279 /** Ask the user for a new session name and then rename the session to it.
2280  */
2281
2282 void
2283 ARDOUR_UI::rename_session ()
2284 {
2285         if (!_session) {
2286                 return;
2287         }
2288
2289         ArdourPrompter prompter (true);
2290         string name;
2291
2292         prompter.set_name ("Prompter");
2293         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2294         prompter.set_title (_("Rename Session"));
2295         prompter.set_prompt (_("New session name"));
2296
2297   again:
2298         switch (prompter.run()) {
2299         case RESPONSE_ACCEPT:
2300         {
2301                 prompter.get_result (name);
2302
2303                 bool do_rename = (name.length() != 0);
2304
2305                 if (do_rename) {
2306                         char illegal = Session::session_name_is_legal (name);
2307
2308                         if (illegal) {
2309                                 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2310                                                                      "session names may not contain a '%1' character"), illegal));
2311                                 msg.run ();
2312                                 goto again;
2313                         }
2314
2315                         switch (_session->rename (name)) {
2316                         case -1: {
2317                                 MessageDialog msg (_("That name is already in use by another directory/folder. Please try again."));
2318                                 msg.set_position (WIN_POS_MOUSE);
2319                                 msg.run ();
2320                                 goto again;
2321                                 break;
2322                         }
2323                         case 0:
2324                                 break;
2325                         default: {
2326                                 MessageDialog msg (_("Renaming this session failed.\nThings could be seriously messed up at this point"));
2327                                 msg.set_position (WIN_POS_MOUSE);
2328                                 msg.run ();
2329                                 break;
2330                         }
2331                         }
2332                 }
2333                 
2334                 break;
2335         }
2336
2337         default:
2338                 break;
2339         }
2340 }
2341
2342 void
2343 ARDOUR_UI::save_state (const string & name, bool switch_to_it)
2344 {
2345         XMLNode* node = new XMLNode (X_("UI"));
2346
2347         WM::Manager::instance().add_state (*node);
2348
2349         node->add_child_nocopy (gui_object_state->get_state());
2350
2351         _session->add_extra_xml (*node);
2352
2353         save_state_canfail (name, switch_to_it);
2354 }
2355
2356 int
2357 ARDOUR_UI::save_state_canfail (string name, bool switch_to_it)
2358 {
2359         if (_session) {
2360                 int ret;
2361
2362                 if (name.length() == 0) {
2363                         name = _session->snap_name();
2364                 }
2365
2366                 if ((ret = _session->save_state (name, false, switch_to_it)) != 0) {
2367                         return ret;
2368                 }
2369         }
2370
2371         save_ardour_state (); /* XXX cannot fail? yeah, right ... */
2372         return 0;
2373 }
2374
2375 void
2376 ARDOUR_UI::primary_clock_value_changed ()
2377 {
2378         if (_session) {
2379                 _session->request_locate (primary_clock->current_time ());
2380         }
2381 }
2382
2383 void
2384 ARDOUR_UI::big_clock_value_changed ()
2385 {
2386         if (_session) {
2387                 _session->request_locate (big_clock->current_time ());
2388         }
2389 }
2390
2391 void
2392 ARDOUR_UI::secondary_clock_value_changed ()
2393 {
2394         if (_session) {
2395                 _session->request_locate (secondary_clock->current_time ());
2396         }
2397 }
2398
2399 void
2400 ARDOUR_UI::transport_rec_enable_blink (bool onoff)
2401 {
2402         if (_session == 0) {
2403                 return;
2404         }
2405
2406         if (_session->step_editing()) {
2407                 return;
2408         }
2409
2410         Session::RecordState const r = _session->record_status ();
2411         bool const h = _session->have_rec_enabled_track ();
2412
2413         if (r == Session::Enabled || (r == Session::Recording && !h)) {
2414                 if (onoff) {
2415                         rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2416                 } else {
2417                         rec_button.set_active_state (Gtkmm2ext::ImplicitActive);
2418                 }
2419         } else if (r == Session::Recording && h) {
2420                 rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2421         } else {
2422                 rec_button.unset_active_state ();
2423         }
2424 }
2425
2426 void
2427 ARDOUR_UI::save_template ()
2428 {
2429         ArdourPrompter prompter (true);
2430         string name;
2431
2432         if (!check_audioengine()) {
2433                 return;
2434         }
2435
2436         prompter.set_name (X_("Prompter"));
2437         prompter.set_title (_("Save Template"));
2438         prompter.set_prompt (_("Name for template:"));
2439         prompter.set_initial_text(_session->name() + _("-template"));
2440         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2441
2442         switch (prompter.run()) {
2443         case RESPONSE_ACCEPT:
2444                 prompter.get_result (name);
2445
2446                 if (name.length()) {
2447                         _session->save_template (name);
2448                 }
2449                 break;
2450
2451         default:
2452                 break;
2453         }
2454 }
2455
2456 void
2457 ARDOUR_UI::edit_metadata ()
2458 {
2459         SessionMetadataEditor dialog;
2460         dialog.set_session (_session);
2461         editor->ensure_float (dialog);
2462         dialog.run ();
2463 }
2464
2465 void
2466 ARDOUR_UI::import_metadata ()
2467 {
2468         SessionMetadataImporter dialog;
2469         dialog.set_session (_session);
2470         editor->ensure_float (dialog);
2471         dialog.run ();
2472 }
2473
2474 bool
2475 ARDOUR_UI::ask_about_loading_existing_session (const std::string& session_path)
2476 {
2477         std::string str = string_compose (_("This session\n%1\nalready exists. Do you want to open it?"), session_path);
2478
2479         MessageDialog msg (str,
2480                            false,
2481                            Gtk::MESSAGE_WARNING,
2482                            Gtk::BUTTONS_YES_NO,
2483                            true);
2484
2485
2486         msg.set_name (X_("OpenExistingDialog"));
2487         msg.set_title (_("Open Existing Session"));
2488         msg.set_wmclass (X_("existing_session"), PROGRAM_NAME);
2489         msg.set_position (Gtk::WIN_POS_MOUSE);
2490         pop_back_splash (msg);
2491
2492         switch (msg.run()) {
2493         case RESPONSE_YES:
2494                 return true;
2495                 break;
2496         }
2497         return false;
2498 }
2499
2500 int
2501 ARDOUR_UI::build_session_from_nsd (const std::string& session_path, const std::string& session_name)
2502 {
2503         BusProfile bus_profile;
2504
2505         if (nsm || Profile->get_sae()) {
2506
2507                 bus_profile.master_out_channels = 2;
2508                 bus_profile.input_ac = AutoConnectPhysical;
2509                 bus_profile.output_ac = AutoConnectMaster;
2510                 bus_profile.requested_physical_in = 0; // use all available
2511                 bus_profile.requested_physical_out = 0; // use all available
2512
2513         } else {
2514
2515                 /* get settings from advanced section of NSD */
2516
2517                 if (_startup->create_master_bus()) {
2518                         bus_profile.master_out_channels = (uint32_t) _startup->master_channel_count();
2519                 } else {
2520                         bus_profile.master_out_channels = 0;
2521                 }
2522
2523                 if (_startup->connect_inputs()) {
2524                         bus_profile.input_ac = AutoConnectPhysical;
2525                 } else {
2526                         bus_profile.input_ac = AutoConnectOption (0);
2527                 }
2528
2529                 bus_profile.output_ac = AutoConnectOption (0);
2530
2531                 if (_startup->connect_outputs ()) {
2532                         if (_startup->connect_outs_to_master()) {
2533                                 bus_profile.output_ac = AutoConnectMaster;
2534                         } else if (_startup->connect_outs_to_physical()) {
2535                                 bus_profile.output_ac = AutoConnectPhysical;
2536                         }
2537                 }
2538
2539                 bus_profile.requested_physical_in = (uint32_t) _startup->input_limit_count();
2540                 bus_profile.requested_physical_out = (uint32_t) _startup->output_limit_count();
2541         }
2542
2543         if (build_session (session_path, session_name, bus_profile)) {
2544                 return -1;
2545         }
2546
2547         return 0;
2548 }
2549
2550 void
2551 ARDOUR_UI::idle_load (const std::string& path)
2552 {
2553         if (_session) {
2554                 if (Glib::file_test (path, Glib::FILE_TEST_IS_DIR)) {
2555                         /* /path/to/foo => /path/to/foo, foo */
2556                         load_session (path, basename_nosuffix (path));
2557                 } else {
2558                         /* /path/to/foo/foo.ardour => /path/to/foo, foo */
2559                         load_session (Glib::path_get_dirname (path), basename_nosuffix (path));
2560                 }
2561
2562         } else {
2563                 ARDOUR_COMMAND_LINE::session_name = path;
2564         }
2565 }
2566
2567 /** @param quit_on_cancel true if exit() should be called if the user clicks `cancel' in the new session dialog */
2568 int
2569 ARDOUR_UI::get_session_parameters (bool quit_on_cancel, bool should_be_new, string load_template)
2570 {
2571         string session_name;
2572         string session_path;
2573         string template_name;
2574         int ret = -1;
2575         bool likely_new = false;
2576
2577         /* deal with any existing DIRTY session now, rather than later. don't
2578          * treat a non-dirty session this way, so that it stays visible 
2579          * as we bring up the new session dialog.
2580          */
2581
2582         if (_session && ARDOUR_UI::instance()->video_timeline) {
2583                 ARDOUR_UI::instance()->video_timeline->sync_session_state();
2584         }
2585
2586         if (_session && _session->dirty()) {
2587                 if (unload_session (false)) {
2588                         /* unload cancelled by user */
2589                         return 0;
2590                 }
2591                 ARDOUR_COMMAND_LINE::session_name = "";
2592         }
2593
2594         if (!load_template.empty()) {
2595                 should_be_new = true;
2596                 template_name = load_template;
2597         }
2598
2599         while (ret != 0) {
2600
2601                 if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
2602
2603                         /* if they named a specific statefile, use it, otherwise they are
2604                            just giving a session folder, and we want to use it as is
2605                            to find the session.
2606                         */
2607
2608                         string::size_type suffix = ARDOUR_COMMAND_LINE::session_name.find (statefile_suffix);
2609
2610                         if (suffix != string::npos) {
2611                                 session_path = Glib::path_get_dirname (ARDOUR_COMMAND_LINE::session_name);
2612                                 session_name = ARDOUR_COMMAND_LINE::session_name.substr (0, suffix);
2613                                 session_name = Glib::path_get_basename (session_name);
2614                         } else {
2615                                 session_path = ARDOUR_COMMAND_LINE::session_name;
2616                                 session_name = Glib::path_get_basename (ARDOUR_COMMAND_LINE::session_name);
2617                         }
2618                 } else {
2619                         session_path = "";
2620                         session_name = "";
2621                 }
2622
2623                 delete _startup;
2624                 _startup = new ArdourStartup (should_be_new, session_name, session_path, load_template);
2625                 
2626                 if (!_startup->ready_without_display()) {
2627                         _startup->present ();
2628                         main().run();
2629                         _startup->hide ();
2630                 }
2631                 
2632                 switch (_startup->response()) {
2633                 case RESPONSE_OK:
2634                         break;
2635                 default:
2636                         if (quit_on_cancel) {
2637                                 exit (1);
2638                         } else {
2639                                 return ret;
2640                         }
2641                 }
2642
2643                 /* if we run the startup dialog again, offer more than just "new session" */
2644                 
2645                 should_be_new = false;
2646                 
2647                 session_name = _startup->session_name (likely_new);
2648                 
2649                 if (nsm) {
2650                         likely_new = true;
2651                 }
2652
2653                 string::size_type suffix = session_name.find (statefile_suffix);
2654                 
2655                 if (suffix != string::npos) {
2656                         session_name = session_name.substr (0, suffix);
2657                 }
2658                 
2659                 /* this shouldn't happen, but we catch it just in case it does */
2660                 
2661                 if (session_name.empty()) {
2662                         continue;
2663                 }
2664                 
2665                 if (_startup->use_session_template()) {
2666                         template_name = _startup->session_template_name();
2667                         _session_is_new = true;
2668                 }
2669                 
2670                 if (session_name[0] == G_DIR_SEPARATOR ||
2671                     (session_name.length() > 2 && session_name[0] == '.' && session_name[1] == G_DIR_SEPARATOR) ||
2672                     (session_name.length() > 3 && session_name[0] == '.' && session_name[1] == '.' && session_name[2] == G_DIR_SEPARATOR)) {
2673                         
2674                         /* absolute path or cwd-relative path specified for session name: infer session folder
2675                            from what was given.
2676                         */
2677                         
2678                         session_path = Glib::path_get_dirname (session_name);
2679                         session_name = Glib::path_get_basename (session_name);
2680                         
2681                 } else {
2682
2683                         session_path = _startup->session_folder();
2684                         
2685                         char illegal = Session::session_name_is_legal (session_name);
2686                         
2687                         if (illegal) {
2688                                 MessageDialog msg (*_startup,
2689                                                    string_compose (_("To ensure compatibility with various systems\n"
2690                                                                      "session names may not contain a '%1' character"),
2691                                                                    illegal));
2692                                 msg.run ();
2693                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2694                                 continue;
2695                         }
2696                 }
2697         
2698                 if (create_engine ()) {
2699                         break;
2700                 }
2701
2702                 if (Glib::file_test (session_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))) {
2703
2704                         if (likely_new && !nsm) {
2705
2706                                 std::string existing = Glib::build_filename (session_path, session_name);
2707
2708                                 if (!ask_about_loading_existing_session (existing)) {
2709                                         ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2710                                         continue;
2711                                 }
2712                         }
2713
2714                         _session_is_new = false;
2715
2716                 } else {
2717
2718                         if (!likely_new) {
2719                                 if (_startup) {
2720                                         pop_back_splash (*_startup);
2721                                 } else {
2722                                         hide_splash ();
2723                                 }
2724
2725                                 MessageDialog msg (string_compose (_("There is no existing session at \"%1\""), session_path));
2726                                 msg.run ();
2727                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2728                                 continue;
2729                         }
2730
2731                         char illegal = Session::session_name_is_legal(session_name);
2732                         if (illegal) {
2733                                 pop_back_splash (*_startup);
2734                                 MessageDialog msg (*_startup, string_compose(_("To ensure compatibility with various systems\n"
2735                                                      "session names may not contain a '%1' character"), illegal));
2736                                 msg.run ();
2737                                 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
2738                                 continue;
2739                         }
2740
2741                         _session_is_new = true;
2742                 }
2743
2744                 if (likely_new && template_name.empty()) {
2745
2746                         ret = build_session_from_nsd (session_path, session_name);
2747
2748                 } else {
2749
2750                         ret = load_session (session_path, session_name, template_name);
2751
2752                         if (ret == -2) {
2753                                 /* not connected to the AudioEngine, so quit to avoid an infinite loop */
2754                                 exit (1);
2755                         }
2756
2757                         if (!ARDOUR_COMMAND_LINE::immediate_save.empty()) {
2758                                 _session->save_state (ARDOUR_COMMAND_LINE::immediate_save, false);
2759                                 exit (1);
2760                         }
2761                 }
2762         }
2763
2764         return ret;
2765 }
2766
2767 void
2768 ARDOUR_UI::close_session()
2769 {
2770         if (!check_audioengine()) {
2771                 return;
2772         }
2773
2774         if (unload_session (true)) {
2775                 return;
2776         }
2777
2778         ARDOUR_COMMAND_LINE::session_name = "";
2779
2780         if (get_session_parameters (true, false)) {
2781                 exit (1);
2782         }
2783
2784         goto_editor_window ();
2785 }
2786
2787 /** @param snap_name Snapshot name (without .ardour suffix).
2788  *  @return -2 if the load failed because we are not connected to the AudioEngine.
2789  */
2790 int
2791 ARDOUR_UI::load_session (const std::string& path, const std::string& snap_name, std::string mix_template)
2792 {
2793         Session *new_session;
2794         int unload_status;
2795         int retval = -1;
2796
2797         session_loaded = false;
2798
2799         if (!check_audioengine()) {
2800                 return -2;
2801         }
2802
2803         unload_status = unload_session ();
2804
2805         if (unload_status < 0) {
2806                 goto out;
2807         } else if (unload_status > 0) {
2808                 retval = 0;
2809                 goto out;
2810         }
2811
2812         loading_message (string_compose (_("Please wait while %1 loads your session"), PROGRAM_NAME));
2813
2814         try {
2815                 new_session = new Session (*engine, path, snap_name, 0, mix_template);
2816         }
2817
2818         /* this one is special */
2819
2820         catch (AudioEngine::PortRegistrationFailure& err) {
2821
2822                 MessageDialog msg (err.what(),
2823                                    true,
2824                                    Gtk::MESSAGE_INFO,
2825                                    Gtk::BUTTONS_CLOSE);
2826
2827                 msg.set_title (_("Port Registration Error"));
2828                 msg.set_secondary_text (_("Click the Close button to try again."));
2829                 msg.set_position (Gtk::WIN_POS_CENTER);
2830                 pop_back_splash (msg);
2831                 msg.present ();
2832
2833                 int response = msg.run ();
2834
2835                 msg.hide ();
2836
2837                 switch (response) {
2838                 case RESPONSE_CANCEL:
2839                         exit (1);
2840                 default:
2841                         break;
2842                 }
2843                 goto out;
2844         }
2845
2846         catch (...) {
2847
2848                 MessageDialog msg (string_compose(
2849                                            _("Session \"%1 (snapshot %2)\" did not load successfully"),
2850                                            path, snap_name),
2851                                    true,
2852                                    Gtk::MESSAGE_INFO,
2853                                    BUTTONS_OK);
2854
2855                 msg.set_title (_("Loading Error"));
2856                 msg.set_secondary_text (_("Click the Refresh button to try again."));
2857                 msg.add_button (Stock::REFRESH, 1);
2858                 msg.set_position (Gtk::WIN_POS_CENTER);
2859                 pop_back_splash (msg);
2860                 msg.present ();
2861
2862                 int response = msg.run ();
2863
2864                 switch (response) {
2865                 case 1:
2866                         break;
2867                 default:
2868                         exit (1);
2869                 }
2870
2871                 msg.hide ();
2872
2873                 goto out;
2874         }
2875
2876         {
2877                 list<string> const u = new_session->unknown_processors ();
2878                 if (!u.empty()) {
2879                         MissingPluginDialog d (_session, u);
2880                         d.run ();
2881                 }
2882         }
2883
2884         /* Now the session been created, add the transport controls */
2885         new_session->add_controllable(roll_controllable);
2886         new_session->add_controllable(stop_controllable);
2887         new_session->add_controllable(goto_start_controllable);
2888         new_session->add_controllable(goto_end_controllable);
2889         new_session->add_controllable(auto_loop_controllable);
2890         new_session->add_controllable(play_selection_controllable);
2891         new_session->add_controllable(rec_controllable);
2892
2893         set_session (new_session);
2894
2895         session_loaded = true;
2896
2897         goto_editor_window ();
2898
2899         if (_session) {
2900                 _session->set_clean ();
2901         }
2902
2903         flush_pending ();
2904         retval = 0;
2905
2906   out:
2907         return retval;
2908 }
2909
2910 int
2911 ARDOUR_UI::build_session (const std::string& path, const std::string& snap_name, BusProfile& bus_profile)
2912 {
2913         Session *new_session;
2914         int x;
2915
2916         if (!check_audioengine()) {
2917                 return -1;
2918         }
2919
2920         session_loaded = false;
2921
2922         x = unload_session ();
2923
2924         if (x < 0) {
2925                 return -1;
2926         } else if (x > 0) {
2927                 return 0;
2928         }
2929
2930         _session_is_new = true;
2931
2932         try {
2933                 new_session = new Session (*engine, path, snap_name, &bus_profile);
2934         }
2935
2936         catch (...) {
2937
2938                 MessageDialog msg (string_compose(_("Could not create session in \"%1\""), path));
2939                 pop_back_splash (msg);
2940                 msg.run ();
2941                 return -1;
2942         }
2943
2944         /* Give the new session the default GUI state, if such things exist */
2945
2946         XMLNode* n;
2947         n = Config->instant_xml (X_("Editor"));
2948         if (n) {
2949                 new_session->add_instant_xml (*n, false);
2950         }
2951         n = Config->instant_xml (X_("Mixer"));
2952         if (n) {
2953                 new_session->add_instant_xml (*n, false);
2954         }
2955
2956         /* Put the playhead at 0 and scroll fully left */
2957         n = new_session->instant_xml (X_("Editor"));
2958         if (n) {
2959                 n->add_property (X_("playhead"), X_("0"));
2960                 n->add_property (X_("left-frame"), X_("0"));
2961         }
2962
2963         set_session (new_session);
2964
2965         session_loaded = true;
2966
2967         new_session->save_state(new_session->name());
2968
2969         return 0;
2970 }
2971
2972 void
2973 ARDOUR_UI::launch_chat ()
2974 {
2975 #ifdef __APPLE__
2976         open_uri("http://webchat.freenode.net/?channels=ardour-osx");
2977 #else
2978         open_uri("http://webchat.freenode.net/?channels=ardour");
2979 #endif
2980 }
2981
2982 void
2983 ARDOUR_UI::launch_manual ()
2984 {
2985         PBD::open_uri (Config->get_tutorial_manual_url());
2986 }
2987
2988 void
2989 ARDOUR_UI::launch_reference ()
2990 {
2991         PBD::open_uri (Config->get_reference_manual_url());
2992 }
2993
2994 void
2995 ARDOUR_UI::loading_message (const std::string& msg)
2996 {
2997         if (ARDOUR_COMMAND_LINE::no_splash) {
2998                 return;
2999         }
3000
3001         if (!splash) {
3002                 show_splash ();
3003         }
3004
3005         splash->message (msg);
3006 }
3007
3008 void
3009 ARDOUR_UI::show_splash ()
3010 {
3011         if (splash == 0) {
3012                 try {
3013                         splash = new Splash;
3014                 } catch (...) {
3015                         return;
3016                 }
3017         }
3018
3019         splash->display ();
3020 }
3021
3022 void
3023 ARDOUR_UI::hide_splash ()
3024 {
3025         delete splash;
3026         splash = 0;
3027 }
3028
3029 void
3030 ARDOUR_UI::display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete)
3031 {
3032         size_t removed;
3033
3034         removed = rep.paths.size();
3035
3036         if (removed == 0) {
3037                 MessageDialog msgd (*editor,
3038                                     _("No files were ready for clean-up"),
3039                                     true,
3040                                     Gtk::MESSAGE_INFO,
3041                                     Gtk::BUTTONS_OK);
3042                 msgd.set_title (_("Clean-up"));
3043                 msgd.set_secondary_text (_("If this seems suprising, \n\
3044 check for any existing snapshots.\n\
3045 These may still include regions that\n\
3046 require some unused files to continue to exist."));
3047
3048                 msgd.run ();
3049                 return;
3050         }
3051
3052         ArdourDialog results (_("Clean-up"), true, false);
3053
3054         struct CleanupResultsModelColumns : public Gtk::TreeModel::ColumnRecord {
3055             CleanupResultsModelColumns() {
3056                     add (visible_name);
3057                     add (fullpath);
3058             }
3059             Gtk::TreeModelColumn<std::string> visible_name;
3060             Gtk::TreeModelColumn<std::string> fullpath;
3061         };
3062
3063
3064         CleanupResultsModelColumns results_columns;
3065         Glib::RefPtr<Gtk::ListStore> results_model;
3066         Gtk::TreeView results_display;
3067
3068         results_model = ListStore::create (results_columns);
3069         results_display.set_model (results_model);
3070         results_display.append_column (list_title, results_columns.visible_name);
3071
3072         results_display.set_name ("CleanupResultsList");
3073         results_display.set_headers_visible (true);
3074         results_display.set_headers_clickable (false);
3075         results_display.set_reorderable (false);
3076
3077         Gtk::ScrolledWindow list_scroller;
3078         Gtk::Label txt;
3079         Gtk::VBox dvbox;
3080         Gtk::HBox dhbox;  // the hbox for the image and text
3081         Gtk::HBox ddhbox; // the hbox we eventually pack into the dialog's vbox
3082         Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_INFO,  Gtk::ICON_SIZE_DIALOG));
3083
3084         dimage->set_alignment(ALIGN_LEFT, ALIGN_TOP);
3085
3086         const string dead_directory = _session->session_directory().dead_path();
3087
3088         /* subst:
3089            %1 - number of files removed
3090            %2 - location of "dead"
3091            %3 - size of files affected
3092            %4 - prefix for "bytes" to produce sensible results (e.g. mega, kilo, giga)
3093         */
3094
3095         const char* bprefix;
3096         double space_adjusted = 0;
3097
3098         if (rep.space < 1000) {
3099                 bprefix = X_("");
3100                 space_adjusted = rep.space;
3101         } else if (rep.space < 1000000) {
3102                 bprefix = _("kilo");
3103                 space_adjusted = truncf((float)rep.space / 1000.0);
3104         } else if (rep.space < 1000000 * 1000) {
3105                 bprefix = _("mega");
3106                 space_adjusted = truncf((float)rep.space / (1000.0 * 1000.0));
3107         } else {
3108                 bprefix = _("giga");
3109                 space_adjusted = truncf((float)rep.space / (1000.0 * 1000 * 1000.0));
3110         }
3111
3112         if (msg_delete) {
3113                 txt.set_markup (string_compose (P_("\
3114 The following file was deleted from %2,\n\
3115 releasing %3 %4bytes of disk space", "\
3116 The following %1 files were deleted from %2,\n\
3117 releasing %3 %4bytes of disk space", removed),
3118                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3119         } else {
3120                 txt.set_markup (string_compose (P_("\
3121 The following file was not in use and \n\
3122 has been moved to: %2\n\n\
3123 After a restart of %5\n\n\
3124 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3125 will release an additional %3 %4bytes of disk space.\n", "\
3126 The following %1 files were not in use and \n\
3127 have been moved to: %2\n\n\
3128 After a restart of %5\n\n\
3129 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3130 will release an additional %3 %4bytes of disk space.\n", removed),
3131                                         removed, Glib::Markup::escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3132         }
3133
3134         dhbox.pack_start (*dimage, true, false, 5);
3135         dhbox.pack_start (txt, true, false, 5);
3136
3137         for (vector<string>::iterator i = rep.paths.begin(); i != rep.paths.end(); ++i) {
3138                 TreeModel::Row row = *(results_model->append());
3139                 row[results_columns.visible_name] = *i;
3140                 row[results_columns.fullpath] = *i;
3141         }
3142
3143         list_scroller.add (results_display);
3144         list_scroller.set_size_request (-1, 150);
3145         list_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
3146
3147         dvbox.pack_start (dhbox, true, false, 5);
3148         dvbox.pack_start (list_scroller, true, false, 5);
3149         ddhbox.pack_start (dvbox, true, false, 5);
3150
3151         results.get_vbox()->pack_start (ddhbox, true, false, 5);
3152         results.add_button (Stock::CLOSE, RESPONSE_CLOSE);
3153         results.set_default_response (RESPONSE_CLOSE);
3154         results.set_position (Gtk::WIN_POS_MOUSE);
3155
3156         results_display.show();
3157         list_scroller.show();
3158         txt.show();
3159         dvbox.show();
3160         dhbox.show();
3161         ddhbox.show();
3162         dimage->show();
3163
3164         //results.get_vbox()->show();
3165         results.set_resizable (false);
3166
3167         results.run ();
3168
3169 }
3170
3171 void
3172 ARDOUR_UI::cleanup ()
3173 {
3174         if (_session == 0) {
3175                 /* shouldn't happen: menu item is insensitive */
3176                 return;
3177         }
3178
3179
3180         MessageDialog checker (_("Are you sure you want to clean-up?"),
3181                                 true,
3182                                 Gtk::MESSAGE_QUESTION,
3183                                 Gtk::BUTTONS_NONE);
3184
3185         checker.set_title (_("Clean-up"));
3186
3187         checker.set_secondary_text(_("Clean-up is a destructive operation.\n\
3188 ALL undo/redo information will be lost if you clean-up.\n\
3189 Clean-up will move all unused files to a \"dead\" location."));
3190
3191         checker.add_button (Stock::CANCEL, RESPONSE_CANCEL);
3192         checker.add_button (_("Clean-up"), RESPONSE_ACCEPT);
3193         checker.set_default_response (RESPONSE_CANCEL);
3194
3195         checker.set_name (_("CleanupDialog"));
3196         checker.set_wmclass (X_("ardour_cleanup"), PROGRAM_NAME);
3197         checker.set_position (Gtk::WIN_POS_MOUSE);
3198
3199         switch (checker.run()) {
3200         case RESPONSE_ACCEPT:
3201                 break;
3202         default:
3203                 return;
3204         }
3205
3206         ARDOUR::CleanupReport rep;
3207
3208         editor->prepare_for_cleanup ();
3209
3210         /* do not allow flush until a session is reloaded */
3211
3212         Glib::RefPtr<Action> act = ActionManager::get_action (X_("Main"), X_("FlushWastebasket"));
3213         if (act) {
3214                 act->set_sensitive (false);
3215         }
3216
3217         if (_session->cleanup_sources (rep)) {
3218                 editor->finish_cleanup ();
3219                 return;
3220         }
3221
3222         editor->finish_cleanup ();
3223
3224         checker.hide();
3225         display_cleanup_results (rep, _("Cleaned Files"), false);
3226 }
3227
3228 void
3229 ARDOUR_UI::flush_trash ()
3230 {
3231         if (_session == 0) {
3232                 /* shouldn't happen: menu item is insensitive */
3233                 return;
3234         }
3235
3236         ARDOUR::CleanupReport rep;
3237
3238         if (_session->cleanup_trash_sources (rep)) {
3239                 return;
3240         }
3241
3242         display_cleanup_results (rep, _("deleted file"), true);
3243 }
3244
3245 void
3246 ARDOUR_UI::add_route (Gtk::Window* float_window)
3247 {
3248         int count;
3249
3250         if (!_session) {
3251                 return;
3252         }
3253
3254         if (add_route_dialog->is_visible()) {
3255                 /* we're already doing this */
3256                 return;
3257         }
3258
3259         if (float_window) {
3260                 add_route_dialog->set_transient_for (*float_window);
3261         }
3262
3263         ResponseType r = (ResponseType) add_route_dialog->run ();
3264
3265         add_route_dialog->hide();
3266
3267         switch (r) {
3268                 case RESPONSE_ACCEPT:
3269                         break;
3270                 default:
3271                         return;
3272                         break;
3273         }
3274
3275         if ((count = add_route_dialog->count()) <= 0) {
3276                 return;
3277         }
3278
3279         PBD::ScopedConnection idle_connection;
3280
3281         if (count > 8) {
3282                 ARDOUR::GUIIdle.connect (idle_connection, MISSING_INVALIDATOR, boost::bind (&Gtkmm2ext::UI::flush_pending, this), gui_context());
3283         }
3284
3285         string template_path = add_route_dialog->track_template();
3286
3287         if (!template_path.empty()) {
3288                 if (add_route_dialog->name_template_is_default())  {
3289                         _session->new_route_from_template (count, template_path, string());
3290                 } else {
3291                         _session->new_route_from_template (count, template_path, add_route_dialog->name_template());
3292                 }
3293                 return;
3294         }
3295
3296         ChanCount input_chan= add_route_dialog->channels ();
3297         ChanCount output_chan;
3298         string name_template = add_route_dialog->name_template ();
3299         PluginInfoPtr instrument = add_route_dialog->requested_instrument ();
3300         RouteGroup* route_group = add_route_dialog->route_group ();
3301         AutoConnectOption oac = Config->get_output_auto_connect();
3302
3303         if (oac & AutoConnectMaster) {
3304                 output_chan.set (DataType::AUDIO, (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan.n_audio()));
3305                 output_chan.set (DataType::MIDI, 0);
3306         } else {
3307                 output_chan = input_chan;
3308         }
3309
3310         /* XXX do something with name template */
3311
3312         switch (add_route_dialog->type_wanted()) {
3313         case AddRouteDialog::AudioTrack:
3314                 session_add_audio_track (input_chan.n_audio(), output_chan.n_audio(), add_route_dialog->mode(), route_group, count, name_template);
3315                 break;
3316         case AddRouteDialog::MidiTrack:
3317                 session_add_midi_track (route_group, count, name_template, instrument);
3318                 break;
3319         case AddRouteDialog::MixedTrack:
3320                 session_add_mixed_track (input_chan, output_chan, route_group, count, name_template, instrument);
3321                 break;
3322         case AddRouteDialog::AudioBus:
3323                 session_add_audio_bus (input_chan.n_audio(), output_chan.n_audio(), route_group, count, name_template);
3324                 break;
3325         }
3326
3327         /* idle connection will end at scope end */
3328 }
3329
3330 void
3331 ARDOUR_UI::stop_video_server (bool ask_confirm)
3332 {
3333         if (!video_server_process && ask_confirm) {
3334                 warning << _("Video-Server was not launched by Ardour. The request to stop it is ignored.") << endmsg;
3335         }
3336         if (video_server_process) {
3337                 if(ask_confirm) {
3338                         ArdourDialog confirm (_("Stop Video-Server"), true);
3339                         Label m (_("Do you really want to stop the Video Server?"));
3340                         confirm.get_vbox()->pack_start (m, true, true);
3341                         confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
3342                         confirm.add_button (_("Yes, Stop It"), Gtk::RESPONSE_ACCEPT);
3343                         confirm.show_all ();
3344                         if (confirm.run() == RESPONSE_CANCEL) {
3345                                 return;
3346                         }
3347                 }
3348                 delete video_server_process;
3349                 video_server_process =0;
3350         }
3351 }
3352
3353 void
3354 ARDOUR_UI::start_video_server_menu (Gtk::Window* float_window)
3355 {
3356   ARDOUR_UI::start_video_server( float_window, true);
3357 }
3358
3359 bool
3360 ARDOUR_UI::start_video_server (Gtk::Window* float_window, bool popup_msg)
3361 {
3362         if (!_session) {
3363                 return false;
3364         }
3365         if (popup_msg) {
3366                 if (ARDOUR_UI::instance()->video_timeline->check_server()) {
3367                         if (video_server_process) {
3368                                 popup_error(_("The Video Server is already started."));
3369                         } else {
3370                                 popup_error(_("An external Video Server is configured and can be reached. Not starting a new instance."));
3371                         }
3372                 }
3373         }
3374
3375         int firsttime = 0;
3376         while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3377                 if (firsttime++) {
3378                         warning << _("Could not connect to the Video Server. Start it or configure its access URL in Edit -> Preferences.") << endmsg;
3379                 }
3380                 VideoServerDialog *video_server_dialog = new VideoServerDialog (_session);
3381                 if (float_window) {
3382                         video_server_dialog->set_transient_for (*float_window);
3383                 }
3384
3385                 if (!Config->get_show_video_server_dialog() && firsttime < 2) {
3386                         video_server_dialog->hide();
3387                 } else {
3388                         ResponseType r = (ResponseType) video_server_dialog->run ();
3389                         video_server_dialog->hide();
3390                         if (r != RESPONSE_ACCEPT) { return false; }
3391                         if (video_server_dialog->show_again()) {
3392                                 Config->set_show_video_server_dialog(false);
3393                         }
3394                 }
3395
3396                 std::string icsd_exec = video_server_dialog->get_exec_path();
3397                 std::string icsd_docroot = video_server_dialog->get_docroot();
3398                 if (icsd_docroot.empty()) {icsd_docroot = X_("/");}
3399
3400                 struct stat sb;
3401                 if (!lstat (icsd_docroot.c_str(), &sb) == 0 || !S_ISDIR(sb.st_mode)) {
3402                         warning << _("Specified docroot is not an existing directory.") << endmsg;
3403                         continue;
3404                 }
3405                 if ( (!lstat (icsd_exec.c_str(), &sb) == 0)
3406                      || (sb.st_mode & (S_IXUSR|S_IXGRP|S_IXOTH)) == 0 ) {
3407                         warning << _("Given Video Server is not an executable file.") << endmsg;
3408                         continue;
3409                 }
3410
3411                 char **argp;
3412                 argp=(char**) calloc(9,sizeof(char*));
3413                 argp[0] = strdup(icsd_exec.c_str());
3414                 argp[1] = strdup("-P");
3415                 argp[2] = (char*) calloc(16,sizeof(char)); snprintf(argp[2], 16, "%s", video_server_dialog->get_listenaddr().c_str());
3416                 argp[3] = strdup("-p");
3417                 argp[4] = (char*) calloc(6,sizeof(char)); snprintf(argp[4], 6, "%i", video_server_dialog->get_listenport());
3418                 argp[5] = strdup("-C");
3419                 argp[6] = (char*) calloc(6,sizeof(char)); snprintf(argp[6], 6, "%i", video_server_dialog->get_cachesize());
3420                 argp[7] = strdup(icsd_docroot.c_str());
3421                 argp[8] = 0;
3422                 stop_video_server();
3423
3424                 if (icsd_docroot == X_("/")) {
3425                         Config->set_video_advanced_setup(false);
3426                 } else {
3427                         std::ostringstream osstream;
3428                         osstream << "http://localhost:" << video_server_dialog->get_listenport() << "/";
3429                         Config->set_video_server_url(osstream.str());
3430                         Config->set_video_server_docroot(icsd_docroot);
3431                         Config->set_video_advanced_setup(true);
3432                 }
3433
3434                 if (video_server_process) {
3435                         delete video_server_process;
3436                 }
3437
3438                 video_server_process = new SystemExec(icsd_exec, argp);
3439                 if (video_server_process->start()) {
3440                         warning << _("Cannot launch the video-server") << endmsg;
3441                         continue;
3442                 }
3443                 int timeout = 120; // 6 sec
3444                 while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
3445                         usleep (50000);
3446                         if (--timeout <= 0 || !video_server_process->is_running()) break;
3447                 }
3448                 if (timeout <= 0) {
3449                         warning << _("Video-server was started but does not respond to requests...") << endmsg;
3450                 } else {
3451                         if (!ARDOUR_UI::instance()->video_timeline->check_server_docroot()) {
3452                                 delete video_server_process;
3453                                 video_server_process = 0;
3454                         }
3455                 }
3456         }
3457         return true;
3458 }
3459
3460 void
3461 ARDOUR_UI::add_video (Gtk::Window* float_window)
3462 {
3463         if (!_session) {
3464                 return;
3465         }
3466
3467         if (!start_video_server(float_window, false)) {
3468                 warning << _("Could not connect to the Video Server. Start it or configure its access URL in Edit -> Preferences.") << endmsg;
3469                 return;
3470         }
3471
3472         if (float_window) {
3473                 add_video_dialog->set_transient_for (*float_window);
3474         }
3475
3476         if (add_video_dialog->is_visible()) {
3477                 /* we're already doing this */
3478                 return;
3479         }
3480
3481         ResponseType r = (ResponseType) add_video_dialog->run ();
3482         add_video_dialog->hide();
3483         if (r != RESPONSE_ACCEPT) { return; }
3484
3485         bool local_file, orig_local_file;
3486         std::string path = add_video_dialog->file_name(local_file);
3487
3488         std::string orig_path = path;
3489         orig_local_file = local_file;
3490
3491         bool auto_set_session_fps = add_video_dialog->auto_set_session_fps();
3492
3493         if (local_file && !Glib::file_test(path, Glib::FILE_TEST_EXISTS)) {
3494                 warning << string_compose(_("could not open %1"), path) << endmsg;
3495                 return;
3496         }
3497         if (!local_file && path.length() == 0) {
3498                 warning << _("no video-file selected") << endmsg;
3499                 return;
3500         }
3501
3502         switch (add_video_dialog->import_option()) {
3503                 case VTL_IMPORT_TRANSCODE:
3504                         {
3505                                 TranscodeVideoDialog *transcode_video_dialog;
3506                                 transcode_video_dialog = new TranscodeVideoDialog (_session, path);
3507                                 ResponseType r = (ResponseType) transcode_video_dialog->run ();
3508                                 transcode_video_dialog->hide();
3509                                 if (r != RESPONSE_ACCEPT) {
3510                                         delete transcode_video_dialog;
3511                                         return;
3512                                 }
3513                                 if (!transcode_video_dialog->get_audiofile().empty()) {
3514                                         editor->embed_audio_from_video(transcode_video_dialog->get_audiofile());
3515                                 }
3516                                 switch (transcode_video_dialog->import_option()) {
3517                                         case VTL_IMPORT_TRANSCODED:
3518                                                 path = transcode_video_dialog->get_filename();
3519                                                 local_file = true;
3520                                                 break;
3521                                         case VTL_IMPORT_REFERENCE:
3522                                                 break;
3523                                         default:
3524                                                 delete transcode_video_dialog;
3525                                                 return;
3526                                 }
3527                                 delete transcode_video_dialog;
3528                         }
3529                         break;
3530                 default:
3531                 case VTL_IMPORT_NONE:
3532                         break;
3533         }
3534
3535         /* strip _session->session_directory().video_path() from video file if possible */
3536         if (local_file && !path.compare(0, _session->session_directory().video_path().size(), _session->session_directory().video_path())) {
3537                  path=path.substr(_session->session_directory().video_path().size());
3538                  if (path.at(0) == G_DIR_SEPARATOR) {
3539                          path=path.substr(1);
3540                  }
3541         }
3542
3543         video_timeline->set_update_session_fps(auto_set_session_fps);
3544         if (video_timeline->video_file_info(path, local_file)) {
3545                 XMLNode* node = new XMLNode(X_("Videotimeline"));
3546                 node->add_property (X_("Filename"), path);
3547                 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
3548                 node->add_property (X_("LocalFile"), local_file?X_("1"):X_("0"));
3549                 if (orig_local_file) {
3550                         node->add_property (X_("OriginalVideoFile"), orig_path);
3551                 } else {
3552                         node->remove_property (X_("OriginalVideoFile"));
3553                 }
3554                 _session->add_extra_xml (*node);
3555                 _session->set_dirty ();
3556
3557                 _session->maybe_update_session_range(
3558                         std::max(video_timeline->get_offset(), (ARDOUR::frameoffset_t) 0),
3559                         std::max(video_timeline->get_offset() + video_timeline->get_duration(), (ARDOUR::frameoffset_t) 0));
3560
3561
3562                 if (add_video_dialog->launch_xjadeo() && local_file) {
3563                         editor->set_xjadeo_sensitive(true);
3564                         editor->toggle_xjadeo_proc(1);
3565                 } else {
3566                         editor->toggle_xjadeo_proc(0);
3567                 }
3568                 editor->toggle_ruler_video(true);
3569         }
3570 }
3571
3572 void
3573 ARDOUR_UI::remove_video ()
3574 {
3575         video_timeline->close_session();
3576         editor->toggle_ruler_video(false);
3577
3578         /* delete session state */
3579         XMLNode* node = new XMLNode(X_("Videotimeline"));
3580         _session->add_extra_xml(*node);
3581         node = new XMLNode(X_("Videomonitor"));
3582         _session->add_extra_xml(*node);
3583         stop_video_server();
3584 }
3585
3586 void
3587 ARDOUR_UI::flush_videotimeline_cache (bool localcacheonly)
3588 {
3589         if (localcacheonly) {
3590                 video_timeline->vmon_update();
3591         } else {
3592                 video_timeline->flush_cache();
3593         }
3594         editor->queue_visual_videotimeline_update();
3595 }
3596
3597 XMLNode*
3598 ARDOUR_UI::mixer_settings () const
3599 {
3600         XMLNode* node = 0;
3601
3602         if (_session) {
3603                 node = _session->instant_xml(X_("Mixer"));
3604         } else {
3605                 node = Config->instant_xml(X_("Mixer"));
3606         }
3607
3608         if (!node) {
3609                 node = new XMLNode (X_("Mixer"));
3610         }
3611
3612         return node;
3613 }
3614
3615 XMLNode*
3616 ARDOUR_UI::editor_settings () const
3617 {
3618         XMLNode* node = 0;
3619
3620         if (_session) {
3621                 node = _session->instant_xml(X_("Editor"));
3622         } else {
3623                 node = Config->instant_xml(X_("Editor"));
3624         }
3625
3626         if (!node) {
3627                 if (getenv("ARDOUR_INSTANT_XML_PATH")) {
3628                         node = Config->instant_xml(getenv("ARDOUR_INSTANT_XML_PATH"));
3629                 }
3630         }
3631
3632         if (!node) {
3633                 node = new XMLNode (X_("Editor"));
3634         }
3635
3636         return node;
3637 }
3638
3639 XMLNode*
3640 ARDOUR_UI::keyboard_settings () const
3641 {
3642         XMLNode* node = 0;
3643
3644         node = Config->extra_xml(X_("Keyboard"));
3645
3646         if (!node) {
3647                 node = new XMLNode (X_("Keyboard"));
3648         }
3649
3650         return node;
3651 }
3652
3653 void
3654 ARDOUR_UI::create_xrun_marker (framepos_t where)
3655 {
3656         editor->mouse_add_new_marker (where, false, true);
3657 }
3658
3659 void
3660 ARDOUR_UI::halt_on_xrun_message ()
3661 {
3662         MessageDialog msg (*editor,
3663                            _("Recording was stopped because your system could not keep up."));
3664         msg.run ();
3665 }
3666
3667 void
3668 ARDOUR_UI::xrun_handler (framepos_t where)
3669 {
3670         if (!_session) {
3671                 return;
3672         }
3673
3674         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::xrun_handler, where)
3675
3676         if (_session && Config->get_create_xrun_marker() && _session->actively_recording()) {
3677                 create_xrun_marker(where);
3678         }
3679
3680         if (_session && Config->get_stop_recording_on_xrun() && _session->actively_recording()) {
3681                 halt_on_xrun_message ();
3682         }
3683 }
3684
3685 void
3686 ARDOUR_UI::disk_overrun_handler ()
3687 {
3688         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_overrun_handler)
3689
3690         if (!have_disk_speed_dialog_displayed) {
3691                 have_disk_speed_dialog_displayed = true;
3692                 MessageDialog* msg = new MessageDialog (*editor, string_compose (_("\
3693 The disk system on your computer\n\
3694 was not able to keep up with %1.\n\
3695 \n\
3696 Specifically, it failed to write data to disk\n\
3697 quickly enough to keep up with recording.\n"), PROGRAM_NAME));
3698                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
3699                 msg->show ();
3700         }
3701 }
3702
3703 void
3704 ARDOUR_UI::disk_underrun_handler ()
3705 {
3706         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_underrun_handler)
3707
3708         if (!have_disk_speed_dialog_displayed) {
3709                 have_disk_speed_dialog_displayed = true;
3710                 MessageDialog* msg = new MessageDialog (
3711                         *editor, string_compose (_("The disk system on your computer\n\
3712 was not able to keep up with %1.\n\
3713 \n\
3714 Specifically, it failed to read data from disk\n\
3715 quickly enough to keep up with playback.\n"), PROGRAM_NAME));
3716                 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
3717                 msg->show ();
3718         }
3719 }
3720
3721 void
3722 ARDOUR_UI::disk_speed_dialog_gone (int /*ignored_response*/, MessageDialog* msg)
3723 {
3724         have_disk_speed_dialog_displayed = false;
3725         delete msg;
3726 }
3727
3728 void
3729 ARDOUR_UI::session_dialog (std::string msg)
3730 {
3731         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::session_dialog, msg)
3732
3733         MessageDialog* d;
3734
3735         if (editor) {
3736                 d = new MessageDialog (*editor, msg, false, MESSAGE_INFO, BUTTONS_OK, true);
3737         } else {
3738                 d = new MessageDialog (msg, false, MESSAGE_INFO, BUTTONS_OK, true);
3739         }
3740
3741         d->show_all ();
3742         d->run ();
3743         delete d;
3744 }
3745
3746 int
3747 ARDOUR_UI::pending_state_dialog ()
3748 {
3749         HBox* hbox = new HBox();
3750         Image* image = new Image (Stock::DIALOG_QUESTION, ICON_SIZE_DIALOG);
3751         ArdourDialog dialog (_("Crash Recovery"), true);
3752         Label  message (string_compose (_("\
3753 This session appears to have been in the\n\
3754 middle of recording when %1 or\n\
3755 the computer was shutdown.\n\
3756 \n\
3757 %1 can recover any captured audio for\n\
3758 you, or it can ignore it. Please decide\n\
3759 what you would like to do.\n"), PROGRAM_NAME));
3760         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
3761         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
3762         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
3763         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
3764         dialog.add_button (_("Ignore crash data"), RESPONSE_REJECT);
3765         dialog.add_button (_("Recover from crash"), RESPONSE_ACCEPT);
3766         dialog.set_default_response (RESPONSE_ACCEPT);
3767         dialog.set_position (WIN_POS_CENTER);
3768         message.show();
3769         image->show();
3770         hbox->show();
3771
3772         switch (dialog.run ()) {
3773         case RESPONSE_ACCEPT:
3774                 return 1;
3775         default:
3776                 return 0;
3777         }
3778 }
3779
3780 int
3781 ARDOUR_UI::sr_mismatch_dialog (framecnt_t desired, framecnt_t actual)
3782 {
3783         HBox* hbox = new HBox();
3784         Image* image = new Image (Stock::DIALOG_WARNING, ICON_SIZE_DIALOG);
3785         ArdourDialog dialog (_("Sample Rate Mismatch"), true);
3786         Label  message (string_compose (_("\
3787 This session was created with a sample rate of %1 Hz, but\n\
3788 %2 is currently running at %3 Hz.  If you load this session,\n\
3789 audio may be played at the wrong sample rate.\n"), desired, PROGRAM_NAME, actual));
3790
3791         image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
3792         hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
3793         hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
3794         dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
3795         dialog.add_button (_("Do not load session"), RESPONSE_REJECT);
3796         dialog.add_button (_("Load session anyway"), RESPONSE_ACCEPT);
3797         dialog.set_default_response (RESPONSE_ACCEPT);
3798         dialog.set_position (WIN_POS_CENTER);
3799         message.show();
3800         image->show();
3801         hbox->show();
3802
3803         switch (dialog.run()) {
3804         case RESPONSE_ACCEPT:
3805                 return 0;
3806         default:
3807                 break;
3808         }
3809
3810         return 1;
3811 }
3812
3813
3814 void
3815 ARDOUR_UI::disconnect_from_jack ()
3816 {
3817         if (engine) {
3818                 if (engine->disconnect_from_jack ()) {
3819                         MessageDialog msg (*editor, _("Could not disconnect from JACK"));
3820                         msg.run ();
3821                 }
3822
3823                 update_sample_rate (0);
3824         }
3825 }
3826
3827 void
3828 ARDOUR_UI::reconnect_to_jack ()
3829 {
3830         if (engine) {
3831                 if (engine->reconnect_to_jack ()) {
3832                         MessageDialog msg (*editor,  _("Could not reconnect to JACK"));
3833                         msg.run ();
3834                 }
3835
3836                 update_sample_rate (0);
3837         }
3838 }
3839
3840 void
3841 ARDOUR_UI::use_config ()
3842 {
3843         XMLNode* node = Config->extra_xml (X_("TransportControllables"));
3844         if (node) {
3845                 set_transport_controllable_state (*node);
3846         }
3847 }
3848
3849 void
3850 ARDOUR_UI::update_transport_clocks (framepos_t pos)
3851 {
3852         if (Config->get_primary_clock_delta_edit_cursor()) {
3853                 primary_clock->set (pos, false, editor->get_preferred_edit_position());
3854         } else {
3855                 primary_clock->set (pos);
3856         }
3857
3858         if (Config->get_secondary_clock_delta_edit_cursor()) {
3859                 secondary_clock->set (pos, false, editor->get_preferred_edit_position());
3860         } else {
3861                 secondary_clock->set (pos);
3862         }
3863
3864         if (big_clock_window) {
3865                 big_clock->set (pos);
3866         }
3867         ARDOUR_UI::instance()->video_timeline->manual_seek_video_monitor(pos);
3868 }
3869
3870 void
3871 ARDOUR_UI::step_edit_status_change (bool yn)
3872 {
3873         // XXX should really store pre-step edit status of things
3874         // we make insensitive
3875
3876         if (yn) {
3877                 rec_button.set_active_state (Gtkmm2ext::ImplicitActive);
3878                 rec_button.set_sensitive (false);
3879         } else {
3880                 rec_button.unset_active_state ();;
3881                 rec_button.set_sensitive (true);
3882         }
3883 }
3884
3885 void
3886 ARDOUR_UI::record_state_changed ()
3887 {
3888         ENSURE_GUI_THREAD (*this, &ARDOUR_UI::record_state_changed);
3889
3890         if (!_session || !big_clock_window) {
3891                 /* why bother - the clock isn't visible */
3892                 return;
3893         }
3894
3895         if (_session->record_status () == Session::Recording && _session->have_rec_enabled_track ()) {
3896                 big_clock->set_active (true);
3897         } else {
3898                 big_clock->set_active (false);
3899         }
3900 }
3901
3902 bool
3903 ARDOUR_UI::first_idle ()
3904 {
3905         if (_session) {
3906                 _session->allow_auto_play (true);
3907         }
3908
3909         if (editor) {
3910                 editor->first_idle();
3911         }
3912
3913         Keyboard::set_can_save_keybindings (true);
3914         return false;
3915 }
3916
3917 void
3918 ARDOUR_UI::store_clock_modes ()
3919 {
3920         XMLNode* node = new XMLNode(X_("ClockModes"));
3921
3922         for (vector<AudioClock*>::iterator x = AudioClock::clocks.begin(); x != AudioClock::clocks.end(); ++x) {
3923                 XMLNode* child = new XMLNode (X_("Clock"));
3924                 
3925                 child->add_property (X_("name"), (*x)->name());
3926                 child->add_property (X_("mode"), enum_2_string ((*x)->mode()));
3927                 child->add_property (X_("on"), ((*x)->off() ? X_("no") : X_("yes")));
3928
3929                 node->add_child_nocopy (*child);
3930         }
3931
3932         _session->add_extra_xml (*node);
3933         _session->set_dirty ();
3934 }
3935
3936 ARDOUR_UI::TransportControllable::TransportControllable (std::string name, ARDOUR_UI& u, ToggleType tp)
3937         : Controllable (name), ui (u), type(tp)
3938 {
3939
3940 }
3941
3942 void
3943 ARDOUR_UI::TransportControllable::set_value (double val)
3944 {
3945         if (val < 0.5) {
3946                 /* do nothing: these are radio-style actions */
3947                 return;
3948         }
3949
3950         const char *action = 0;
3951
3952         switch (type) {
3953         case Roll:
3954                 action = X_("Roll");
3955                 break;
3956         case Stop:
3957                 action = X_("Stop");
3958                 break;
3959         case GotoStart:
3960                 action = X_("GotoStart");
3961                 break;
3962         case GotoEnd:
3963                 action = X_("GotoEnd");
3964                 break;
3965         case AutoLoop:
3966                 action = X_("Loop");
3967                 break;
3968         case PlaySelection:
3969                 action = X_("PlaySelection");
3970                 break;
3971         case RecordEnable:
3972                 action = X_("Record");
3973                 break;
3974         default:
3975                 break;
3976         }
3977
3978         if (action == 0) {
3979                 return;
3980         }
3981
3982         Glib::RefPtr<Action> act = ActionManager::get_action ("Transport", action);
3983
3984         if (act) {
3985                 act->activate ();
3986         }
3987 }
3988
3989 double
3990 ARDOUR_UI::TransportControllable::get_value (void) const
3991 {
3992         float val = 0.0;
3993
3994         switch (type) {
3995         case Roll:
3996                 break;
3997         case Stop:
3998                 break;
3999         case GotoStart:
4000                 break;
4001         case GotoEnd:
4002                 break;
4003         case AutoLoop:
4004                 break;
4005         case PlaySelection:
4006                 break;
4007         case RecordEnable:
4008                 break;
4009         default:
4010                 break;
4011         }
4012
4013         return val;
4014 }
4015
4016 void
4017 ARDOUR_UI::setup_profile ()
4018 {
4019         if (gdk_screen_width() < 1200 || getenv ("ARDOUR_NARROW_SCREEN")) {
4020                 Profile->set_small_screen ();
4021         }
4022
4023         if (getenv ("ARDOUR_SAE")) {
4024                 Profile->set_sae ();
4025                 Profile->set_single_package ();
4026         }
4027 }
4028
4029 int
4030 ARDOUR_UI::missing_file (Session*s, std::string str, DataType type)
4031 {
4032         MissingFileDialog dialog (s, str, type);
4033
4034         dialog.show ();
4035         dialog.present ();
4036
4037         int result = dialog.run ();
4038         dialog.hide ();
4039
4040         switch (result) {
4041         case RESPONSE_OK:
4042                 break;
4043         default:
4044                 return 1; // quit entire session load
4045         }
4046
4047         result = dialog.get_action ();
4048
4049         return result;
4050 }
4051
4052 int
4053 ARDOUR_UI::ambiguous_file (std::string file, std::vector<std::string> hits)
4054 {
4055         AmbiguousFileDialog dialog (file, hits);
4056
4057         dialog.show ();
4058         dialog.present ();
4059
4060         dialog.run ();
4061         return dialog.get_which ();
4062 }
4063
4064 /** Allocate our thread-local buffers */
4065 void
4066 ARDOUR_UI::get_process_buffers ()
4067 {
4068         _process_thread->get_buffers ();
4069 }
4070
4071 /** Drop our thread-local buffers */
4072 void
4073 ARDOUR_UI::drop_process_buffers ()
4074 {
4075         _process_thread->drop_buffers ();
4076 }
4077
4078 void
4079 ARDOUR_UI::feedback_detected ()
4080 {
4081         _feedback_exists = true;
4082 }
4083
4084 void
4085 ARDOUR_UI::successful_graph_sort ()
4086 {
4087         _feedback_exists = false;
4088 }
4089
4090 void
4091 ARDOUR_UI::midi_panic ()
4092 {
4093         if (_session) {
4094                 _session->midi_panic();
4095         }
4096 }
4097
4098 void
4099 ARDOUR_UI::session_format_mismatch (std::string xml_path, std::string backup_path)
4100 {
4101         const char* start_big = "<span size=\"x-large\" weight=\"bold\">";
4102         const char* end_big = "</span>";
4103         const char* start_mono = "<tt>";
4104         const char* end_mono = "</tt>";
4105
4106         MessageDialog msg (string_compose (_("%4This is a session from an older version of %3%5\n\n"
4107                                              "%3 has copied the old session file\n\n%6%1%7\n\nto\n\n%6%2%7\n\n"
4108                                              "From now on, use the -2000 version with older versions of %3"),
4109                                            xml_path, backup_path, PROGRAM_NAME,
4110                                            start_big, end_big,
4111                                            start_mono, end_mono), true);
4112
4113         msg.run ();
4114 }