tweak GUI for backends where nperiods is driver dependent.
[ardour.git] / gtk2_ardour / engine_dialog.cc
index f76008cc438aa3e76eb877d4aec843a8991159b1..ef19aa871446c282c6f8c38d892c0ecb4162009a 100644 (file)
@@ -186,7 +186,8 @@ EngineControl::EngineControl ()
        lm_measure_button.add (lm_measure_label);
        lm_measure_button.signal_clicked().connect (sigc::mem_fun (*this, &EngineControl::latency_button_clicked));
        lm_use_button.signal_clicked().connect (sigc::mem_fun (*this, &EngineControl::use_latency_button_clicked));
-       lm_back_button_signal = lm_back_button.signal_clicked().connect (sigc::bind (sigc::mem_fun (notebook, &Gtk::Notebook::set_current_page), 0));
+       lm_back_button_signal = lm_back_button.signal_clicked().connect(
+           sigc::mem_fun(*this, &EngineControl::latency_back_button_clicked));
 
        lm_use_button.set_sensitive (false);
 
@@ -320,6 +321,8 @@ EngineControl::connect_changed_signals ()
            sigc::mem_fun (*this, &EngineControl::sample_rate_changed));
        buffer_size_combo_connection = buffer_size_combo.signal_changed ().connect (
            sigc::mem_fun (*this, &EngineControl::buffer_size_changed));
+       nperiods_combo_connection = nperiods_combo.signal_changed ().connect (
+           sigc::mem_fun (*this, &EngineControl::nperiods_changed));
        device_combo_connection = device_combo.signal_changed ().connect (
            sigc::mem_fun (*this, &EngineControl::device_changed));
        midi_option_combo_connection = midi_option_combo.signal_changed ().connect (
@@ -349,6 +352,7 @@ EngineControl::block_changed_signals ()
                driver_combo_connection.block ();
                sample_rate_combo_connection.block ();
                buffer_size_combo_connection.block ();
+               nperiods_combo_connection.block ();
                device_combo_connection.block ();
                input_device_combo_connection.block ();
                output_device_combo_connection.block ();
@@ -369,6 +373,7 @@ EngineControl::unblock_changed_signals ()
                driver_combo_connection.unblock ();
                sample_rate_combo_connection.unblock ();
                buffer_size_combo_connection.unblock ();
+               nperiods_combo_connection.unblock ();
                device_combo_connection.unblock ();
                input_device_combo_connection.unblock ();
                output_device_combo_connection.unblock ();
@@ -419,6 +424,18 @@ EngineControl::start_engine ()
        return true;
 }
 
+bool
+EngineControl::stop_engine (bool for_latency)
+{
+       if (ARDOUR::AudioEngine::instance()->stop(for_latency)) {
+               MessageDialog msg(*this,
+                                 ARDOUR::AudioEngine::instance()->get_last_backend_error());
+               msg.run();
+               return false;
+       }
+       return true;
+}
+
 void
 EngineControl::on_response (int response_id)
 {
@@ -559,9 +576,18 @@ EngineControl::build_full_control_notebook ()
        buffer_size_duration_label.set_alignment (0.0); /* left-align */
        basic_packer.attach (buffer_size_duration_label, 2, 3, row, row+1, SHRINK, (AttachOptions) 0);
 
-       /* button spans 2 rows */
+       int ctrl_btn_span = 1;
+       if (backend->can_set_period_size ()) {
+               row++;
+               label = manage (left_aligned_label (_("Periods:")));
+               basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
+               basic_packer.attach (nperiods_combo, 1, 2, row, row + 1, xopt, (AttachOptions) 0);
+               ++ctrl_btn_span;
+       }
+
+       /* button spans 2 or 3 rows */
 
-       basic_packer.attach (control_app_button, 3, 4, row-1, row+1, xopt, xopt);
+       basic_packer.attach (control_app_button, 3, 4, row - ctrl_btn_span, row + 1, xopt, xopt);
        row++;
 
        input_channels.set_name ("InputChannels");
@@ -714,7 +740,8 @@ EngineControl::enable_latency_tab ()
                lm_back_button_signal = lm_back_button.signal_clicked().connect (sigc::bind (sigc::mem_fun (notebook, &Gtk::Notebook::set_current_page), midi_tab));
                lm_preamble.hide ();
        } else {
-               lm_back_button_signal = lm_back_button.signal_clicked().connect (sigc::bind (sigc::mem_fun (notebook, &Gtk::Notebook::set_current_page), 0));
+               lm_back_button_signal = lm_back_button.signal_clicked().connect(
+                   sigc::mem_fun(*this, &EngineControl::latency_back_button_clicked));
                lm_preamble.show ();
        }
 
