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