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