+// @return true if there are drivers available
+bool
+EngineControl::set_driver_popdown_strings ()
+{
+ DEBUG_ECONTROL ("set_driver_popdown_strings");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ vector<string> drivers = backend->enumerate_drivers();
+
+ if (drivers.empty ()) {
+ // This is an error...?
+ return false;
+ }
+
+ string current_driver = backend->driver_name ();
+
+ DEBUG_ECONTROL (string_compose ("backend->driver_name: %1", current_driver));
+
+ if (std::find (drivers.begin (), drivers.end (), current_driver) ==
+ drivers.end ()) {
+
+ current_driver = drivers.front ();
+ }
+
+ set_popdown_strings (driver_combo, drivers);
+ DEBUG_ECONTROL (
+ string_compose ("driver_combo.set_active_text: %1", current_driver));
+ driver_combo.set_active_text (current_driver);
+ return true;
+}
+
+std::string
+EngineControl::get_default_device(const string& current_device_name,
+ const vector<string>& available_devices)
+{
+ // If the current device is available, use it as default
+ if (std::find (available_devices.begin (),
+ available_devices.end (),
+ current_device_name) != available_devices.end ()) {
+
+ return current_device_name;
+ }
+
+ using namespace ARDOUR;
+
+ string default_device_name =
+ AudioBackend::get_standard_device_name(AudioBackend::DeviceDefault);
+
+ vector<string>::const_iterator i;
+
+ // If there is a "Default" device available, use it
+ for (i = available_devices.begin(); i != available_devices.end(); ++i) {
+ if (*i == default_device_name) {
+ return *i;
+ }
+ }
+
+ string none_device_name =
+ AudioBackend::get_standard_device_name(AudioBackend::DeviceNone);
+
+ // Use the first device that isn't "None"
+ for (i = available_devices.begin(); i != available_devices.end(); ++i) {
+ if (*i != none_device_name) {
+ return *i;
+ }
+ }
+
+ // Use "None" if there are no other available
+ return available_devices.front();
+}
+
+// @return true if there are devices available
+bool
+EngineControl::set_device_popdown_strings ()
+{
+ DEBUG_ECONTROL ("set_device_popdown_strings");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ vector<ARDOUR::AudioBackend::DeviceStatus> all_devices = backend->enumerate_devices ();
+
+ /* NOTE: Ardour currently does not display the "available" field of the
+ * returned devices.
+ *
+ * Doing so would require a different GUI widget than the combo
+ * box/popdown that we currently use, since it has no way to list
+ * items that are not selectable. Something more like a popup menu,
+ * which could have unselectable items, would be appropriate.
+ */
+
+ vector<string> available_devices;
+
+ for (vector<ARDOUR::AudioBackend::DeviceStatus>::const_iterator i = all_devices.begin(); i != all_devices.end(); ++i) {
+ available_devices.push_back (i->name);
+ }
+
+ if (available_devices.empty ()) {
+ return false;
+ }
+
+ set_popdown_strings (device_combo, available_devices);
+
+ std::string default_device =
+ get_default_device(backend->device_name(), available_devices);
+
+ DEBUG_ECONTROL (
+ string_compose ("set device_combo active text: %1", default_device));
+
+ device_combo.set_active_text(default_device);
+ return true;
+}
+
+// @return true if there are input devices available
+bool
+EngineControl::set_input_device_popdown_strings ()
+{
+ DEBUG_ECONTROL ("set_input_device_popdown_strings");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ vector<ARDOUR::AudioBackend::DeviceStatus> all_devices = backend->enumerate_input_devices ();
+
+ vector<string> available_devices;
+
+ for (vector<ARDOUR::AudioBackend::DeviceStatus>::const_iterator i = all_devices.begin(); i != all_devices.end(); ++i) {
+ available_devices.push_back (i->name);
+ }
+
+ if (available_devices.empty()) {
+ return false;
+ }
+
+ set_popdown_strings (input_device_combo, available_devices);
+
+ std::string default_device =
+ get_default_device(backend->input_device_name(), available_devices);
+
+ DEBUG_ECONTROL (
+ string_compose ("set input_device_combo active text: %1", default_device));
+ input_device_combo.set_active_text(default_device);
+ return true;
+}
+
+// @return true if there are output devices available
+bool
+EngineControl::set_output_device_popdown_strings ()
+{
+ DEBUG_ECONTROL ("set_output_device_popdown_strings");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ vector<ARDOUR::AudioBackend::DeviceStatus> all_devices = backend->enumerate_output_devices ();
+
+ vector<string> available_devices;
+
+ for (vector<ARDOUR::AudioBackend::DeviceStatus>::const_iterator i = all_devices.begin(); i != all_devices.end(); ++i) {
+ available_devices.push_back (i->name);
+ }
+
+ if (available_devices.empty()) {
+ return false;
+ }
+
+ set_popdown_strings (output_device_combo, available_devices);
+
+ std::string default_device =
+ get_default_device(backend->output_device_name(), available_devices);
+
+ DEBUG_ECONTROL (
+ string_compose ("set output_device_combo active text: %1", default_device));
+ output_device_combo.set_active_text(default_device);
+ return true;
+}
+
+void
+EngineControl::list_devices ()
+{
+ DEBUG_ECONTROL ("list_devices");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ assert (backend);
+
+ /* now fill out devices, mark sample rates, buffer sizes insensitive */
+
+ bool devices_available = false;
+
+ if (backend->use_separate_input_and_output_devices ()) {
+ bool input_devices_available = set_input_device_popdown_strings ();
+ bool output_devices_available = set_output_device_popdown_strings ();
+ devices_available = input_devices_available || output_devices_available;
+ } else {
+ devices_available = set_device_popdown_strings ();
+ }
+
+ if (devices_available) {
+ device_changed ();
+ } else {
+ device_combo.clear();
+ input_device_combo.clear();
+ output_device_combo.clear();
+ }
+ update_sensitivity ();
+}
+
+void
+EngineControl::driver_changed ()
+{
+ SignalBlocker blocker (*this, "driver_changed");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ assert (backend);
+
+ backend->set_driver (driver_combo.get_active_text());
+ list_devices ();
+
+ // TODO load LRU device(s) for backend + driver combo
+
+ if (!ignore_changes) {
+ maybe_display_saved_state ();
+ }
+}
+
+vector<float>
+EngineControl::get_sample_rates_for_all_devices ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend =
+ ARDOUR::AudioEngine::instance ()->current_backend ();
+ vector<float> all_rates;
+
+ if (backend->use_separate_input_and_output_devices ()) {
+ all_rates = backend->available_sample_rates2 (get_input_device_name (), get_output_device_name ());
+ } else {
+ all_rates = backend->available_sample_rates (get_device_name ());
+ }
+ return all_rates;
+}
+
+vector<float>
+EngineControl::get_default_sample_rates ()
+{
+ vector<float> rates;
+ rates.push_back (8000.0f);
+ rates.push_back (16000.0f);
+ rates.push_back (32000.0f);
+ rates.push_back (44100.0f);
+ rates.push_back (48000.0f);
+ rates.push_back (88200.0f);
+ rates.push_back (96000.0f);
+ rates.push_back (192000.0f);
+ rates.push_back (384000.0f);
+ return rates;
+}
+
+void
+EngineControl::set_samplerate_popdown_strings ()
+{
+ DEBUG_ECONTROL ("set_samplerate_popdown_strings");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ string desired;
+ vector<float> sr;
+ vector<string> s;
+
+ if (_have_control) {
+ sr = get_sample_rates_for_all_devices ();
+ } else {
+ sr = get_default_sample_rates ();
+ }
+
+ for (vector<float>::const_iterator x = sr.begin(); x != sr.end(); ++x) {
+ s.push_back (rate_as_string (*x));
+ if (*x == _desired_sample_rate) {
+ desired = s.back();
+ }
+ }
+
+ set_popdown_strings (sample_rate_combo, s);
+
+ if (!s.empty()) {
+ if (ARDOUR::AudioEngine::instance()->running()) {
+ sample_rate_combo.set_active_text (rate_as_string (backend->sample_rate()));
+ } else if (ARDOUR_UI::instance()->session_loaded) {
+ float active_sr = ARDOUR_UI::instance()->the_session()->nominal_sample_rate ();
+
+ if (std::find (sr.begin (), sr.end (), active_sr) == sr.end ()) {
+ active_sr = sr.front ();
+ }
+
+ sample_rate_combo.set_active_text (rate_as_string (active_sr));
+ } else if (desired.empty ()) {
+ float new_active_sr = backend->default_sample_rate ();
+
+ if (std::find (sr.begin (), sr.end (), new_active_sr) == sr.end ()) {
+ new_active_sr = sr.front ();
+ }
+
+ sample_rate_combo.set_active_text (rate_as_string (new_active_sr));
+ } else {
+ sample_rate_combo.set_active_text (desired);
+ }
+ }
+ update_sensitivity ();
+}
+
+vector<uint32_t>
+EngineControl::get_buffer_sizes_for_all_devices ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend =
+ ARDOUR::AudioEngine::instance ()->current_backend ();
+ vector<uint32_t> all_sizes;
+
+ if (backend->use_separate_input_and_output_devices ()) {
+ all_sizes = backend->available_buffer_sizes2 (get_input_device_name (), get_output_device_name ());
+ } else {
+ all_sizes = backend->available_buffer_sizes (get_device_name ());
+ }
+ return all_sizes;
+}
+
+vector<uint32_t>
+EngineControl::get_default_buffer_sizes ()
+{
+ vector<uint32_t> sizes;
+ sizes.push_back (8);
+ sizes.push_back (16);
+ sizes.push_back (32);
+ sizes.push_back (64);
+ sizes.push_back (128);
+ sizes.push_back (256);
+ sizes.push_back (512);
+ sizes.push_back (1024);
+ sizes.push_back (2048);
+ sizes.push_back (4096);
+ sizes.push_back (8192);
+ return sizes;
+}
+
+void
+EngineControl::set_buffersize_popdown_strings ()
+{
+ DEBUG_ECONTROL ("set_buffersize_popdown_strings");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ vector<uint32_t> bs;
+ vector<string> s;
+
+ if (_have_control) {
+ bs = get_buffer_sizes_for_all_devices ();
+ } else if (backend->can_change_buffer_size_when_running()) {
+ bs = get_default_buffer_sizes ();
+ }
+
+ for (vector<uint32_t>::const_iterator x = bs.begin(); x != bs.end(); ++x) {
+ s.push_back (bufsize_as_string (*x));
+ }
+
+ uint32_t previous_size = backend->buffer_size ();
+ if (!buffer_size_combo.get_active_text().empty()) {
+ previous_size = get_buffer_size ();
+ }
+
+ set_popdown_strings (buffer_size_combo, s);
+
+ if (!s.empty()) {
+
+ if (std::find(bs.begin(), bs.end(), previous_size) != bs.end()) {
+ buffer_size_combo.set_active_text(bufsize_as_string(previous_size));
+ } else {
+
+ buffer_size_combo.set_active_text(s.front());
+
+ uint32_t period = backend->buffer_size();
+ if (0 == period && backend->use_separate_input_and_output_devices()) {
+ period = backend->default_buffer_size(get_input_device_name());
+ }
+ if (0 == period && backend->use_separate_input_and_output_devices()) {
+ period = backend->default_buffer_size(get_output_device_name());
+ }
+ if (0 == period && !backend->use_separate_input_and_output_devices()) {
+ period = backend->default_buffer_size(get_device_name());
+ }
+
+ set_active_text_if_present(buffer_size_combo, bufsize_as_string(period));
+ }
+ show_buffer_duration ();
+ }
+ update_sensitivity ();
+}
+
+void
+EngineControl::set_nperiods_popdown_strings ()
+{
+ DEBUG_ECONTROL ("set_nperiods_popdown_strings");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ vector<uint32_t> np;
+ vector<string> s;
+
+ if (backend->can_set_period_size()) {
+ np = backend->available_period_sizes (get_driver());
+ }
+
+ for (vector<uint32_t>::const_iterator x = np.begin(); x != np.end(); ++x) {
+ s.push_back (to_string (*x));
+ }
+
+ set_popdown_strings (nperiods_combo, s);
+
+ if (!s.empty()) {
+ set_active_text_if_present (nperiods_combo, to_string (backend->period_size())); // XXX
+ }
+
+ update_sensitivity ();
+}
+
+void
+EngineControl::device_changed ()
+{
+ SignalBlocker blocker (*this, "device_changed");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ assert (backend);
+
+ string device_name_in;
+ string device_name_out; // only used if backend support separate I/O devices
+
+ if (backend->use_separate_input_and_output_devices()) {
+ device_name_in = get_input_device_name ();
+ device_name_out = get_output_device_name ();
+ } else {
+ device_name_in = get_device_name ();
+ }
+
+ /* we set the backend-device to query various device related intormation.
+ * This has the side effect that backend->device_name() will match
+ * the device_name and 'change_device' will never be true.
+ * so work around this by setting...
+ */
+ if (backend->use_separate_input_and_output_devices()) {
+ if (device_name_in != backend->input_device_name() || device_name_out != backend->output_device_name ()) {
+ queue_device_changed = true;
+ }
+ } else {
+ if (device_name_in != backend->device_name()) {
+ queue_device_changed = true;
+ }
+ }
+
+ //the device name must be set FIRST so ASIO can populate buffersizes and the control panel button
+ if (backend->use_separate_input_and_output_devices()) {
+ backend->set_input_device_name (device_name_in);
+ backend->set_output_device_name (device_name_out);
+ } else {
+ backend->set_device_name(device_name_in);
+ }
+
+ {
+ /* don't allow programmatic change to combos to cause a
+ recursive call to this method.
+ */
+ PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
+
+ set_samplerate_popdown_strings ();
+ set_buffersize_popdown_strings ();
+ set_nperiods_popdown_strings ();
+
+ /* TODO set min + max channel counts here */
+
+ manage_control_app_sensitivity ();
+ }
+
+ /* pick up any saved state for this device */
+
+ if (!ignore_changes) {
+ maybe_display_saved_state ();
+ }
+}
+
+void
+EngineControl::input_device_changed ()
+{
+ DEBUG_ECONTROL ("input_device_changed");
+
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ if (backend && backend->match_input_output_devices_or_none ()) {
+ const std::string& dev_none = ARDOUR::AudioBackend::get_standard_device_name (ARDOUR::AudioBackend::DeviceNone);
+
+ if (get_output_device_name () != dev_none
+ && get_input_device_name () != dev_none
+ && get_input_device_name () != get_output_device_name ()) {
+ block_changed_signals ();
+ if (contains_value (output_device_combo, get_input_device_name ())) {
+ output_device_combo.set_active_text (get_input_device_name ());
+ } else {
+ assert (contains_value (output_device_combo, dev_none));
+ output_device_combo.set_active_text (dev_none);
+ }
+ unblock_changed_signals ();
+ }
+ }
+ device_changed ();
+}
+
+void
+EngineControl::output_device_changed ()
+{
+ DEBUG_ECONTROL ("output_device_changed");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ if (backend && backend->match_input_output_devices_or_none ()) {
+ const std::string& dev_none = ARDOUR::AudioBackend::get_standard_device_name (ARDOUR::AudioBackend::DeviceNone);
+
+ if (get_input_device_name () != dev_none
+ && get_input_device_name () != dev_none
+ && get_input_device_name () != get_output_device_name ()) {
+ block_changed_signals ();
+ if (contains_value (input_device_combo, get_output_device_name ())) {
+ input_device_combo.set_active_text (get_output_device_name ());
+ } else {
+ assert (contains_value (input_device_combo, dev_none));
+ input_device_combo.set_active_text (dev_none);
+ }
+ unblock_changed_signals ();
+ }
+ }
+ device_changed ();
+}
+
+string
+EngineControl::bufsize_as_string (uint32_t sz)
+{
+ return string_compose (P_("%1 sample", "%1 samples", sz), to_string(sz));
+}
+
+void
+EngineControl::sample_rate_changed ()
+{
+ DEBUG_ECONTROL ("sample_rate_changed");
+ /* reset the strings for buffer size to show the correct msec value
+ (reflecting the new sample rate).
+ */
+
+ show_buffer_duration ();
+
+}
+
+void
+EngineControl::buffer_size_changed ()
+{
+ DEBUG_ECONTROL ("buffer_size_changed");
+ if (ARDOUR::AudioEngine::instance()->running()) {
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ if (backend && backend->can_change_buffer_size_when_running ()) {
+ backend->set_buffer_size (get_buffer_size());
+ }
+ }
+ show_buffer_duration ();
+}
+
+void
+EngineControl::nperiods_changed ()
+{
+ DEBUG_ECONTROL ("nperiods_changed");
+ show_buffer_duration ();
+}
+
+void
+EngineControl::show_buffer_duration ()
+{
+ DEBUG_ECONTROL ("show_buffer_duration");
+ /* buffer sizes - convert from just samples to samples + msecs for
+ * the displayed string
+ */
+
+ string bs_text = buffer_size_combo.get_active_text ();
+ uint32_t samples = atoi (bs_text); /* will ignore trailing text */
+ uint32_t rate = get_rate();
+
+ /* Except for ALSA and Dummy backends, we don't know the number of periods
+ * per cycle and settings.
+ *
+ * jack1 vs jack2 have different default latencies since jack2 start
+ * in async-mode unless --sync is given which adds an extra cycle
+ * of latency. The value is not known if jackd is started externally..
+ *
+ * So just display the period size, that's also what
+ * ARDOUR_UI::update_sample_rate() does for the status bar.
+ * (the statusbar calls AudioEngine::instance()->usecs_per_cycle()
+ * but still, that's the buffer period, not [round-trip] latency)
+ */
+ char buf[32];
+ snprintf (buf, sizeof (buf), _("(%.1f ms)"), (samples / (rate/1000.0f)));
+ buffer_size_duration_label.set_text (buf);
+}
+
+void
+EngineControl::midi_option_changed ()
+{
+ DEBUG_ECONTROL ("midi_option_changed");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ assert (backend);
+
+ backend->set_midi_option (get_midi_option());
+
+ vector<ARDOUR::AudioBackend::DeviceStatus> midi_devices = backend->enumerate_midi_devices();
+
+ //_midi_devices.clear(); // TODO merge with state-saved settings..
+ _can_set_midi_latencies = backend->can_set_systemic_midi_latencies();
+ std::vector<MidiDeviceSettings> new_devices;
+
+ for (vector<ARDOUR::AudioBackend::DeviceStatus>::const_iterator i = midi_devices.begin(); i != midi_devices.end(); ++i) {
+ MidiDeviceSettings mds = find_midi_device (i->name);
+ if (i->available && !mds) {
+ uint32_t input_latency = 0;
+ uint32_t output_latency = 0;
+ if (_can_set_midi_latencies) {
+ input_latency = backend->systemic_midi_input_latency (i->name);
+ output_latency = backend->systemic_midi_output_latency (i->name);
+ }
+ bool enabled = backend->midi_device_enabled (i->name);
+ MidiDeviceSettings ptr (new MidiDeviceSetting (i->name, enabled, input_latency, output_latency));
+ new_devices.push_back (ptr);
+ } else if (i->available) {
+ new_devices.push_back (mds);
+ }
+ }
+ _midi_devices = new_devices;
+
+ if (_midi_devices.empty()) {
+ midi_devices_button.hide ();
+ } else {
+ midi_devices_button.show ();
+ }
+}
+
+void
+EngineControl::parameter_changed ()
+{
+}
+
+EngineControl::State
+EngineControl::get_matching_state (const string& backend)
+{
+ for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
+ if ((*i)->backend == backend) {
+ return (*i);
+ }
+ }
+ return State();
+}
+
+EngineControl::State
+EngineControl::get_matching_state (
+ const string& backend,
+ const string& driver,
+ const string& device)
+{
+ for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
+ if ((*i)->backend == backend &&
+ (!_have_control || ((*i)->driver == driver && (*i)->device == device)))
+ {
+ return (*i);
+ }
+ }
+ return State();
+}
+
+EngineControl::State
+EngineControl::get_matching_state (
+ const string& backend,
+ const string& driver,
+ const string& input_device,
+ const string& output_device)
+{
+ for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
+ if ((*i)->backend == backend &&
+ (!_have_control || ((*i)->driver == driver && ((*i)->input_device == input_device) && (*i)->output_device == output_device)))
+ {
+ return (*i);
+ }
+ }
+ return State();
+}
+
+EngineControl::State
+EngineControl::get_saved_state_for_currently_displayed_backend_and_device ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+
+ if (backend) {
+ if (backend->use_separate_input_and_output_devices ()) {
+ return get_matching_state (backend_combo.get_active_text(),
+ (backend->requires_driver_selection() ? (std::string) driver_combo.get_active_text() : string()),
+ input_device_combo.get_active_text(),
+ output_device_combo.get_active_text());
+ } else {
+ return get_matching_state (backend_combo.get_active_text(),
+ (backend->requires_driver_selection() ? (std::string) driver_combo.get_active_text() : string()),
+ device_combo.get_active_text());
+ }
+ }
+
+ return get_matching_state (backend_combo.get_active_text(),
+ string(),
+ device_combo.get_active_text());
+}
+
+bool EngineControl::equivalent_states (const EngineControl::State& state1,
+ const EngineControl::State& state2)
+{
+ if (state1->backend == state2->backend &&
+ state1->driver == state2->driver &&
+ state1->device == state2->device &&
+ state1->input_device == state2->input_device &&
+ state1->output_device == state2->output_device) {
+ return true;
+ }
+ return false;
+}
+
+// sort active first, then most recently used to the beginning of the list
+bool
+EngineControl::state_sort_cmp (const State &a, const State &b) {
+ if (a->active) {
+ return true;
+ }
+ else if (b->active) {
+ return false;
+ }
+ else {
+ return a->lru > b->lru;
+ }
+}
+
+EngineControl::State
+EngineControl::save_state ()
+{
+ State state;
+
+ if (!_have_control) {
+ state = get_matching_state (backend_combo.get_active_text(), string(), string());
+ if (state) {
+ state->lru = time (NULL) ;
+ return state;
+ }
+ state.reset(new StateStruct);
+ state->backend = get_backend ();
+ } else {
+ state.reset(new StateStruct);
+ store_state (state);
+ }
+
+ for (StateList::iterator i = states.begin(); i != states.end();) {
+ if (equivalent_states (*i, state)) {
+ i = states.erase(i);
+ } else {
+ ++i;
+ }
+ }
+
+ states.push_back (state);
+
+ states.sort (state_sort_cmp);
+
+ return state;
+}
+
+void
+EngineControl::store_state (State state)
+{
+ state->backend = get_backend ();
+ state->driver = get_driver ();
+ state->device = get_device_name ();
+ state->input_device = get_input_device_name ();
+ state->output_device = get_output_device_name ();
+ state->sample_rate = get_rate ();
+ state->buffer_size = get_buffer_size ();
+ state->n_periods = get_nperiods ();
+ state->input_latency = get_input_latency ();
+ state->output_latency = get_output_latency ();
+ state->input_channels = get_input_channels ();
+ state->output_channels = get_output_channels ();
+ state->midi_option = get_midi_option ();
+ state->midi_devices = _midi_devices;
+ state->use_buffered_io = get_use_buffered_io ();
+ state->lru = time (NULL) ;
+}
+
+void
+EngineControl::maybe_display_saved_state ()
+{
+ if (!_have_control || ARDOUR::AudioEngine::instance()->running ()) {
+ return;
+ }
+
+ State state = get_saved_state_for_currently_displayed_backend_and_device ();
+
+ if (state) {
+ DEBUG_ECONTROL ("Restoring saved state");
+ PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
+
+ if (0 == _desired_sample_rate && sample_rate_combo.get_sensitive ()) {
+ sample_rate_combo.set_active_text (rate_as_string (state->sample_rate));
+ }
+ set_active_text_if_present (buffer_size_combo, bufsize_as_string (state->buffer_size));
+
+ set_active_text_if_present (nperiods_combo, to_string(state->n_periods));
+ /* call this explicitly because we're ignoring changes to
+ the controls at this point.
+ */
+ show_buffer_duration ();
+ input_latency.set_value (state->input_latency);
+ output_latency.set_value (state->output_latency);
+
+ use_buffered_io_button.set_active (state->use_buffered_io);
+
+ if (!state->midi_option.empty()) {
+ midi_option_combo.set_active_text (state->midi_option);
+ _midi_devices = state->midi_devices;
+ }
+ } else {
+ DEBUG_ECONTROL ("Unable to find saved state for backend and devices");
+ }
+}
+
+XMLNode&
+EngineControl::get_state ()
+{
+ LocaleGuard lg;
+
+ XMLNode* root = new XMLNode ("AudioMIDISetup");
+ std::string path;
+
+ if (!states.empty()) {
+ XMLNode* state_nodes = new XMLNode ("EngineStates");
+
+ for (StateList::const_iterator i = states.begin(); i != states.end(); ++i) {
+
+ XMLNode* node = new XMLNode ("State");
+
+ node->set_property ("backend", (*i)->backend);
+ node->set_property ("driver", (*i)->driver);
+ node->set_property ("device", (*i)->device);
+ node->set_property ("input-device", (*i)->input_device);
+ node->set_property ("output-device", (*i)->output_device);
+ node->set_property ("sample-rate", (*i)->sample_rate);
+ node->set_property ("buffer-size", (*i)->buffer_size);
+ node->set_property ("n-periods", (*i)->n_periods);
+ node->set_property ("input-latency", (*i)->input_latency);
+ node->set_property ("output-latency", (*i)->output_latency);
+ node->set_property ("input-channels", (*i)->input_channels);
+ node->set_property ("output-channels", (*i)->output_channels);
+ node->set_property ("active", (*i)->active);
+ node->set_property ("use-buffered-io", (*i)->use_buffered_io);
+ node->set_property ("midi-option", (*i)->midi_option);
+ int32_t lru_val = (*i)->active ? time (NULL) : (*i)->lru;
+ node->set_property ("lru", lru_val );
+
+ XMLNode* midi_devices = new XMLNode ("MIDIDevices");
+ for (std::vector<MidiDeviceSettings>::const_iterator p = (*i)->midi_devices.begin(); p != (*i)->midi_devices.end(); ++p) {
+ XMLNode* midi_device_stuff = new XMLNode ("MIDIDevice");
+ midi_device_stuff->set_property (X_("name"), (*p)->name);
+ midi_device_stuff->set_property (X_("enabled"), (*p)->enabled);
+ midi_device_stuff->set_property (X_("input-latency"), (*p)->input_latency);
+ midi_device_stuff->set_property (X_("output-latency"), (*p)->output_latency);
+ midi_devices->add_child_nocopy (*midi_device_stuff);
+ }
+ node->add_child_nocopy (*midi_devices);
+
+ state_nodes->add_child_nocopy (*node);
+ }
+
+ root->add_child_nocopy (*state_nodes);
+ }
+
+ return *root;
+}
+
+void
+EngineControl::set_default_state ()
+{
+ vector<string> backend_names;
+ vector<const ARDOUR::AudioBackendInfo*> backends = ARDOUR::AudioEngine::instance()->available_backends();
+
+ for (vector<const ARDOUR::AudioBackendInfo*>::const_iterator b = backends.begin(); b != backends.end(); ++b) {
+ backend_names.push_back ((*b)->name);
+ }
+ backend_combo.set_active_text (backend_names.front());
+
+ // We could set default backends per platform etc here
+
+ backend_changed ();
+}
+
+bool
+EngineControl::set_state (const XMLNode& root)
+{
+ XMLNodeList clist, cclist;
+ XMLNodeConstIterator citer, cciter;
+ XMLNode const * child;
+ XMLNode const * grandchild;
+
+ if (root.name() != "AudioMIDISetup") {
+ return false;
+ }
+
+ clist = root.children();
+
+ states.clear ();
+
+ for (citer = clist.begin(); citer != clist.end(); ++citer) {
+
+ child = *citer;
+
+ if (child->name() != "EngineStates") {
+ continue;
+ }
+
+ cclist = child->children();
+
+ for (cciter = cclist.begin(); cciter != cclist.end(); ++cciter) {
+ State state (new StateStruct);
+
+ grandchild = *cciter;
+
+ if (grandchild->name() != "State") {
+ continue;
+ }
+
+ if (!grandchild->get_property ("backend", state->backend)) {
+ continue;
+ }
+
+ // If any of the required properties are not found in the state node
+ // then continue/skip to the next engine state
+ if (!grandchild->get_property ("driver", state->driver) ||
+ !grandchild->get_property ("device", state->device) ||
+ !grandchild->get_property ("input-device", state->input_device) ||
+ !grandchild->get_property ("output-device", state->output_device) ||
+ !grandchild->get_property ("sample-rate", state->sample_rate) ||
+ !grandchild->get_property ("buffer-size", state->buffer_size) ||
+ !grandchild->get_property ("input-latency", state->input_latency) ||
+ !grandchild->get_property ("output-latency", state->output_latency) ||
+ !grandchild->get_property ("input-channels", state->input_channels) ||
+ !grandchild->get_property ("output-channels", state->output_channels) ||
+ !grandchild->get_property ("active", state->active) ||
+ !grandchild->get_property ("use-buffered-io", state->use_buffered_io) ||
+ !grandchild->get_property ("midi-option", state->midi_option)) {
+ continue;
+ }
+
+ if (!grandchild->get_property ("n-periods", state->n_periods)) {
+ // optional (new value in 4.5)
+ state->n_periods = 0;
+ }
+
+ state->midi_devices.clear();
+ XMLNode* midinode;
+ if ((midinode = ARDOUR::find_named_node (*grandchild, "MIDIDevices")) != 0) {
+ const XMLNodeList mnc = midinode->children();
+ for (XMLNodeList::const_iterator n = mnc.begin(); n != mnc.end(); ++n) {
+ std::string name;
+ bool enabled;
+ uint32_t input_latency;
+ uint32_t output_latency;
+
+ if (!(*n)->get_property (X_("name"), name) ||
+ !(*n)->get_property (X_("enabled"), enabled) ||
+ !(*n)->get_property (X_("input-latency"), input_latency) ||
+ !(*n)->get_property (X_("output-latency"), output_latency)) {
+ continue;
+ }
+
+ MidiDeviceSettings ptr (
+ new MidiDeviceSetting (name, enabled, input_latency, output_latency));
+ state->midi_devices.push_back (ptr);
+ }
+ }
+
+ int32_t lru_val;
+ if (grandchild->get_property ("lru", lru_val)) {
+ state->lru = lru_val;
+ }
+
+ states.push_back (state);
+ }
+ }
+
+ /* now see if there was an active state and switch the setup to it */
+
+ /* purge states of backend that are not available in this built */
+ vector<const ARDOUR::AudioBackendInfo*> backends = ARDOUR::AudioEngine::instance()->available_backends();
+ vector<std::string> backend_names;
+
+ for (vector<const ARDOUR::AudioBackendInfo*>::const_iterator i = backends.begin(); i != backends.end(); ++i) {
+ backend_names.push_back((*i)->name);
+ }
+ for (StateList::iterator i = states.begin(); i != states.end();) {
+ if (std::find(backend_names.begin(), backend_names.end(), (*i)->backend) == backend_names.end()) {
+ i = states.erase(i);
+ } else {
+ ++i;
+ }
+ }
+
+ states.sort (state_sort_cmp);
+
+ /* purge old states referring to the same backend */
+ const time_t now = time (NULL);
+ for (vector<std::string>::const_iterator bi = backend_names.begin(); bi != backend_names.end(); ++bi) {
+ bool first = true;
+ for (StateList::iterator i = states.begin(); i != states.end();) {
+ if ((*i)->backend != *bi) {
+ ++i; continue;
+ }
+ // keep at latest one for every audio-system
+ if (first) {
+ first = false;
+ ++i; continue;
+ }
+ // also keep states used in the last 90 days.
+ if ((now - (*i)->lru) < 86400 * 90) {
+ ++i; continue;
+ }
+ assert (!(*i)->active);
+ i = states.erase(i);
+ }
+ }
+
+ for (StateList::const_iterator i = states.begin(); i != states.end(); ++i) {
+
+ if ((*i)->active) {
+ return set_current_state (*i);
+ }
+ }
+ return false;
+}
+
+bool
+EngineControl::set_current_state (const State& state)
+{
+ DEBUG_ECONTROL ("set_current_state");
+
+ boost::shared_ptr<ARDOUR::AudioBackend> backend;
+
+ if (!(backend = ARDOUR::AudioEngine::instance ()->set_backend (
+ state->backend, downcase (std::string(PROGRAM_NAME)), ""))) {
+ DEBUG_ECONTROL (string_compose ("Unable to set backend to %1", state->backend));
+ // this shouldn't happen as the invalid backend names should have been
+ // removed from the list of states.
+ return false;
+ }
+
+ // now reflect the change in the backend in the GUI so backend_changed will
+ // do the right thing
+ backend_combo.set_active_text (state->backend);
+
+ if (!ARDOUR::AudioEngine::instance()->setup_required ()) {
+ backend_changed ();
+ // we don't have control don't restore state
+ return true;
+ }
+
+
+ if (!state->driver.empty ()) {
+ if (!backend->requires_driver_selection ()) {
+ DEBUG_ECONTROL ("Backend should require driver selection");
+ // A backend has changed from having driver selection to not having
+ // it or someone has been manually editing a config file and messed
+ // it up
+ return false;
+ }
+
+ if (backend->set_driver (state->driver) != 0) {
+ DEBUG_ECONTROL (string_compose ("Unable to set driver %1", state->driver));
+ // Driver names for a backend have changed and the name in the
+ // config file is now invalid or support for driver is no longer
+ // included in the backend
+ return false;
+ }
+ // no need to set the driver_combo as backend_changed will use
+ // backend->driver_name to set the active driver
+ }
+
+ if (!state->device.empty ()) {
+ if (backend->set_device_name (state->device) != 0) {
+ DEBUG_ECONTROL (
+ string_compose ("Unable to set device name %1", state->device));
+ // device is no longer available on the system
+ return false;
+ }
+ // no need to set active device as it will be picked up in
+ // via backend_changed ()/set_device_popdown_strings
+
+ } else {
+ // backend supports separate input/output devices
+ if (backend->set_input_device_name (state->input_device) != 0) {
+ DEBUG_ECONTROL (string_compose ("Unable to set input device name %1",
+ state->input_device));
+ // input device is no longer available on the system
+ return false;
+ }
+
+ if (backend->set_output_device_name (state->output_device) != 0) {
+ DEBUG_ECONTROL (string_compose ("Unable to set output device name %1",
+ state->input_device));
+ // output device is no longer available on the system
+ return false;
+ }
+ // no need to set active devices as it will be picked up in via
+ // backend_changed ()/set_*_device_popdown_strings
+ }
+
+ backend_changed ();
+
+ // Now restore the state of the rest of the controls
+
+ // We don't use a SignalBlocker as set_current_state is currently only
+ // called from set_state before any signals are connected. If at some point
+ // a more general named state mechanism is implemented and
+ // set_current_state is called while signals are connected then a
+ // SignalBlocker will need to be instantiated before setting these.
+
+ device_combo.set_active_text (state->device);
+ input_device_combo.set_active_text (state->input_device);
+ output_device_combo.set_active_text (state->output_device);
+ if (0 == _desired_sample_rate && sample_rate_combo.get_sensitive ()) {
+ sample_rate_combo.set_active_text (rate_as_string (state->sample_rate));
+ }
+ set_active_text_if_present (buffer_size_combo, bufsize_as_string (state->buffer_size));
+ set_active_text_if_present (nperiods_combo, to_string (state->n_periods));
+ input_latency.set_value (state->input_latency);
+ output_latency.set_value (state->output_latency);
+ midi_option_combo.set_active_text (state->midi_option);
+ use_buffered_io_button.set_active (state->use_buffered_io);
+ return true;
+}
+
+int
+EngineControl::push_state_to_backend (bool start)
+{
+ DEBUG_ECONTROL ("push_state_to_backend");
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ PBD::Unwinder<uint32_t> protect_ignore_device_changes (ignore_device_changes, ignore_device_changes + 1);
+
+ if (!backend) {
+ return 0;
+ }
+
+ /* figure out what is going to change */
+
+ bool restart_required = false;
+ bool was_running = ARDOUR::AudioEngine::instance()->running();
+ bool change_driver = false;
+ bool change_device = false;
+ bool change_rate = false;
+ bool change_bufsize = false;
+ bool change_nperiods = false;
+ bool change_latency = false;
+ bool change_channels = false;
+ bool change_midi = false;
+ bool change_buffered_io = false;
+
+ uint32_t ochan = get_output_channels ();
+ uint32_t ichan = get_input_channels ();
+
+ if (_have_control) {
+
+ if (started_at_least_once) {
+
+ /* we can control the backend */
+
+ if (backend->requires_driver_selection()) {
+ if (get_driver() != backend->driver_name()) {
+ change_driver = true;
+ }
+ }
+
+ if (backend->use_separate_input_and_output_devices()) {
+ if (get_input_device_name() != backend->input_device_name()) {
+ change_device = true;
+ }
+ if (get_output_device_name() != backend->output_device_name()) {
+ change_device = true;
+ }
+ } else {
+ if (get_device_name() != backend->device_name()) {
+ change_device = true;
+ }
+ }
+
+ if (queue_device_changed) {
+ change_device = true;
+ }
+
+ if (get_rate() != backend->sample_rate()) {
+ change_rate = true;
+ }
+
+ if (get_buffer_size() != backend->buffer_size()) {
+ change_bufsize = true;
+ }
+
+ if (backend->can_set_period_size() && get_popdown_string_count (nperiods_combo) > 0
+ && get_nperiods() != backend->period_size()) {
+ change_nperiods = true;
+ }
+
+ if (get_midi_option() != backend->midi_option()) {
+ change_midi = true;
+ }
+
+ if (backend->can_use_buffered_io()) {
+ if (get_use_buffered_io() != backend->get_use_buffered_io()) {
+ change_buffered_io = true;
+ }
+ }
+
+ /* zero-requested channels means "all available" */
+
+ if (ichan == 0) {
+ ichan = backend->input_channels();
+ }
+
+ if (ochan == 0) {
+ ochan = backend->output_channels();
+ }
+
+ if (ichan != backend->input_channels()) {
+ change_channels = true;
+ }
+
+ if (ochan != backend->output_channels()) {
+ change_channels = true;
+ }
+
+ if (get_input_latency() != backend->systemic_input_latency() ||
+ get_output_latency() != backend->systemic_output_latency()) {
+ change_latency = true;
+ }
+ } else {
+ /* backend never started, so we have to force a group
+ of settings.
+ */
+ change_device = true;
+ if (backend->requires_driver_selection()) {
+ change_driver = true;
+ }
+ change_rate = true;
+ change_bufsize = true;
+ change_channels = true;
+ change_latency = true;
+ change_midi = true;
+ change_buffered_io = backend->can_use_buffered_io();
+ change_channels = true;
+ change_nperiods = backend->can_set_period_size() && get_popdown_string_count (nperiods_combo) > 0;
+ }
+
+ } else {
+
+ /* we have no control over the backend, meaning that we can
+ * only possibly change sample rate and buffer size.
+ */
+
+
+ if (get_rate() != backend->sample_rate()) {
+ change_bufsize = true;
+ }
+
+ if (get_buffer_size() != backend->buffer_size()) {
+ change_bufsize = true;
+ }
+ }
+
+ queue_device_changed = false;
+
+ if (!_have_control) {
+
+ /* We do not have control over the backend, so the best we can
+ * do is try to change the sample rate and/or bufsize and get
+ * out of here.
+ */
+
+ if (change_rate && !backend->can_change_sample_rate_when_running()) {
+ return 1;
+ }
+
+ if (change_bufsize && !backend->can_change_buffer_size_when_running()) {
+ return 1;
+ }
+
+ if (change_rate) {
+ backend->set_sample_rate (get_rate());
+ }
+
+ if (change_bufsize) {
+ backend->set_buffer_size (get_buffer_size());
+ }
+
+ if (start) {
+ if (ARDOUR::AudioEngine::instance()->start ()) {
+ error << string_compose (_("Could not start backend engine %1"), backend->name()) << endmsg;
+ return -1;
+ }
+ }
+
+ post_push ();
+
+ return 0;
+ }
+
+ /* determine if we need to stop the backend before changing parameters */
+
+ if (change_driver || change_device || change_channels || change_nperiods ||
+ (change_latency && !backend->can_change_systemic_latency_when_running ()) ||
+ (change_rate && !backend->can_change_sample_rate_when_running()) ||
+ change_midi || change_buffered_io ||
+ (change_bufsize && !backend->can_change_buffer_size_when_running())) {
+ restart_required = true;
+ } else {
+ restart_required = false;
+ }
+
+
+ if (was_running) {
+ if (restart_required) {
+ if (ARDOUR::AudioEngine::instance()->stop()) {
+ return -1;
+ }
+ }
+ }
+
+ if (change_driver && backend->set_driver (get_driver())) {
+ error << string_compose (_("Cannot set driver to %1"), get_driver()) << endmsg;
+ return -1;
+ }
+ if (backend->use_separate_input_and_output_devices()) {
+ if (change_device && backend->set_input_device_name (get_input_device_name())) {
+ error << string_compose (_("Cannot set input device name to %1"), get_input_device_name()) << endmsg;
+ return -1;
+ }
+ if (change_device && backend->set_output_device_name (get_output_device_name())) {
+ error << string_compose (_("Cannot set output device name to %1"), get_output_device_name()) << endmsg;
+ return -1;
+ }
+ } else {
+ if (change_device && backend->set_device_name (get_device_name())) {
+ error << string_compose (_("Cannot set device name to %1"), get_device_name()) << endmsg;
+ return -1;
+ }
+ }
+ if (change_rate && backend->set_sample_rate (get_rate())) {
+ error << string_compose (_("Cannot set sample rate to %1"), get_rate()) << endmsg;
+ return -1;
+ }
+ if (change_bufsize && backend->set_buffer_size (get_buffer_size())) {
+ error << string_compose (_("Cannot set buffer size to %1"), get_buffer_size()) << endmsg;
+ return -1;
+ }
+ if (change_nperiods && backend->set_peridod_size (get_nperiods())) {
+ error << string_compose (_("Cannot set periods to %1"), get_nperiods()) << endmsg;
+ return -1;
+ }
+
+ if (change_channels || get_input_channels() == 0 || get_output_channels() == 0) {
+ if (backend->set_input_channels (get_input_channels())) {
+ error << string_compose (_("Cannot set input channels to %1"), get_input_channels()) << endmsg;
+ return -1;
+ }
+ if (backend->set_output_channels (get_output_channels())) {
+ error << string_compose (_("Cannot set output channels to %1"), get_output_channels()) << endmsg;
+ return -1;
+ }
+ }
+ if (change_latency) {
+ if (backend->set_systemic_input_latency (get_input_latency())) {
+ error << string_compose (_("Cannot set input latency to %1"), get_input_latency()) << endmsg;
+ return -1;
+ }
+ if (backend->set_systemic_output_latency (get_output_latency())) {
+ error << string_compose (_("Cannot set output latency to %1"), get_output_latency()) << endmsg;
+ return -1;
+ }
+ }
+
+ if (change_midi) {
+ backend->set_midi_option (get_midi_option());
+ }
+
+ if (change_buffered_io) {
+ backend->set_use_buffered_io (use_buffered_io_button.get_active());
+ }
+
+ if (1 /* TODO */) {
+ for (vector<MidiDeviceSettings>::const_iterator p = _midi_devices.begin(); p != _midi_devices.end(); ++p) {
+ if (_measure_midi) {
+ if (*p == _measure_midi) {
+ backend->set_midi_device_enabled ((*p)->name, true);
+ } else {
+ backend->set_midi_device_enabled ((*p)->name, false);
+ }
+ if (backend->can_change_systemic_latency_when_running ()) {
+ backend->set_systemic_midi_input_latency ((*p)->name, 0);
+ backend->set_systemic_midi_output_latency ((*p)->name, 0);
+ }
+ continue;
+ }
+ backend->set_midi_device_enabled ((*p)->name, (*p)->enabled);
+ if (backend->can_set_systemic_midi_latencies()) {
+ backend->set_systemic_midi_input_latency ((*p)->name, (*p)->input_latency);
+ backend->set_systemic_midi_output_latency ((*p)->name, (*p)->output_latency);
+ }
+ }
+ }
+
+ if (start || (was_running && restart_required)) {
+ if (ARDOUR::AudioEngine::instance()->start()) {
+ return -1;
+ }
+ }
+
+ post_push ();
+
+ return 0;
+}
+
+void
+EngineControl::post_push ()
+{
+ /* get a pointer to the current state object, creating one if
+ * necessary
+ */
+
+ State state = get_saved_state_for_currently_displayed_backend_and_device ();
+
+ if (!state) {
+ state = save_state ();
+ assert (state);
+ } else {
+ store_state(state);
+ }
+
+ states.sort (state_sort_cmp);
+
+ /* all off */
+
+ for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
+ (*i)->active = false;
+ }
+
+ /* mark this one active (to be used next time the dialog is
+ * shown)
+ */
+
+ state->active = true;
+
+ if (_have_control) { // XXX
+ manage_control_app_sensitivity ();
+ }
+
+ /* schedule a redisplay of MIDI ports */
+ //Glib::signal_timeout().connect (sigc::bind_return (sigc::mem_fun (*this, &EngineControl::refresh_midi_display), false), 1000);
+}
+
+
+float
+EngineControl::get_rate () const
+{
+ float r = atof (sample_rate_combo.get_active_text ());
+ /* the string may have been translated with an abbreviation for
+ * thousands, so use a crude heuristic to fix this.
+ */
+ if (r < 1000.0) {
+ r *= 1000.0;
+ }
+ return r;
+}
+
+
+uint32_t
+EngineControl::get_buffer_size () const
+{
+ string txt = buffer_size_combo.get_active_text ();
+ uint32_t samples;
+
+ if (sscanf (txt.c_str(), "%d", &samples) != 1) {
+ fprintf(stderr, "Find a trout and repeatedly slap the nearest C++ who throws exceptions without catching them.\n");
+ fprintf(stderr, "Ardour will likely crash now, giving you time to get the trout.\n");
+ throw exception ();
+ }
+
+ return samples;
+}
+
+uint32_t
+EngineControl::get_nperiods () const
+{
+ string txt = nperiods_combo.get_active_text ();
+ return atoi (txt.c_str());
+}
+
+string
+EngineControl::get_midi_option () const
+{
+ return midi_option_combo.get_active_text();
+}
+
+bool
+EngineControl::get_use_buffered_io () const
+{
+ return use_buffered_io_button.get_active();
+}
+
+uint32_t
+EngineControl::get_input_channels() const
+{
+ if (ARDOUR::Profile->get_mixbus()) {
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ if (!backend) return 0;
+ return backend->input_channels();
+ }
+ return (uint32_t) input_channels_adjustment.get_value();
+}
+
+uint32_t
+EngineControl::get_output_channels() const
+{
+ if (ARDOUR::Profile->get_mixbus()) {
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ if (!backend) return 0;
+ return backend->input_channels();
+ }
+ return (uint32_t) output_channels_adjustment.get_value();
+}
+
+uint32_t
+EngineControl::get_input_latency() const
+{
+ return (uint32_t) input_latency_adjustment.get_value();
+}
+
+uint32_t
+EngineControl::get_output_latency() const
+{
+ return (uint32_t) output_latency_adjustment.get_value();
+}
+
+string
+EngineControl::get_backend () const
+{
+ return backend_combo.get_active_text ();
+}
+
+string
+EngineControl::get_driver () const
+{
+ if (driver_combo.get_parent()) {
+ return driver_combo.get_active_text ();
+ } else {
+ return "";
+ }
+}
+
+string
+EngineControl::get_device_name () const
+{
+ return device_combo.get_active_text ();
+}
+
+string
+EngineControl::get_input_device_name () const
+{
+ return input_device_combo.get_active_text ();
+}
+
+string
+EngineControl::get_output_device_name () const
+{
+ return output_device_combo.get_active_text ();
+}
+
+void
+EngineControl::control_app_button_clicked ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+
+ if (!backend) {
+ return;
+ }
+
+ backend->launch_control_app ();
+}
+
+void
+EngineControl::start_stop_button_clicked ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+
+ if (!backend) {
+ return;
+ }
+
+ if (ARDOUR::AudioEngine::instance()->running()) {
+ ARDOUR::AudioEngine::instance()->stop ();
+ } else {
+ if (!ARDOUR_UI::instance()->session_loaded) {
+ pop_splash ();
+ hide ();
+ ARDOUR::GUIIdle ();
+ }
+ start_engine ();
+ if (!ARDOUR_UI::instance()->session_loaded) {
+ ArdourDialog::on_response (RESPONSE_OK);
+ }
+ }
+}
+
+void
+EngineControl::update_devices_button_clicked ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+
+ if (!backend) {
+ return;
+ }
+
+ if (backend->update_devices()) {
+ device_list_changed ();
+ }
+}
+
+void
+EngineControl::use_buffered_io_button_clicked ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+
+ if (!backend) {
+ return;
+ }
+
+ bool set_buffered_io = !use_buffered_io_button.get_active();
+ use_buffered_io_button.set_active (set_buffered_io);
+ backend->set_use_buffered_io (set_buffered_io);
+}
+
+void
+EngineControl::manage_control_app_sensitivity ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+
+ if (!backend) {
+ return;
+ }
+
+ string appname = backend->control_app_name();
+
+ if (appname.empty()) {
+ control_app_button.set_sensitive (false);
+ } else {
+ control_app_button.set_sensitive (true);
+ }
+}
+
+void
+EngineControl::set_desired_sample_rate (uint32_t sr)
+{
+ _desired_sample_rate = sr;
+ if (ARDOUR::AudioEngine::instance ()->running ()
+ && ARDOUR::AudioEngine::instance ()->sample_rate () != sr) {
+ stop_engine ();
+ }
+ device_changed ();
+}
+
+void
+EngineControl::on_switch_page (GtkNotebookPage*, guint page_num)
+{
+ if (page_num == 0) {
+ _measure_midi.reset();
+ update_sensitivity ();
+ }
+
+ if (page_num == midi_tab) {
+ /* MIDI tab */
+ refresh_midi_display ();
+ }
+
+ if (page_num == latency_tab) {
+ /* latency tab */
+
+ if (ARDOUR::AudioEngine::instance()->running()) {
+ stop_engine (true);
+ }
+
+ {
+ PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
+
+ /* save any existing latency values */
+
+ uint32_t il = (uint32_t) input_latency.get_value ();
+ uint32_t ol = (uint32_t) input_latency.get_value ();
+
+ /* reset to zero so that our new test instance
+ will be clean of any existing latency measures.
+
+ NB. this should really be done by the backend
+ when stated for latency measurement.
+ */
+
+ input_latency.set_value (0);
+ output_latency.set_value (0);
+
+ push_state_to_backend (false);
+
+ /* reset control */
+
+ input_latency.set_value (il);
+ output_latency.set_value (ol);
+
+ }
+ // This should be done in push_state_to_backend()
+ if (ARDOUR::AudioEngine::instance()->prepare_for_latency_measurement()) {
+ disable_latency_tab ();
+ }
+
+ enable_latency_tab ();
+
+ } else {
+ if (lm_running) {
+ end_latency_detection ();
+ ARDOUR::AudioEngine::instance()->stop_latency_detection();
+ }
+ }
+}
+
+/* latency measurement */
+
+bool
+EngineControl::check_audio_latency_measurement ()
+{
+ MTDM* mtdm = ARDOUR::AudioEngine::instance()->mtdm ();
+
+ if (mtdm->resolve () < 0) {
+ lm_results.set_markup (string_compose (results_markup, _("No signal detected ")));
+ return true;
+ }
+
+ if (mtdm->get_peak () > 0.707f) {
+ // get_peak() resets the peak-hold in the detector.
+ // this GUI callback is at 10Hz and so will be fine (test-signal is at higher freq)
+ lm_results.set_markup (string_compose (results_markup, _("Input signal is > -3dBFS. Lower the signal level (output gain, input gain) on the audio-interface.")));
+ return true;
+ }
+
+ if (mtdm->err () > 0.3) {
+ mtdm->invert ();
+ mtdm->resolve ();
+ }
+
+ char buf[256];
+ ARDOUR::samplecnt_t const sample_rate = ARDOUR::AudioEngine::instance()->sample_rate();
+
+ if (sample_rate == 0) {
+ lm_results.set_markup (string_compose (results_markup, _("Disconnected from audio engine")));
+ ARDOUR::AudioEngine::instance()->stop_latency_detection ();
+ return false;
+ }
+
+ int samples_total = mtdm->del();
+ int extra = samples_total - ARDOUR::AudioEngine::instance()->latency_signal_delay();
+
+ snprintf (buf, sizeof (buf), "%s%d samples (%.3lf ms)\n%s%d samples (%.3lf ms)",
+ _("Detected roundtrip latency: "),
+ samples_total, samples_total * 1000.0f/sample_rate,
+ _("Systemic latency: "),
+ extra, extra * 1000.0f/sample_rate);
+
+ bool solid = true;
+
+ if (mtdm->err () > 0.2) {
+ strcat (buf, " ");
+ strcat (buf, _("(signal detection error)"));
+ solid = false;
+ }
+
+ if (mtdm->inv ()) {
+ strcat (buf, " ");
+ strcat (buf, _("(inverted - bad wiring)"));
+ solid = false;
+ }
+
+ lm_results.set_markup (string_compose (results_markup, buf));
+
+ if (solid) {
+ have_lm_results = true;
+ end_latency_detection ();
+ lm_use_button.set_sensitive (true);
+ return false;
+ }
+
+ return true;
+}
+
+bool
+EngineControl::check_midi_latency_measurement ()
+{
+ ARDOUR::MIDIDM* mididm = ARDOUR::AudioEngine::instance()->mididm ();
+
+ if (!mididm->have_signal () || mididm->latency () == 0) {
+ lm_results.set_markup (string_compose (results_markup, _("No signal detected ")));
+ return true;
+ }
+
+ char buf[256];
+ ARDOUR::samplecnt_t const sample_rate = ARDOUR::AudioEngine::instance()->sample_rate();
+
+ if (sample_rate == 0) {
+ lm_results.set_markup (string_compose (results_markup, _("Disconnected from audio engine")));
+ ARDOUR::AudioEngine::instance()->stop_latency_detection ();
+ return false;
+ }
+
+ ARDOUR::samplecnt_t samples_total = mididm->latency();
+ ARDOUR::samplecnt_t extra = samples_total - ARDOUR::AudioEngine::instance()->latency_signal_delay();
+ snprintf (buf, sizeof (buf), "%s%" PRId64" samples (%.1lf ms) dev: %.2f[spl]\n%s%" PRId64" samples (%.1lf ms)",
+ _("Detected roundtrip latency: "),
+ samples_total, samples_total * 1000.0f / sample_rate, mididm->deviation (),
+ _("Systemic latency: "),
+ extra, extra * 1000.0f / sample_rate);
+
+ bool solid = true;
+
+ if (!mididm->ok ()) {
+ strcat (buf, " ");
+ strcat (buf, _("(averaging)"));
+ solid = false;
+ }
+
+ if (mididm->deviation () > 50.0) {
+ strcat (buf, " ");
+ strcat (buf, _("(too large jitter)"));
+ solid = false;
+ } else if (mididm->deviation () > 10.0) {
+ strcat (buf, " ");
+ strcat (buf, _("(large jitter)"));
+ }
+
+ if (solid) {
+ have_lm_results = true;
+ end_latency_detection ();
+ lm_use_button.set_sensitive (true);
+ lm_results.set_markup (string_compose (results_markup, buf));
+ return false;
+ } else if (mididm->processed () > 400) {
+ have_lm_results = false;
+ end_latency_detection ();
+ lm_results.set_markup (string_compose (results_markup, _("Timeout - large MIDI jitter.")));
+ return false;
+ }
+
+ lm_results.set_markup (string_compose (results_markup, buf));
+
+ return true;
+}
+
+void
+EngineControl::start_latency_detection ()
+{
+ ARDOUR::AudioEngine::instance()->set_latency_input_port (lm_input_channel_combo.get_active_text());
+ ARDOUR::AudioEngine::instance()->set_latency_output_port (lm_output_channel_combo.get_active_text());
+
+ if (ARDOUR::AudioEngine::instance()->start_latency_detection (_measure_midi ? true : false) == 0) {
+ lm_results.set_markup (string_compose (results_markup, _("Detecting ...")));
+ if (_measure_midi) {
+ latency_timeout = Glib::signal_timeout().connect (mem_fun (*this, &EngineControl::check_midi_latency_measurement), 100);
+ } else {
+ latency_timeout = Glib::signal_timeout().connect (mem_fun (*this, &EngineControl::check_audio_latency_measurement), 100);
+ }
+ lm_measure_label.set_text (_("Cancel"));
+ have_lm_results = false;
+ lm_use_button.set_sensitive (false);
+ lm_input_channel_combo.set_sensitive (false);
+ lm_output_channel_combo.set_sensitive (false);
+ lm_running = true;
+ }
+}
+
+void
+EngineControl::end_latency_detection ()
+{
+ latency_timeout.disconnect ();
+ ARDOUR::AudioEngine::instance()->stop_latency_detection ();
+ lm_measure_label.set_text (_("Measure"));
+ if (!have_lm_results) {
+ lm_use_button.set_sensitive (false);
+ }
+ lm_input_channel_combo.set_sensitive (true);
+ lm_output_channel_combo.set_sensitive (true);
+ lm_running = false;
+}
+
+void
+EngineControl::latency_button_clicked ()
+{
+ if (!lm_running) {
+ start_latency_detection ();
+ } else {
+ end_latency_detection ();
+ }
+}
+
+void
+EngineControl::latency_back_button_clicked ()
+{
+ ARDOUR::AudioEngine::instance()->stop_latency_detection ();
+ notebook.set_current_page(0);
+}
+
+void
+EngineControl::use_latency_button_clicked ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ if (_measure_midi) {
+ ARDOUR::MIDIDM* mididm = ARDOUR::AudioEngine::instance()->mididm ();
+ if (!mididm) {
+ return;
+ }
+ ARDOUR::samplecnt_t samples_total = mididm->latency();
+ ARDOUR::samplecnt_t extra = samples_total - ARDOUR::AudioEngine::instance()->latency_signal_delay();
+ uint32_t one_way = max ((ARDOUR::samplecnt_t) 0, extra / 2);
+ _measure_midi->input_latency = one_way;
+ _measure_midi->output_latency = one_way;
+ if (backend->can_change_systemic_latency_when_running ()) {
+ backend->set_systemic_midi_input_latency (_measure_midi->name, one_way);
+ backend->set_systemic_midi_output_latency (_measure_midi->name, one_way);
+ }
+ notebook.set_current_page (midi_tab);
+ } else {
+ MTDM* mtdm = ARDOUR::AudioEngine::instance()->mtdm ();
+
+ if (!mtdm) {
+ return;
+ }
+
+ double one_way = rint ((mtdm->del() - ARDOUR::AudioEngine::instance()->latency_signal_delay()) / 2.0);
+ one_way = std::max (0., one_way);
+
+ input_latency_adjustment.set_value (one_way);
+ output_latency_adjustment.set_value (one_way);
+ if (backend->can_change_systemic_latency_when_running ()) {
+ backend->set_systemic_input_latency (one_way);
+ backend->set_systemic_output_latency (one_way);
+ }
+
+ /* back to settings page */
+ notebook.set_current_page (0);
+ }
+}
+
+bool
+EngineControl::on_delete_event (GdkEventAny* ev)
+{
+ if (notebook.get_current_page() == 2) {
+ /* currently on latency tab - be sure to clean up */
+ end_latency_detection ();
+ }
+ return ArdourDialog::on_delete_event (ev);
+}
+
+void
+EngineControl::engine_running ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ assert (backend);
+
+ set_active_text_if_present (buffer_size_combo, bufsize_as_string (backend->buffer_size()));
+ sample_rate_combo.set_active_text (rate_as_string (backend->sample_rate()));
+
+ if (backend->can_set_period_size ()) {
+ set_active_text_if_present (nperiods_combo, to_string (backend->period_size()));
+ }
+
+ connect_disconnect_button.set_label (string_compose (_("Disconnect from %1"), backend->name()));
+ connect_disconnect_button.show();
+
+ started_at_least_once = true;
+ if (_have_control) {
+ engine_status.set_markup(string_compose ("<span foreground=\"green\">%1</span>", _("Running")));
+ } else {
+ engine_status.set_markup(string_compose ("<span foreground=\"green\">%1</span>", _("Connected")));
+ }
+ update_sensitivity();
+}
+
+void
+EngineControl::engine_stopped ()
+{
+ boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
+ assert (backend);
+
+ connect_disconnect_button.set_label (string_compose (_("Connect to %1"), backend->name()));
+ connect_disconnect_button.show();
+
+ if (_have_control) {
+ engine_status.set_markup(string_compose ("<span foreground=\"red\">%1</span>", _("Stopped")));
+ } else {
+ engine_status.set_markup(X_(""));
+ }
+
+ update_sensitivity();
+}
+
+void
+EngineControl::device_list_changed ()
+{
+ if (ignore_device_changes) {
+ return;
+ }
+ PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1); // ??
+ list_devices ();
+ midi_option_changed();
+}
+
+void
+EngineControl::connect_disconnect_click()
+{
+ if (ARDOUR::AudioEngine::instance()->running()) {
+ stop_engine ();
+ } else {
+ if (!ARDOUR_UI::instance()->session_loaded) {
+ pop_splash ();
+ hide ();
+ ARDOUR::GUIIdle ();
+ }
+ start_engine ();
+ if (!ARDOUR_UI::instance()->session_loaded) {
+ ArdourDialog::on_response (RESPONSE_OK);
+ }
+ }
+}
+
+void
+EngineControl::calibrate_audio_latency ()
+{
+ _measure_midi.reset ();
+ have_lm_results = false;
+ lm_use_button.set_sensitive (false);
+ lm_results.set_markup (string_compose (results_markup, _("No measurement results yet")));
+ notebook.set_current_page (latency_tab);
+}
+
+void
+EngineControl::calibrate_midi_latency (MidiDeviceSettings s)
+{
+ _measure_midi = s;
+ have_lm_results = false;
+ lm_use_button.set_sensitive (false);
+ lm_results.set_markup (string_compose (results_markup, _("No measurement results yet")));
+ notebook.set_current_page (latency_tab);
+}
+
+void
+EngineControl::configure_midi_devices ()
+{
+ notebook.set_current_page (midi_tab);
+}