@@ -817,6 +844,16 @@ EngineControl::update_sensitivity ()
                valid = false;
        }
 
+       if (get_popdown_string_count (nperiods_combo) > 0) {
+               if (!ARDOUR::AudioEngine::instance()->running()) {
+                       nperiods_combo.set_sensitive (true);
+               } else {
+                       nperiods_combo.set_sensitive (false);
+               }
+       } else {
+               nperiods_combo.set_sensitive (false);
+       }
+
        if (_have_control) {
                start_stop_button.set_sensitive(true);
                start_stop_button.show();
@@ -1002,6 +1039,20 @@ EngineControl::backend_changed ()
         */
        engine_stopped (); // set "active/inactive"
 
+       if (!_have_control) {
+               // set settings from backend that we do have control over
+               set_active_text_if_present (buffer_size_combo, bufsize_as_string (backend->buffer_size()));
+       }
+
+       if (_have_control && !ignore_changes) {
+               // set driver & devices
+               State state = get_matching_state (backend_combo.get_active_text());
+               if (state) {
+                       PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
+                       set_current_state (state);
+               }
+       }
+
        if (!ignore_changes) {
                maybe_display_saved_state ();
        }
@@ -1251,6 +1302,8 @@ EngineControl::driver_changed ()
        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 ();
        }
@@ -1412,6 +1465,31 @@ EngineControl::set_buffersize_popdown_strings ()
        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 (nperiods_as_string (*x));
+       }
+
+       set_popdown_strings (nperiods_combo, s);
+
+       if (!s.empty()) {
+               set_active_text_if_present (nperiods_combo, nperiods_as_string (backend->period_size())); // XXX 
+       }
+
+       update_sensitivity ();
+}
+
 void
 EngineControl::device_changed ()
 {
@@ -1460,6 +1538,7 @@ EngineControl::device_changed ()
 
                set_samplerate_popdown_strings ();
                set_buffersize_popdown_strings ();
+               set_nperiods_popdown_strings ();
 
                /* TODO set min + max channel counts here */
 
@@ -1498,6 +1577,15 @@ EngineControl::bufsize_as_string (uint32_t sz)
        return buf;
 }
 
+string
+EngineControl::nperiods_as_string (uint32_t np)
+{
+       char buf[8];
+       snprintf (buf, sizeof (buf), "%u", np);
+       return buf;
+}
+
+
 void
 EngineControl::sample_rate_changed ()
 {
@@ -1517,6 +1605,13 @@ EngineControl::buffer_size_changed ()
        show_buffer_duration ();
 }
 
