2 Copyright (C) 1999-2013 Paul Davis
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.
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.
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.
21 #include "gtk2ardour-config.h"
22 #include "gtk2ardour-version.h"
32 #ifndef PLATFORM_WINDOWS
33 #include <sys/resource.h>
37 #include <sys/types.h>
38 #include <sys/sysctl.h>
48 #include "pbd/gstdio_compat.h"
50 #include <gtkmm/messagedialog.h>
51 #include <gtkmm/accelmap.h>
52 #include <gtkmm/stock.h>
54 #include "pbd/error.h"
55 #include "pbd/basename.h"
56 #include "pbd/compose.h"
57 #include "pbd/convert.h"
58 #include "pbd/failed_constructor.h"
59 #include "pbd/file_archive.h"
60 #include "pbd/enumwriter.h"
61 #include "pbd/memento_command.h"
62 #include "pbd/openuri.h"
63 #include "pbd/stl_delete.h"
64 #include "pbd/file_utils.h"
65 #include "pbd/localtime_r.h"
66 #include "pbd/pthread_utils.h"
67 #include "pbd/replace_all.h"
68 #include "pbd/xml++.h"
70 #include "gtkmm2ext/application.h"
71 #include "gtkmm2ext/bindings.h"
72 #include "gtkmm2ext/gtk_ui.h"
73 #include "gtkmm2ext/utils.h"
74 #include "gtkmm2ext/click_box.h"
75 #include "gtkmm2ext/fastmeter.h"
76 #include "gtkmm2ext/popup.h"
77 #include "gtkmm2ext/window_title.h"
79 #include "ardour/ardour.h"
80 #include "ardour/audio_backend.h"
81 #include "ardour/audio_track.h"
82 #include "ardour/audioengine.h"
83 #include "ardour/audiofilesource.h"
84 #include "ardour/automation_watch.h"
85 #include "ardour/diskstream.h"
86 #include "ardour/filename_extensions.h"
87 #include "ardour/filesystem_paths.h"
88 #include "ardour/ltc_file_reader.h"
89 #include "ardour/midi_track.h"
90 #include "ardour/port.h"
91 #include "ardour/plugin_manager.h"
92 #include "ardour/process_thread.h"
93 #include "ardour/profile.h"
94 #include "ardour/recent_sessions.h"
95 #include "ardour/record_enable_control.h"
96 #include "ardour/session_directory.h"
97 #include "ardour/session_route.h"
98 #include "ardour/session_state_utils.h"
99 #include "ardour/session_utils.h"
100 #include "ardour/source_factory.h"
101 #include "ardour/slave.h"
102 #include "ardour/system_exec.h"
103 #include "ardour/track.h"
104 #include "ardour/vca_manager.h"
105 #include "ardour/utils.h"
107 #include "LuaBridge/LuaBridge.h"
109 #ifdef WINDOWS_VST_SUPPORT
112 #ifdef AUDIOUNIT_SUPPORT
113 #include "ardour/audio_unit.h"
116 // fix for OSX (nsm.h has a check function, AU/Apple defines check)
121 #include "timecode/time.h"
123 typedef uint64_t microseconds_t;
128 #include "add_route_dialog.h"
129 #include "ambiguous_file_dialog.h"
130 #include "ardour_ui.h"
131 #include "audio_clock.h"
132 #include "audio_region_view.h"
133 #include "big_clock_window.h"
134 #include "bundle_manager.h"
135 #include "duplicate_routes_dialog.h"
137 #include "engine_dialog.h"
138 #include "export_video_dialog.h"
139 #include "export_video_infobox.h"
140 #include "gain_meter.h"
141 #include "global_port_matrix.h"
142 #include "gui_object.h"
143 #include "gui_thread.h"
144 #include "keyboard.h"
145 #include "keyeditor.h"
146 #include "location_ui.h"
147 #include "lua_script_manager.h"
148 #include "luawindow.h"
149 #include "main_clock.h"
150 #include "missing_file_dialog.h"
151 #include "missing_plugin_dialog.h"
152 #include "mixer_ui.h"
153 #include "meterbridge.h"
154 #include "mouse_cursors.h"
157 #include "pingback.h"
158 #include "processor_box.h"
159 #include "prompter.h"
160 #include "public_editor.h"
161 #include "rc_option_editor.h"
162 #include "route_time_axis.h"
163 #include "route_params_ui.h"
164 #include "save_as_dialog.h"
165 #include "script_selector.h"
166 #include "session_archive_dialog.h"
167 #include "session_dialog.h"
168 #include "session_metadata_dialog.h"
169 #include "session_option_editor.h"
170 #include "speaker_dialog.h"
173 #include "time_axis_view_item.h"
174 #include "time_info_box.h"
177 #include "utils_videotl.h"
178 #include "video_server_dialog.h"
179 #include "add_video_dialog.h"
180 #include "transcode_video_dialog.h"
182 #include "pbd/i18n.h"
184 using namespace ARDOUR;
185 using namespace ARDOUR_UI_UTILS;
187 using namespace Gtkmm2ext;
190 using namespace Editing;
192 ARDOUR_UI *ARDOUR_UI::theArdourUI = 0;
194 sigc::signal<void, framepos_t, bool, framepos_t> ARDOUR_UI::Clock;
195 sigc::signal<void> ARDOUR_UI::CloseAllDialogs;
198 ask_about_configuration_copy (string const & old_dir, string const & new_dir, int version)
200 MessageDialog msg (string_compose (_("%1 %2.x has discovered configuration files from %1 %3.x.\n\n"
201 "Would you like these files to be copied and used for %1 %2.x?\n\n"
202 "(This will require you to restart %1.)"),
203 PROGRAM_NAME, PROGRAM_VERSION, version),
204 false, /* no markup */
207 true /* modal, though it hardly matters since it is the only window */
210 msg.set_default_response (Gtk::RESPONSE_YES);
213 return (msg.run() == Gtk::RESPONSE_YES);
217 libxml_generic_error_func (void* /* parsing_context*/,
225 vsnprintf (buf, sizeof (buf), msg, ap);
226 error << buf << endmsg;
231 libxml_structured_error_func (void* /* parsing_context*/,
239 replace_all (msg, "\n", "");
242 if (err->file && err->line) {
243 error << X_("XML error: ") << msg << " in " << err->file << " at line " << err->line;
246 error << ':' << err->int2;
251 error << X_("XML error: ") << msg << endmsg;
257 ARDOUR_UI::ARDOUR_UI (int *argcp, char **argvp[], const char* localedir)
258 : Gtkmm2ext::UI (PROGRAM_NAME, X_("gui"), argcp, argvp)
259 , session_loaded (false)
260 , gui_object_state (new GUIObjectState)
261 , primary_clock (new MainClock (X_("primary"), X_("transport"), true ))
262 , secondary_clock (new MainClock (X_("secondary"), X_("secondary"), false))
263 , big_clock (new AudioClock (X_("bigclock"), false, "big", true, true, false, false))
265 , global_actions (X_("global"))
266 , ignore_dual_punch (false)
267 , main_window_visibility (0)
272 , _mixer_on_top (false)
273 , _initial_verbose_plugin_scan (false)
274 , first_time_engine_run (true)
275 , secondary_clock_spacer (0)
276 , auto_input_button (ArdourButton::led_default_elements)
278 , auto_return_button (ArdourButton::led_default_elements)
279 , follow_edits_button (ArdourButton::led_default_elements)
280 , auditioning_alert_button (_("Audition"))
281 , solo_alert_button (_("Solo"))
282 , feedback_alert_button (_("Feedback"))
283 , error_alert_button ( ArdourButton::just_led_default_elements )
285 , editor_meter_peak_display()
286 , _numpad_locate_happening (false)
287 , _session_is_new (false)
288 , last_key_press_time (0)
292 , rc_option_editor (0)
293 , speaker_config_window (X_("speaker-config"), _("Speaker Configuration"))
294 , add_route_dialog (X_("add-routes"), _("Add Tracks/Busses"))
295 , about (X_("about"), _("About"))
296 , location_ui (X_("locations"), S_("Ranges|Locations"))
297 , route_params (X_("inspector"), _("Tracks and Busses"))
298 , audio_midi_setup (X_("audio-midi-setup"), _("Audio/MIDI Setup"))
299 , export_video_dialog (X_("video-export"), _("Video Export Dialog"))
300 , lua_script_window (X_("script-manager"), _("Script Manager"))
301 , session_option_editor (X_("session-options-editor"), _("Properties"), boost::bind (&ARDOUR_UI::create_session_option_editor, this))
302 , add_video_dialog (X_("add-video"), _("Add Video"), boost::bind (&ARDOUR_UI::create_add_video_dialog, this))
303 , bundle_manager (X_("bundle-manager"), _("Bundle Manager"), boost::bind (&ARDOUR_UI::create_bundle_manager, this))
304 , big_clock_window (X_("big-clock"), _("Big Clock"), boost::bind (&ARDOUR_UI::create_big_clock_window, this))
305 , audio_port_matrix (X_("audio-connection-manager"), _("Audio Connections"), boost::bind (&ARDOUR_UI::create_global_port_matrix, this, ARDOUR::DataType::AUDIO))
306 , midi_port_matrix (X_("midi-connection-manager"), _("MIDI Connections"), boost::bind (&ARDOUR_UI::create_global_port_matrix, this, ARDOUR::DataType::MIDI))
307 , key_editor (X_("key-editor"), _("Keyboard Shortcuts"), boost::bind (&ARDOUR_UI::create_key_editor, this))
308 , video_server_process (0)
310 , have_configure_timeout (false)
311 , last_configure_time (0)
313 , have_disk_speed_dialog_displayed (false)
314 , _status_bar_visibility (X_("status-bar"))
315 , _feedback_exists (false)
316 , _log_not_acknowledged (LogLevelNone)
317 , duplicate_routes_dialog (0)
318 , editor_visibility_button (S_("Window|Editor"))
319 , mixer_visibility_button (S_("Window|Mixer"))
320 , prefs_visibility_button (S_("Window|Preferences"))
322 Gtkmm2ext::init (localedir);
324 UIConfiguration::instance().post_gui_init ();
326 if (ARDOUR::handle_old_configuration_files (boost::bind (ask_about_configuration_copy, _1, _2, _3))) {
327 MessageDialog msg (string_compose (_("Your configuration files were copied. You can now restart %1."), PROGRAM_NAME), true);
329 /* configuration was modified, exit immediately */
334 if (string (VERSIONSTRING).find (".pre") != string::npos) {
335 /* check this is not being run from ./ardev etc. */
336 if (!running_from_source_tree ()) {
337 pre_release_dialog ();
341 if (theArdourUI == 0) {
345 /* track main window visibility */
347 main_window_visibility = new VisibilityTracker (_main_window);
349 /* stop libxml from spewing to stdout/stderr */
351 xmlSetGenericErrorFunc (this, libxml_generic_error_func);
352 xmlSetStructuredErrorFunc (this, libxml_structured_error_func);
354 UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &ARDOUR_UI::parameter_changed));
355 boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
356 UIConfiguration::instance().map_parameters (pc);
358 Glib::RefPtr<Gtk::Action> act;
360 act = ActionManager::get_action ("Transport/Roll");
361 roll_button.set_related_action (act);
362 act = ActionManager::get_action ("Transport/Stop");
363 stop_button.set_related_action (act);
364 act = ActionManager::get_action ("Transport/GotoStart");
365 goto_start_button.set_related_action (act);
366 act = ActionManager::get_action ("Transport/GotoEnd");
367 goto_end_button.set_related_action (act);
368 act = ActionManager::get_action ("Transport/Loop");
369 auto_loop_button.set_related_action (act);
370 act = ActionManager::get_action ("Transport/PlaySelection");
371 play_selection_button.set_related_action (act);
372 act = ActionManager::get_action ("Transport/Record");
373 rec_button.set_related_action (act);
375 roll_button.set_name ("transport button");
376 stop_button.set_name ("transport button");
377 goto_start_button.set_name ("transport button");
378 goto_end_button.set_name ("transport button");
379 auto_loop_button.set_name ("transport button");
380 play_selection_button.set_name ("transport button");
381 rec_button.set_name ("transport recenable button");
382 midi_panic_button.set_name ("transport button");
384 ARDOUR::Diskstream::DiskOverrun.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::disk_overrun_handler, this), gui_context());
385 ARDOUR::Diskstream::DiskUnderrun.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::disk_underrun_handler, this), gui_context());
387 ARDOUR::Session::VersionMismatch.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::session_format_mismatch, this, _1, _2), gui_context());
389 /* handle dialog requests */
391 ARDOUR::Session::Dialog.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::session_dialog, this, _1), gui_context());
393 /* handle pending state with a dialog (PROBLEM: needs to return a value and thus cannot be x-thread) */
395 ARDOUR::Session::AskAboutPendingState.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::pending_state_dialog, this));
397 /* handle Audio/MIDI setup when session requires it */
399 ARDOUR::Session::AudioEngineSetupRequired.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::do_audio_midi_setup, this, _1));
401 /* handle sr mismatch with a dialog (PROBLEM: needs to return a value and thus cannot be x-thread) */
403 ARDOUR::Session::AskAboutSampleRateMismatch.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::sr_mismatch_dialog, this, _1, _2));
405 /* handle sr mismatch with a dialog - cross-thread from engine */
406 ARDOUR::Session::NotifyAboutSampleRateMismatch.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::sr_mismatch_message, this, _1, _2), gui_context ());
408 /* handle requests to quit (coming from JACK session) */
410 ARDOUR::Session::Quit.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::finish, this), gui_context ());
412 /* tell the user about feedback */
414 ARDOUR::Session::FeedbackDetected.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::feedback_detected, this), gui_context ());
415 ARDOUR::Session::SuccessfulGraphSort.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::successful_graph_sort, this), gui_context ());
417 /* handle requests to deal with missing files */
419 ARDOUR::Session::MissingFile.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::missing_file, this, _1, _2, _3));
421 /* and ambiguous files */
423 ARDOUR::FileSource::AmbiguousFileName.connect_same_thread (forever_connections, boost::bind (&ARDOUR_UI::ambiguous_file, this, _1, _2));
425 /* also plugin scan messages */
426 ARDOUR::PluginScanMessage.connect (forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::plugin_scan_dialog, this, _1, _2, _3), gui_context());
427 ARDOUR::PluginScanTimeout.connect (forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::plugin_scan_timeout, this, _1), gui_context());
429 ARDOUR::GUIIdle.connect (forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::gui_idle_handler, this), gui_context());
431 Config->ParameterChanged.connect ( forever_connections, MISSING_INVALIDATOR, boost::bind(&ARDOUR_UI::set_flat_buttons, this), gui_context() );
434 /* lets get this party started */
436 setup_gtk_ardour_enums ();
439 SessionEvent::create_per_thread_pool ("GUI", 4096);
441 /* we like keyboards */
443 keyboard = new ArdourKeyboard(*this);
445 XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
447 keyboard->set_state (*node, Stateful::loading_state_version);
450 UIConfiguration::instance().reset_dpi ();
452 TimeAxisViewItem::set_constant_heights ();
454 /* Set this up so that our window proxies can register actions */
456 ActionManager::init ();
458 /* The following must happen after ARDOUR::init() so that Config is set up */
460 const XMLNode* ui_xml = Config->extra_xml (X_("UI"));
463 key_editor.set_state (*ui_xml, 0);
464 session_option_editor.set_state (*ui_xml, 0);
465 speaker_config_window.set_state (*ui_xml, 0);
466 about.set_state (*ui_xml, 0);
467 add_route_dialog.set_state (*ui_xml, 0);
468 add_video_dialog.set_state (*ui_xml, 0);
469 route_params.set_state (*ui_xml, 0);
470 bundle_manager.set_state (*ui_xml, 0);
471 location_ui.set_state (*ui_xml, 0);
472 big_clock_window.set_state (*ui_xml, 0);
473 audio_port_matrix.set_state (*ui_xml, 0);
474 midi_port_matrix.set_state (*ui_xml, 0);
475 export_video_dialog.set_state (*ui_xml, 0);
476 lua_script_window.set_state (*ui_xml, 0);
479 /* Separate windows */
481 WM::Manager::instance().register_window (&key_editor);
482 WM::Manager::instance().register_window (&session_option_editor);
483 WM::Manager::instance().register_window (&speaker_config_window);
484 WM::Manager::instance().register_window (&about);
485 WM::Manager::instance().register_window (&add_route_dialog);
486 WM::Manager::instance().register_window (&add_video_dialog);
487 WM::Manager::instance().register_window (&route_params);
488 WM::Manager::instance().register_window (&audio_midi_setup);
489 WM::Manager::instance().register_window (&export_video_dialog);
490 WM::Manager::instance().register_window (&lua_script_window);
491 WM::Manager::instance().register_window (&bundle_manager);
492 WM::Manager::instance().register_window (&location_ui);
493 WM::Manager::instance().register_window (&big_clock_window);
494 WM::Manager::instance().register_window (&audio_port_matrix);
495 WM::Manager::instance().register_window (&midi_port_matrix);
497 /* do not retain position for add route dialog */
498 add_route_dialog.set_state_mask (WindowProxy::Size);
500 /* Trigger setting up the color scheme and loading the GTK RC file */
502 UIConfiguration::instance().load_rc_file (false);
504 _process_thread = new ProcessThread ();
505 _process_thread->init ();
507 UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &ARDOUR_UI::resize_text_widgets));
513 ARDOUR_UI::pre_release_dialog ()
515 ArdourDialog d (_("Pre-Release Warning"), true, false);
516 d.add_button (Gtk::Stock::OK, Gtk::RESPONSE_OK);
518 Label* label = manage (new Label);
519 label->set_markup (string_compose (_("<b>Welcome to this pre-release build of %1 %2</b>\n\n\
520 There are still several issues and bugs to be worked on,\n\
521 as well as general workflow improvements, before this can be considered\n\
522 release software. So, a few guidelines:\n\
524 1) Please do <b>NOT</b> use this software with the expectation that it is stable or reliable\n\
525 though it may be so, depending on your workflow.\n\
526 2) Please wait for a helpful writeup of new features.\n\
527 3) <b>Please do NOT use the forums at ardour.org to report issues</b>.\n\
528 4) Please <b>DO</b> use the bugtracker at http://tracker.ardour.org/ to report issues\n\
529 making sure to note the product version number as 5.0-pre.\n\
530 5) Please <b>DO</b> use the ardour-users mailing list to discuss ideas and pass on comments.\n\
531 6) Please <b>DO</b> join us on IRC for real time discussions about %1 %2. You\n\
532 can get there directly from within the program via the Help->Chat menu option.\n\
534 Full information on all the above can be found on the support page at\n\
536 http://ardour.org/support\n\
537 "), PROGRAM_NAME, VERSIONSTRING));
539 d.get_vbox()->set_border_width (12);
540 d.get_vbox()->pack_start (*label, false, false, 12);
541 d.get_vbox()->show_all ();
546 GlobalPortMatrixWindow*
547 ARDOUR_UI::create_global_port_matrix (ARDOUR::DataType type)
552 return new GlobalPortMatrixWindow (_session, type);
556 ARDOUR_UI::attach_to_engine ()
558 AudioEngine::instance()->Running.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_running, this), gui_context());
559 ARDOUR::Port::set_connecting_blocked (ARDOUR_COMMAND_LINE::no_connect_ports);
563 ARDOUR_UI::engine_stopped ()
565 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::engine_stopped)
566 ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, false);
567 ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, true);
568 update_sample_rate (0);
573 ARDOUR_UI::engine_running ()
575 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::engine_running)
576 if (first_time_engine_run) {
578 first_time_engine_run = false;
582 _session->reset_xrun_count ();
584 update_disk_space ();
586 update_xrun_count ();
587 update_sample_rate (AudioEngine::instance()->sample_rate());
588 update_timecode_format ();
589 update_peak_thread_work ();
590 ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, true);
591 ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, false);
595 ARDOUR_UI::engine_halted (const char* reason, bool free_reason)
597 if (!Gtkmm2ext::UI::instance()->caller_is_ui_thread()) {
598 /* we can't rely on the original string continuing to exist when we are called
599 again in the GUI thread, so make a copy and note that we need to
602 char *copy = strdup (reason);
603 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_halted, this, copy, true));
607 ActionManager::set_sensitive (ActionManager::engine_sensitive_actions, false);
608 ActionManager::set_sensitive (ActionManager::engine_opposite_sensitive_actions, true);
610 update_sample_rate (0);
614 /* if the reason is a non-empty string, it means that the backend was shutdown
615 rather than just Ardour.
618 if (strlen (reason)) {
619 msgstr = string_compose (_("The audio backend was shutdown because:\n\n%1"), reason);
621 msgstr = string_compose (_("\
622 The audio backend has either been shutdown or it\n\
623 disconnected %1 because %1\n\
624 was not fast enough. Try to restart\n\
625 the audio backend and save the session."), PROGRAM_NAME);
628 MessageDialog msg (_main_window, msgstr);
629 pop_back_splash (msg);
633 free (const_cast<char*> (reason));
638 ARDOUR_UI::post_engine ()
640 /* Things to be done once (and once ONLY) after we have a backend running in the AudioEngine
642 #ifdef AUDIOUNIT_SUPPORT
644 if (AUPluginInfo::au_get_crashlog(au_msg)) {
645 popup_error(_("Audio Unit Plugin Scan Failed. Automatic AU scanning has been disabled. Please see the log window for further details."));
646 error << _("Audio Unit Plugin Scan Failed:") << endmsg;
647 info << au_msg << endmsg;
651 ARDOUR::init_post_engine ();
653 /* connect to important signals */
655 AudioEngine::instance()->Stopped.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::engine_stopped, this), gui_context());
656 AudioEngine::instance()->SampleRateChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::update_sample_rate, this, _1), gui_context());
657 AudioEngine::instance()->BufferSizeChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::update_sample_rate, this, _1), gui_context());
658 AudioEngine::instance()->Halted.connect_same_thread (halt_connection, boost::bind (&ARDOUR_UI::engine_halted, this, _1, false));
659 AudioEngine::instance()->BecameSilent.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::audioengine_became_silent, this), gui_context());
661 if (setup_windows ()) {
662 throw failed_constructor ();
665 /* Do this after setup_windows (), as that's when the _status_bar_visibility is created */
666 XMLNode* n = Config->extra_xml (X_("UI"));
668 _status_bar_visibility.set_state (*n);
671 check_memory_locking();
673 /* this is the first point at which all the possible actions are
674 * available, because some of the available actions are dependent on
675 * aspects of the engine/backend.
678 if (ARDOUR_COMMAND_LINE::show_key_actions) {
681 vector<string> paths;
682 vector<string> labels;
683 vector<string> tooltips;
685 vector<Glib::RefPtr<Gtk::Action> > actions;
687 Gtkmm2ext::ActionMap::get_all_actions (paths, labels, tooltips, keys, actions);
689 vector<string>::iterator k;
690 vector<string>::iterator p;
692 for (p = paths.begin(), k = keys.begin(); p != paths.end(); ++k, ++p) {
697 cout << *p << " => " << *k << endl;
701 halt_connection.disconnect ();
702 AudioEngine::instance()->stop ();
706 /* this being a GUI and all, we want peakfiles */
708 AudioFileSource::set_build_peakfiles (true);
709 AudioFileSource::set_build_missing_peakfiles (true);
711 /* set default clock modes */
713 primary_clock->set_mode (AudioClock::Timecode);
714 secondary_clock->set_mode (AudioClock::BBT);
716 /* start the time-of-day-clock */
719 /* OS X provides a nearly-always visible wallclock, so don't be stupid */
720 update_wall_clock ();
721 Glib::signal_timeout().connect_seconds (sigc::mem_fun(*this, &ARDOUR_UI::update_wall_clock), 1);
726 Config->ParameterChanged.connect (forever_connections, MISSING_INVALIDATOR, boost::bind (&ARDOUR_UI::parameter_changed, this, _1), gui_context());
727 boost::function<void (string)> pc (boost::bind (&ARDOUR_UI::parameter_changed, this, _1));
728 Config->map_parameters (pc);
730 UIConfiguration::instance().map_parameters (pc);
734 ARDOUR_UI::~ARDOUR_UI ()
736 UIConfiguration::instance().save_state();
740 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
741 // don't bother at 'real' exit. the OS cleans up for us.
742 delete big_clock; big_clock = 0;
743 delete primary_clock; primary_clock = 0;
744 delete secondary_clock; secondary_clock = 0;
745 delete _process_thread; _process_thread = 0;
746 delete time_info_box; time_info_box = 0;
747 delete meterbridge; meterbridge = 0;
748 delete luawindow; luawindow = 0;
749 delete editor; editor = 0;
750 delete mixer; mixer = 0;
751 delete rc_option_editor; rc_option_editor = 0; // failed to wrap object warning
753 delete gui_object_state; gui_object_state = 0;
754 delete main_window_visibility;
755 FastMeter::flush_pattern_cache ();
756 PixFader::flush_pattern_cache ();
760 /* Small trick to flush main-thread event pool.
761 * Other thread-pools are destroyed at pthread_exit(),
762 * but tmain thread termination is too late to trigger Pool::~Pool()
764 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Clear, SessionEvent::Immediate, 0, 0); // get the pool reference, values don't matter since the event is never queued.
765 delete ev->event_pool();
770 ARDOUR_UI::pop_back_splash (Gtk::Window& win)
772 if (Splash::instance()) {
773 Splash::instance()->pop_back_for (win);
778 ARDOUR_UI::configure_timeout ()
780 if (last_configure_time == 0) {
781 /* no configure events yet */
785 /* force a gap of 0.5 seconds since the last configure event
788 if (get_microseconds() - last_configure_time < 500000) {
791 have_configure_timeout = false;
792 save_ardour_state ();
798 ARDOUR_UI::configure_handler (GdkEventConfigure* /*conf*/)
800 if (have_configure_timeout) {
801 last_configure_time = get_microseconds();
803 Glib::signal_timeout().connect (sigc::mem_fun(*this, &ARDOUR_UI::configure_timeout), 100);
804 have_configure_timeout = true;
811 ARDOUR_UI::save_session_at_its_request (std::string snapshot_name)
814 _session->save_state (snapshot_name);
819 ARDOUR_UI::autosave_session ()
821 if (g_main_depth() > 1) {
822 /* inside a recursive main loop,
823 give up because we may not be able to
829 if (!Config->get_periodic_safety_backups()) {
834 _session->maybe_write_autosave();
841 ARDOUR_UI::session_dirty_changed ()
848 ARDOUR_UI::update_autosave ()
850 if (_session && _session->dirty()) {
851 if (_autosave_connection.connected()) {
852 _autosave_connection.disconnect();
855 _autosave_connection = Glib::signal_timeout().connect (sigc::mem_fun (*this, &ARDOUR_UI::autosave_session),
856 Config->get_periodic_safety_backup_interval() * 1000);
859 if (_autosave_connection.connected()) {
860 _autosave_connection.disconnect();
866 ARDOUR_UI::check_announcements ()
869 string _annc_filename;
872 _annc_filename = PROGRAM_NAME "_announcements_osx_";
873 #elif defined PLATFORM_WINDOWS
874 _annc_filename = PROGRAM_NAME "_announcements_windows_";
876 _annc_filename = PROGRAM_NAME "_announcements_linux_";
878 _annc_filename.append (VERSIONSTRING);
880 _announce_string = "";
882 std::string path = Glib::build_filename (user_config_directory(), _annc_filename);
883 FILE* fin = g_fopen (path.c_str(), "rb");
885 while (!feof (fin)) {
888 if ((len = fread (tmp, sizeof(char), 1024, fin)) == 0 || ferror (fin)) {
891 _announce_string.append (tmp, len);
896 pingback (VERSIONSTRING, path);
901 _hide_splash (gpointer arg)
903 ((ARDOUR_UI*)arg)->hide_splash();
908 ARDOUR_UI::starting ()
910 Application* app = Application::instance ();
912 bool brand_new_user = ArdourStartup::required ();
914 app->ShouldQuit.connect (sigc::mem_fun (*this, &ARDOUR_UI::queue_finish));
915 app->ShouldLoad.connect (sigc::mem_fun (*this, &ARDOUR_UI::load_from_application_api));
917 if (ARDOUR_COMMAND_LINE::check_announcements) {
918 check_announcements ();
923 /* we need to create this early because it may need to set the
924 * audio backend end up.
928 audio_midi_setup.get (true);
930 std::cerr << "audio-midi engine setup failed."<< std::endl;
934 if ((nsm_url = g_getenv ("NSM_URL")) != 0) {
935 nsm = new NSM_Client;
936 if (!nsm->init (nsm_url)) {
937 /* the ardour executable may have different names:
939 * waf's obj.target for distro versions: eg ardour4, ardourvst4
940 * Ardour4, Mixbus3 for bundled versions + full path on OSX & windows
941 * argv[0] does not apply since we need the wrapper-script (not the binary itself)
943 * The wrapper startup script should set the environment variable 'ARDOUR_SELF'
945 const char *process_name = g_getenv ("ARDOUR_SELF");
946 nsm->announce (PROGRAM_NAME, ":dirty:", process_name ? process_name : "ardour4");
949 // wait for announce reply from nsm server
950 for ( i = 0; i < 5000; ++i) {
954 if (nsm->is_active()) {
959 error << _("NSM server did not announce itself") << endmsg;
962 // wait for open command from nsm server
963 for ( i = 0; i < 5000; ++i) {
966 if (nsm->client_id ()) {
972 error << _("NSM: no client ID provided") << endmsg;
976 if (_session && nsm) {
977 _session->set_nsm_state( nsm->is_active() );
979 error << _("NSM: no session created") << endmsg;
983 // nsm requires these actions disabled
984 vector<string> action_names;
985 action_names.push_back("SaveAs");
986 action_names.push_back("Rename");
987 action_names.push_back("New");
988 action_names.push_back("Open");
989 action_names.push_back("Recent");
990 action_names.push_back("Close");
992 for (vector<string>::const_iterator n = action_names.begin(); n != action_names.end(); ++n) {
993 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Main"), (*n).c_str());
995 act->set_sensitive (false);
1002 error << _("NSM: initialization failed") << endmsg;
1008 if (brand_new_user) {
1009 _initial_verbose_plugin_scan = true;
1014 _initial_verbose_plugin_scan = false;
1015 switch (s.response ()) {
1016 case Gtk::RESPONSE_OK:
1023 // TODO: maybe IFF brand_new_user
1024 if (ARDOUR::Profile->get_mixbus () && Config->get_copy_demo_sessions ()) {
1025 std::string dspd (Config->get_default_session_parent_dir());
1026 Searchpath ds (ARDOUR::ardour_data_search_path());
1027 ds.add_subdirectory_to_paths ("sessions");
1028 vector<string> demos;
1029 find_files_matching_pattern (demos, ds, "*.tar.xz");
1031 ARDOUR::RecentSessions rs;
1032 ARDOUR::read_recent_sessions (rs);
1034 for (vector<string>::iterator i = demos.begin(); i != demos.end (); ++i) {
1035 /* "demo-session" must be inside "demo-session.tar.xz"
1038 std::string name = basename_nosuffix (basename_nosuffix (*i));
1039 std::string path = Glib::build_filename (dspd, name);
1040 /* skip if session-dir already exists */
1041 if (Glib::file_test(path.c_str(), Glib::FILE_TEST_IS_DIR)) {
1044 /* skip sessions that are already in 'recent'.
1045 * eg. a new user changed <session-default-dir> shorly after installation
1047 for (ARDOUR::RecentSessions::iterator r = rs.begin(); r != rs.end(); ++r) {
1048 if ((*r).first == name) {
1053 PBD::FileArchive ar (*i);
1054 if (0 == ar.inflate (dspd)) {
1055 store_recent_sessions (name, path);
1056 info << string_compose (_("Copied Demo Session %1."), name) << endmsg;
1062 #ifdef NO_PLUGIN_STATE
1064 ARDOUR::RecentSessions rs;
1065 ARDOUR::read_recent_sessions (rs);
1067 string path = Glib::build_filename (user_config_directory(), ".iknowaboutfreeversion");
1069 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS) && !rs.empty()) {
1071 /* already used Ardour, have sessions ... warn about plugin state */
1073 ArdourDialog d (_("Free/Demo Version Warning"), true);
1075 Button b (string_compose (_("Subscribe and support development of %1"), PROGRAM_NAME));
1076 CheckButton c (_("Don't warn me about this again"));
1078 l.set_markup (string_compose (_("<span weight=\"bold\" size=\"large\">%1</span>\n\n<b>%2</b>\n\n<i>%3</i>\n\n%4"),
1079 string_compose (_("This is a free/demo version of %1"), PROGRAM_NAME),
1080 _("It will not restore OR save any plugin settings"),
1081 _("If you load an existing session with plugin settings\n"
1082 "they will not be used and will be lost."),
1083 _("To get full access to updates without this limitation\n"
1084 "consider becoming a subscriber for a low cost every month.")));
1085 l.set_justify (JUSTIFY_CENTER);
1087 b.signal_clicked().connect (mem_fun(*this, &ARDOUR_UI::launch_subscribe));
1089 d.get_vbox()->pack_start (l, true, true);
1090 d.get_vbox()->pack_start (b, false, false, 12);
1091 d.get_vbox()->pack_start (c, false, false, 12);
1093 d.add_button (_("Quit now"), RESPONSE_CANCEL);
1094 d.add_button (string_compose (_("Continue using %1"), PROGRAM_NAME), RESPONSE_OK);
1098 c.signal_toggled().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (toggle_file_existence), path)));
1100 if (d.run () != RESPONSE_OK) {
1106 /* go get a session */
1108 const bool new_session_required = (ARDOUR_COMMAND_LINE::new_session || brand_new_user);
1110 if (get_session_parameters (false, new_session_required, ARDOUR_COMMAND_LINE::load_template)) {
1111 std::cerr << "Cannot get session parameters."<< std::endl;
1118 WM::Manager::instance().show_visible ();
1120 /* We have to do this here since goto_editor_window() ends up calling show_all() on the
1121 * editor window, and we may want stuff to be hidden.
1123 _status_bar_visibility.update ();
1125 BootMessage (string_compose (_("%1 is ready for use"), PROGRAM_NAME));
1127 if (splash && splash->is_visible()) {
1128 // in 1 second, hide the splash screen
1129 Glib::signal_timeout().connect (sigc::bind (sigc::ptr_fun (_hide_splash), this), 1000);
1132 /* all other dialogs are created conditionally */
1138 ARDOUR_UI::check_memory_locking ()
1140 #if defined(__APPLE__) || defined(PLATFORM_WINDOWS)
1141 /* OS X doesn't support mlockall(2), and so testing for memory locking capability there is pointless */
1145 XMLNode* memory_warning_node = Config->instant_xml (X_("no-memory-warning"));
1147 if (AudioEngine::instance()->is_realtime() && memory_warning_node == 0) {
1149 struct rlimit limits;
1151 long pages, page_size;
1153 size_t pages_len=sizeof(pages);
1154 if ((page_size = getpagesize()) < 0 ||
1155 sysctlbyname("hw.availpages", &pages, &pages_len, NULL, 0))
1157 if ((page_size = sysconf (_SC_PAGESIZE)) < 0 ||(pages = sysconf (_SC_PHYS_PAGES)) < 0)
1162 ram = (int64_t) pages * (int64_t) page_size;
1165 if (getrlimit (RLIMIT_MEMLOCK, &limits)) {
1169 if (limits.rlim_cur != RLIM_INFINITY) {
1171 if (ram == 0 || ((double) limits.rlim_cur / ram) < 0.75) {
1175 _("WARNING: Your system has a limit for maximum amount of locked memory. "
1176 "This might cause %1 to run out of memory before your system "
1177 "runs out of memory. \n\n"
1178 "You can view the memory limit with 'ulimit -l', "
1179 "and it is normally controlled by %2"),
1182 X_("/etc/login.conf")
1184 X_(" /etc/security/limits.conf")
1188 msg.set_default_response (RESPONSE_OK);
1190 VBox* vbox = msg.get_vbox();
1192 CheckButton cb (_("Do not show this window again"));
1193 hbox.pack_start (cb, true, false);
1194 vbox->pack_start (hbox);
1199 pop_back_splash (msg);
1203 if (cb.get_active()) {
1204 XMLNode node (X_("no-memory-warning"));
1205 Config->add_instant_xml (node);
1210 #endif // !__APPLE__
1215 ARDOUR_UI::queue_finish ()
1217 Glib::signal_idle().connect (mem_fun (*this, &ARDOUR_UI::idle_finish));
1221 ARDOUR_UI::idle_finish ()
1224 return false; /* do not call again */
1231 ARDOUR_UI::instance()->video_timeline->sync_session_state();
1233 if (_session->dirty()) {
1234 vector<string> actions;
1235 actions.push_back (_("Don't quit"));
1236 actions.push_back (_("Just quit"));
1237 actions.push_back (_("Save and quit"));
1238 switch (ask_about_saving_session(actions)) {
1243 /* use the default name */
1244 if (save_state_canfail ("")) {
1245 /* failed - don't quit */
1246 MessageDialog msg (_main_window,
1247 string_compose (_("\
1248 %1 was unable to save your session.\n\n\
1249 If you still wish to quit, please use the\n\n\
1250 \"Just quit\" option."), PROGRAM_NAME));
1251 pop_back_splash(msg);
1261 second_connection.disconnect ();
1262 point_one_second_connection.disconnect ();
1263 point_zero_something_second_connection.disconnect();
1264 fps_connection.disconnect();
1267 delete ARDOUR_UI::instance()->video_timeline;
1268 ARDOUR_UI::instance()->video_timeline = NULL;
1269 stop_video_server();
1271 /* Save state before deleting the session, as that causes some
1272 windows to be destroyed before their visible state can be
1275 save_ardour_state ();
1277 if (key_editor.get (false)) {
1278 key_editor->disconnect ();
1281 close_all_dialogs ();
1284 _session->set_clean ();
1285 _session->remove_pending_capture_state ();
1290 halt_connection.disconnect ();
1291 AudioEngine::instance()->stop ();
1292 #ifdef WINDOWS_VST_SUPPORT
1293 fst_stop_threading();
1299 ARDOUR_UI::ask_about_saving_session (const vector<string>& actions)
1301 ArdourDialog window (_("Unsaved Session"));
1302 Gtk::HBox dhbox; // the hbox for the image and text
1303 Gtk::Label prompt_label;
1304 Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_WARNING, Gtk::ICON_SIZE_DIALOG));
1308 assert (actions.size() >= 3);
1310 window.add_button (actions[0], RESPONSE_REJECT);
1311 window.add_button (actions[1], RESPONSE_APPLY);
1312 window.add_button (actions[2], RESPONSE_ACCEPT);
1314 window.set_default_response (RESPONSE_ACCEPT);
1316 Gtk::Button noquit_button (msg);
1317 noquit_button.set_name ("EditorGTKButton");
1321 if (_session->snap_name() == _session->name()) {
1322 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?"),
1323 _session->snap_name());
1325 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?"),
1326 _session->snap_name());
1329 prompt_label.set_text (prompt);
1330 prompt_label.set_name (X_("PrompterLabel"));
1331 prompt_label.set_alignment(ALIGN_LEFT, ALIGN_TOP);
1333 dimage->set_alignment(ALIGN_CENTER, ALIGN_TOP);
1334 dhbox.set_homogeneous (false);
1335 dhbox.pack_start (*dimage, false, false, 5);
1336 dhbox.pack_start (prompt_label, true, false, 5);
1337 window.get_vbox()->pack_start (dhbox);
1339 window.set_name (_("Prompter"));
1340 window.set_modal (true);
1341 window.set_resizable (false);
1344 prompt_label.show();
1349 ResponseType r = (ResponseType) window.run();
1354 case RESPONSE_ACCEPT: // save and get out of here
1356 case RESPONSE_APPLY: // get out of here
1367 ARDOUR_UI::every_second ()
1370 update_xrun_count ();
1371 update_buffer_load ();
1372 update_disk_space ();
1373 update_timecode_format ();
1374 update_peak_thread_work ();
1376 if (nsm && nsm->is_active ()) {
1379 if (!_was_dirty && _session->dirty ()) {
1383 else if (_was_dirty && !_session->dirty ()){
1391 ARDOUR_UI::every_point_one_seconds ()
1393 // TODO get rid of this..
1394 // ShuttleControl is updated directly via TransportStateChange signal
1398 ARDOUR_UI::every_point_zero_something_seconds ()
1400 // august 2007: actual update frequency: 25Hz (40ms), not 100Hz
1402 if (editor_meter && UIConfiguration::instance().get_show_editor_meter() && editor_meter_peak_display.is_mapped ()) {
1403 float mpeak = editor_meter->update_meters();
1404 if (mpeak > editor_meter_max_peak) {
1405 if (mpeak >= UIConfiguration::instance().get_meter_peak()) {
1406 editor_meter_peak_display.set_active_state ( Gtkmm2ext::ExplicitActive );
1413 ARDOUR_UI::set_fps_timeout_connection ()
1415 unsigned int interval = 40;
1416 if (!_session) return;
1417 if (_session->timecode_frames_per_second() != 0) {
1418 /* ideally we'll use a select() to sleep and not accumulate
1419 * idle time to provide a regular periodic signal.
1420 * See linux_vst_gui_support.cc 'elapsed_time_ms'.
1421 * However, that'll require a dedicated thread and cross-thread
1422 * signals to the GUI Thread..
1424 interval = floor(500. /* update twice per FPS, since Glib::signal_timeout is very irregular */
1425 * _session->frame_rate() / _session->nominal_frame_rate()
1426 / _session->timecode_frames_per_second()
1428 #ifdef PLATFORM_WINDOWS
1429 // the smallest windows scheduler time-slice is ~15ms.
1430 // periodic GUI timeouts shorter than that will cause
1431 // WaitForSingleObject to spinlock (100% of one CPU Core)
1432 // and gtk never enters idle mode.
1433 // also changing timeBeginPeriod(1) does not affect that in
1434 // any beneficial way, so we just limit the max rate for now.
1435 interval = std::max(30u, interval); // at most ~33Hz.
1437 interval = std::max(8u, interval); // at most 120Hz.
1440 fps_connection.disconnect();
1441 Timers::set_fps_interval (interval);
1445 ARDOUR_UI::update_sample_rate (framecnt_t)
1449 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::update_sample_rate, ignored)
1451 if (!AudioEngine::instance()->connected()) {
1453 snprintf (buf, sizeof (buf), "%s", _("Audio: <span foreground=\"red\">none</span>"));
1457 framecnt_t rate = AudioEngine::instance()->sample_rate();
1460 /* no sample rate available */
1461 snprintf (buf, sizeof (buf), "%s", _("Audio: <span foreground=\"red\">none</span>"));
1464 if (fmod (rate, 1000.0) != 0.0) {
1465 snprintf (buf, sizeof (buf), _("Audio: <span foreground=\"green\">%.1f kHz / %4.1f ms</span>"),
1466 (float) rate / 1000.0f,
1467 (AudioEngine::instance()->usecs_per_cycle() / 1000.0f));
1469 snprintf (buf, sizeof (buf), _("Audio: <span foreground=\"green\">%" PRId64 " kHz / %4.1f ms</span>"),
1471 (AudioEngine::instance()->usecs_per_cycle() / 1000.0f));
1475 sample_rate_label.set_markup (buf);
1479 ARDOUR_UI::update_format ()
1482 format_label.set_text ("");
1487 s << _("File:") << X_(" <span foreground=\"green\">");
1489 switch (_session->config.get_native_file_header_format ()) {
1521 switch (_session->config.get_native_file_data_format ()) {
1535 format_label.set_markup (s.str ());
1539 ARDOUR_UI::update_xrun_count ()
1543 /* If this text is changed, the set_size_request_to_display_given_text call in ARDOUR_UI::resize_text_widgets
1544 should also be changed.
1548 const unsigned int x = _session->get_xrun_count ();
1550 snprintf (buf, sizeof (buf), _("X: <span foreground=\"%s\">>10K</span>"), X_("red"));
1552 snprintf (buf, sizeof (buf), _("X: <span foreground=\"%s\">%u</span>"), x > 0 ? X_("red") : X_("green"), x);
1555 snprintf (buf, sizeof (buf), _("X: <span foreground=\"%s\">?</span>"), X_("yellow"));
1557 xrun_label.set_markup (buf);
1558 set_tip (xrun_label, _("Audio dropouts. Shift+click to reset"));
1562 ARDOUR_UI::update_cpu_load ()
1566 /* If this text is changed, the set_size_request_to_display_given_text call in ARDOUR_UI::resize_text_widgets
1567 should also be changed.
1570 double const c = AudioEngine::instance()->get_dsp_load ();
1571 snprintf (buf, sizeof (buf), _("DSP: <span foreground=\"%s\">%5.1f%%</span>"), c >= 90 ? X_("red") : X_("green"), c);
1572 cpu_load_label.set_markup (buf);
1576 ARDOUR_UI::update_peak_thread_work ()
1579 const int c = SourceFactory::peak_work_queue_length ();
1581 snprintf (buf, sizeof (buf), _("PkBld: <span foreground=\"%s\">%d</span>"), c >= 2 ? X_("red") : X_("green"), c);
1582 peak_thread_work_label.set_markup (buf);
1584 peak_thread_work_label.set_markup (X_(""));
1589 ARDOUR_UI::update_buffer_load ()
1593 uint32_t const playback = _session ? _session->playback_load () : 100;
1594 uint32_t const capture = _session ? _session->capture_load () : 100;
1596 /* If this text is changed, the set_size_request_to_display_given_text call in ARDOUR_UI::resize_text_widgets
1597 should also be changed.
1603 _("Buffers: <span foreground=\"green\">p:</span><span foreground=\"%s\">%" PRIu32 "%%</span> "
1604 "<span foreground=\"green\">c:</span><span foreground=\"%s\">%" PRIu32 "%%</span>"),
1605 playback <= 5 ? X_("red") : X_("green"),
1607 capture <= 5 ? X_("red") : X_("green"),
1611 buffer_load_label.set_markup (buf);
1613 buffer_load_label.set_text ("");
1618 ARDOUR_UI::count_recenabled_streams (Route& route)
1620 Track* track = dynamic_cast<Track*>(&route);
1621 if (track && track->rec_enable_control()->get_value()) {
1622 rec_enabled_streams += track->n_inputs().n_total();
1627 ARDOUR_UI::update_disk_space()
1629 if (_session == 0) {
1633 boost::optional<framecnt_t> opt_frames = _session->available_capture_duration();
1635 framecnt_t fr = _session->frame_rate();
1638 /* skip update - no SR available */
1643 /* Available space is unknown */
1644 snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">Unknown</span>"));
1645 } else if (opt_frames.get_value_or (0) == max_framecnt) {
1646 snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">24hrs+</span>"));
1648 rec_enabled_streams = 0;
1649 _session->foreach_route (this, &ARDOUR_UI::count_recenabled_streams, false);
1651 framecnt_t frames = opt_frames.get_value_or (0);
1653 if (rec_enabled_streams) {
1654 frames /= rec_enabled_streams;
1661 hrs = frames / (fr * 3600);
1664 snprintf (buf, sizeof (buf), "%s", _("Disk: <span foreground=\"green\">>24 hrs</span>"));
1666 frames -= hrs * fr * 3600;
1667 mins = frames / (fr * 60);
1668 frames -= mins * fr * 60;
1671 bool const low = (hrs == 0 && mins <= 30);
1675 _("Disk: <span foreground=\"%s\">%02dh:%02dm:%02ds</span>"),
1676 low ? X_("red") : X_("green"),
1682 disk_space_label.set_markup (buf);
1686 ARDOUR_UI::update_timecode_format ()
1692 TimecodeSlave* tcslave;
1693 SyncSource sync_src = Config->get_sync_source();
1695 if ((sync_src == LTC || sync_src == MTC) && (tcslave = dynamic_cast<TimecodeSlave*>(_session->slave())) != 0) {
1696 matching = (tcslave->apparent_timecode_format() == _session->config.get_timecode_format());
1701 snprintf (buf, sizeof (buf), S_("Timecode|TC: <span foreground=\"%s\">%s</span>"),
1702 matching ? X_("green") : X_("red"),
1703 Timecode::timecode_format_name (_session->config.get_timecode_format()).c_str());
1705 snprintf (buf, sizeof (buf), "TC: n/a");
1708 timecode_format_label.set_markup (buf);
1712 ARDOUR_UI::update_wall_clock ()
1716 static int last_min = -1;
1719 tm_now = localtime (&now);
1720 if (last_min != tm_now->tm_min) {
1722 sprintf (buf, "%02d:%02d", tm_now->tm_hour, tm_now->tm_min);
1723 wall_clock_label.set_text (buf);
1724 last_min = tm_now->tm_min;
1731 ARDOUR_UI::open_recent_session ()
1733 bool can_return = (_session != 0);
1735 SessionDialog recent_session_dialog;
1739 ResponseType r = (ResponseType) recent_session_dialog.run ();
1742 case RESPONSE_ACCEPT:
1746 recent_session_dialog.hide();
1753 recent_session_dialog.hide();
1757 std::string path = recent_session_dialog.session_folder();
1758 std::string state = recent_session_dialog.session_name (should_be_new);
1760 if (should_be_new == true) {
1764 _session_is_new = false;
1766 if (load_session (path, state) == 0) {
1772 if (splash && splash->is_visible()) {
1773 // in 1 second, hide the splash screen
1774 Glib::signal_timeout().connect (sigc::bind (sigc::ptr_fun (_hide_splash), this), 1000);
1779 ARDOUR_UI::check_audioengine (Gtk::Window& parent)
1781 if (!AudioEngine::instance()->connected()) {
1782 MessageDialog msg (parent, string_compose (
1783 _("%1 is not connected to any audio backend.\n"
1784 "You cannot open or close sessions in this condition"),
1786 pop_back_splash (msg);
1794 ARDOUR_UI::open_session ()
1796 if (!check_audioengine (_main_window)) {
1800 /* ardour sessions are folders */
1801 Gtk::FileChooserDialog open_session_selector(_("Open Session"), FILE_CHOOSER_ACTION_OPEN);
1802 open_session_selector.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
1803 open_session_selector.add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
1804 open_session_selector.set_default_response(Gtk::RESPONSE_ACCEPT);
1807 string session_parent_dir = Glib::path_get_dirname(_session->path());
1808 open_session_selector.set_current_folder(session_parent_dir);
1810 open_session_selector.set_current_folder(Config->get_default_session_parent_dir());
1813 Gtkmm2ext::add_volume_shortcuts (open_session_selector);
1815 /* add_shortcut_folder throws an exception if the folder being added already has a shortcut */
1816 string default_session_folder = Config->get_default_session_parent_dir();
1817 open_session_selector.add_shortcut_folder (default_session_folder);
1819 catch (Glib::Error & e) {
1820 std::cerr << "open_session_selector.add_shortcut_folder() threw Glib::Error " << e.what() << std::endl;
1823 FileFilter session_filter;
1824 session_filter.add_pattern (string_compose(X_("*%1"), ARDOUR::statefile_suffix));
1825 session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
1826 open_session_selector.add_filter (session_filter);
1828 FileFilter archive_filter;
1829 archive_filter.add_pattern (X_("*.tar.xz"));
1830 archive_filter.set_name (_("Session Archives"));
1832 open_session_selector.add_filter (archive_filter);
1834 open_session_selector.set_filter (session_filter);
1836 int response = open_session_selector.run();
1837 open_session_selector.hide ();
1839 if (response == Gtk::RESPONSE_CANCEL) {
1843 string session_path = open_session_selector.get_filename();
1847 if (session_path.length() > 0) {
1848 int rv = ARDOUR::inflate_session (session_path,
1849 Config->get_default_session_parent_dir(), path, name);
1851 _session_is_new = false;
1852 load_session (path, name);
1855 MessageDialog msg (_main_window,
1856 string_compose (_("Extracting session-archive failed: %1"), inflate_error (rv)));
1859 else if (ARDOUR::find_session (session_path, path, name, isnew) == 0) {
1860 _session_is_new = isnew;
1861 load_session (path, name);
1867 ARDOUR_UI::session_add_vca (const string& name_template, uint32_t n)
1873 _session->vca_manager().create_vca (n, name_template);
1877 ARDOUR_UI::session_add_mixed_track (
1878 const ChanCount& input,
1879 const ChanCount& output,
1880 RouteGroup* route_group,
1882 const string& name_template,
1884 PluginInfoPtr instrument,
1885 Plugin::PresetRecord* pset,
1886 ARDOUR::PresentationInfo::order_t order)
1888 if (_session == 0) {
1889 warning << _("You cannot add a track without a session already loaded.") << endmsg;
1893 if (Profile->get_mixbus ()) {
1898 list<boost::shared_ptr<MidiTrack> > tracks;
1899 tracks = _session->new_midi_track (input, output, strict_io, instrument, pset, route_group, how_many, name_template, order, ARDOUR::Normal);
1901 if (tracks.size() != how_many) {
1902 error << string_compose(P_("could not create %1 new mixed track", "could not create %1 new mixed tracks", how_many), how_many) << endmsg;
1907 display_insufficient_ports_message ();
1913 ARDOUR_UI::session_add_midi_bus (
1914 RouteGroup* route_group,
1916 const string& name_template,
1918 PluginInfoPtr instrument,
1919 Plugin::PresetRecord* pset,
1920 ARDOUR::PresentationInfo::order_t order)
1922 if (_session == 0) {
1923 warning << _("You cannot add a track without a session already loaded.") << endmsg;
1927 if (Profile->get_mixbus ()) {
1933 routes = _session->new_midi_route (route_group, how_many, name_template, strict_io, instrument, pset, PresentationInfo::MidiBus, order);
1934 if (routes.size() != how_many) {
1935 error << string_compose(P_("could not create %1 new Midi Bus", "could not create %1 new Midi Busses", how_many), how_many) << endmsg;
1940 display_insufficient_ports_message ();
1946 ARDOUR_UI::session_add_midi_route (
1948 RouteGroup* route_group,
1950 const string& name_template,
1952 PluginInfoPtr instrument,
1953 Plugin::PresetRecord* pset,
1954 ARDOUR::PresentationInfo::order_t order)
1956 ChanCount one_midi_channel;
1957 one_midi_channel.set (DataType::MIDI, 1);
1960 session_add_mixed_track (one_midi_channel, one_midi_channel, route_group, how_many, name_template, strict_io, instrument, pset, order);
1962 session_add_midi_bus (route_group, how_many, name_template, strict_io, instrument, pset, order);
1967 ARDOUR_UI::session_add_audio_route (
1969 int32_t input_channels,
1970 int32_t output_channels,
1971 ARDOUR::TrackMode mode,
1972 RouteGroup* route_group,
1974 string const & name_template,
1976 ARDOUR::PresentationInfo::order_t order)
1978 list<boost::shared_ptr<AudioTrack> > tracks;
1981 if (_session == 0) {
1982 warning << _("You cannot add a track or bus without a session already loaded.") << endmsg;
1988 tracks = _session->new_audio_track (input_channels, output_channels, route_group, how_many, name_template, order, mode);
1990 if (tracks.size() != how_many) {
1991 error << string_compose (P_("could not create %1 new audio track", "could not create %1 new audio tracks", how_many), how_many)
1997 routes = _session->new_audio_route (input_channels, output_channels, route_group, how_many, name_template, PresentationInfo::AudioBus, order);
1999 if (routes.size() != how_many) {
2000 error << string_compose (P_("could not create %1 new audio bus", "could not create %1 new audio busses", how_many), how_many)
2007 display_insufficient_ports_message ();
2012 for (list<boost::shared_ptr<AudioTrack> >::iterator i = tracks.begin(); i != tracks.end(); ++i) {
2013 (*i)->set_strict_io (true);
2015 for (RouteList::iterator i = routes.begin(); i != routes.end(); ++i) {
2016 (*i)->set_strict_io (true);
2022 ARDOUR_UI::display_insufficient_ports_message ()
2024 MessageDialog msg (_main_window,
2025 string_compose (_("There are insufficient ports available\n\
2026 to create a new track or bus.\n\
2027 You should save %1, exit and\n\
2028 restart with more ports."), PROGRAM_NAME));
2029 pop_back_splash (msg);
2034 ARDOUR_UI::transport_goto_start ()
2037 _session->goto_start();
2039 /* force displayed area in editor to start no matter
2040 what "follow playhead" setting is.
2044 editor->center_screen (_session->current_start_frame ());
2050 ARDOUR_UI::transport_goto_zero ()
2053 _session->request_locate (0);
2055 /* force displayed area in editor to start no matter
2056 what "follow playhead" setting is.
2060 editor->reset_x_origin (0);
2066 ARDOUR_UI::transport_goto_wallclock ()
2068 if (_session && editor) {
2075 localtime_r (&now, &tmnow);
2077 framecnt_t frame_rate = _session->frame_rate();
2079 if (frame_rate == 0) {
2080 /* no frame rate available */
2084 frames = tmnow.tm_hour * (60 * 60 * frame_rate);
2085 frames += tmnow.tm_min * (60 * frame_rate);
2086 frames += tmnow.tm_sec * frame_rate;
2088 _session->request_locate (frames, _session->transport_rolling ());
2090 /* force displayed area in editor to start no matter
2091 what "follow playhead" setting is.
2095 editor->center_screen (frames);
2101 ARDOUR_UI::transport_goto_end ()
2104 framepos_t const frame = _session->current_end_frame();
2105 _session->request_locate (frame);
2107 /* force displayed area in editor to start no matter
2108 what "follow playhead" setting is.
2112 editor->center_screen (frame);
2118 ARDOUR_UI::transport_stop ()
2124 if (_session->is_auditioning()) {
2125 _session->cancel_audition ();
2129 _session->request_stop (false, true);
2132 /** Check if any tracks are record enabled. If none are, record enable all of them.
2133 * @return true if track record-enabled status was changed, false otherwise.
2136 ARDOUR_UI::trx_record_enable_all_tracks ()
2142 boost::shared_ptr<RouteList> rl = _session->get_tracks ();
2143 bool none_record_enabled = true;
2145 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2146 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*r);
2149 if (t->rec_enable_control()->get_value()) {
2150 none_record_enabled = false;
2155 if (none_record_enabled) {
2156 _session->set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), 1.0, Controllable::NoGroup);
2159 return none_record_enabled;
2163 ARDOUR_UI::transport_record (bool roll)
2166 switch (_session->record_status()) {
2167 case Session::Disabled:
2168 if (_session->ntracks() == 0) {
2169 MessageDialog msg (_main_window, _("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."));
2173 if (Profile->get_trx()) {
2174 roll = trx_record_enable_all_tracks ();
2176 _session->maybe_enable_record ();
2181 case Session::Recording:
2183 _session->request_stop();
2185 _session->disable_record (false, true);
2189 case Session::Enabled:
2190 _session->disable_record (false, true);
2196 ARDOUR_UI::transport_roll ()
2202 if (_session->is_auditioning()) {
2207 if (_session->config.get_external_sync()) {
2208 switch (Config->get_sync_source()) {
2212 /* transport controlled by the master */
2218 bool rolling = _session->transport_rolling();
2220 if (_session->get_play_loop()) {
2222 /* If loop playback is not a mode, then we should cancel
2223 it when this action is requested. If it is a mode
2224 we just leave it in place.
2227 if (!Config->get_loop_is_mode()) {
2228 /* XXX it is not possible to just leave seamless loop and keep
2229 playing at present (nov 4th 2009)
2231 if (!Config->get_seamless_loop()) {
2232 /* stop loop playback and stop rolling */
2233 _session->request_play_loop (false, true);
2234 } else if (rolling) {
2235 /* stop loop playback but keep rolling */
2236 _session->request_play_loop (false, false);
2240 } else if (_session->get_play_range () ) {
2241 /* stop playing a range if we currently are */
2242 _session->request_play_range (0, true);
2246 _session->request_transport_speed (1.0f);
2251 ARDOUR_UI::get_smart_mode() const
2253 return ( editor->get_smart_mode() );
2258 ARDOUR_UI::toggle_roll (bool with_abort, bool roll_out_of_bounded_mode)
2264 if (_session->is_auditioning()) {
2265 _session->cancel_audition ();
2269 if (_session->config.get_external_sync()) {
2270 switch (Config->get_sync_source()) {
2274 /* transport controlled by the master */
2279 bool rolling = _session->transport_rolling();
2280 bool affect_transport = true;
2282 if (rolling && roll_out_of_bounded_mode) {
2283 /* drop out of loop/range playback but leave transport rolling */
2284 if (_session->get_play_loop()) {
2285 if (_session->actively_recording()) {
2287 /* just stop using the loop, then actually stop
2290 _session->request_play_loop (false, affect_transport);
2293 if (Config->get_seamless_loop()) {
2294 /* the disk buffers contain copies of the loop - we can't
2295 just keep playing, so stop the transport. the user
2296 can restart as they wish.
2298 affect_transport = true;
2300 /* disk buffers are normal, so we can keep playing */
2301 affect_transport = false;
2303 _session->request_play_loop (false, affect_transport);
2305 } else if (_session->get_play_range ()) {
2306 affect_transport = false;
2307 _session->request_play_range (0, true);
2311 if (affect_transport) {
2313 _session->request_stop (with_abort, true);
2315 } else if (!with_abort) { /* with_abort == true means the
2316 * command was intended to stop
2317 * transport, not start.
2320 /* the only external sync condition we can be in here
2321 * would be Engine (JACK) sync, in which case we still
2325 if (UIConfiguration::instance().get_follow_edits() && ( editor->get_selection().time.front().start == _session->transport_frame() ) ) { //if playhead is exactly at the start of a range, we can assume it was placed there by follow_edits
2326 _session->request_play_range (&editor->get_selection().time, true);
2327 _session->set_requested_return_frame( editor->get_selection().time.front().start ); //force an auto-return here
2329 _session->request_transport_speed (1.0f);
2335 ARDOUR_UI::toggle_session_auto_loop ()
2341 Location * looploc = _session->locations()->auto_loop_location();
2347 if (_session->get_play_loop()) {
2349 /* looping enabled, our job is to disable it */
2351 _session->request_play_loop (false);
2355 /* looping not enabled, our job is to enable it.
2357 loop-is-NOT-mode: this action always starts the transport rolling.
2358 loop-IS-mode: this action simply sets the loop play mechanism, but
2359 does not start transport.
2361 if (Config->get_loop_is_mode()) {
2362 _session->request_play_loop (true, false);
2364 _session->request_play_loop (true, true);
2368 //show the loop markers
2369 looploc->set_hidden (false, this);
2373 ARDOUR_UI::transport_play_selection ()
2379 editor->play_selection ();
2383 ARDOUR_UI::transport_play_preroll ()
2388 editor->play_with_preroll ();
2392 ARDOUR_UI::transport_rec_preroll ()
2397 editor->rec_with_preroll ();
2401 ARDOUR_UI::transport_rewind (int option)
2403 float current_transport_speed;
2406 current_transport_speed = _session->transport_speed();
2408 if (current_transport_speed >= 0.0f) {
2411 _session->request_transport_speed (-1.0f);
2414 _session->request_transport_speed (-4.0f);
2417 _session->request_transport_speed (-0.5f);
2422 _session->request_transport_speed (current_transport_speed * 1.5f);
2428 ARDOUR_UI::transport_forward (int option)
2434 float current_transport_speed = _session->transport_speed();
2436 if (current_transport_speed <= 0.0f) {
2439 _session->request_transport_speed (1.0f);
2442 _session->request_transport_speed (4.0f);
2445 _session->request_transport_speed (0.5f);
2450 _session->request_transport_speed (current_transport_speed * 1.5f);
2455 ARDOUR_UI::toggle_record_enable (uint16_t rid)
2461 boost::shared_ptr<Route> r;
2463 if ((r = _session->get_remote_nth_route (rid)) != 0) {
2465 boost::shared_ptr<Track> t;
2467 if ((t = boost::dynamic_pointer_cast<Track>(r)) != 0) {
2468 t->rec_enable_control()->set_value (!t->rec_enable_control()->get_value(), Controllable::UseGroup);
2474 ARDOUR_UI::map_transport_state ()
2477 auto_loop_button.unset_active_state ();
2478 play_selection_button.unset_active_state ();
2479 roll_button.unset_active_state ();
2480 stop_button.set_active_state (Gtkmm2ext::ExplicitActive);
2481 layered_button.set_sensitive (false);
2485 shuttle_box.map_transport_state ();
2487 float sp = _session->transport_speed();
2493 if (_session->get_play_range()) {
2495 play_selection_button.set_active_state (Gtkmm2ext::ExplicitActive);
2496 roll_button.unset_active_state ();
2497 auto_loop_button.unset_active_state ();
2499 } else if (_session->get_play_loop ()) {
2501 auto_loop_button.set_active (true);
2502 play_selection_button.set_active (false);
2503 if (Config->get_loop_is_mode()) {
2504 roll_button.set_active (true);
2506 roll_button.set_active (false);
2511 roll_button.set_active (true);
2512 play_selection_button.set_active (false);
2513 auto_loop_button.set_active (false);
2516 if (UIConfiguration::instance().get_follow_edits() && !_session->config.get_external_sync()) {
2517 /* light up both roll and play-selection if they are joined */
2518 roll_button.set_active (true);
2519 play_selection_button.set_active (true);
2521 layered_button.set_sensitive (!_session->actively_recording ());
2523 stop_button.set_active (false);
2527 layered_button.set_sensitive (true);
2528 stop_button.set_active (true);
2529 roll_button.set_active (false);
2530 play_selection_button.set_active (false);
2531 if (Config->get_loop_is_mode ()) {
2532 auto_loop_button.set_active (_session->get_play_loop());
2534 auto_loop_button.set_active (false);
2536 update_disk_space ();
2541 ARDOUR_UI::blink_handler (bool blink_on)
2543 transport_rec_enable_blink (blink_on);
2544 solo_blink (blink_on);
2545 sync_blink (blink_on);
2546 audition_blink (blink_on);
2547 feedback_blink (blink_on);
2548 error_blink (blink_on);
2552 ARDOUR_UI::update_clocks ()
2554 if (!_session) return;
2556 if (editor && !editor->dragging_playhead()) {
2557 Clock (_session->audible_frame(), false, editor->get_preferred_edit_position (EDIT_IGNORE_PHEAD)); /* EMIT_SIGNAL */
2562 ARDOUR_UI::start_clocking ()
2564 if (UIConfiguration::instance().get_super_rapid_clock_update()) {
2565 clock_signal_connection = Timers::fps_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2567 clock_signal_connection = Timers::rapid_connect (sigc::mem_fun(*this, &ARDOUR_UI::update_clocks));
2572 ARDOUR_UI::stop_clocking ()
2574 clock_signal_connection.disconnect ();
2578 ARDOUR_UI::save_as_progress_update (float fraction, int64_t cnt, int64_t total, Gtk::Label* label, Gtk::ProgressBar* bar)
2582 snprintf (buf, sizeof (buf), _("Copied %" PRId64 " of %" PRId64), cnt, total);
2584 label->set_text (buf);
2585 bar->set_fraction (fraction);
2587 /* process events, redraws, etc. */
2589 while (gtk_events_pending()) {
2590 gtk_main_iteration ();
2593 return true; /* continue with save-as */
2597 ARDOUR_UI::save_session_as ()
2603 if (!save_as_dialog) {
2604 save_as_dialog = new SaveAsDialog;
2607 save_as_dialog->set_name (_session->name());
2609 int response = save_as_dialog->run ();
2611 save_as_dialog->hide ();
2614 case Gtk::RESPONSE_OK:
2623 sa.new_parent_folder = save_as_dialog->new_parent_folder ();
2624 sa.new_name = save_as_dialog->new_name ();
2625 sa.switch_to = save_as_dialog->switch_to();
2626 sa.copy_media = save_as_dialog->copy_media();
2627 sa.copy_external = save_as_dialog->copy_external();
2628 sa.include_media = save_as_dialog->include_media ();
2630 /* Only bother with a progress dialog if we're going to copy
2631 media into the save-as target. Without that choice, this
2632 will be very fast because we're only talking about a few kB's to
2633 perhaps a couple of MB's of data.
2636 ArdourDialog progress_dialog (_("Save As"), true);
2638 if (sa.include_media && sa.copy_media) {
2641 Gtk::ProgressBar progress_bar;
2643 progress_dialog.get_vbox()->pack_start (label);
2644 progress_dialog.get_vbox()->pack_start (progress_bar);
2646 progress_bar.show ();
2648 /* this signal will be emitted from within this, the calling thread,
2649 * after every file is copied. It provides information on percentage
2650 * complete (in terms of total data to copy), the number of files
2651 * copied so far, and the total number to copy.
2656 sa.Progress.connect_same_thread (c, boost::bind (&ARDOUR_UI::save_as_progress_update, this, _1, _2, _3, &label, &progress_bar));
2658 progress_dialog.show_all ();
2659 progress_dialog.present ();
2662 if (_session->save_as (sa)) {
2664 MessageDialog msg (string_compose (_("Save As failed: %1"), sa.failure_message));
2668 /* the logic here may seem odd: why isn't the condition sa.switch_to ?
2669 * the trick is this: if the new session was copy with media included,
2670 * then Session::save_as() will have already done a neat trick to avoid
2671 * us having to unload and load the new state. But if the media was not
2672 * included, then this is required (it avoids us having to otherwise
2673 * drop all references to media (sources).
2676 if (!sa.include_media && sa.switch_to) {
2677 unload_session (false);
2678 load_session (sa.final_session_folder_name, sa.new_name);
2684 ARDOUR_UI::archive_session ()
2692 Glib::DateTime gdt (Glib::DateTime::create_now_local (n));
2694 SessionArchiveDialog sad;
2695 sad.set_name (_session->name() + gdt.format ("_%F_%H%M%S"));
2696 int response = sad.run ();
2698 if (response != Gtk::RESPONSE_OK) {
2703 if (_session->archive_session (sad.target_folder(), sad.name(), sad.encode_option (), sad.only_used_sources (), &sad)) {
2704 MessageDialog msg (_("Session Archiving failed."));
2710 ARDOUR_UI::quick_snapshot_session (bool switch_to_it)
2714 struct tm local_time;
2717 localtime_r (&n, &local_time);
2718 strftime (timebuf, sizeof(timebuf), "%FT%H.%M.%S", &local_time);
2720 save_state (timebuf, switch_to_it);
2725 ARDOUR_UI::process_snapshot_session_prompter (ArdourPrompter& prompter, bool switch_to_it)
2729 prompter.get_result (snapname);
2731 bool do_save = (snapname.length() != 0);
2734 char illegal = Session::session_name_is_legal(snapname);
2736 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2737 "snapshot names may not contain a '%1' character"), illegal));
2743 vector<std::string> p;
2744 get_state_files_in_directory (_session->session_directory().root_path(), p);
2745 vector<string> n = get_file_names_no_extension (p);
2747 if (find (n.begin(), n.end(), snapname) != n.end()) {
2749 do_save = overwrite_file_dialog (prompter,
2750 _("Confirm Snapshot Overwrite"),
2751 _("A snapshot already exists with that name. Do you want to overwrite it?"));
2755 save_state (snapname, switch_to_it);
2765 /** Ask the user for the name of a new snapshot and then take it.
2769 ARDOUR_UI::snapshot_session (bool switch_to_it)
2771 ArdourPrompter prompter (true);
2773 prompter.set_name ("Prompter");
2774 prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2776 prompter.set_title (_("Snapshot and switch"));
2777 prompter.set_prompt (_("New session name"));
2779 prompter.set_title (_("Take Snapshot"));
2780 prompter.set_prompt (_("Name of new snapshot"));
2784 prompter.set_initial_text (_session->snap_name());
2786 Glib::DateTime tm (g_date_time_new_now_local ());
2787 prompter.set_initial_text (tm.format ("%FT%H.%M.%S"));
2790 bool finished = false;
2792 switch (prompter.run()) {
2793 case RESPONSE_ACCEPT:
2795 finished = process_snapshot_session_prompter (prompter, switch_to_it);
2806 /** Ask the user for a new session name and then rename the session to it.
2810 ARDOUR_UI::rename_session ()
2816 ArdourPrompter prompter (true);
2819 prompter.set_name ("Prompter");
2820 prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2821 prompter.set_title (_("Rename Session"));
2822 prompter.set_prompt (_("New session name"));
2825 switch (prompter.run()) {
2826 case RESPONSE_ACCEPT:
2828 prompter.get_result (name);
2830 bool do_rename = (name.length() != 0);
2833 char illegal = Session::session_name_is_legal (name);
2836 MessageDialog msg (string_compose (_("To ensure compatibility with various systems\n"
2837 "session names may not contain a '%1' character"), illegal));
2842 switch (_session->rename (name)) {
2844 MessageDialog msg (_("That name is already in use by another directory/folder. Please try again."));
2845 msg.set_position (WIN_POS_MOUSE);
2853 MessageDialog msg (_("Renaming this session failed.\nThings could be seriously messed up at this point"));
2854 msg.set_position (WIN_POS_MOUSE);
2870 ARDOUR_UI::save_state (const string & name, bool switch_to_it)
2872 if (!_session || _session->deletion_in_progress()) {
2876 XMLNode* node = new XMLNode (X_("UI"));
2878 WM::Manager::instance().add_state (*node);
2880 node->add_child_nocopy (gui_object_state->get_state());
2882 _session->add_extra_xml (*node);
2884 if (export_video_dialog) {
2885 _session->add_extra_xml (export_video_dialog->get_state());
2888 save_state_canfail (name, switch_to_it);
2892 ARDOUR_UI::save_state_canfail (string name, bool switch_to_it)
2897 if ((ret = _session->save_state (name, false, switch_to_it)) != 0) {
2902 save_ardour_state (); /* XXX cannot fail? yeah, right ... */
2907 ARDOUR_UI::primary_clock_value_changed ()
2910 _session->request_locate (primary_clock->current_time ());
2915 ARDOUR_UI::big_clock_value_changed ()
2918 _session->request_locate (big_clock->current_time ());
2923 ARDOUR_UI::secondary_clock_value_changed ()
2926 _session->request_locate (secondary_clock->current_time ());
2931 ARDOUR_UI::transport_rec_enable_blink (bool onoff)
2933 if (_session == 0) {
2937 if (_session->step_editing()) {
2941 Session::RecordState const r = _session->record_status ();
2942 bool const h = _session->have_rec_enabled_track ();
2944 if (r == Session::Enabled || (r == Session::Recording && !h)) {
2946 rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2948 rec_button.set_active_state (Gtkmm2ext::Off);
2950 } else if (r == Session::Recording && h) {
2951 rec_button.set_active_state (Gtkmm2ext::ExplicitActive);
2953 rec_button.unset_active_state ();
2958 ARDOUR_UI::process_save_template_prompter (ArdourPrompter& prompter)
2962 prompter.get_result (name);
2964 if (name.length()) {
2965 int failed = _session->save_template (name);
2967 if (failed == -2) { /* file already exists. */
2968 bool overwrite = overwrite_file_dialog (prompter,
2969 _("Confirm Template Overwrite"),
2970 _("A template already exists with that name. Do you want to overwrite it?"));
2973 _session->save_template (name, true);
2985 ARDOUR_UI::save_template ()
2987 ArdourPrompter prompter (true);
2989 if (!check_audioengine (_main_window)) {
2993 prompter.set_name (X_("Prompter"));
2994 prompter.set_title (_("Save Template"));
2995 prompter.set_prompt (_("Name for template:"));
2996 prompter.set_initial_text(_session->name() + _("-template"));
2997 prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
2999 bool finished = false;
3001 switch (prompter.run()) {
3002 case RESPONSE_ACCEPT:
3003 finished = process_save_template_prompter (prompter);
3014 ARDOUR_UI::edit_metadata ()
3016 SessionMetadataEditor dialog;
3017 dialog.set_session (_session);
3018 dialog.grab_focus ();
3023 ARDOUR_UI::import_metadata ()
3025 SessionMetadataImporter dialog;
3026 dialog.set_session (_session);
3031 ARDOUR_UI::ask_about_loading_existing_session (const std::string& session_path)
3033 std::string str = string_compose (_("This session\n%1\nalready exists. Do you want to open it?"), session_path);
3035 MessageDialog msg (str,
3037 Gtk::MESSAGE_WARNING,
3038 Gtk::BUTTONS_YES_NO,
3042 msg.set_name (X_("OpenExistingDialog"));
3043 msg.set_title (_("Open Existing Session"));
3044 msg.set_wmclass (X_("existing_session"), PROGRAM_NAME);
3045 msg.set_position (Gtk::WIN_POS_CENTER);
3046 pop_back_splash (msg);
3048 switch (msg.run()) {
3057 ARDOUR_UI::build_session_from_dialog (SessionDialog& sd, const std::string& session_path, const std::string& session_name)
3059 BusProfile bus_profile;
3063 bus_profile.master_out_channels = 2;
3064 bus_profile.input_ac = AutoConnectPhysical;
3065 bus_profile.output_ac = AutoConnectMaster;
3066 bus_profile.requested_physical_in = 0; // use all available
3067 bus_profile.requested_physical_out = 0; // use all available
3071 /* get settings from advanced section of NSD */
3073 if (sd.create_master_bus()) {
3074 bus_profile.master_out_channels = (uint32_t) sd.master_channel_count();
3076 bus_profile.master_out_channels = 0;
3079 if (sd.connect_inputs()) {
3080 bus_profile.input_ac = AutoConnectPhysical;
3082 bus_profile.input_ac = AutoConnectOption (0);
3085 bus_profile.output_ac = AutoConnectOption (0);
3087 if (sd.connect_outputs ()) {
3088 if (sd.connect_outs_to_master()) {
3089 bus_profile.output_ac = AutoConnectMaster;
3090 } else if (sd.connect_outs_to_physical()) {
3091 bus_profile.output_ac = AutoConnectPhysical;
3095 bus_profile.requested_physical_in = (uint32_t) sd.input_limit_count();
3096 bus_profile.requested_physical_out = (uint32_t) sd.output_limit_count();
3099 if (build_session (session_path, session_name, bus_profile)) {
3107 ARDOUR_UI::load_from_application_api (const std::string& path)
3109 /* OS X El Capitan (and probably later) now somehow passes the command
3110 line arguments to an app via the openFile delegate protocol. Ardour
3111 already does its own command line processing, and having both
3112 pathways active causes crashes. So, if the command line was already
3113 set, do nothing here.
3116 if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
3120 ARDOUR_COMMAND_LINE::session_name = path;
3122 /* Cancel SessionDialog if it's visible to make OSX delegates work.
3124 * ARDOUR_UI::starting connects app->ShouldLoad signal and then shows a SessionDialog
3126 * - ShouldLoad does not arrive in time, ARDOUR_COMMAND_LINE::session_name is empty:
3127 * -> ARDOUR_UI::get_session_parameters starts a SessionDialog.
3128 * - ShouldLoad signal arrives, this function is called and sets ARDOUR_COMMAND_LINE::session_name
3129 * -> SessionDialog is not displayed
3132 if (_session_dialog) {
3133 std::string session_name = basename_nosuffix (ARDOUR_COMMAND_LINE::session_name);
3134 std::string session_path = path;
3135 if (Glib::file_test (session_path, Glib::FILE_TEST_IS_REGULAR)) {
3136 session_path = Glib::path_get_dirname (session_path);
3138 // signal the existing dialog in ARDOUR_UI::get_session_parameters()
3139 _session_dialog->set_provided_session (session_name, session_path);
3140 _session_dialog->response (RESPONSE_NONE);
3141 _session_dialog->hide();
3146 if (Glib::file_test (path, Glib::FILE_TEST_IS_DIR)) {
3147 /* /path/to/foo => /path/to/foo, foo */
3148 rv = load_session (path, basename_nosuffix (path));
3150 /* /path/to/foo/foo.ardour => /path/to/foo, foo */
3151 rv =load_session (Glib::path_get_dirname (path), basename_nosuffix (path));
3154 // if load_session fails -> pop up SessionDialog.
3156 ARDOUR_COMMAND_LINE::session_name = "";
3158 if (get_session_parameters (true, false)) {
3164 /** @param quit_on_cancel true if exit() should be called if the user clicks `cancel' in the new session dialog */
3166 ARDOUR_UI::get_session_parameters (bool quit_on_cancel, bool should_be_new, string load_template)
3168 string session_name;
3169 string session_path;
3170 string template_name;
3172 bool likely_new = false;
3173 bool cancel_not_quit;
3175 /* deal with any existing DIRTY session now, rather than later. don't
3176 * treat a non-dirty session this way, so that it stays visible
3177 * as we bring up the new session dialog.
3180 if (_session && ARDOUR_UI::instance()->video_timeline) {
3181 ARDOUR_UI::instance()->video_timeline->sync_session_state();
3184 /* if there is already a session, relabel the button
3185 on the SessionDialog so that we don't Quit directly
3187 cancel_not_quit = (_session != 0);
3189 if (_session && _session->dirty()) {
3190 if (unload_session (false)) {
3191 /* unload cancelled by user */
3194 ARDOUR_COMMAND_LINE::session_name = "";
3197 if (!load_template.empty()) {
3198 should_be_new = true;
3199 template_name = load_template;
3202 session_name = basename_nosuffix (ARDOUR_COMMAND_LINE::session_name);
3203 session_path = ARDOUR_COMMAND_LINE::session_name;
3205 if (!session_path.empty()) {
3206 if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_EXISTS)) {
3207 if (Glib::file_test (session_path.c_str(), Glib::FILE_TEST_IS_REGULAR)) {
3208 /* session/snapshot file, change path to be dir */
3209 session_path = Glib::path_get_dirname (session_path);
3214 SessionDialog session_dialog (should_be_new, session_name, session_path, load_template, cancel_not_quit);
3216 _session_dialog = &session_dialog;
3219 if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
3221 /* if they named a specific statefile, use it, otherwise they are
3222 just giving a session folder, and we want to use it as is
3223 to find the session.
3226 string::size_type suffix = ARDOUR_COMMAND_LINE::session_name.find (statefile_suffix);
3228 if (suffix != string::npos) {
3229 session_path = Glib::path_get_dirname (ARDOUR_COMMAND_LINE::session_name);
3230 session_name = ARDOUR_COMMAND_LINE::session_name.substr (0, suffix);
3231 session_name = Glib::path_get_basename (session_name);
3233 session_path = ARDOUR_COMMAND_LINE::session_name;
3234 session_name = Glib::path_get_basename (ARDOUR_COMMAND_LINE::session_name);
3239 session_dialog.clear_given ();
3242 if (should_be_new || session_name.empty()) {
3243 /* need the dialog to get info from user */
3245 cerr << "run dialog\n";
3247 switch (session_dialog.run()) {
3248 case RESPONSE_ACCEPT:
3251 /* this is used for async * app->ShouldLoad(). */
3252 continue; // while loop
3255 if (quit_on_cancel) {
3256 // JE - Currently (July 2014) this section can only get reached if the
3257 // user quits from the main 'Session Setup' dialog (i.e. reaching this
3258 // point does NOT indicate an abnormal termination). Therefore, let's
3259 // behave gracefully (i.e. let's do some cleanup) before we call exit()
3261 pthread_cancel_all ();
3269 session_dialog.hide ();
3272 /* if we run the startup dialog again, offer more than just "new session" */
3274 should_be_new = false;
3276 session_name = session_dialog.session_name (likely_new);
3277 session_path = session_dialog.session_folder ();
3284 int rv = ARDOUR::inflate_session (session_name,
3285 Config->get_default_session_parent_dir(), session_path, session_name);
3287 MessageDialog msg (session_dialog,
3288 string_compose (_("Extracting session-archive failed: %1"), inflate_error (rv)));
3293 session_dialog.set_provided_session (session_name, session_path);
3297 // XXX check archive, inflate
3298 string::size_type suffix = session_name.find (statefile_suffix);
3300 if (suffix != string::npos) {
3301 session_name = session_name.substr (0, suffix);
3304 /* this shouldn't happen, but we catch it just in case it does */
3306 if (session_name.empty()) {
3310 if (session_dialog.use_session_template()) {
3311 template_name = session_dialog.session_template_name();
3312 _session_is_new = true;
3315 if (session_name[0] == G_DIR_SEPARATOR ||
3316 #ifdef PLATFORM_WINDOWS
3317 (session_name.length() > 3 && session_name[1] == ':' && session_name[2] == G_DIR_SEPARATOR)
3319 (session_name.length() > 2 && session_name[0] == '.' && session_name[1] == G_DIR_SEPARATOR) ||
3320 (session_name.length() > 3 && session_name[0] == '.' && session_name[1] == '.' && session_name[2] == G_DIR_SEPARATOR)
3325 /* absolute path or cwd-relative path specified for session name: infer session folder
3326 from what was given.
3329 session_path = Glib::path_get_dirname (session_name);
3330 session_name = Glib::path_get_basename (session_name);
3334 session_path = session_dialog.session_folder();
3336 char illegal = Session::session_name_is_legal (session_name);
3339 MessageDialog msg (session_dialog,
3340 string_compose (_("To ensure compatibility with various systems\n"
3341 "session names may not contain a '%1' character"),
3344 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
3349 if (Glib::file_test (session_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))) {
3352 if (likely_new && !nsm) {
3354 std::string existing = Glib::build_filename (session_path, session_name);
3356 if (!ask_about_loading_existing_session (existing)) {
3357 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
3362 _session_is_new = false;
3367 pop_back_splash (session_dialog);
3368 MessageDialog msg (string_compose (_("There is no existing session at \"%1\""), session_path));
3370 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
3374 char illegal = Session::session_name_is_legal(session_name);
3377 pop_back_splash (session_dialog);
3378 MessageDialog msg (session_dialog, string_compose(_("To ensure compatibility with various systems\n"
3379 "session names may not contain a '%1' character"), illegal));
3381 ARDOUR_COMMAND_LINE::session_name = ""; // cancel that
3385 _session_is_new = true;
3388 if (likely_new && template_name.empty()) {
3390 ret = build_session_from_dialog (session_dialog, session_path, session_name);
3394 ret = load_session (session_path, session_name, template_name);
3397 /* not connected to the AudioEngine, so quit to avoid an infinite loop */
3401 if (!ARDOUR_COMMAND_LINE::immediate_save.empty()) {
3402 _session->save_state (ARDOUR_COMMAND_LINE::immediate_save, false);
3406 /* clear this to avoid endless attempts to load the
3410 ARDOUR_COMMAND_LINE::session_name = "";
3414 _session_dialog = NULL;
3420 ARDOUR_UI::close_session()
3422 if (!check_audioengine (_main_window)) {
3426 if (unload_session (true)) {
3430 ARDOUR_COMMAND_LINE::session_name = "";
3432 if (get_session_parameters (true, false)) {
3435 if (splash && splash->is_visible()) {
3436 // in 1 second, hide the splash screen
3437 Glib::signal_timeout().connect (sigc::bind (sigc::ptr_fun (_hide_splash), this), 1000);
3441 /** @param snap_name Snapshot name (without .ardour suffix).
3442 * @return -2 if the load failed because we are not connected to the AudioEngine.
3445 ARDOUR_UI::load_session (const std::string& path, const std::string& snap_name, std::string mix_template)
3447 Session *new_session;
3452 unload_status = unload_session ();
3454 if (unload_status < 0) {
3456 } else if (unload_status > 0) {
3462 session_loaded = false;
3464 loading_message (string_compose (_("Please wait while %1 loads your session"), PROGRAM_NAME));
3467 new_session = new Session (*AudioEngine::instance(), path, snap_name, 0, mix_template);
3470 /* this one is special */
3472 catch (AudioEngine::PortRegistrationFailure& err) {
3474 MessageDialog msg (err.what(),
3477 Gtk::BUTTONS_CLOSE);
3479 msg.set_title (_("Port Registration Error"));
3480 msg.set_secondary_text (_("Click the Close button to try again."));
3481 msg.set_position (Gtk::WIN_POS_CENTER);
3482 pop_back_splash (msg);
3485 int response = msg.run ();
3490 case RESPONSE_CANCEL:
3497 catch (SessionException e) {
3498 MessageDialog msg (string_compose(
3499 _("Session \"%1 (snapshot %2)\" did not load successfully: %3"),
3500 path, snap_name, e.what()),
3505 msg.set_title (_("Loading Error"));
3506 msg.set_position (Gtk::WIN_POS_CENTER);
3507 pop_back_splash (msg);
3519 MessageDialog msg (string_compose(
3520 _("Session \"%1 (snapshot %2)\" did not load successfully"),
3526 msg.set_title (_("Loading Error"));
3527 msg.set_position (Gtk::WIN_POS_CENTER);
3528 pop_back_splash (msg);
3540 list<string> const u = new_session->unknown_processors ();
3542 MissingPluginDialog d (_session, u);
3547 if (!new_session->writable()) {
3548 MessageDialog msg (_("This session has been opened in read-only mode.\n\nYou will not be able to record or save."),
3553 msg.set_title (_("Read-only Session"));
3554 msg.set_position (Gtk::WIN_POS_CENTER);
3555 pop_back_splash (msg);
3561 set_session (new_session);
3563 session_loaded = true;
3566 _session->set_clean ();
3569 #ifdef WINDOWS_VST_SUPPORT
3570 fst_stop_threading();
3574 Timers::TimerSuspender t;
3578 #ifdef WINDOWS_VST_SUPPORT
3579 fst_start_threading();
3588 ARDOUR_UI::build_session (const std::string& path, const std::string& snap_name, BusProfile& bus_profile)
3590 Session *new_session;
3593 session_loaded = false;
3594 x = unload_session ();
3602 _session_is_new = true;
3605 new_session = new Session (*AudioEngine::instance(), path, snap_name, &bus_profile);
3608 catch (SessionException e) {
3609 cerr << "Here are the errors associated with this failed session:\n";
3611 cerr << "---------\n";
3612 MessageDialog msg (string_compose(_("Could not create session in \"%1\": %2"), path, e.what()));
3613 msg.set_title (_("Loading Error"));
3614 msg.set_position (Gtk::WIN_POS_CENTER);
3615 pop_back_splash (msg);
3620 cerr << "Here are the errors associated with this failed session:\n";
3622 cerr << "---------\n";
3623 MessageDialog msg (string_compose(_("Could not create session in \"%1\""), path));
3624 msg.set_title (_("Loading Error"));
3625 msg.set_position (Gtk::WIN_POS_CENTER);
3626 pop_back_splash (msg);
3631 /* Give the new session the default GUI state, if such things exist */
3634 n = Config->instant_xml (X_("Editor"));
3636 n->remove_nodes_and_delete ("Selection"); // no not apply selection to new sessions.
3637 new_session->add_instant_xml (*n, false);
3639 n = Config->instant_xml (X_("Mixer"));
3641 new_session->add_instant_xml (*n, false);
3644 n = Config->instant_xml (X_("Preferences"));
3646 new_session->add_instant_xml (*n, false);
3649 /* Put the playhead at 0 and scroll fully left */
3650 n = new_session->instant_xml (X_("Editor"));
3652 n->add_property (X_("playhead"), X_("0"));
3653 n->add_property (X_("left-frame"), X_("0"));
3656 set_session (new_session);
3658 session_loaded = true;
3660 new_session->save_state(new_session->name());
3666 ARDOUR_UI::launch_chat ()
3668 MessageDialog dialog(_("<b>Just ask and wait for an answer.\nIt may take from minutes to hours.</b>"), true);
3670 dialog.set_title (_("About the Chat"));
3671 dialog.set_secondary_text (_("When you're inside the chat just ask your question and wait for an answer. The chat is occupied by real people with real lives so many of them are passively online and might not read your question before minutes or hours later.\nSo please be patient and wait for an answer.\n\nYou should just leave the chat window open and check back regularly until someone has answered your question."));
3673 switch (dialog.run()) {
3676 open_uri("http://webchat.freenode.net/?channels=ardour-osx");
3677 #elif defined PLATFORM_WINDOWS
3678 open_uri("http://webchat.freenode.net/?channels=ardour-windows");
3680 open_uri("http://webchat.freenode.net/?channels=ardour");
3689 ARDOUR_UI::launch_manual ()
3691 PBD::open_uri (Config->get_tutorial_manual_url());
3695 ARDOUR_UI::launch_reference ()
3697 PBD::open_uri (Config->get_reference_manual_url());
3701 ARDOUR_UI::launch_tracker ()
3703 PBD::open_uri ("http://tracker.ardour.org");
3707 ARDOUR_UI::launch_subscribe ()
3709 PBD::open_uri ("https://community.ardour.org/s/subscribe");
3713 ARDOUR_UI::launch_cheat_sheet ()
3716 PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheat_sheet_osx.pdf");
3718 PBD::open_uri ("http://manual.ardour.org/files/a3_mnemonic_cheatsheet.pdf");
3723 ARDOUR_UI::launch_website ()
3725 PBD::open_uri ("http://ardour.org");
3729 ARDOUR_UI::launch_website_dev ()
3731 PBD::open_uri ("http://ardour.org/development.html");
3735 ARDOUR_UI::launch_forums ()
3737 PBD::open_uri ("https://community.ardour.org/forums");
3741 ARDOUR_UI::launch_howto_report ()
3743 PBD::open_uri ("http://ardour.org/reporting_bugs");
3747 ARDOUR_UI::loading_message (const std::string& msg)
3749 if (ARDOUR_COMMAND_LINE::no_splash) {
3757 splash->message (msg);
3761 ARDOUR_UI::show_splash ()
3765 splash = new Splash;
3775 ARDOUR_UI::hide_splash ()
3782 ARDOUR_UI::display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete)
3786 removed = rep.paths.size();
3789 MessageDialog msgd (_main_window,
3790 _("No files were ready for clean-up"),
3794 msgd.set_title (_("Clean-up"));
3795 msgd.set_secondary_text (_("If this seems suprising, \n\
3796 check for any existing snapshots.\n\
3797 These may still include regions that\n\
3798 require some unused files to continue to exist."));
3804 ArdourDialog results (_("Clean-up"), true, false);
3806 struct CleanupResultsModelColumns : public Gtk::TreeModel::ColumnRecord {
3807 CleanupResultsModelColumns() {
3811 Gtk::TreeModelColumn<std::string> visible_name;
3812 Gtk::TreeModelColumn<std::string> fullpath;
3816 CleanupResultsModelColumns results_columns;
3817 Glib::RefPtr<Gtk::ListStore> results_model;
3818 Gtk::TreeView results_display;
3820 results_model = ListStore::create (results_columns);
3821 results_display.set_model (results_model);
3822 results_display.append_column (list_title, results_columns.visible_name);
3824 results_display.set_name ("CleanupResultsList");
3825 results_display.set_headers_visible (true);
3826 results_display.set_headers_clickable (false);
3827 results_display.set_reorderable (false);
3829 Gtk::ScrolledWindow list_scroller;
3832 Gtk::HBox dhbox; // the hbox for the image and text
3833 Gtk::HBox ddhbox; // the hbox we eventually pack into the dialog's vbox
3834 Gtk::Image* dimage = manage (new Gtk::Image(Stock::DIALOG_INFO, Gtk::ICON_SIZE_DIALOG));
3836 dimage->set_alignment(ALIGN_LEFT, ALIGN_TOP);
3838 const string dead_directory = _session->session_directory().dead_path();
3841 %1 - number of files removed
3842 %2 - location of "dead"
3843 %3 - size of files affected
3844 %4 - prefix for "bytes" to produce sensible results (e.g. mega, kilo, giga)
3847 const char* bprefix;
3848 double space_adjusted = 0;
3850 if (rep.space < 1000) {
3852 space_adjusted = rep.space;
3853 } else if (rep.space < 1000000) {
3854 bprefix = _("kilo");
3855 space_adjusted = floorf((float)rep.space / 1000.0);
3856 } else if (rep.space < 1000000 * 1000) {
3857 bprefix = _("mega");
3858 space_adjusted = floorf((float)rep.space / (1000.0 * 1000.0));
3860 bprefix = _("giga");
3861 space_adjusted = floorf((float)rep.space / (1000.0 * 1000 * 1000.0));
3865 txt.set_markup (string_compose (P_("\
3866 The following file was deleted from %2,\n\
3867 releasing %3 %4bytes of disk space", "\
3868 The following %1 files were deleted from %2,\n\
3869 releasing %3 %4bytes of disk space", removed),
3870 removed, Gtkmm2ext::markup_escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3872 txt.set_markup (string_compose (P_("\
3873 The following file was not in use and \n\
3874 has been moved to: %2\n\n\
3875 After a restart of %5\n\n\
3876 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3877 will release an additional %3 %4bytes of disk space.\n", "\
3878 The following %1 files were not in use and \n\
3879 have been moved to: %2\n\n\
3880 After a restart of %5\n\n\
3881 <span face=\"mono\">Session -> Clean-up -> Flush Wastebasket</span>\n\n\
3882 will release an additional %3 %4bytes of disk space.\n", removed),
3883 removed, Gtkmm2ext::markup_escape_text (dead_directory), space_adjusted, bprefix, PROGRAM_NAME));
3886 dhbox.pack_start (*dimage, true, false, 5);
3887 dhbox.pack_start (txt, true, false, 5);
3889 for (vector<string>::iterator i = rep.paths.begin(); i != rep.paths.end(); ++i) {
3890 TreeModel::Row row = *(results_model->append());
3891 row[results_columns.visible_name] = *i;
3892 row[results_columns.fullpath] = *i;
3895 list_scroller.add (results_display);
3896 list_scroller.set_size_request (-1, 150);
3897 list_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
3899 dvbox.pack_start (dhbox, true, false, 5);
3900 dvbox.pack_start (list_scroller, true, false, 5);
3901 ddhbox.pack_start (dvbox, true, false, 5);
3903 results.get_vbox()->pack_start (ddhbox, true, false, 5);
3904 results.add_button (Stock::CLOSE, RESPONSE_CLOSE);
3905 results.set_default_response (RESPONSE_CLOSE);
3906 results.set_position (Gtk::WIN_POS_MOUSE);
3908 results_display.show();
3909 list_scroller.show();
3916 //results.get_vbox()->show();
3917 results.set_resizable (false);
3924 ARDOUR_UI::cleanup ()
3926 if (_session == 0) {
3927 /* shouldn't happen: menu item is insensitive */
3932 MessageDialog checker (_("Are you sure you want to clean-up?"),
3934 Gtk::MESSAGE_QUESTION,
3937 checker.set_title (_("Clean-up"));
3939 checker.set_secondary_text(_("Clean-up is a destructive operation.\n\
3940 ALL undo/redo information will be lost if you clean-up.\n\
3941 Clean-up will move all unused files to a \"dead\" location."));
3943 checker.add_button (Stock::CANCEL, RESPONSE_CANCEL);
3944 checker.add_button (_("Clean-up"), RESPONSE_ACCEPT);
3945 checker.set_default_response (RESPONSE_CANCEL);
3947 checker.set_name (_("CleanupDialog"));
3948 checker.set_wmclass (X_("ardour_cleanup"), PROGRAM_NAME);
3949 checker.set_position (Gtk::WIN_POS_MOUSE);
3951 switch (checker.run()) {
3952 case RESPONSE_ACCEPT:
3958 ARDOUR::CleanupReport rep;
3960 editor->prepare_for_cleanup ();
3962 /* do not allow flush until a session is reloaded */
3964 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Main"), X_("FlushWastebasket"));
3966 act->set_sensitive (false);
3969 if (_session->cleanup_sources (rep)) {
3970 editor->finish_cleanup ();
3974 editor->finish_cleanup ();
3977 display_cleanup_results (rep, _("Cleaned Files"), false);
3981 ARDOUR_UI::flush_trash ()
3983 if (_session == 0) {
3984 /* shouldn't happen: menu item is insensitive */
3988 ARDOUR::CleanupReport rep;
3990 if (_session->cleanup_trash_sources (rep)) {
3994 display_cleanup_results (rep, _("deleted file"), true);
3998 ARDOUR_UI::cleanup_peakfiles ()
4000 if (_session == 0) {
4001 /* shouldn't happen: menu item is insensitive */
4005 if (! _session->can_cleanup_peakfiles ()) {
4009 // get all region-views in this session
4011 TrackViewList empty;
4013 editor->get_regions_after(rs, (framepos_t) 0, empty);
4014 std::list<RegionView*> views = rs.by_layer();
4016 // remove displayed audio-region-views waveforms
4017 for (list<RegionView*>::iterator i = views.begin(); i != views.end(); ++i) {
4018 AudioRegionView* arv = dynamic_cast<AudioRegionView*> (*i);
4019 if (!arv) { continue ; }
4020 arv->delete_waves();
4023 // cleanup peak files:
4024 // - stop pending peakfile threads
4025 // - close peakfiles if any
4026 // - remove peak dir in session
4027 // - setup peakfiles (background thread)
4028 _session->cleanup_peakfiles ();
4030 // re-add waves to ARV
4031 for (list<RegionView*>::iterator i = views.begin(); i != views.end(); ++i) {
4032 AudioRegionView* arv = dynamic_cast<AudioRegionView*> (*i);
4033 if (!arv) { continue ; }
4034 arv->create_waves();
4038 PresentationInfo::order_t
4039 ARDOUR_UI::translate_order (RouteDialogs::InsertAt place)
4041 if (editor->get_selection().tracks.empty()) {
4042 return PresentationInfo::max_order;
4045 PresentationInfo::order_t order_hint = PresentationInfo::max_order;
4048 we want the new routes to have their order keys set starting from
4049 the highest order key in the selection + 1 (if available).
4052 if (place == RouteDialogs::AfterSelection) {
4053 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.back());
4055 order_hint = rtav->route()->presentation_info().order();
4058 } else if (place == RouteDialogs::BeforeSelection) {
4059 RouteTimeAxisView *rtav = dynamic_cast<RouteTimeAxisView*> (editor->get_selection().tracks.front());
4061 order_hint = rtav->route()->presentation_info().order();
4063 } else if (place == RouteDialogs::First) {
4066 /* leave order_hint at max_order */
4073 ARDOUR_UI::start_duplicate_routes ()
4075 if (!duplicate_routes_dialog) {
4076 duplicate_routes_dialog = new DuplicateRouteDialog;
4079 if (duplicate_routes_dialog->restart (_session)) {
4083 duplicate_routes_dialog->present ();
4087 ARDOUR_UI::add_route ()
4089 if (!add_route_dialog.get (false)) {
4090 add_route_dialog->signal_response().connect (sigc::mem_fun (*this, &ARDOUR_UI::add_route_dialog_finished));
4097 if (add_route_dialog->is_visible()) {
4098 /* we're already doing this */
4102 add_route_dialog->set_position (WIN_POS_MOUSE);
4103 add_route_dialog->present();
4107 ARDOUR_UI::add_route_dialog_finished (int r)
4111 add_route_dialog->hide();
4114 case RESPONSE_ACCEPT:
4121 if ((count = add_route_dialog->count()) <= 0) {
4125 PresentationInfo::order_t order = translate_order (add_route_dialog->insert_at());
4126 string template_path = add_route_dialog->track_template();
4127 DisplaySuspender ds;
4129 if (!template_path.empty()) {
4130 if (add_route_dialog->name_template_is_default()) {
4131 _session->new_route_from_template (count, order, template_path, string());
4133 _session->new_route_from_template (count, order, template_path, add_route_dialog->name_template());
4138 ChanCount input_chan= add_route_dialog->channels ();
4139 ChanCount output_chan;
4140 string name_template = add_route_dialog->name_template ();
4141 PluginInfoPtr instrument = add_route_dialog->requested_instrument ();
4142 RouteGroup* route_group = add_route_dialog->route_group ();
4143 AutoConnectOption oac = Config->get_output_auto_connect();
4144 bool strict_io = add_route_dialog->use_strict_io ();
4146 if (oac & AutoConnectMaster) {
4147 output_chan.set (DataType::AUDIO, (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan.n_audio()));
4148 output_chan.set (DataType::MIDI, 0);
4150 output_chan = input_chan;
4153 /* XXX do something with name template */
4155 Session::ProcessorChangeBlocker pcb (_session);
4157 switch (add_route_dialog->type_wanted()) {
4158 case AddRouteDialog::AudioTrack:
4159 session_add_audio_track (input_chan.n_audio(), output_chan.n_audio(), add_route_dialog->mode(), route_group, count, name_template, strict_io, order);
4161 case AddRouteDialog::MidiTrack:
4162 session_add_midi_track (route_group, count, name_template, strict_io, instrument, 0, order);
4164 case AddRouteDialog::MixedTrack:
4165 session_add_mixed_track (input_chan, output_chan, route_group, count, name_template, strict_io, instrument, 0, order);
4167 case AddRouteDialog::AudioBus:
4168 session_add_audio_bus (input_chan.n_audio(), output_chan.n_audio(), route_group, count, name_template, strict_io, order);
4170 case AddRouteDialog::MidiBus:
4171 session_add_midi_bus (route_group, count, name_template, strict_io, instrument, 0, order);
4173 case AddRouteDialog::VCAMaster:
4174 session_add_vca (name_template, count);
4180 ARDOUR_UI::add_lua_script ()
4186 LuaScriptInfoPtr spi;
4187 ScriptSelector ss ("Add Lua Session Script", LuaScriptInfo::Session);
4188 switch (ss.run ()) {
4189 case Gtk::RESPONSE_ACCEPT:
4197 std::string script = "";
4200 script = Glib::file_get_contents (spi->path);
4201 } catch (Glib::FileError e) {
4202 string msg = string_compose (_("Cannot read session script '%1': %2"), spi->path, e.what());
4203 MessageDialog am (msg);
4208 LuaScriptParamList lsp = LuaScriptParams::script_params (spi, "sess_params");
4209 std::vector<std::string> reg = _session->registered_lua_functions ();
4211 ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp);
4212 switch (spd.run ()) {
4213 case Gtk::RESPONSE_ACCEPT:
4220 _session->register_lua_function (spd.name(), script, lsp);
4221 } catch (luabridge::LuaException const& e) {
4222 string msg = string_compose (_("Session script '%1' instantiation failed: %2"), spd.name(), e.what ());
4223 MessageDialog am (msg);
4225 } catch (SessionException e) {
4226 string msg = string_compose (_("Loading Session script '%1' failed: %2"), spd.name(), e.what ());
4227 MessageDialog am (msg);
4233 ARDOUR_UI::remove_lua_script ()
4238 if (_session->registered_lua_function_count () == 0) {
4239 string msg = _("There are no active Lua session scripts present in this session.");
4240 MessageDialog am (msg);
4245 std::vector<std::string> reg = _session->registered_lua_functions ();
4246 SessionScriptManager sm ("Remove Lua Session Script", reg);
4247 switch (sm.run ()) {
4248 case Gtk::RESPONSE_ACCEPT:
4254 _session->unregister_lua_function (sm.name());
4255 } catch (luabridge::LuaException const& e) {
4256 string msg = string_compose (_("Session script '%1' removal failed: %2"), sm.name(), e.what ());
4257 MessageDialog am (msg);
4263 ARDOUR_UI::stop_video_server (bool ask_confirm)
4265 if (!video_server_process && ask_confirm) {
4266 warning << string_compose (_("Video-Server was not launched by %1. The request to stop it is ignored."), PROGRAM_NAME) << endmsg;
4268 if (video_server_process) {
4270 ArdourDialog confirm (_("Stop Video-Server"), true);
4271 Label m (_("Do you really want to stop the Video Server?"));
4272 confirm.get_vbox()->pack_start (m, true, true);
4273 confirm.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
4274 confirm.add_button (_("Yes, Stop It"), Gtk::RESPONSE_ACCEPT);
4275 confirm.show_all ();
4276 if (confirm.run() == RESPONSE_CANCEL) {
4280 delete video_server_process;
4281 video_server_process =0;
4286 ARDOUR_UI::start_video_server_menu (Gtk::Window* float_window)
4288 ARDOUR_UI::start_video_server( float_window, true);
4292 ARDOUR_UI::start_video_server (Gtk::Window* float_window, bool popup_msg)
4298 if (ARDOUR_UI::instance()->video_timeline->check_server()) {
4299 if (video_server_process) {
4300 popup_error(_("The Video Server is already started."));
4302 popup_error(_("An external Video Server is configured and can be reached. Not starting a new instance."));
4308 while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
4310 warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
4312 VideoServerDialog *video_server_dialog = new VideoServerDialog (_session);
4314 video_server_dialog->set_transient_for (*float_window);
4317 if (!Config->get_show_video_server_dialog() && firsttime < 2) {
4318 video_server_dialog->hide();
4320 ResponseType r = (ResponseType) video_server_dialog->run ();
4321 video_server_dialog->hide();
4322 if (r != RESPONSE_ACCEPT) { return false; }
4323 if (video_server_dialog->show_again()) {
4324 Config->set_show_video_server_dialog(false);
4328 std::string icsd_exec = video_server_dialog->get_exec_path();
4329 std::string icsd_docroot = video_server_dialog->get_docroot();
4330 #ifndef PLATFORM_WINDOWS
4331 if (icsd_docroot.empty()) {
4332 icsd_docroot = VideoUtils::video_get_docroot (Config);
4337 #ifdef PLATFORM_WINDOWS
4338 if (VideoUtils::harvid_version >= 0x000802 && icsd_docroot.empty()) {
4339 /* OK, allow all drive letters */
4342 if (g_lstat (icsd_docroot.c_str(), &sb) != 0 || !S_ISDIR(sb.st_mode)) {
4343 warning << _("Specified docroot is not an existing directory.") << endmsg;
4346 #ifndef PLATFORM_WINDOWS
4347 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
4348 || (sb.st_mode & (S_IXUSR|S_IXGRP|S_IXOTH)) == 0 ) {
4349 warning << _("Given Video Server is not an executable file.") << endmsg;
4353 if ( (g_lstat (icsd_exec.c_str(), &sb) != 0)
4354 || (sb.st_mode & (S_IXUSR)) == 0 ) {
4355 warning << _("Given Video Server is not an executable file.") << endmsg;
4361 argp=(char**) calloc(9,sizeof(char*));
4362 argp[0] = strdup(icsd_exec.c_str());
4363 argp[1] = strdup("-P");
4364 argp[2] = (char*) calloc(16,sizeof(char)); snprintf(argp[2], 16, "%s", video_server_dialog->get_listenaddr().c_str());
4365 argp[3] = strdup("-p");
4366 argp[4] = (char*) calloc(6,sizeof(char)); snprintf(argp[4], 6, "%i", video_server_dialog->get_listenport());
4367 argp[5] = strdup("-C");
4368 argp[6] = (char*) calloc(6,sizeof(char)); snprintf(argp[6], 6, "%i", video_server_dialog->get_cachesize());
4369 argp[7] = strdup(icsd_docroot.c_str());
4371 stop_video_server();
4373 #ifdef PLATFORM_WINDOWS
4374 if (VideoUtils::harvid_version >= 0x000802 && icsd_docroot.empty()) {
4375 /* OK, allow all drive letters */
4378 if (icsd_docroot == X_("/") || icsd_docroot == X_("C:\\")) {
4379 Config->set_video_advanced_setup(false);
4381 std::ostringstream osstream;
4382 osstream << "http://127.0.0.1:" << video_server_dialog->get_listenport() << "/";
4383 Config->set_video_server_url(osstream.str());
4384 Config->set_video_server_docroot(icsd_docroot);
4385 Config->set_video_advanced_setup(true);
4388 if (video_server_process) {
4389 delete video_server_process;
4392 video_server_process = new ARDOUR::SystemExec(icsd_exec, argp);
4393 if (video_server_process->start()) {
4394 warning << _("Cannot launch the video-server") << endmsg;
4397 int timeout = 120; // 6 sec
4398 while (!ARDOUR_UI::instance()->video_timeline->check_server()) {
4399 Glib::usleep (50000);
4401 if (--timeout <= 0 || !video_server_process->is_running()) break;
4404 warning << _("Video-server was started but does not respond to requests...") << endmsg;
4406 if (!ARDOUR_UI::instance()->video_timeline->check_server_docroot()) {
4407 delete video_server_process;
4408 video_server_process = 0;
4416 ARDOUR_UI::add_video (Gtk::Window* float_window)
4422 if (!start_video_server(float_window, false)) {
4423 warning << _("Could not connect to the Video Server. Start it or configure its access URL in Preferences.") << endmsg;
4428 add_video_dialog->set_transient_for (*float_window);
4431 if (add_video_dialog->is_visible()) {
4432 /* we're already doing this */
4436 ResponseType r = (ResponseType) add_video_dialog->run ();
4437 add_video_dialog->hide();
4438 if (r != RESPONSE_ACCEPT) { return; }
4440 bool local_file, orig_local_file;
4441 std::string path = add_video_dialog->file_name(local_file);
4443 std::string orig_path = path;
4444 orig_local_file = local_file;
4446 bool auto_set_session_fps = add_video_dialog->auto_set_session_fps();
4448 if (local_file && !Glib::file_test(path, Glib::FILE_TEST_EXISTS)) {
4449 warning << string_compose(_("could not open %1"), path) << endmsg;
4452 if (!local_file && path.length() == 0) {
4453 warning << _("no video-file selected") << endmsg;
4457 std::string audio_from_video;
4458 bool detect_ltc = false;
4460 switch (add_video_dialog->import_option()) {
4461 case VTL_IMPORT_TRANSCODE:
4463 TranscodeVideoDialog *transcode_video_dialog;
4464 transcode_video_dialog = new TranscodeVideoDialog (_session, path);
4465 ResponseType r = (ResponseType) transcode_video_dialog->run ();
4466 transcode_video_dialog->hide();
4467 if (r != RESPONSE_ACCEPT) {
4468 delete transcode_video_dialog;
4472 audio_from_video = transcode_video_dialog->get_audiofile();
4474 if (!audio_from_video.empty() && transcode_video_dialog->detect_ltc()) {
4477 else if (!audio_from_video.empty()) {
4478 editor->embed_audio_from_video(
4480 video_timeline->get_offset(),
4481 (transcode_video_dialog->import_option() != VTL_IMPORT_NO_VIDEO)
4484 switch (transcode_video_dialog->import_option()) {
4485 case VTL_IMPORT_TRANSCODED:
4486 path = transcode_video_dialog->get_filename();
4489 case VTL_IMPORT_REFERENCE:
4492 delete transcode_video_dialog;
4495 delete transcode_video_dialog;
4499 case VTL_IMPORT_NONE:
4503 /* strip _session->session_directory().video_path() from video file if possible */
4504 if (local_file && !path.compare(0, _session->session_directory().video_path().size(), _session->session_directory().video_path())) {
4505 path=path.substr(_session->session_directory().video_path().size());
4506 if (path.at(0) == G_DIR_SEPARATOR) {
4507 path=path.substr(1);
4511 video_timeline->set_update_session_fps(auto_set_session_fps);
4513 if (video_timeline->video_file_info(path, local_file)) {
4514 XMLNode* node = new XMLNode(X_("Videotimeline"));
4515 node->add_property (X_("Filename"), path);
4516 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
4517 node->add_property (X_("LocalFile"), local_file?X_("1"):X_("0"));
4518 if (orig_local_file) {
4519 node->add_property (X_("OriginalVideoFile"), orig_path);
4521 node->remove_property (X_("OriginalVideoFile"));
4523 _session->add_extra_xml (*node);
4524 _session->set_dirty ();
4526 if (!audio_from_video.empty() && detect_ltc) {
4527 std::vector<LTCFileReader::LTCMap> ltc_seq;
4530 /* TODO ask user about TV standard (LTC alignment if any) */
4531 LTCFileReader ltcr (audio_from_video, video_timeline->get_video_file_fps());
4532 /* TODO ASK user which channel: 0 .. ltcr->channels() - 1 */
4534 ltc_seq = ltcr.read_ltc (/*channel*/ 0, /*max LTC frames to decode*/ 15);
4536 /* TODO seek near end of file, and read LTC until end.
4537 * if it fails to find any LTC frames, scan complete file
4539 * calculate drift of LTC compared to video-duration,
4540 * ask user for reference (timecode from start/mid/end)
4543 // LTCFileReader will have written error messages
4546 ::g_unlink(audio_from_video.c_str());
4548 if (ltc_seq.size() == 0) {
4549 PBD::error << _("No LTC detected, video will not be aligned.") << endmsg;
4551 /* the very first TC in the file is somteimes not aligned properly */
4552 int i = ltc_seq.size() -1;
4553 ARDOUR::frameoffset_t video_start_offset =
4554 _session->nominal_frame_rate() * (ltc_seq[i].timecode_sec - ltc_seq[i].framepos_sec);
4555 PBD::info << string_compose (_("Align video-start to %1 [samples]"), video_start_offset) << endmsg;
4556 video_timeline->set_offset(video_start_offset);
4560 _session->maybe_update_session_range(
4561 std::max(video_timeline->get_offset(), (ARDOUR::frameoffset_t) 0),
4562 std::max(video_timeline->get_offset() + video_timeline->get_duration(), (ARDOUR::frameoffset_t) 0));
4565 if (add_video_dialog->launch_xjadeo() && local_file) {
4566 editor->set_xjadeo_sensitive(true);
4567 editor->toggle_xjadeo_proc(1);
4569 editor->toggle_xjadeo_proc(0);
4571 editor->toggle_ruler_video(true);
4576 ARDOUR_UI::remove_video ()
4578 video_timeline->close_session();
4579 editor->toggle_ruler_video(false);
4582 video_timeline->set_offset_locked(false);
4583 video_timeline->set_offset(0);
4585 /* delete session state */
4586 XMLNode* node = new XMLNode(X_("Videotimeline"));
4587 _session->add_extra_xml(*node);
4588 node = new XMLNode(X_("Videomonitor"));
4589 _session->add_extra_xml(*node);
4590 node = new XMLNode(X_("Videoexport"));
4591 _session->add_extra_xml(*node);
4592 stop_video_server();
4596 ARDOUR_UI::flush_videotimeline_cache (bool localcacheonly)
4598 if (localcacheonly) {
4599 video_timeline->vmon_update();
4601 video_timeline->flush_cache();
4603 editor->queue_visual_videotimeline_update();
4607 ARDOUR_UI::export_video (bool range)
4609 if (ARDOUR::Config->get_show_video_export_info()) {
4610 ExportVideoInfobox infobox (_session);
4611 Gtk::ResponseType rv = (Gtk::ResponseType) infobox.run();
4612 if (infobox.show_again()) {
4613 ARDOUR::Config->set_show_video_export_info(false);
4616 case GTK_RESPONSE_YES:
4617 PBD::open_uri (ARDOUR::Config->get_reference_manual_url() + "/video-timeline/operations/#export");
4623 export_video_dialog->set_session (_session);
4624 export_video_dialog->apply_state(editor->get_selection().time, range);
4625 export_video_dialog->run ();
4626 export_video_dialog->hide ();
4630 ARDOUR_UI::preferences_settings () const
4635 node = _session->instant_xml(X_("Preferences"));
4637 node = Config->instant_xml(X_("Preferences"));
4641 node = new XMLNode (X_("Preferences"));
4648 ARDOUR_UI::mixer_settings () const
4653 node = _session->instant_xml(X_("Mixer"));
4655 node = Config->instant_xml(X_("Mixer"));
4659 node = new XMLNode (X_("Mixer"));
4666 ARDOUR_UI::main_window_settings () const
4671 node = _session->instant_xml(X_("Main"));
4673 node = Config->instant_xml(X_("Main"));
4677 if (getenv("ARDOUR_INSTANT_XML_PATH")) {
4678 node = Config->instant_xml(getenv("ARDOUR_INSTANT_XML_PATH"));
4683 node = new XMLNode (X_("Main"));
4690 ARDOUR_UI::editor_settings () const
4695 node = _session->instant_xml(X_("Editor"));
4697 node = Config->instant_xml(X_("Editor"));
4701 if (getenv("ARDOUR_INSTANT_XML_PATH")) {
4702 node = Config->instant_xml(getenv("ARDOUR_INSTANT_XML_PATH"));
4707 node = new XMLNode (X_("Editor"));
4714 ARDOUR_UI::keyboard_settings () const
4718 node = Config->extra_xml(X_("Keyboard"));
4721 node = new XMLNode (X_("Keyboard"));
4728 ARDOUR_UI::create_xrun_marker (framepos_t where)
4731 Location *location = new Location (*_session, where, where, _("xrun"), Location::IsMark, 0);
4732 _session->locations()->add (location);
4737 ARDOUR_UI::halt_on_xrun_message ()
4739 cerr << "HALT on xrun\n";
4740 MessageDialog msg (_main_window, _("Recording was stopped because your system could not keep up."));
4745 ARDOUR_UI::xrun_handler (framepos_t where)
4751 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::xrun_handler, where)
4753 if (_session && Config->get_create_xrun_marker() && _session->actively_recording()) {
4754 create_xrun_marker(where);
4757 if (_session && Config->get_stop_recording_on_xrun() && _session->actively_recording()) {
4758 halt_on_xrun_message ();
4763 ARDOUR_UI::disk_overrun_handler ()
4765 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_overrun_handler)
4767 if (!have_disk_speed_dialog_displayed) {
4768 have_disk_speed_dialog_displayed = true;
4769 MessageDialog* msg = new MessageDialog (_main_window, string_compose (_("\
4770 The disk system on your computer\n\
4771 was not able to keep up with %1.\n\
4773 Specifically, it failed to write data to disk\n\
4774 quickly enough to keep up with recording.\n"), PROGRAM_NAME));
4775 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4781 /* TODO: this is getting elaborate enough to warrant being split into a dedicated class */
4782 static MessageDialog *scan_dlg = NULL;
4783 static ProgressBar *scan_pbar = NULL;
4784 static HBox *scan_tbox = NULL;
4785 static Gtk::Button *scan_timeout_button;
4788 ARDOUR_UI::cancel_plugin_scan ()
4790 PluginManager::instance().cancel_plugin_scan();
4794 ARDOUR_UI::cancel_plugin_timeout ()
4796 PluginManager::instance().cancel_plugin_timeout();
4797 scan_timeout_button->set_sensitive (false);
4801 ARDOUR_UI::plugin_scan_timeout (int timeout)
4803 if (!scan_dlg || !scan_dlg->is_mapped() || !scan_pbar) {
4807 scan_pbar->set_sensitive (false);
4808 scan_timeout_button->set_sensitive (true);
4809 scan_pbar->set_fraction ((float) timeout / (float) Config->get_vst_scan_timeout());
4812 scan_pbar->set_sensitive (false);
4813 scan_timeout_button->set_sensitive (false);
4819 ARDOUR_UI::plugin_scan_dialog (std::string type, std::string plugin, bool can_cancel)
4821 if (type == X_("closeme") && !(scan_dlg && scan_dlg->is_mapped())) {
4825 const bool cancelled = PluginManager::instance().cancelled();
4826 if (type != X_("closeme") && (!UIConfiguration::instance().get_show_plugin_scan_window()) && !_initial_verbose_plugin_scan) {
4827 if (cancelled && scan_dlg->is_mapped()) {
4832 if (cancelled || !can_cancel) {
4837 static Gtk::Button *cancel_button;
4839 scan_dlg = new MessageDialog("", false, MESSAGE_INFO, BUTTONS_NONE); // TODO manage
4840 VBox* vbox = scan_dlg->get_vbox();
4841 vbox->set_size_request(400,-1);
4842 scan_dlg->set_title (_("Scanning for plugins"));
4844 cancel_button = manage(new Gtk::Button(_("Cancel plugin scan")));
4845 cancel_button->set_name ("EditorGTKButton");
4846 cancel_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_scan) );
4847 cancel_button->show();
4849 scan_dlg->get_vbox()->pack_start ( *cancel_button, PACK_SHRINK);
4851 scan_tbox = manage( new HBox() );
4853 scan_timeout_button = manage(new Gtk::Button(_("Stop Timeout")));
4854 scan_timeout_button->set_name ("EditorGTKButton");
4855 scan_timeout_button->signal_clicked().connect ( mem_fun (*this, &ARDOUR_UI::cancel_plugin_timeout) );
4856 scan_timeout_button->show();
4858 scan_pbar = manage(new ProgressBar());
4859 scan_pbar->set_orientation(Gtk::PROGRESS_RIGHT_TO_LEFT);
4860 scan_pbar->set_text(_("Scan Timeout"));
4863 scan_tbox->pack_start (*scan_pbar, PACK_EXPAND_WIDGET, 4);
4864 scan_tbox->pack_start (*scan_timeout_button, PACK_SHRINK, 4);
4866 scan_dlg->get_vbox()->pack_start (*scan_tbox, PACK_SHRINK, 4);
4869 assert(scan_dlg && scan_tbox && cancel_button);
4871 if (type == X_("closeme")) {
4875 scan_dlg->set_message(type + ": " + Glib::path_get_basename(plugin));
4878 if (!can_cancel || !cancelled) {
4879 scan_timeout_button->set_sensitive(false);
4881 cancel_button->set_sensitive(can_cancel && !cancelled);
4887 ARDOUR_UI::gui_idle_handler ()
4890 /* due to idle calls, gtk_events_pending() may always return true */
4891 while (gtk_events_pending() && --timeout) {
4892 gtk_main_iteration ();
4897 ARDOUR_UI::disk_underrun_handler ()
4899 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::disk_underrun_handler)
4901 if (!have_disk_speed_dialog_displayed) {
4902 have_disk_speed_dialog_displayed = true;
4903 MessageDialog* msg = new MessageDialog (
4904 _main_window, string_compose (_("The disk system on your computer\n\
4905 was not able to keep up with %1.\n\
4907 Specifically, it failed to read data from disk\n\
4908 quickly enough to keep up with playback.\n"), PROGRAM_NAME));
4909 msg->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::disk_speed_dialog_gone), msg));
4915 ARDOUR_UI::disk_speed_dialog_gone (int /*ignored_response*/, MessageDialog* msg)
4917 have_disk_speed_dialog_displayed = false;
4922 ARDOUR_UI::session_dialog (std::string msg)
4924 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::session_dialog, msg)
4928 d = new MessageDialog (msg, false, MESSAGE_INFO, BUTTONS_OK, true);
4935 ARDOUR_UI::pending_state_dialog ()
4937 HBox* hbox = manage (new HBox());
4938 Image* image = manage (new Image (Stock::DIALOG_QUESTION, ICON_SIZE_DIALOG));
4939 ArdourDialog dialog (_("Crash Recovery"), true);
4940 Label message (string_compose (_("\
4941 This session appears to have been in the\n\
4942 middle of recording when %1 or\n\
4943 the computer was shutdown.\n\
4945 %1 can recover any captured audio for\n\
4946 you, or it can ignore it. Please decide\n\
4947 what you would like to do.\n"), PROGRAM_NAME));
4948 image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4949 hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4950 hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4951 dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4952 dialog.add_button (_("Ignore crash data"), RESPONSE_REJECT);
4953 dialog.add_button (_("Recover from crash"), RESPONSE_ACCEPT);
4954 dialog.set_default_response (RESPONSE_ACCEPT);
4955 dialog.set_position (WIN_POS_CENTER);
4960 switch (dialog.run ()) {
4961 case RESPONSE_ACCEPT:
4969 ARDOUR_UI::sr_mismatch_dialog (framecnt_t desired, framecnt_t actual)
4971 HBox* hbox = new HBox();
4972 Image* image = new Image (Stock::DIALOG_WARNING, ICON_SIZE_DIALOG);
4973 ArdourDialog dialog (_("Sample Rate Mismatch"), true);
4974 Label message (string_compose (_("\
4975 This session was created with a sample rate of %1 Hz, but\n\
4976 %2 is currently running at %3 Hz. If you load this session,\n\
4977 audio may be played at the wrong sample rate.\n"), desired, PROGRAM_NAME, actual));
4979 image->set_alignment(ALIGN_CENTER, ALIGN_TOP);
4980 hbox->pack_start (*image, PACK_EXPAND_WIDGET, 12);
4981 hbox->pack_end (message, PACK_EXPAND_PADDING, 12);
4982 dialog.get_vbox()->pack_start(*hbox, PACK_EXPAND_PADDING, 6);
4983 dialog.add_button (_("Do not load session"), RESPONSE_REJECT);
4984 dialog.add_button (_("Load session anyway"), RESPONSE_ACCEPT);
4985 dialog.set_default_response (RESPONSE_ACCEPT);
4986 dialog.set_position (WIN_POS_CENTER);
4991 switch (dialog.run()) {
4992 case RESPONSE_ACCEPT:
5002 ARDOUR_UI::sr_mismatch_message (framecnt_t desired, framecnt_t actual)
5004 MessageDialog msg (string_compose (_("\
5005 This session was created with a sample rate of %1 Hz, but\n\
5006 %2 is currently running at %3 Hz.\n\
5007 Audio will be recorded and played at the wrong sample rate.\n\
5008 Re-Configure the Audio Engine in\n\
5009 Menu > Window > Audio/Midi Setup"),
5010 desired, PROGRAM_NAME, actual),
5012 Gtk::MESSAGE_WARNING);
5017 ARDOUR_UI::use_config ()
5022 ARDOUR_UI::update_transport_clocks (framepos_t pos)
5024 if (UIConfiguration::instance().get_primary_clock_delta_edit_cursor()) {
5025 primary_clock->set (pos, false, editor->get_preferred_edit_position (EDIT_IGNORE_PHEAD));
5027 primary_clock->set (pos);
5030 if (UIConfiguration::instance().get_secondary_clock_delta_edit_cursor()) {
5031 secondary_clock->set (pos, false, editor->get_preferred_edit_position (EDIT_IGNORE_PHEAD));
5033 secondary_clock->set (pos);
5036 if (big_clock_window) {
5037 big_clock->set (pos);
5039 ARDOUR_UI::instance()->video_timeline->manual_seek_video_monitor(pos);
5043 ARDOUR_UI::step_edit_status_change (bool yn)
5045 // XXX should really store pre-step edit status of things
5046 // we make insensitive
5049 rec_button.set_active_state (Gtkmm2ext::ImplicitActive);
5050 rec_button.set_sensitive (false);
5052 rec_button.unset_active_state ();;
5053 rec_button.set_sensitive (true);
5058 ARDOUR_UI::record_state_changed ()
5060 ENSURE_GUI_THREAD (*this, &ARDOUR_UI::record_state_changed);
5063 /* why bother - the clock isn't visible */
5067 ActionManager::set_sensitive (ActionManager::rec_sensitive_actions, !_session->actively_recording());
5069 if (big_clock_window) {
5070 if (_session->record_status () == Session::Recording && _session->have_rec_enabled_track ()) {
5071 big_clock->set_active (true);
5073 big_clock->set_active (false);
5080 ARDOUR_UI::first_idle ()
5083 _session->allow_auto_play (true);
5087 editor->first_idle();
5090 Keyboard::set_can_save_keybindings (true);
5095 ARDOUR_UI::store_clock_modes ()
5097 XMLNode* node = new XMLNode(X_("ClockModes"));
5099 for (vector<AudioClock*>::iterator x = AudioClock::clocks.begin(); x != AudioClock::clocks.end(); ++x) {
5100 XMLNode* child = new XMLNode (X_("Clock"));
5102 child->add_property (X_("name"), (*x)->name());
5103 child->add_property (X_("mode"), enum_2_string ((*x)->mode()));
5104 child->add_property (X_("on"), ((*x)->off() ? X_("no") : X_("yes")));
5106 node->add_child_nocopy (*child);
5109 _session->add_extra_xml (*node);
5110 _session->set_dirty ();
5114 ARDOUR_UI::setup_profile ()
5116 if (gdk_screen_width() < 1200 || getenv ("ARDOUR_NARROW_SCREEN")) {
5117 Profile->set_small_screen ();
5120 if (g_getenv ("TRX")) {
5121 Profile->set_trx ();
5124 if (g_getenv ("MIXBUS")) {
5125 Profile->set_mixbus ();
5130 ARDOUR_UI::missing_file (Session*s, std::string str, DataType type)
5132 MissingFileDialog dialog (s, str, type);
5137 int result = dialog.run ();
5144 return 1; // quit entire session load
5147 result = dialog.get_action ();
5153 ARDOUR_UI::ambiguous_file (std::string file, std::vector<std::string> hits)
5155 AmbiguousFileDialog dialog (file, hits);
5162 return dialog.get_which ();
5165 /** Allocate our thread-local buffers */
5167 ARDOUR_UI::get_process_buffers ()
5169 _process_thread->get_buffers ();
5172 /** Drop our thread-local buffers */
5174 ARDOUR_UI::drop_process_buffers ()
5176 _process_thread->drop_buffers ();
5180 ARDOUR_UI::feedback_detected ()
5182 _feedback_exists = true;
5186 ARDOUR_UI::successful_graph_sort ()
5188 _feedback_exists = false;
5192 ARDOUR_UI::midi_panic ()
5195 _session->midi_panic();
5200 ARDOUR_UI::session_format_mismatch (std::string xml_path, std::string backup_path)
5202 const char* start_big = "<span size=\"x-large\" weight=\"bold\">";
5203 const char* end_big = "</span>";
5204 const char* start_mono = "<tt>";
5205 const char* end_mono = "</tt>";
5207 MessageDialog msg (string_compose (_("%4This is a session from an older version of %3%5\n\n"
5208 "%3 has copied the old session file\n\n%6%1%7\n\nto\n\n%6%2%7\n\n"
5209 "From now on, use the backup copy with older versions of %3"),
5210 xml_path, backup_path, PROGRAM_NAME,
5212 start_mono, end_mono), true);
5219 ARDOUR_UI::reset_peak_display ()
5221 if (!_session || !_session->master_out() || !editor_meter) return;
5222 editor_meter->clear_meters();
5223 editor_meter_max_peak = -INFINITY;
5224 editor_meter_peak_display.set_active_state ( Gtkmm2ext::Off );
5228 ARDOUR_UI::reset_group_peak_display (RouteGroup* group)
5230 if (!_session || !_session->master_out()) return;
5231 if (group == _session->master_out()->route_group()) {
5232 reset_peak_display ();
5237 ARDOUR_UI::reset_route_peak_display (Route* route)
5239 if (!_session || !_session->master_out()) return;
5240 if (_session->master_out().get() == route) {
5241 reset_peak_display ();
5246 ARDOUR_UI::do_audio_midi_setup (uint32_t desired_sample_rate)
5248 audio_midi_setup->set_desired_sample_rate (desired_sample_rate);
5249 audio_midi_setup->set_position (WIN_POS_CENTER);
5251 if (Config->get_try_autostart_engine () || getenv ("TRY_AUTOSTART_ENGINE")) {
5252 audio_midi_setup->try_autostart ();
5253 if (ARDOUR::AudioEngine::instance()->running()) {
5259 int response = audio_midi_setup->run();
5260 printf("RESPONSE %d\n", response);
5262 case Gtk::RESPONSE_DELETE_EVENT:
5265 if (!AudioEngine::instance()->running()) {
5268 audio_midi_setup->hide ();
5276 ARDOUR_UI::transport_numpad_timeout ()
5278 _numpad_locate_happening = false;
5279 if (_numpad_timeout_connection.connected() )
5280 _numpad_timeout_connection.disconnect();
5285 ARDOUR_UI::transport_numpad_decimal ()
5287 _numpad_timeout_connection.disconnect();
5289 if (_numpad_locate_happening) {
5290 if (editor) editor->goto_nth_marker(_pending_locate_num - 1);
5291 _numpad_locate_happening = false;
5293 _pending_locate_num = 0;
5294 _numpad_locate_happening = true;
5295 _numpad_timeout_connection = Glib::signal_timeout().connect (mem_fun(*this, &ARDOUR_UI::transport_numpad_timeout), 2*1000);
5300 ARDOUR_UI::transport_numpad_event (int num)
5302 if ( _numpad_locate_happening ) {
5303 _pending_locate_num = _pending_locate_num*10 + num;
5306 case 0: toggle_roll(false, false); break;
5307 case 1: transport_rewind(1); break;
5308 case 2: transport_forward(1); break;
5309 case 3: transport_record(true); break;
5310 case 4: toggle_session_auto_loop(); break;
5311 case 5: transport_record(false); toggle_session_auto_loop(); break;
5312 case 6: toggle_punch(); break;
5313 case 7: toggle_click(); break;
5314 case 8: toggle_auto_return(); break;
5315 case 9: toggle_follow_edits(); break;
5321 ARDOUR_UI::set_flat_buttons ()
5323 CairoWidget::set_flat_buttons( UIConfiguration::instance().get_flat_buttons() );
5327 ARDOUR_UI::audioengine_became_silent ()
5329 MessageDialog msg (string_compose (_("This is a free/demo copy of %1. It has just switched to silent mode."), PROGRAM_NAME),
5331 Gtk::MESSAGE_WARNING,
5335 msg.set_title (string_compose (_("%1 is now silent"), PROGRAM_NAME));
5337 Gtk::Label pay_label (string_compose (_("Please consider paying for a copy of %1 - you can pay whatever you want."), PROGRAM_NAME));
5338 Gtk::Label subscribe_label (_("Better yet become a subscriber - subscriptions start at US$1 per month."));
5339 Gtk::Button pay_button (_("Pay for a copy (via the web)"));
5340 Gtk::Button subscribe_button (_("Become a subscriber (via the web)"));
5341 Gtk::HBox pay_button_box;
5342 Gtk::HBox subscribe_button_box;
5344 pay_button_box.pack_start (pay_button, true, false);
5345 subscribe_button_box.pack_start (subscribe_button, true, false);
5347 bool (*openuri)(const char*) = PBD::open_uri; /* this forces selection of the const char* variant of PBD::open_uri(), which we need to avoid ambiguity below */
5349 pay_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://ardour.org/download")));
5350 subscribe_button.signal_clicked().connect (sigc::hide_return (sigc::bind (sigc::ptr_fun (openuri), (const char*) "https://community.ardour.org/s/subscribe")));
5352 msg.get_vbox()->pack_start (pay_label);
5353 msg.get_vbox()->pack_start (pay_button_box);
5354 msg.get_vbox()->pack_start (subscribe_label);
5355 msg.get_vbox()->pack_start (subscribe_button_box);
5357 msg.get_vbox()->show_all ();
5359 msg.add_button (_("Remain silent"), Gtk::RESPONSE_CANCEL);
5360 msg.add_button (_("Save and quit"), Gtk::RESPONSE_NO);
5361 msg.add_button (_("Give me more time"), Gtk::RESPONSE_YES);
5366 case Gtk::RESPONSE_YES:
5367 AudioEngine::instance()->reset_silence_countdown ();
5370 case Gtk::RESPONSE_NO:
5372 save_state_canfail ("");
5376 case Gtk::RESPONSE_CANCEL:
5378 /* don't reset, save session and exit */
5384 ARDOUR_UI::hide_application ()
5386 Application::instance ()-> hide ();
5390 ARDOUR_UI::setup_toplevel_window (Gtk::Window& window, const string& name, void* owner)
5392 /* icons, titles, WM stuff */
5394 static list<Glib::RefPtr<Gdk::Pixbuf> > window_icons;
5396 if (window_icons.empty()) {
5397 Glib::RefPtr<Gdk::Pixbuf> icon;
5398 if ((icon = ::get_icon (PROGRAM_NAME "-icon_16px"))) {
5399 window_icons.push_back (icon);
5401 if ((icon = ::get_icon (PROGRAM_NAME "-icon_22px"))) {
5402 window_icons.push_back (icon);
5404 if ((icon = ::get_icon (PROGRAM_NAME "-icon_32px"))) {
5405 window_icons.push_back (icon);
5407 if ((icon = ::get_icon (PROGRAM_NAME "-icon_48px"))) {
5408 window_icons.push_back (icon);
5412 if (!window_icons.empty()) {
5413 window.set_default_icon_list (window_icons);
5416 Gtkmm2ext::WindowTitle title (Glib::get_application_name());
5418 if (!name.empty()) {
5422 window.set_title (title.get_string());
5423 window.set_wmclass (string_compose (X_("%1_%1"), downcase (std::string(PROGRAM_NAME)), downcase (name)), PROGRAM_NAME);
5425 window.set_flags (CAN_FOCUS);
5426 window.add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
5428 /* This is a hack to ensure that GTK-accelerators continue to
5429 * work. Once we switch over to entirely native bindings, this will be
5430 * unnecessary and should be removed
5432 window.add_accel_group (ActionManager::ui_manager->get_accel_group());
5434 window.signal_configure_event().connect (sigc::mem_fun (*this, &ARDOUR_UI::configure_handler));
5435 window.signal_window_state_event().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::tabbed_window_state_event_handler), owner));
5436 window.signal_key_press_event().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::key_event_handler), &window), false);
5437 window.signal_key_release_event().connect (sigc::bind (sigc::mem_fun (*this, &ARDOUR_UI::key_event_handler), &window), false);
5441 ARDOUR_UI::key_event_handler (GdkEventKey* ev, Gtk::Window* event_window)
5443 Gtkmm2ext::Bindings* bindings = 0;
5444 Gtk::Window* window = 0;
5446 /* until we get ardour bindings working, we are not handling key
5450 if (ev->type != GDK_KEY_PRESS) {
5454 if (event_window == &_main_window) {
5456 window = event_window;
5458 /* find current tab contents */
5460 Gtk::Widget* w = _tabs.get_nth_page (_tabs.get_current_page());
5462 /* see if it uses the ardour binding system */
5465 bindings = reinterpret_cast<Gtkmm2ext::Bindings*>(w->get_data ("ardour-bindings"));
5468 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("main window key event, bindings = %1, global = %2\n", bindings, &global_bindings));
5472 window = event_window;
5474 /* see if window uses ardour binding system */
5476 bindings = reinterpret_cast<Gtkmm2ext::Bindings*>(window->get_data ("ardour-bindings"));
5479 /* An empty binding set is treated as if it doesn't exist */
5481 if (bindings && bindings->empty()) {
5485 return key_press_focus_accelerator_handler (*window, ev, bindings);
5488 static Gtkmm2ext::Bindings*
5489 get_bindings_from_widget_heirarchy (GtkWidget** w)
5494 if ((p = g_object_get_data (G_OBJECT(*w), "ardour-bindings")) != 0) {
5497 *w = gtk_widget_get_parent (*w);
5500 return reinterpret_cast<Gtkmm2ext::Bindings*> (p);
5504 ARDOUR_UI::key_press_focus_accelerator_handler (Gtk::Window& window, GdkEventKey* ev, Gtkmm2ext::Bindings* bindings)
5506 GtkWindow* win = window.gobj();
5507 GtkWidget* focus = gtk_window_get_focus (win);
5508 GtkWidget* binding_widget = focus;
5509 bool special_handling_of_unmodified_accelerators = false;
5510 const guint mask = (Keyboard::RelevantModifierKeyMask & ~(Gdk::SHIFT_MASK|Gdk::LOCK_MASK));
5514 /* some widget has keyboard focus */
5516 if (GTK_IS_ENTRY(focus) || Keyboard::some_magic_widget_has_focus()) {
5518 /* A particular kind of focusable widget currently has keyboard
5519 * focus. All unmodified key events should go to that widget
5520 * first and not be used as an accelerator by default
5523 special_handling_of_unmodified_accelerators = true;
5527 Gtkmm2ext::Bindings* focus_bindings = get_bindings_from_widget_heirarchy (&binding_widget);
5528 if (focus_bindings) {
5529 bindings = focus_bindings;
5530 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("Switch bindings based on focus widget, now using %1\n", bindings->name()));
5535 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("Win = %1 [title = %9] focus = %7 (%8) Key event: code = %2 state = %3 special handling ? %4 magic widget focus ? %5 focus widget %6 named %7 mods ? %8\n",
5538 Gtkmm2ext::show_gdk_event_state (ev->state),
5539 special_handling_of_unmodified_accelerators,
5540 Keyboard::some_magic_widget_has_focus(),
5542 (focus ? gtk_widget_get_name (focus) : "no focus widget"),
5543 ((ev->state & mask) ? "yes" : "no"),
5544 window.get_title()));
5546 /* This exists to allow us to override the way GTK handles
5547 key events. The normal sequence is:
5549 a) event is delivered to a GtkWindow
5550 b) accelerators/mnemonics are activated
5551 c) if (b) didn't handle the event, propagate to
5552 the focus widget and/or focus chain
5554 The problem with this is that if the accelerators include
5555 keys without modifiers, such as the space bar or the
5556 letter "e", then pressing the key while typing into
5557 a text entry widget results in the accelerator being
5558 activated, instead of the desired letter appearing
5561 There is no good way of fixing this, but this
5562 represents a compromise. The idea is that
5563 key events involving modifiers (not Shift)
5564 get routed into the activation pathway first, then
5565 get propagated to the focus widget if necessary.
5567 If the key event doesn't involve modifiers,
5568 we deliver to the focus widget first, thus allowing
5569 it to get "normal text" without interference
5572 Of course, this can also be problematic: if there
5573 is a widget with focus, then it will swallow
5574 all "normal text" accelerators.
5578 if (!special_handling_of_unmodified_accelerators || (ev->state & mask)) {
5580 /* no special handling or there are modifiers in effect: accelerate first */
5582 DEBUG_TRACE (DEBUG::Accelerators, "\tactivate, then propagate\n");
5583 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("\tevent send-event:%1 time:%2 length:%3 name %7 string:%4 hardware_keycode:%5 group:%6\n",
5584 ev->send_event, ev->time, ev->length, ev->string, ev->hardware_keycode, ev->group, gdk_keyval_name (ev->keyval)));
5586 DEBUG_TRACE (DEBUG::Accelerators, "\tsending to window\n");
5587 KeyboardKey k (ev->state, ev->keyval);
5591 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("\tusing Ardour bindings %1 @ %2 for this event\n", bindings->name(), bindings));
5593 if (bindings->activate (k, Bindings::Press)) {
5594 DEBUG_TRACE (DEBUG::Accelerators, "\t\thandled\n");
5598 if (binding_widget) {
5599 binding_widget = gtk_widget_get_parent (binding_widget);
5600 if (binding_widget) {
5601 bindings = get_bindings_from_widget_heirarchy (&binding_widget);
5610 DEBUG_TRACE (DEBUG::Accelerators, "\tnot yet handled, try global bindings\n");
5612 if (global_bindings && global_bindings->activate (k, Bindings::Press)) {
5613 DEBUG_TRACE (DEBUG::Accelerators, "\t\thandled\n");
5617 DEBUG_TRACE (DEBUG::Accelerators, "\tnot accelerated, now propagate\n");
5619 if (gtk_window_propagate_key_event (win, ev)) {
5620 DEBUG_TRACE (DEBUG::Accelerators, "\tpropagate handled\n");
5626 /* no modifiers, propagate first */
5628 DEBUG_TRACE (DEBUG::Accelerators, "\tpropagate, then activate\n");
5630 if (gtk_window_propagate_key_event (win, ev)) {
5631 DEBUG_TRACE (DEBUG::Accelerators, "\thandled by propagate\n");
5635 DEBUG_TRACE (DEBUG::Accelerators, "\tpropagation didn't handle, so activate\n");
5636 KeyboardKey k (ev->state, ev->keyval);
5640 DEBUG_TRACE (DEBUG::Accelerators, "\tusing Ardour bindings for this window\n");
5643 if (bindings->activate (k, Bindings::Press)) {
5644 DEBUG_TRACE (DEBUG::Accelerators, "\t\thandled\n");
5648 if (binding_widget) {
5649 binding_widget = gtk_widget_get_parent (binding_widget);
5650 if (binding_widget) {
5651 bindings = get_bindings_from_widget_heirarchy (&binding_widget);
5660 DEBUG_TRACE (DEBUG::Accelerators, "\tnot yet handled, try global bindings\n");
5662 if (global_bindings && global_bindings->activate (k, Bindings::Press)) {
5663 DEBUG_TRACE (DEBUG::Accelerators, "\t\thandled\n");
5668 DEBUG_TRACE (DEBUG::Accelerators, "\tnot handled\n");
5673 ARDOUR_UI::load_bindings ()
5675 if ((global_bindings = Bindings::get_bindings (X_("Global"), global_actions)) == 0) {
5676 error << _("Global keybindings are missing") << endmsg;
5681 ARDOUR_UI::cancel_solo ()
5684 _session->cancel_all_solo ();
5689 ARDOUR_UI::reset_focus (Gtk::Widget* w)
5691 /* this resets focus to the first focusable parent of the given widget,
5692 * or, if there is no focusable parent, cancels focus in the toplevel
5693 * window that the given widget is packed into (if there is one).
5700 Gtk::Widget* top = w->get_toplevel();
5702 if (!top || !top->is_toplevel()) {
5706 w = w->get_parent ();
5710 if (w->is_toplevel()) {
5711 /* Setting the focus widget to a Gtk::Window causes all
5712 * subsequent calls to ::has_focus() on the nominal
5713 * focus widget in that window to return
5714 * false. Workaround: never set focus to the toplevel
5720 if (w->get_can_focus ()) {
5721 Gtk::Window* win = dynamic_cast<Gtk::Window*> (top);
5722 win->set_focus (*w);
5725 w = w->get_parent ();
5728 if (top == &_main_window) {
5732 /* no focusable parent found, cancel focus in top level window.
5733 C++ API cannot be used for this. Thanks, references.
5736 gtk_window_set_focus (GTK_WINDOW(top->gobj()), 0);