diff options
Diffstat (limited to 'libs/ardour')
-rw-r--r-- | libs/ardour/ardour/engine_state_controller.h | 605 | ||||
-rw-r--r-- | libs/ardour/engine_state_controller.cc | 1766 |
2 files changed, 2371 insertions, 0 deletions
diff --git a/libs/ardour/ardour/engine_state_controller.h b/libs/ardour/ardour/engine_state_controller.h new file mode 100644 index 0000000000..5baaff480d --- /dev/null +++ b/libs/ardour/ardour/engine_state_controller.h @@ -0,0 +1,605 @@ +/* + Copyright (C) 2014 Waves Audio Ltd. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + + */ + +#ifndef __gtk2_ardour__engine_state_controller__ +#define __gtk2_ardour__engine_state_controller__ + +#include <vector> +#include <list> + +#include "ardour/types.h" +#include "ardour/audio_backend.h" + +namespace ARDOUR { + +class AudioBackendInfo; + +/** + * @class EngineStateController + * @brief EngineStateController class. + * + * Implements usecases for Audio devices and Audio/Midi ports. + * Persistantly saves to the config device configuration settings and audio/midi port states + */ +class EngineStateController +{ +public: + + // public data types: + + /** + * @struct PortState + * Structure which represents AudioPort state + */ + struct PortState { + std::string name; ///< Audio Port name + bool active; ///< Audio Port state + + PortState () + : name(""), + active(false) + { + } + + PortState (const std::string& name) + : name(name), + active(false) + { + } + + bool operator==(const PortState& rhs) {return rhs.name == name; } + + }; + + /// @typedef Type for the list of all available audio ports + typedef std::list<PortState> PortStateList; + + /** + * @struct MidiPortState + * Structure which represents MidiPort state. + */ + struct MidiPortState + { + std::string name; ///< Midi Port name + bool active; ///< Midi Port state + bool available; ///< Midi Port availability - if it is physicaly available or not + bool scene_connected; ///< Is midi port used for scene MIDI marker in/out + bool mtc_in; ///< Is midi port used as MTC in + + MidiPortState(const std::string& name): + name(name), + active(false), + available(false), + scene_connected(false), + mtc_in(false) + {} + + bool operator==(const MidiPortState& rhs) + { + return name == rhs.name; + } + }; + + /// @typedef Type for the list of MidiPorts ever registered in the system + typedef std::list<MidiPortState> MidiPortStateList; + + + //Interfaces + + /** Get an instance of EngineStateController singleton. + * @return EngineStateController instance pointer + */ + static EngineStateController* instance (); + + /** Associate session with EngineStateController instance. + */ + void set_session (Session* session); + + /** Remove link to the associated session. + */ + void remove_session (); + + ////////////////////////////////////////////////////////////////////////////////////////////////////////// + // General backend/device information methods + + /** Provides names of all available backends. + * + * @param[out] available_backends - vector of available backends + */ + void available_backends (std::vector<const AudioBackendInfo*>& available_backends); + + /** Provides the name of currently used backend. + * + * @return the name of currently used backend + */ + const std::string& get_current_backend_name() const; + + /** Provides the name of currently used device. + * + * @return the name of currently used device + */ + const std::string& get_current_device_name () const; + + /** Provides names for all available devices. + * + * @param[out] device_vector - vector of available devices + */ + void enumerate_devices (std::vector<ARDOUR::AudioBackend::DeviceStatus>& device_vector) const; + + /** Get sample rate used by current device. + * + * @return current sample rate + */ + ARDOUR::framecnt_t get_current_sample_rate () const; + + /** Get default sample rate for current backend. + * + * @return default sample rate for current backend + */ + ARDOUR::framecnt_t get_default_sample_rate () const; + + /** Get sample rates which are supported by current device and current backend. + * + * @param[out] sample_rates - vector of supported sample rates + */ + void available_sample_rates_for_current_device (std::vector<float>& sample_rates) const; + + /** Get buffer size used by current device. + * + * @return current buffer size + */ + ARDOUR::pframes_t get_current_buffer_size () const; + + /** Get default buffer size for current backend. + * + * @return default buffer size for current backend + */ + ARDOUR::pframes_t get_default_buffer_size () const; + + /** Get buffer sizes which are supported by current device and current backend. + * + * @param[out] buffer_sizes - vector of supported buffer_sizes + */ + void available_buffer_sizes_for_current_device (std::vector<ARDOUR::pframes_t>& buffer_sizes) const; + + ///////////////////////////////////////////////////////////////////////////////////////////////////////////////// + // device state control methods + + /** Get the number of all enabled Audio inputs. + * + * @return number of all enabled Audio inputs + */ + uint32_t get_available_inputs_count() const; + /** Get the number of all enabled Audio outputs. + * + * @return number of all enabled Audio outputs + */ + uint32_t get_available_outputs_count () const; + + /** Get vector of all enabled physical Audio input port names. + * + * @param[out] port_names - vector of all enabled Audio input names + */ + void get_physical_audio_inputs (std::vector<std::string>& port_names); + /** Get vector of all enabled physical Audio input port names. + * + * @param[out] port_names - vector of all enabled Audio input names + */ + void get_physical_audio_outputs (std::vector<std::string>& port_names); + + /** Get vector of all enabled physical MIDI input port names. + * + * @param[out] port_names - vector of all enabled MIDI input names + */ + void get_physical_midi_inputs (std::vector<std::string>& port_names); + /** Get vector of all enabled physical MIDI output port names. + * + * @param[out] port_names - vector of all enabled MIDI output names + */ + void get_physical_midi_outputs (std::vector<std::string>& port_names); + + /** Sets new state to all Audio inputs. + * + * @param[in] state - new state + */ + void set_state_to_all_inputs(bool state); + /** Sets new state to all Audio outputs. + * @note Does nothing in Stereo Out mode + * @param[in] state - new state + */ + void set_state_to_all_outputs(bool state); + + /** Get vector of states for all physical Audio input ports. + * + * @param[out] channel_states - vector of input port states + */ + void get_physical_audio_input_states(std::vector<PortState>& channel_states); + /** Get vector of states for all physical Audio output ports. + * + * @param[out] channel_states - vector of output port states + */ + void get_physical_audio_output_states(std::vector<PortState>& channel_states); + + /** Set state of the specified Audio input port. + * + * @param[in] port_name - input name + * @param[in] state - new state + */ + void set_physical_audio_input_state(const std::string& port_name, bool state); + /** Set state of the specified Audio output port. + * + * @param[in] port_name - output name + * @param[in] state - new state + */ + void set_physical_audio_output_state(const std::string& port_name, bool state); + + /** Get state of the specified Audio input port. + * + * @param[in] port_name - input name + * @return input state + */ + bool get_physical_audio_input_state(const std::string& port_name); + /** Get state of the specified Audi output port. + * + * @param[in] port_name - output name + * @return output state + */ + bool get_physical_audio_output_state(const std::string& port_name); + + /** Get vector of all enabled MIDI input port names. + * + * @param[out] channel_states - vector of enabled inputs + */ + void get_physical_midi_input_states (std::vector<MidiPortState>& channel_states); + /** Get vector of all enabled MIDI output port names. + * + * @param[out] channel_states - vector of enabled outputs + */ + void get_physical_midi_output_states (std::vector<MidiPortState>& channel_states); + + /** Set state of the specified MIDI input port. + * + * @param[in] port_name - input name + * @param[in] state - new state + */ + void set_physical_midi_input_state(const std::string& port_name, bool state); + /** Set state of the specified MIDI output port. + * + * @param[in] port_name - output name + * @param[in] state - new state + */ + void set_physical_midi_output_state(const std::string& port_name, bool state); + /** Get state of the specified MIDI input port. + * + * @param[in] port_name - input name + * @param[out] scene_connected - is port used as Scene In or not + * @return input state + */ + bool get_physical_midi_input_state(const std::string& port_name, bool& scene_connected); + /** Get state of the specified MIDI output port. + * + * @param[in] port_name - output name + * @param[out] scene_connected - is port used as Scene Out or not + * @return output state + */ + bool get_physical_midi_output_state(const std::string& port_name, bool& scene_connected); + + /** Set state of Scene In connection for the specified MIDI input port. + * + * @param[in] port_name - input name + * @param[in] state - new state + */ + void set_physical_midi_scene_in_connection_state(const std::string& port_name, bool state); + /** Set state of Scene Out connection for the specified MIDI output port. + * + * @param[in] port_name - input name + * @param[in] state - new state + */ + void set_physical_midi_scenen_out_connection_state(const std::string&, bool); + + /** Disocnnect all MIDI input ports from Scene In. + */ + void set_all_midi_scene_inputs_disconnected(); + /** Disocnnect all MIDI output ports from Scene Out. + */ + void set_all_midi_scene_outputs_disconnected(); + + /** Set MIDI TimeCode input port + * @note There is a sense to choose MIDI TimeCode input only because + * our MIDI TimeCode is propagated to all midi output ports. + */ + void set_mtc_input(const std::string&); + + /** Check if AudioEngine setup is required + * @return true if setup is required, otherwise - false + */ + bool is_setup_required() const {return ARDOUR::AudioEngine::instance()->setup_required (); } + + //////////////////////////////////////////////////////////////////////////////////////////////////// + // Methods set parameters inside the controller + // the state of engine won't change untill we make a "push" of this state to the backend + // NOTE: Use push_state_to_backend() method to update backend with the most recent controller state + + /** Set new sample rate for current device in EngineStateController database + * @note Use push_state_to_backend() method to update backend/device state with the most recent controller state + * @param sample_rate - new sample rate + */ + bool set_new_sample_rate_in_controller(framecnt_t sample_rate); + /** Set new buffer size for current device in EngineStateController database + * @note Use push_state_to_backend() method to update backend/device state with the most recent controller state + * @param buffer_size - new buffer size + */ + bool set_new_buffer_size_in_controller(pframes_t buffer_size); + + /** @brief push current controller state to backend. + * Propagate and set all current EngineStateController parameters to the backend + * @note Engine will be restarted if it's running when this method is called. + * @note If an attempt ot set parameters is unsuccessful current device will be switched to "None". + * @param start - start the Engine if it was not running when this function was called. + * @return true on success, otherwise - false + */ + bool push_current_state_to_backend(bool start); + /** Switch to new backend + * @note The change will be propagated emmidiatelly as if push_current_state_to_backend () was called. + * @param backend_name - new backend name. + * @return true on success, otherwise - false + */ + bool set_new_backend_as_current(const std::string& backend_name); + /** Switch to new device + * @note The change will be propagated emmidiatelly as if push_current_state_to_backend () was called. + * @param device_name - new device name. + * @return true on success, otherwise - false + */ + bool set_new_device_as_current(const std::string& device_name); + + + //////////////////////////////////////////////////////////////////////////////////////////////////// + // Methods to save/serialize setting states + + /** Serialize Audio/Midi settings (entire EngineStateController database) to XML + * @return XML note with serialized states + */ + XMLNode& serialize_audio_midi_settings(); + /** Save Audio/Midi settings (entire EngineStateController database) to config persistently + */ + void save_audio_midi_settings(); + + //////////////////////////////////////////////////////////////////////////////////////////////////// + //UPDATE SIGNALS + /** This signal is emitted if the sample rate changes */ + PBD::Signal0<void> SampleRateChanged; + /** This signal is emitted if the buffer size changes */ + PBD::Signal0<void> BufferSizeChanged; + /** This signal is emitted if the device list changes */ + PBD::Signal1<void, bool> DeviceListChanged; + /** This signal is emitted if the device cannot operate properly */ + PBD::Signal0<void> DeviceError; + + //////////////////////////////////////////////////////////////////////////////////////////////////// + //ENGINE STATE SIGNALS + /** This signal is emitted when the engine is started */ + PBD::Signal0<void> EngineRunning; + /** This signal is emitted when the engine is stopped */ + PBD::Signal0<void> EngineStopped; + /** This signal is emitted if Engine processing is terminated */ + PBD::Signal0<void> EngineHalted; + + /** This signal is emitted if the AUDIO input channel configuration changes */ + PBD::Signal0<void> InputConfigChanged; + /** This signal is emitted if the AUDIO output channel configuration changes */ + PBD::Signal0<void> OutputConfigChanged; + /** This signal is emitted if the AUDIO output connection mode changes + * @note By output connection mode "Stereo Out" or "Multi Out" is meant + */ + PBD::Signal0<void> OutputConnectionModeChanged; + + /** This signals is emitted if the MIDI input channel configuration changes */ + PBD::Signal0<void> MIDIInputConfigChanged; + /** This signals is emitted if the MIDI output channel configuration changes */ + PBD::Signal0<void> MIDIOutputConfigChanged; + /** This signals is emitted if the MIDI Scene In connection changes */ + PBD::Signal2<void, const std::vector<std::string>&, bool> MIDISceneInputConnectionChanged; + /** This signals is emitted if the MIDI Scene Out connection changes */ + PBD::Signal2<void, const std::vector<std::string>&, bool> MIDISceneOutputConnectionChanged; + + /** This signal is emitted if the MTC Input channel is changed */ + PBD::Signal1<void, const std::string&> MTCInputChanged; + + /** This signal is emitted if new Audio/MIDI ports are registered or unregistered */ + PBD::Signal0<void> PortRegistrationChanged; + +private: + + EngineStateController(); /// singleton + ~EngineStateController(); /// singleton + EngineStateController(const EngineStateController& ); /// prohibited + EngineStateController& operator=(const EngineStateController&); /// prohibited + + //////////////////////////////////////////////////////////////////////////////////////////// + // private data structures + + /** @struct Engine state + * @brief State structure. + * Contains information about single device/backend state + */ + struct State { + std::string backend_name; ///< state backend name + std::string device_name; ///< state device name + ARDOUR::framecnt_t sample_rate; ///< sample rate used by the device in this state + ARDOUR::pframes_t buffer_size; ///< buffer size used by the device in this state + + PortStateList input_channel_states; ///< states of device Audio inputs + PortStateList multi_out_channel_states; ///< states of device Audio inputs in Multi Out mode + PortStateList stereo_out_channel_states; ///< states of device Audio inputs in Stereo Out mode + bool active; ///< was this state the most recent active one + + State() + : sample_rate(0) + , buffer_size(0) + , input_channel_states (0) + , multi_out_channel_states (0) + , stereo_out_channel_states (0) + , active (false) + { + } + + bool operator==(const State& rhs) + { + return (backend_name == rhs.backend_name) && (device_name == rhs.device_name); + } + + /** Forms string name for the state + * @return name string + */ + std::string form_state_name() { + return std::string("State:" + backend_name + ":" + device_name); + } + + /** @struct StatepPredicate + * This predicate is used to identify a state during search in the list of states + */ + struct StatePredicate + { + StatePredicate(const std::string& backend_name, const std::string& device_name) + : _backend_name (backend_name) + , _device_name (device_name) + {} + + bool operator()(boost::shared_ptr<ARDOUR::EngineStateController::State> rhs) + { + return (_backend_name == rhs->backend_name) && (_device_name == rhs->device_name); + } + + private: + std::string _backend_name; + std::string _device_name; + }; + }; + + /// @typedef Type for the state pointer + typedef boost::shared_ptr<State> StatePtr; + /// @typedef Type for the list of states + typedef std::list<StatePtr> StateList; + + //////////////////////////////////////////////////////////////////////////////////////////////////// + // methods to manage setting states + + /** Deserializes and loads Engine and Audio port states from the config to EngineStateController + */ + void _deserialize_and_load_engine_states(); + /** Deserializes and loads MIDI port states from the config to EngineStateController + */ + void _deserialize_and_load_midi_port_states(); + /** Serializes Engine and Audio port states from EngineStateController to XML node + * @param[in,out] audio_midi_settings_node - node to serialize the satets to + */ + void _serialize_engine_states(XMLNode* audio_midi_settings_node); + /** Serializes MIDI port states from EngineStateController to XML node + * @param[in,out] audio_midi_settings_node - node to serialize the satets to + */ + void _serialize_midi_port_states(XMLNode* audio_midi_settings_node); + + /** Provides initial state configuration. + * It loades the last active state if there is one and it is aplicable. + * Otherwise default state (None device with default sample rate and buffer size) is loaded. + */ + void _do_initial_engine_setup(); + + /** Loades provided state. + * @note It's possible that provided state can't be loaded + * (device disconnected or reqested parameters are not supported anymore). + * @param state - state to apply + * @return true on success, otherwise - false + */ + bool _apply_state(const StatePtr& state); + + /** Gets available device channels from engine and updates internal controller state + */ + void _update_device_channels_state(); + + /** Check "Stereo Out" mode channels state configuration and make it correspond Stereo Out mode requirements + */ + void _refresh_stereo_out_channel_states(); + + //////////////////////////////////////////////////////////////////////////////////////////////////////////// + // internal helper functions + /** make sure that current device parameters are supported and fit session requirements + * @return true if current state is valid and all parameters are supported, otherwise - false + */ + bool _validate_current_device_state(); + //////////////////////////////////////////////////////////////////////////////////////////////////////////// + + //////////////////////////////////////// + // callbacks + /** Invoked when Engine starts running + */ + void _on_engine_running(); + /** Invoked when Engine is halted + */ + void _on_engine_halted(); + /** Invoked when Engine processing is terminated + */ + void _on_engine_stopped(); + /** Invoked when Device error accured, it failed to start or didn't accept the change which should + */ + void _on_device_error(); + /** Invoked when current device changes sample rate + */ + void _on_sample_rate_change(ARDOUR::framecnt_t); + /** Invoked when current device changes buffer size + */ + void _on_buffer_size_change(ARDOUR::pframes_t); + /** Invoked when the list of available devices is changed + */ + void _on_device_list_change(); + /** Invoked when the config parameter is changed + */ + void _on_parameter_changed (const std::string&); + /** Invoked when Audio/MIDI ports are registered or unregistered + */ + void _on_ports_registration_update (); + /** Invoked when session loading process is complete + */ + void _on_session_loaded(); + //////////////////////////////////////// + + //////////////////////////////////////// + // attributes + StatePtr _current_state; ///< current state pointer + // list of system states + StateList _states; ///< list of all available states + + MidiPortStateList _midi_inputs; ///< midi input states + MidiPortStateList _midi_outputs; ///< midi output states + + std::string _last_used_real_device; ///< last active non-default (real) device + + Session* _session; ///< current session + + // Engine connections stuff + PBD::ScopedConnectionList update_connections; ///< connection container for update signals + PBD::ScopedConnectionList session_connections; ///< connection container for session signals + PBD::ScopedConnection running_connection; ///< connection container for EngineRunning signal + PBD::ScopedConnection halt_connection; ///< connection container for EngineHalted signal + PBD::ScopedConnection stopped_connection; ///< connection container for EngineStopped signal +}; + +} // namespace ARDOUR + +#endif /* defined(__gtk2_ardour__engine_state_controller__) */ diff --git a/libs/ardour/engine_state_controller.cc b/libs/ardour/engine_state_controller.cc new file mode 100644 index 0000000000..fa9fefd67c --- /dev/null +++ b/libs/ardour/engine_state_controller.cc @@ -0,0 +1,1766 @@ +/* + Copyright (C) 2014 Waves Audio Ltd. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + + */ + +#include "ardour/engine_state_controller.h" + +#include "ardour/audioengine.h" +#include "ardour/session.h" +#include "ardour/rc_configuration.h" +#include "ardour/data_type.h" + +#include "pbd/pthread_utils.h" +#include "pbd/error.h" +#include "i18n.h" + + +using namespace ARDOUR; +using namespace PBD; + +namespace { + + struct DevicePredicate + { + DevicePredicate(const std::string& device_name) + : _device_name(device_name) + {} + + bool operator()(const AudioBackend::DeviceStatus& rhs) + { + return _device_name == rhs.name; + } + + private: + std::string _device_name; + }; +} + +EngineStateController* +EngineStateController::instance() +{ + static EngineStateController instance; + return &instance; +} + + +EngineStateController::EngineStateController() +: _current_state() +, _last_used_real_device("") + +{ + AudioEngine::instance ()->Running.connect_same_thread (running_connection, boost::bind (&EngineStateController::_on_engine_running, this) ); + AudioEngine::instance ()->Stopped.connect_same_thread (stopped_connection, boost::bind (&EngineStateController::_on_engine_stopped, this) ); + AudioEngine::instance ()->Halted.connect_same_thread (stopped_connection, boost::bind (&EngineStateController::_on_engine_stopped, this) ); + + /* Subscribe for udpates from AudioEngine */ + AudioEngine::instance ()->PortRegisteredOrUnregistered.connect_same_thread (update_connections, boost::bind (&EngineStateController::_on_ports_registration_update, this) ); + AudioEngine::instance()->SampleRateChanged.connect_same_thread (update_connections, boost::bind (&EngineStateController::_on_sample_rate_change, this, _1) ); + AudioEngine::instance()->BufferSizeChanged.connect_same_thread (update_connections, boost::bind (&EngineStateController::_on_buffer_size_change, this, _1) ); + AudioEngine::instance()->DeviceListChanged.connect_same_thread (update_connections, boost::bind (&EngineStateController::_on_device_list_change, this) ); + AudioEngine::instance()->DeviceError.connect_same_thread (update_connections, boost::bind (&EngineStateController::_on_device_error, this) ); + + /* Global configuration parameters update */ + Config->ParameterChanged.connect_same_thread (update_connections, boost::bind (&EngineStateController::_on_parameter_changed, this, _1) ); + + _deserialize_and_load_engine_states(); + _deserialize_and_load_midi_port_states(); + _do_initial_engine_setup(); + + // now push the sate to the backend + push_current_state_to_backend(false); +} + + +EngineStateController::~EngineStateController() +{ +} + + +void +EngineStateController::set_session(Session* session) +{ + _session = session; + _session->SessionLoaded.connect_same_thread (session_connections, boost::bind (&EngineStateController::_on_session_loaded, this) ); +} + + +void +EngineStateController::remove_session () +{ + session_connections.drop_connections (); + _session = 0; +} + + +XMLNode& +EngineStateController::serialize_audio_midi_settings() +{ + + XMLNode* root = new XMLNode ("AudioMidiSettings"); + + _serialize_engine_states(root); + _serialize_midi_port_states(root); + + return *root; +} + + +void +EngineStateController::save_audio_midi_settings() +{ + Config->add_extra_xml (serialize_audio_midi_settings() ); + Config->save_state (); +} + + +void +EngineStateController::_deserialize_and_load_engine_states() +{ + XMLNode* audio_midi_settings_root = ARDOUR::Config->extra_xml ("AudioMidiSettings"); + + if (!audio_midi_settings_root) { + return; + } + + XMLNode* engine_states = audio_midi_settings_root->child("EngineStates"); + + if (!engine_states) { + return; + } + + XMLNodeList state_nodes_list = engine_states->children(); + XMLNodeConstIterator state_node_iter = state_nodes_list.begin(); + + for (; state_node_iter != state_nodes_list.end(); ++state_node_iter) { + + XMLNode* state_node = *state_node_iter; + StatePtr engine_state(new State); + XMLProperty* prop = NULL; + + if ((prop = state_node->property ("backend-name")) == 0) { + continue; + } + engine_state->backend_name = prop->value (); + + if ((prop = state_node->property ("device-name")) == 0) { + continue; + } + engine_state->device_name = prop->value (); + + if ((prop = state_node->property ("sample-rate")) == 0) { + continue; + } + engine_state->sample_rate = atoi (prop->value ()); + + if ((prop = state_node->property ("buffer-size")) == 0) { + continue; + } + engine_state->buffer_size = atoi (prop->value ()); + + if ((prop = state_node->property ("active")) == 0) { + continue; + } + engine_state->active = string_is_affirmative (prop->value ()); + + XMLNodeList state_children_list = state_node->children(); + XMLNodeConstIterator state_child_iter = state_children_list.begin(); + + for (; state_child_iter != state_children_list.end(); ++state_child_iter) { + XMLNode* state_child = *state_child_iter; + + if (state_child->name() == "InputConfiguration") { + + XMLNodeList input_states_nodes = state_child->children(); + XMLNodeConstIterator input_state_node_iter = input_states_nodes.begin(); + PortStateList& input_states = engine_state->input_channel_states; + + for (; input_state_node_iter != input_states_nodes.end(); ++input_state_node_iter) { + + XMLNode* input_state_node = *input_state_node_iter; + + if (input_state_node->name() != "input") { + continue; + } + PortState input_state (input_state_node->name() ); + + if ((prop = input_state_node->property ("name")) == 0) { + continue; + } + input_state.name = prop->value(); + + if ((prop = input_state_node->property ("active")) == 0) { + continue; + } + input_state.active = string_is_affirmative (prop->value ()); + + input_states.push_back(input_state); + } + + } else if (state_child->name() == "MultiOutConfiguration") { + + XMLNodeList multi_out_state_nodes = state_child->children(); + XMLNodeConstIterator multi_out_state_node_iter = multi_out_state_nodes.begin(); + PortStateList& multi_out_states = engine_state->multi_out_channel_states; + + for (; multi_out_state_node_iter != multi_out_state_nodes.end(); ++multi_out_state_node_iter) { + + XMLNode* multi_out_state_node = *multi_out_state_node_iter; + + if (multi_out_state_node->name() != "output") { + continue; + } + PortState multi_out_state (multi_out_state_node->name() ); + + if ((prop = multi_out_state_node->property ("name")) == 0) { + continue; + } + multi_out_state.name = prop->value(); + + if ((prop = multi_out_state_node->property ("active")) == 0) { + continue; + } + multi_out_state.active = string_is_affirmative (prop->value ()); + + multi_out_states.push_back(multi_out_state); + } + } else if (state_child->name() == "StereoOutConfiguration") { + + XMLNodeList stereo_out_state_nodes = state_child->children(); + XMLNodeConstIterator stereo_out_state_node_iter = stereo_out_state_nodes.begin(); + PortStateList& stereo_out_states = engine_state->stereo_out_channel_states; + + for (; stereo_out_state_node_iter != stereo_out_state_nodes.end(); ++stereo_out_state_node_iter) { + + XMLNode* stereo_out_state_node = *stereo_out_state_node_iter; + + if (stereo_out_state_node->name() != "output") { + continue; + } + PortState stereo_out_state (stereo_out_state_node->name() ); + + if ((prop = stereo_out_state_node->property ("name")) == 0) { + continue; + } + stereo_out_state.name = prop->value(); + + if ((prop = stereo_out_state_node->property ("active")) == 0) { + continue; + } + stereo_out_state.active = string_is_affirmative (prop->value ()); + + stereo_out_states.push_back(stereo_out_state); + } + } + } + + _states.push_back (engine_state); + } +} + + +void +EngineStateController::_deserialize_and_load_midi_port_states() +{ + XMLNode* audio_midi_settings_root = ARDOUR::Config->extra_xml ("AudioMidiSettings"); + + if (!audio_midi_settings_root) { + return; + } + + XMLNode* midi_states = audio_midi_settings_root->child("MidiStates"); + + if (!midi_states) { + return; + } + + XMLNodeList state_nodes_list = midi_states->children(); + XMLNodeConstIterator state_node_iter = state_nodes_list.begin(); + for (; state_node_iter != state_nodes_list.end(); ++state_node_iter) { + + XMLNode* state_node = *state_node_iter; + if (state_node->name() == "MidiInputs") { + + XMLNodeList input_state_nodes = state_node->children(); + XMLNodeConstIterator input_state_node_iter = input_state_nodes.begin(); + _midi_inputs.clear(); + + for (; input_state_node_iter != input_state_nodes.end(); ++input_state_node_iter) { + + XMLNode* input_state_node = *input_state_node_iter; + XMLProperty* prop = NULL; + + if (input_state_node->name() != "input") { + continue; + } + MidiPortState input_state (input_state_node->name() ); + + if ((prop = input_state_node->property ("name")) == 0) { + continue; + } + input_state.name = prop->value(); + + if ((prop = input_state_node->property ("active")) == 0) { + continue; + } + input_state.active = string_is_affirmative (prop->value ()); + + if ((prop = input_state_node->property ("scene-connected")) == 0) { + continue; + } + input_state.scene_connected = string_is_affirmative (prop->value ()); + + if ((prop = input_state_node->property ("mtc-in")) == 0) { + continue; + } + input_state.mtc_in = string_is_affirmative (prop->value ()); + + _midi_inputs.push_back(input_state); + } + + } else if (state_node->name() == "MidiOutputs") { + + XMLNodeList output_state_nodes = state_node->children(); + XMLNodeConstIterator output_state_node_iter = output_state_nodes.begin(); + _midi_outputs.clear(); + + for (; output_state_node_iter != output_state_nodes.end(); ++output_state_node_iter) { + + XMLNode* output_state_node = *output_state_node_iter; + XMLProperty* prop = NULL; + + if (output_state_node->name() != "output") { + continue; + } + MidiPortState output_state (output_state_node->name() ); + + if ((prop = output_state_node->property ("name")) == 0) { + continue; + } + output_state.name = prop->value(); + + if ((prop = output_state_node->property ("active")) == 0) { + continue; + } + output_state.active = string_is_affirmative (prop->value ()); + + if ((prop = output_state_node->property ("scene-connected")) == 0) { + continue; + } + output_state.scene_connected = string_is_affirmative (prop->value ()); + + if ((prop = output_state_node->property ("mtc-in")) == 0) { + continue; + } + output_state.mtc_in = string_is_affirmative (prop->value ()); + + _midi_outputs.push_back(output_state); + } + } + } +} + + +void +EngineStateController::_serialize_engine_states(XMLNode* audio_midi_settings_node) +{ + if (!audio_midi_settings_node) { + return; + } + + // clean up state data first + audio_midi_settings_node->remove_nodes_and_delete("EngineStates" ); + + XMLNode* engine_states = new XMLNode("EngineStates" ); + + StateList::const_iterator state_iter = _states.begin(); + for (; state_iter != _states.end(); ++state_iter) { + + StatePtr state_ptr = *state_iter; + + // create new node for the state + XMLNode* state_node = new XMLNode("State"); + + state_node->add_property ("backend-name", state_ptr->backend_name); + state_node->add_property ("device-name", state_ptr->device_name); + state_node->add_property ("sample-rate", state_ptr->sample_rate); + state_node->add_property ("buffer-size", state_ptr->buffer_size); + state_node->add_property ("active", state_ptr->active ? "yes" : "no"); + + // store channel states: + // inputs + XMLNode* input_config_node = new XMLNode("InputConfiguration"); + PortStateList& input_channels = state_ptr->input_channel_states; + PortStateList::const_iterator input_state_iter = input_channels.begin(); + for (; input_state_iter != input_channels.end(); ++input_state_iter) { + XMLNode* input_state_node = new XMLNode("input"); + input_state_node->add_property ("name", input_state_iter->name); + input_state_node->add_property ("active", input_state_iter->active ? "yes" : "no"); + input_config_node->add_child_nocopy(*input_state_node); + } + state_node->add_child_nocopy(*input_config_node); + + // multi out outputs + XMLNode* multi_out_config_node = new XMLNode("MultiOutConfiguration"); + PortStateList& multi_out_channels = state_ptr->multi_out_channel_states; + PortStateList::const_iterator multi_out_state_iter = multi_out_channels.begin(); + for (; multi_out_state_iter != multi_out_channels.end(); ++multi_out_state_iter) { + XMLNode* multi_out_state_node = new XMLNode("output" ); + multi_out_state_node->add_property ("name", multi_out_state_iter->name); + multi_out_state_node->add_property ("active", multi_out_state_iter->active ? "yes" : "no"); + multi_out_config_node->add_child_nocopy(*multi_out_state_node); + } + state_node->add_child_nocopy(*multi_out_config_node); + + // stereo out outputs + XMLNode* stereo_out_config_node = new XMLNode("StereoOutConfiguration"); + PortStateList& stereo_out_channels = state_ptr->stereo_out_channel_states; + PortStateList::const_iterator stereo_out_state_iter = stereo_out_channels.begin(); + for (; stereo_out_state_iter != stereo_out_channels.end(); ++stereo_out_state_iter) { + XMLNode* stereo_out_state_node = new XMLNode("output" ); + stereo_out_state_node->add_property ("name", stereo_out_state_iter->name); + stereo_out_state_node->add_property ("active", stereo_out_state_iter->active ? "yes" : "no"); + stereo_out_config_node->add_child_nocopy(*stereo_out_state_node); + } + state_node->add_child_nocopy(*stereo_out_config_node); + + engine_states->add_child_nocopy(*state_node); + } + + audio_midi_settings_node->add_child_nocopy(*engine_states); +} + + +void +EngineStateController::_serialize_midi_port_states(XMLNode* audio_midi_settings_node) +{ + if (!audio_midi_settings_node) { + return; + } + + // clean up state data first + audio_midi_settings_node->remove_nodes_and_delete("MidiStates" ); + + XMLNode* midi_states_node = new XMLNode("MidiStates" ); + + XMLNode* midi_input_states_node = new XMLNode("MidiInputs" ); + MidiPortStateList::const_iterator midi_input_state_iter = _midi_inputs.begin(); + for (; midi_input_state_iter != _midi_inputs.end(); ++midi_input_state_iter) { + XMLNode* midi_input_node = new XMLNode("input" ); + midi_input_node->add_property ("name", midi_input_state_iter->name); + midi_input_node->add_property ("active", midi_input_state_iter->active ? "yes" : "no"); + midi_input_node->add_property ("scene_connected", midi_input_state_iter->scene_connected ? "yes" : "no"); + midi_input_node->add_property ("mtc-in", midi_input_state_iter->mtc_in ? "yes" : "no"); + midi_input_states_node->add_child_nocopy(*midi_input_node); + } + midi_states_node->add_child_nocopy(*midi_input_states_node); + + XMLNode* midi_output_states_node = new XMLNode("MidiOutputs" ); + MidiPortStateList::const_iterator midi_output_state_iter = _midi_outputs.begin(); + for (; midi_output_state_iter != _midi_outputs.end(); ++midi_output_state_iter) { + XMLNode* midi_output_node = new XMLNode("output" ); + midi_output_node->add_property ("name", midi_output_state_iter->name); + midi_output_node->add_property ("active", midi_output_state_iter->active ? "yes" : "no"); + midi_output_node->add_property ("scene_connected", midi_output_state_iter->scene_connected ? "yes" : "no"); + midi_output_node->add_property ("mtc-in", midi_output_state_iter->mtc_in ? "yes" : "no"); + midi_output_states_node->add_child_nocopy(*midi_output_node); + } + midi_states_node->add_child_nocopy(*midi_output_states_node); + + audio_midi_settings_node->add_child_nocopy(*midi_states_node); +} + + +bool +EngineStateController::_apply_state(const StatePtr& state) +{ + bool applied = false; + + if (set_new_backend_as_current(state->backend_name) ) { + applied = set_new_device_as_current(state->device_name); + } + + return applied; +} + + +void +EngineStateController::_do_initial_engine_setup() +{ + bool state_applied = false; + + // if we have no saved state load default values + if (!_states.empty() ) { + + // look for last active state first + StateList::const_iterator state_iter = _states.begin(); + for (; state_iter != _states.end(); ++state_iter) { + if ( (*state_iter)->active ) { + state_applied = _apply_state(*state_iter); + break; + } + } + + // last active state was not applied + // try others + if (!state_applied) { + StateList::const_iterator state_iter = _states.begin(); + for (; state_iter != _states.end(); ++state_iter) { + state_applied = _apply_state(*state_iter); + break; + } + } + } + + if (!state_applied ){ + std::vector<const AudioBackendInfo*> backends = AudioEngine::instance()->available_backends(); + + if (!backends.empty() ) { + + if (!set_new_backend_as_current(backends.front()->name ) ) { + std::cerr << "\tfailed to set backend [" << backends.front()->name << "]\n"; + } + } + + } +} + + +bool +EngineStateController::_validate_current_device_state() +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + + // check if device parameters from the state record are still valid + // validate sample rate + std::vector<float> sample_rates = backend->available_sample_rates (_current_state->device_name); + + if (sample_rates.empty() ) { + return false; + } + + // check if session desired sample rate (if it's set) could be used with this device + if (_session != 0) { + + if ( !set_new_sample_rate_in_controller (_session->nominal_frame_rate ()) ) { + if ( !set_new_sample_rate_in_controller (backend->default_sample_rate() ) ) { + if (!set_new_sample_rate_in_controller (sample_rates.front() ) ) { + return false; + } + } + } + + } else { + // check if current sample rate is supported because we have no session desired sample rate value + if ( !set_new_sample_rate_in_controller (_current_state->sample_rate) ) { + if ( !set_new_sample_rate_in_controller (backend->default_sample_rate() ) ) { + if (!set_new_sample_rate_in_controller (sample_rates.front() ) ) { + return false; + } + } + } + } + + // validate buffer size + std::vector<pframes_t> buffer_sizes = backend->available_buffer_sizes (_current_state->device_name); + // check if buffer size is supported + std::vector<pframes_t>::iterator bs_iter = std::find (buffer_sizes.begin(), buffer_sizes.end(), _current_state->buffer_size); + // if current is not found switch to default if is supported + if (bs_iter == buffer_sizes.end() ) { + bs_iter = std::find (buffer_sizes.begin(), buffer_sizes.end(), backend->default_buffer_size () ); + + if (bs_iter != buffer_sizes.end() ) { + _current_state->buffer_size = backend->default_buffer_size (); + } else { + if (!buffer_sizes.empty() ) { + _current_state->buffer_size = buffer_sizes.front(); + } + } + + } + + return true; +} + + +const std::string& +EngineStateController::get_current_backend_name() const +{ + return _current_state->backend_name; +} + + +const std::string& +EngineStateController::get_current_device_name() const +{ + return _current_state->device_name; +} + + +void +EngineStateController::available_backends(std::vector<const AudioBackendInfo*>& available_backends) +{ + available_backends = AudioEngine::instance()->available_backends(); +} + + +void +EngineStateController::enumerate_devices (std::vector<AudioBackend::DeviceStatus>& device_vector) const +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + device_vector = backend->enumerate_devices(); +} + + +framecnt_t +EngineStateController::get_current_sample_rate() const +{ + return _current_state->sample_rate; +} + + +framecnt_t +EngineStateController::get_default_sample_rate() const +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + return backend->default_sample_rate(); +} + + +void +EngineStateController::available_sample_rates_for_current_device(std::vector<float>& sample_rates) const +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + sample_rates = backend->available_sample_rates (_current_state->device_name); +} + + +uint32_t +EngineStateController::get_current_buffer_size() const +{ + return _current_state->buffer_size; +} + + +uint32_t +EngineStateController::get_default_buffer_size() const +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + return backend->default_buffer_size(); +} + + +void +EngineStateController::available_buffer_sizes_for_current_device(std::vector<pframes_t>& buffer_sizes) const +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + buffer_sizes = backend->available_buffer_sizes (_current_state->device_name); +} + + +bool +EngineStateController::set_new_backend_as_current(const std::string& backend_name) +{ + if (backend_name == AudioEngine::instance()->current_backend_name () ) { + return true; + } + + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->set_backend (backend_name, PROGRAM_NAME, ""); + if (backend) + { + if (_current_state != NULL) { + _current_state->active = false; + } + + StateList::iterator found_state_iter = find_if (_states.begin(), _states.end(), + State::StatePredicate(backend_name, "None") ); + + if (found_state_iter != _states.end() ) { + // we found a record for new engine with None device - switch to it + _current_state = *found_state_iter; + _validate_current_device_state(); + } else { + // create new record for this engine with default device + _current_state = boost::shared_ptr<State>(new State() ); + _current_state->backend_name = backend_name; + _current_state->device_name = "None"; + _validate_current_device_state(); + _states.push_front(_current_state); + } + + push_current_state_to_backend(false); + + return true; + } + + return false; +} + + +bool +EngineStateController::set_new_device_as_current(const std::string& device_name) +{ + if (_current_state->device_name == device_name) { + return true; + } + + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + + std::vector<AudioBackend::DeviceStatus> device_vector = backend->enumerate_devices(); + + // validate the device + std::vector<AudioBackend::DeviceStatus>::iterator device_iter; + device_iter = std::find_if (device_vector.begin(), device_vector.end(), DevicePredicate(device_name) ); + + // device is available + if (device_iter != device_vector.end() ) { + + boost::shared_ptr<State> previous_state (_current_state); + + // look through state list and find the record for this device and current engine + StateList::iterator found_state_iter = find_if (_states.begin(), _states.end(), + State::StatePredicate(backend->name(), device_name) ); + + if (found_state_iter != _states.end() ) + { + // we found a record for current engine and provided device name - switch to it + + _current_state = *found_state_iter; + + if (!_validate_current_device_state() ) { + _current_state = previous_state; + return false; + } + + } else { + + // the record is not found, create new one + _current_state = boost::shared_ptr<State>(new State() ); + + _current_state->backend_name = backend->name(); + _current_state->device_name = device_name; + + if (!_validate_current_device_state() ) { + _current_state = previous_state; + return false; + } + + _states.push_front(_current_state); + } + + if (previous_state != NULL) { + previous_state->active = false; + } + + push_current_state_to_backend(false); + + _last_used_real_device.clear(); + + if (device_name != "None") { + _last_used_real_device = device_name; + } + + return true; + } + + // device is not supported by current backend + return false; +} + + + +bool +EngineStateController::set_new_sample_rate_in_controller(framecnt_t sample_rate) +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + + std::vector<float> sample_rates = backend->available_sample_rates (_current_state->device_name); + std::vector<float>::iterator iter = std::find (sample_rates.begin(), sample_rates.end(), (float)sample_rate); + + if (iter != sample_rates.end() ) { + _current_state->sample_rate = sample_rate; + return true; + } + + return false; +} + + +bool +EngineStateController::set_new_buffer_size_in_controller(pframes_t buffer_size) +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + + std::vector<uint32_t> buffer_sizes = backend->available_buffer_sizes (_current_state->device_name); + std::vector<uint32_t>::iterator iter = std::find (buffer_sizes.begin(), buffer_sizes.end(), buffer_size); + + if (iter != buffer_sizes.end() ) { + _current_state->buffer_size = buffer_size; + return true; + } + + return false; +} + + +uint32_t +EngineStateController::get_available_inputs_count() const +{ + uint32_t available_channel_count = 0; + + PortStateList::const_iterator iter = _current_state->input_channel_states.begin(); + + for (; iter != _current_state->input_channel_states.end(); ++iter) { + if (iter->active) { + ++available_channel_count; + } + } + + return available_channel_count; +} + + +uint32_t +EngineStateController::get_available_outputs_count () const +{ + uint32_t available_channel_count = 0; + + PortStateList* output_states; + if (Config->get_output_auto_connect() & AutoConnectMaster) { + output_states = &_current_state->stereo_out_channel_states; + } else { + output_states = &_current_state->multi_out_channel_states; + } + + PortStateList::const_iterator iter = output_states->begin(); + + for (; iter != output_states->end(); ++iter) { + if (iter->active) { + ++available_channel_count; + } + } + + return available_channel_count; +} + + +void +EngineStateController::get_physical_audio_inputs(std::vector<std::string>& port_names) +{ + port_names.clear(); + + PortStateList &input_states = _current_state->input_channel_states; + + PortStateList::iterator iter = input_states.begin(); + for (; iter != input_states.end(); ++iter) { + if (iter->active) { + port_names.push_back(iter->name); + } + } +} + + +void +EngineStateController::get_physical_audio_outputs(std::vector<std::string>& port_names) +{ + port_names.clear(); + + PortStateList* output_states; + if (Config->get_output_auto_connect() & AutoConnectMaster) { + output_states = &_current_state->stereo_out_channel_states; + } else { + output_states = &_current_state->multi_out_channel_states; + } + + PortStateList::iterator iter = output_states->begin(); + for (; iter != output_states->end(); ++iter) { + if (iter->active) { + port_names.push_back(iter->name); + } + } +} + + +void +EngineStateController::get_physical_midi_inputs (std::vector<std::string>& port_names) +{ + port_names.clear(); + + MidiPortStateList::iterator iter = _midi_inputs.begin(); + for (; iter != _midi_inputs.end(); ++iter) { + if (iter->available && iter->active) { + port_names.push_back(iter->name); + } + } +} + + +void +EngineStateController::get_physical_midi_outputs (std::vector<std::string>& port_names) +{ + port_names.clear(); + + MidiPortStateList::iterator iter = _midi_outputs.begin(); + for (; iter != _midi_outputs.end(); ++iter) { + if (iter->available && iter->active) { + port_names.push_back(iter->name); + } + } +} + + +void +EngineStateController::set_physical_audio_input_state(const std::string& port_name, bool state) +{ + PortStateList &input_states = _current_state->input_channel_states; + PortStateList::iterator found_state_iter; + found_state_iter = std::find(input_states.begin(), input_states.end(), PortState(port_name) ); + + if (found_state_iter != input_states.end() && found_state_iter->active != state ) { + found_state_iter->active = state; + AudioEngine::instance()->reconnect_session_routes(true, false); + + InputConfigChanged(); + } +} + + +void +EngineStateController::set_physical_audio_output_state(const std::string& port_name, bool state) +{ + PortStateList* output_states; + if (Config->get_output_auto_connect() & AutoConnectMaster) { + output_states = &_current_state->stereo_out_channel_states; + } else { + output_states = &_current_state->multi_out_channel_states; + } + + PortStateList::iterator target_state_iter; + target_state_iter = std::find(output_states->begin(), output_states->end(), PortState(port_name) ); + + if (target_state_iter != output_states->end() && target_state_iter->active != state ) { + target_state_iter->active = state; + + // if StereoOut mode is used + if (Config->get_output_auto_connect() & AutoConnectMaster) { + + // get next element + PortStateList::iterator next_state_iter(target_state_iter); + + // loopback + if (++next_state_iter == output_states->end() ) { + next_state_iter = output_states->begin(); + } + + + // only two outputs should be enabled + if (output_states->size() <= 2) { + + target_state_iter->active = true; + next_state_iter->active = true; + + } else { + + // if current was set to active - activate next and disable the rest + if (target_state_iter->active ) { + next_state_iter->active = true; + } else { + // if current was deactivated but the next is active + if (next_state_iter->active) { + if (++next_state_iter == output_states->end() ) { + next_state_iter = output_states->begin(); + } + next_state_iter->active = true; + } else { + // if current was deactivated but the previous is active - restore the state of current + target_state_iter->active = true; // state restored; + --target_state_iter; // switch to previous to make it stop point in the next cycle + target_state_iter->active = true; + } + } + + // now deactivate the rest + while (++next_state_iter != target_state_iter) { + + if (next_state_iter == output_states->end() ) { + next_state_iter = output_states->begin(); + // we jumped, so additional check is required + if (next_state_iter == target_state_iter) { + break; + } + } + + next_state_iter->active = false; + } + + } + } + + AudioEngine::instance()->reconnect_session_routes(false, true); + OutputConfigChanged(); + } +} + + +bool +EngineStateController::get_physical_audio_input_state(const std::string& port_name) +{ + bool state = false; + + PortStateList &input_states = _current_state->input_channel_states; + PortStateList::iterator found_state_iter; + found_state_iter = std::find(input_states.begin(), input_states.end(), PortState(port_name) ); + + if (found_state_iter != input_states.end() ) { + state = found_state_iter->active; + } + + return state; +} + + +bool +EngineStateController::get_physical_audio_output_state(const std::string& port_name) +{ + bool state = false; + + PortStateList* output_states; + if (Config->get_output_auto_connect() & AutoConnectMaster) { + output_states = &_current_state->stereo_out_channel_states; + } else { + output_states = &_current_state->multi_out_channel_states; + } + + PortStateList::iterator found_state_iter; + found_state_iter = std::find(output_states->begin(), output_states->end(), PortState(port_name) ); + + if (found_state_iter != output_states->end() ) { + state = found_state_iter->active; + } + + return state; +} + + +void +EngineStateController::set_physical_midi_input_state(const std::string& port_name, bool state) { + + MidiPortStateList::iterator found_state_iter; + found_state_iter = std::find(_midi_inputs.begin(), _midi_inputs.end(), MidiPortState(port_name) ); + + if (found_state_iter != _midi_inputs.end() && found_state_iter->available && found_state_iter->active != state ) { + found_state_iter->active = state; + + if (_session) { + // reconnect MTC inputs as well + if (found_state_iter->mtc_in) { + _session->reconnect_mtc_ports (); + } + _session->reconnect_mmc_ports(true); + } + + MIDIInputConfigChanged(); + } +} + + +void +EngineStateController::set_physical_midi_output_state(const std::string& port_name, bool state) { + + MidiPortStateList::iterator found_state_iter; + found_state_iter = std::find(_midi_outputs.begin(), _midi_outputs.end(), MidiPortState(port_name) ); + + if (found_state_iter != _midi_outputs.end() && found_state_iter->available && found_state_iter->active != state ) { + found_state_iter->active = state; + + if (_session) { + _session->reconnect_mmc_ports(false); + } + + MIDIOutputConfigChanged(); + } +} + + +bool +EngineStateController::get_physical_midi_input_state(const std::string& port_name, bool& scene_connected) { + + bool state = false; + + MidiPortStateList::iterator found_state_iter; + found_state_iter = std::find(_midi_inputs.begin(), _midi_inputs.end(), MidiPortState(port_name) ); + + if (found_state_iter != _midi_inputs.end() && found_state_iter->available) { + state = found_state_iter->active; + scene_connected = found_state_iter->scene_connected; + } + + return state; +} + + +bool +EngineStateController::get_physical_midi_output_state(const std::string& port_name, bool& scene_connected) { + + bool state = false; + + MidiPortStateList::iterator found_state_iter; + found_state_iter = std::find(_midi_outputs.begin(), _midi_outputs.end(), MidiPortState(port_name) ); + + if (found_state_iter != _midi_outputs.end() && found_state_iter->available) { + state = found_state_iter->active; + scene_connected = found_state_iter->scene_connected; + } + + return state; +} + + +void +EngineStateController::set_physical_midi_scene_in_connection_state(const std::string& port_name, bool state) { + + MidiPortStateList::iterator found_state_iter; + found_state_iter = std::find(_midi_inputs.begin(), _midi_inputs.end(), MidiPortState(port_name) ); + + if (found_state_iter != _midi_inputs.end() && found_state_iter->available && found_state_iter->active ) { + found_state_iter->scene_connected = state; + + std::vector<std::string> ports; + ports.push_back(port_name); + MIDISceneInputConnectionChanged(ports, state); + } + +} + + +void +EngineStateController::set_physical_midi_scenen_out_connection_state(const std::string& port_name, bool state) { + + MidiPortStateList::iterator found_state_iter; + found_state_iter = std::find(_midi_outputs.begin(), _midi_outputs.end(), MidiPortState(port_name) ); + + if (found_state_iter != _midi_outputs.end() && found_state_iter->available && found_state_iter->active ) { + found_state_iter->scene_connected = state; + + std::vector<std::string> ports; + ports.push_back(port_name); + MIDISceneOutputConnectionChanged(ports, state); + } + +} + + +void +EngineStateController::set_all_midi_scene_inputs_disconnected() +{ + MidiPortStateList::iterator iter = _midi_inputs.begin(); + for (; iter != _midi_inputs.end(); ++iter) { + iter->scene_connected = false; + } + + std::vector<std::string> ports; + MIDISceneInputConnectionChanged(ports, false); +} + + +void +EngineStateController::set_all_midi_scene_outputs_disconnected() +{ + MidiPortStateList::iterator iter = _midi_outputs.begin(); + for (; iter != _midi_outputs.end(); ++iter) { + iter->scene_connected = false; + } + + std::vector<std::string> ports; + MIDISceneOutputConnectionChanged(ports, false); +} + + +void +EngineStateController::set_mtc_input(const std::string& port_name) +{ + MidiPortStateList::iterator iter = _midi_inputs.begin(); + for (; iter != _midi_inputs.end(); ++iter) { + iter->mtc_in = false; + + if (iter->name == port_name) { + iter->mtc_in = true; + + if (_session) { + _session->reconnect_mtc_ports (); + } + } + } + + MTCInputChanged(port_name); +} + + +void +EngineStateController::set_state_to_all_inputs(bool state) +{ + bool something_changed = false; + + PortStateList::iterator iter = _current_state->input_channel_states.begin(); + for (; iter != _current_state->input_channel_states.end(); ++iter) { + if (iter->active != state) { + iter->active = state; + something_changed = true; + } + } + + if (something_changed) { + AudioEngine::instance()->reconnect_session_routes(true, false); + InputConfigChanged(); + } +} + + +void +EngineStateController::set_state_to_all_outputs(bool state) +{ + // unapplicable in Stereo Out mode, just return + if (Config->get_output_auto_connect() & AutoConnectMaster) { + return; + } + + bool something_changed = false; + + PortStateList::iterator iter = _current_state->multi_out_channel_states.begin(); + for (; iter != _current_state->multi_out_channel_states.end(); ++iter) { + if (iter->active != state) { + iter->active = state; + something_changed = true; + } + } + + if (something_changed) { + AudioEngine::instance()->reconnect_session_routes(false, true); + OutputConfigChanged(); + } +} + + +void +EngineStateController::get_physical_audio_input_states(std::vector<PortState>& channel_states) +{ + PortStateList &input_states = _current_state->input_channel_states; + channel_states.assign(input_states.begin(), input_states.end()); +} + + +void +EngineStateController::get_physical_audio_output_states(std::vector<PortState>& channel_states) +{ + PortStateList* output_states; + if (Config->get_output_auto_connect() & AutoConnectMaster) { + output_states = &_current_state->stereo_out_channel_states; + } else { + output_states = &_current_state->multi_out_channel_states; + } + + channel_states.assign(output_states->begin(), output_states->end()); +} + + +void +EngineStateController::get_physical_midi_input_states (std::vector<MidiPortState>& channel_states) +{ + channel_states.clear(); + + MidiPortStateList::iterator iter = _midi_inputs.begin(); + + for (; iter != _midi_inputs.end(); ++iter ) { + if (iter->available) { + MidiPortState state(iter->name); + state.active = iter->active; + state.available = true; + state.scene_connected = iter->scene_connected; + state.mtc_in = iter->mtc_in; + channel_states.push_back(state); + } + } +} + +void +EngineStateController::get_physical_midi_output_states (std::vector<MidiPortState>& channel_states) +{ + channel_states.clear(); + + MidiPortStateList::iterator iter = _midi_outputs.begin(); + + for (; iter != _midi_outputs.end(); ++iter ) { + if (iter->available) { + MidiPortState state(iter->name); + state.active = iter->active; + state.available = true; + state.scene_connected = iter->scene_connected; + state.mtc_in = iter->mtc_in; + channel_states.push_back(state); + } + } +} + + +void +EngineStateController::_on_session_loaded () +{ + if (!_session) { + return; + } + + AudioEngine::instance()->reconnect_session_routes(true, true); + _session->reconnect_mtc_ports (); + _session->reconnect_mmc_ports (true); + _session->reconnect_mmc_ports (false); + + framecnt_t desired_sample_rate = _session->nominal_frame_rate (); + if ( desired_sample_rate > 0 && set_new_sample_rate_in_controller(desired_sample_rate) ) + { + push_current_state_to_backend(false); + SampleRateChanged(); // emit a signal + } +} + + +void +EngineStateController::_on_sample_rate_change(framecnt_t new_sample_rate) +{ + if (_current_state->sample_rate != new_sample_rate) { + + // if sample rate has been changed + framecnt_t sample_rate_to_set = new_sample_rate; + if (AudioEngine::instance()->session() ) { + // and we have current session we should restore it back to the one tracks uses + sample_rate_to_set = AudioEngine::instance()->session()->frame_rate (); + } + + if ( !set_new_sample_rate_in_controller (sample_rate_to_set) ) { + // if sample rate can't be set + // switch to NONE device + set_new_device_as_current ("None"); + DeviceListChanged(false); + DeviceError(); + } + } + + SampleRateChanged(); // emit a signal +} + + +void +EngineStateController::_on_buffer_size_change(pframes_t new_buffer_size) +{ + if (_current_state->buffer_size != new_buffer_size) { + _current_state->buffer_size = new_buffer_size; + } + + BufferSizeChanged(); // emit a signal +} + + +void +EngineStateController::_on_device_list_change() +{ + bool current_device_disconnected = false; + + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + + std::vector<AudioBackend::DeviceStatus> device_vector = backend->enumerate_devices(); + + // find out out if current device is still available if it's not None + if (_current_state->device_name != "None") + { + std::vector<AudioBackend::DeviceStatus>::iterator device_iter; + device_iter = std::find_if (device_vector.begin(), device_vector.end(), DevicePredicate(_current_state->device_name) ); + + // if current device is not available any more - switch to None device + if (device_iter == device_vector.end() ) { + + StateList::iterator found_state_iter = find_if (_states.begin(), _states.end(), + State::StatePredicate(_current_state->backend_name, "None") ); + + if (found_state_iter != _states.end() ) { + // found the record - switch to it + _current_state = *found_state_iter; + _validate_current_device_state(); + } else { + // create new record for this engine with default device + _current_state = boost::shared_ptr<State>(new State() ); + _current_state->backend_name = backend->name(); + _current_state->device_name = "None"; + _validate_current_device_state(); + _states.push_front(_current_state); + } + + push_current_state_to_backend(true); + current_device_disconnected = true; + } + } else { + // if the device which was active before is available now - switch to it + + std::vector<AudioBackend::DeviceStatus>::iterator device_iter; + device_iter = std::find_if (device_vector.begin(), device_vector.end(), DevicePredicate(_last_used_real_device) ); + + if (device_iter != device_vector.end() ) { + StateList::iterator found_state_iter = find_if (_states.begin(), _states.end(), + State::StatePredicate(_current_state->backend_name, + _last_used_real_device) ); + + if (found_state_iter != _states.end() ) { + + boost::shared_ptr<State> previous_state (_current_state); + _current_state = *found_state_iter; + + if (_validate_current_device_state() ) { + push_current_state_to_backend(false); + } else { + // cannot use this device right now + _last_used_real_device.clear(); + _current_state = previous_state; + } + } + } + } + + DeviceListChanged(current_device_disconnected); // emit a signal +} + + +void +EngineStateController::_update_device_channels_state() +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + assert(backend); + + // update audio input states + std::vector<std::string> phys_audio_inputs; + backend->get_physical_inputs(DataType::AUDIO, phys_audio_inputs); + + PortStateList new_input_states; + PortStateList &input_states = _current_state->input_channel_states; + + std::vector<std::string>::const_iterator input_iter = phys_audio_inputs.begin(); + for (; input_iter != phys_audio_inputs.end(); ++input_iter) { + + PortState state(*input_iter); + state.active = true; + PortStateList::const_iterator found_state_iter = std::find(input_states.begin(), input_states.end(), state); + + if (found_state_iter != input_states.end() ) { + new_input_states.push_back(*found_state_iter); + } else { + new_input_states.push_back(state); + } + } + _current_state->input_channel_states = new_input_states; + + // update audio output states (multi out mode) + std::vector<std::string> phys_audio_outputs; + backend->get_physical_outputs(DataType::AUDIO, phys_audio_outputs); + + PortStateList new_output_states; + PortStateList &output_multi_states = _current_state->multi_out_channel_states; + + std::vector<std::string>::const_iterator output_iter = phys_audio_outputs.begin(); + for (; output_iter != phys_audio_outputs.end(); ++output_iter) { + + PortState state(*output_iter); + state.active = true; + PortStateList::const_iterator found_state_iter = std::find(output_multi_states.begin(), output_multi_states.end(), state); + + if (found_state_iter != output_multi_states.end() ) { + new_output_states.push_back(*found_state_iter); + } else { + new_output_states.push_back(state); + } + } + + _current_state->multi_out_channel_states = new_output_states; + + // update audio output states (stereo out mode) + new_output_states.clear(); + PortStateList &output_stereo_states = _current_state->stereo_out_channel_states; + + output_iter = phys_audio_outputs.begin(); + for (; output_iter != phys_audio_outputs.end(); ++output_iter) { + + PortState state(*output_iter); + state.active = true; + PortStateList::const_iterator found_state_iter = std::find(output_stereo_states.begin(), output_stereo_states.end(), state); + + if (found_state_iter != output_stereo_states.end() ) { + new_output_states.push_back(*found_state_iter); + } else { + new_output_states.push_back(state); + } + } + + _current_state->stereo_out_channel_states = new_output_states; + _refresh_stereo_out_channel_states(); + + + // update midi ports: unlike audio ports which states are saved per device + // each midi port state is saved individualy + // so get all midi ports from the backend + // and compare to the list of midi ports we have + // if physical port is new, add it to our state list + // if physical port is present in our state list - mark it available + // if there is no corresponding physical port to one we have in a list - leave it unavailable + MidiPortStateList::iterator iter = _midi_inputs.begin(); + for (; iter != _midi_inputs.end(); ++iter) { + iter->available = false; + } + + for (iter = _midi_outputs.begin(); iter != _midi_outputs.end(); ++iter) { + iter->available = false; + } + + // update midi input ports + std::vector<std::string> phys_midi_inputs; + backend->get_physical_inputs(DataType::MIDI, phys_midi_inputs); + + std::vector<std::string>::const_iterator midi_input_iter = phys_midi_inputs.begin(); + for (; midi_input_iter != phys_midi_inputs.end(); ++midi_input_iter) { + + MidiPortState state(*midi_input_iter); + state.active = false; + state.available = true; + MidiPortStateList::iterator found_state_iter = std::find(_midi_inputs.begin(), _midi_inputs.end(), state); + + if (found_state_iter != _midi_inputs.end() ) { + found_state_iter->available = true; + } else { + _midi_inputs.push_back(state); + } + } + + // update midi output ports + std::vector<std::string> phys_midi_outputs; + backend->get_physical_outputs(DataType::MIDI, phys_midi_outputs); + + std::vector<std::string>::const_iterator midi_output_iter = phys_midi_outputs.begin(); + for (; midi_output_iter != phys_midi_outputs.end(); ++midi_output_iter) { + + MidiPortState state(*midi_output_iter); + state.active = false; + state.available = true; + MidiPortStateList::iterator found_state_iter = std::find(_midi_outputs.begin(), _midi_outputs.end(), state); + + if (found_state_iter != _midi_outputs.end() ) { + found_state_iter->available = true; + } else { + _midi_outputs.push_back(state); + } + } +} + + +void +EngineStateController::_refresh_stereo_out_channel_states() +{ + PortStateList &output_states = _current_state->stereo_out_channel_states; + PortStateList::iterator active_iter = output_states.begin(); + + for (; active_iter != output_states.end(); ++active_iter) { + if (active_iter->active) { + break; + } + } + + uint32_t pending_active_channels = 2; + PortStateList::iterator iter = output_states.begin(); + // if found active + if (active_iter != output_states.end() ) { + iter = active_iter; + if (++iter == output_states.end() ) { + iter = output_states.begin(); + } + + (iter++)->active = true; + pending_active_channels = 0; + } + + // drop the rest of the states to false (until we reach the end or first existing active channel) + for (; iter != output_states.end() && iter != active_iter; ++iter) { + if (pending_active_channels) { + iter->active = true; + --pending_active_channels; + } else { + iter->active = false; + } + } +} + + +void +EngineStateController::_on_engine_running () +{ + AudioEngine::instance()->reconnect_session_routes(true, true); + _current_state->active = true; + + EngineRunning(); // emit a signal +} + + +void +EngineStateController::_on_engine_stopped () +{ + EngineStopped(); +} + + +void +EngineStateController::_on_engine_halted () +{ + EngineHalted(); +} + + +void +EngineStateController::_on_device_error() +{ + set_new_device_as_current ("None"); + push_current_state_to_backend(true); + DeviceListChanged(false); + DeviceError(); +} + + +void +EngineStateController::_on_parameter_changed (const std::string& parameter_name) +{ + if (parameter_name == "output-auto-connect") { + + AudioEngine::instance()->reconnect_session_routes(false, true); + OutputConfigChanged(); // emit a signal + OutputConnectionModeChanged(); // emit signal + } +} + + +void +EngineStateController::_on_ports_registration_update () +{ + _update_device_channels_state(); + + // update MIDI connections + if (_session) { + _session->reconnect_midi_scene_ports (true); + _session->reconnect_midi_scene_ports (false); + + _session->reconnect_mtc_ports (); + + _session->reconnect_mmc_ports (true); + _session->reconnect_mmc_ports (false); + } + + PortRegistrationChanged(); // emit a signal +} + + +bool +EngineStateController::push_current_state_to_backend(bool start) +{ + boost::shared_ptr<AudioBackend> backend = AudioEngine::instance()->current_backend(); + + if (!backend) { + return false; + } + + // check if anything changed + bool state_changed = (_current_state->device_name != backend->device_name() ) || + (_current_state->sample_rate != backend->sample_rate() ) || + (_current_state->buffer_size != backend->buffer_size() ); + + bool was_running = AudioEngine::instance()->running(); + + Glib::Threads::RecMutex::Lock sl (AudioEngine::instance()->state_lock() ); + if (state_changed) { + + if (was_running) { + if (AudioEngine::instance()->stop () ) { + return false; + } + } + + int result = 0; + { + std::cout << "EngineStateController::Setting device: " << _current_state->device_name << std::endl; + if ((_current_state->device_name != backend->device_name()) && (result = backend->set_device_name (_current_state->device_name)) ) { + error << string_compose (_("Cannot set device name to %1"), get_current_device_name()) << endmsg; + } + + if (!result ) { + std::cout << "EngineStateController::Setting device sample rate " << _current_state->sample_rate << std::endl; + result = backend->set_sample_rate (_current_state->sample_rate); + + if (result) { + error << string_compose (_("Cannot set sample rate to %1"), get_current_sample_rate()) << endmsg; + } + } + + if (!result ) { + std::cout << "EngineStateController::Setting device buffer size " << _current_state->buffer_size << std::endl; + result = backend->set_buffer_size (_current_state->buffer_size); + + if (result) { + error << string_compose (_("Cannot set buffer size to %1"), get_current_buffer_size()) << endmsg; + } + } + } + + if (result) // error during device setup + { + //switch to None device and notify about the issue + set_new_device_as_current ("None"); + DeviceListChanged(false); + DeviceError(); + } + + if (AudioEngine::instance()->backend_reset_requested() ) { + // device asked for reset, do not start engine now + // free sate lock and let Engine reset the device as it's required + return true; + } + } + + if(start || (was_running && state_changed) ) { + if (AudioEngine::instance()->start () && !AudioEngine::instance()->is_reset_requested() ) { + //switch to None device and notify about the issue + set_new_device_as_current ("None"); + AudioEngine::instance()->start (); + DeviceListChanged(false); + DeviceError(); + return false; + } + } + + save_audio_midi_settings(); + + return true; +} |