+void
+EngineControl::nperiods_changed ()
+{
+       DEBUG_ECONTROL ("nperiods_changed");
+       show_buffer_duration ();
+}
+
 void
 EngineControl::show_buffer_duration ()
 {
@@ -1529,17 +1624,12 @@ EngineControl::show_buffer_duration ()
        uint32_t samples = atoi (bs_text); /* will ignore trailing text */
        uint32_t rate = get_rate();
 
-       /* Developers: note the hard-coding of a double buffered model
-          in the (2 * samples) computation of latency. we always start
-          the audiobackend in this configuration.
-        */
-       /* note to jack1 developers: ardour also always starts the engine
-        * in async mode (no jack2 --sync option) which adds an extra cycle
-        * of latency with jack2 (and *3 would be correct)
-        * The value can also be wrong if jackd is started externally..
+       /* Except for ALSA and Dummy backends, we don't know the number of periods
+        * per cycle and settings.
         *
-        * At the time of writing the ALSA backend always uses double-buffering *2,
-        * The Dummy backend *1, and who knows what ASIO really does :)
+        * 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.
@@ -1596,6 +1686,17 @@ 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,
@@ -1665,6 +1766,19 @@ bool EngineControl::equivalent_states (const EngineControl::State& state1,
        return false;
 }
 
+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 ()
 {
@@ -1673,6 +1787,7 @@ EngineControl::save_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);
@@ -1692,6 +1807,8 @@ EngineControl::save_state ()
 
        states.push_back (state);
 
+       states.sort (state_sort_cmp);
+
        return state;
 }
 
@@ -1705,12 +1822,14 @@ EngineControl::store_state (State state)
        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->lru = time (NULL) ;
 }
 
 void
@@ -1730,6 +1849,8 @@ EngineControl::maybe_display_saved_state ()
                        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, nperiods_as_string (state->n_periods));
                /* call this explicitly because we're ignoring changes to
                   the controls at this point.
                 */
@@ -1768,12 +1889,14 @@ EngineControl::get_state ()
                        node->add_property ("output-device", (*i)->output_device);
                        node->add_property ("sample-rate", (*i)->sample_rate);
                        node->add_property ("buffer-size", (*i)->buffer_size);
+                       node->add_property ("n-periods", (*i)->n_periods);
                        node->add_property ("input-latency", (*i)->input_latency);
                        node->add_property ("output-latency", (*i)->output_latency);
                        node->add_property ("input-channels", (*i)->input_channels);
                        node->add_property ("output-channels", (*i)->output_channels);
                        node->add_property ("active", (*i)->active ? "yes" : "no");
                        node->add_property ("midi-option", (*i)->midi_option);
+                       node->add_property ("lru", (*i)->active ? time (NULL) : (*i)->lru);
 
                        XMLNode* midi_devices = new XMLNode ("MIDIDevices");
                        for (std::vector<MidiDeviceSettings>::const_iterator p = (*i)->midi_devices.begin(); p != (*i)->midi_devices.end(); ++p) {
@@ -1884,6 +2007,13 @@ EngineControl::set_state (const XMLNode& root)
                        }
                        state->buffer_size = atoi (prop->value ());
 
+                       if ((prop = grandchild->property ("n-periods")) == 0) {
+                               // optional (new value in 4.5)
+                               state->n_periods = 0;
+                       } else {
+                               state->n_periods = atoi (prop->value ());
+                       }
+
                        if ((prop = grandchild->property ("input-latency")) == 0) {
                                continue;
                        }
@@ -1937,6 +2067,10 @@ EngineControl::set_state (const XMLNode& root)
                                }
                        }
 
+                       if ((prop = grandchild->property ("lru"))) {
+                               state->lru = atoi (prop->value ());
+                       }
+
 #if 1
                        /* remove accumulated duplicates (due to bug in ealier version)
                         * this can be removed again before release
@@ -1973,6 +2107,8 @@ EngineControl::set_state (const XMLNode& root)
                }
        }
 
+       states.sort (state_sort_cmp);
+
        for (StateList::const_iterator i = states.begin(); i != states.end(); ++i) {
 
                if ((*i)->active) {
@@ -2001,6 +2137,13 @@ EngineControl::set_current_state (const State& state)
        // 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");
@@ -2065,6 +2208,7 @@ EngineControl::set_current_state (const State& state)
        output_device_combo.set_active_text (state->output_device);
        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, nperiods_as_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);
@@ -2089,6 +2233,7 @@ EngineControl::push_state_to_backend (bool start)
        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;
@@ -2133,6 +2278,11 @@ EngineControl::push_state_to_backend (bool start)
                                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;
                        }
@@ -2172,6 +2322,7 @@ EngineControl::push_state_to_backend (bool start)
                        change_channels = true;
                        change_latency = true;
                        change_midi = true;
+                       change_nperiods = backend->can_set_period_size() && get_popdown_string_count (nperiods_combo) > 0;
                }
 
        } else {
@@ -2229,7 +2380,8 @@ EngineControl::push_state_to_backend (bool start)
 
        /* determine if we need to stop the backend before changing parameters */
 
