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