-       if (change_driver || change_device || change_channels || change_latency ||
+       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_bufsize && !backend->can_change_buffer_size_when_running())) {
@@ -2238,35 +2390,15 @@ EngineControl::push_state_to_backend (bool start)
                restart_required = false;
        }
 
-       if (was_running) {
-
-               if (!change_driver && !change_device && !change_channels && !change_latency && !change_midi) {
-                       /* no changes in any parameters that absolutely require a
-                        * restart, so check those that might be changeable without a
-                        * restart
-                        */
-
-                       if (change_rate && !backend->can_change_sample_rate_when_running()) {
-                               /* can't do this while running ... */
-                               restart_required = true;
-                       }
-
-                       if (change_bufsize && !backend->can_change_buffer_size_when_running()) {
-                               /* can't do this while running ... */
-                               restart_required = true;
-                       }
-               }
-       }
 
        if (was_running) {
                if (restart_required) {
-                       if (ARDOUR_UI::instance()->disconnect_from_engine ()) {
+                       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;
@@ -2294,6 +2426,10 @@ EngineControl::push_state_to_backend (bool start)
                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())) {
@@ -2328,6 +2464,10 @@ EngineControl::push_state_to_backend (bool start)
                                } 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);
@@ -2365,6 +2505,8 @@ EngineControl::post_push ()
                store_state(state);
        }
 
+       states.sort (state_sort_cmp);
+
        /* all off */
 
        for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
@@ -2415,6 +2557,13 @@ EngineControl::get_buffer_size () const
        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
 {
@@ -2577,8 +2726,7 @@ EngineControl::on_switch_page (GtkNotebookPage*, guint page_num)
                /* latency tab */
 
                if (ARDOUR::AudioEngine::instance()->running()) {
-                       // TODO - mark as 'stopped for latency
-                       ARDOUR_UI::instance()->disconnect_from_engine ();
+                       stop_engine (true);
                }
 
                {
@@ -2791,6 +2939,13 @@ EngineControl::latency_button_clicked ()
        }
 }
 
+void
+EngineControl::latency_back_button_clicked ()
+{
+       ARDOUR::AudioEngine::instance()->stop(true);
+       notebook.set_current_page(0);
+}
+
 void
 EngineControl::use_latency_button_clicked ()
 {
@@ -2820,9 +2975,8 @@ EngineControl::use_latency_button_clicked ()
 
                /* back to settings page */
                notebook.set_current_page (0);
-}
        }
-
+}
 
 bool
 EngineControl::on_delete_event (GdkEventAny* ev)
@@ -2843,6 +2997,10 @@ EngineControl::engine_running ()
        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, nperiods_as_string (backend->period_size()));
+       }
+
        connect_disconnect_button.set_label (string_compose (_("Disconnect from %1"), backend->name()));
        connect_disconnect_button.show();
 
@@ -2885,9 +3043,9 @@ void
 EngineControl::connect_disconnect_click()
 {
        if (ARDOUR::AudioEngine::instance()->running()) {
-               ARDOUR_UI::instance()->disconnect_from_engine ();
+               stop_engine ();
        } else {
-               ARDOUR_UI::instance()->reconnect_to_engine ();
+               start_engine ();
        }
 }