Use XMLNode::get/set_property API in ARDOUR::RouteGroup
[ardour.git] / libs / ardour / plugin_insert.cc
index d3bbbf0c0ddcfac3b92152e30da17e97cd0b1fac..39371423f92f2f707cebc5e7d71c80216cae5423 100644 (file)
@@ -25,7 +25,7 @@
 
 #include "pbd/failed_constructor.h"
 #include "pbd/xml++.h"
-#include "pbd/convert.h"
+#include "pbd/types_convert.h"
 
 #include "ardour/audio_buffer.h"
 #include "ardour/automation_list.h"
@@ -98,6 +98,9 @@ PluginInsert::PluginInsert (Session& s, boost::shared_ptr<Plugin> plug)
 
 PluginInsert::~PluginInsert ()
 {
+       for (CtrlOutMap::const_iterator i = _control_outputs.begin(); i != _control_outputs.end(); ++i) {
+               boost::dynamic_pointer_cast<ReadOnlyControl>(i->second)->drop_references ();
+       }
 }
 
 void
@@ -430,6 +433,13 @@ PluginInsert::has_output_presets (ChanCount in, ChanCount out)
                        return false;
                }
        }
+
+       if (ppc.size () == 1 && ppc.find (0) != ppc.end () && !_plugins[0]->get_info ()->reconfigurable_io ()) {
+               // some midi-sequencer (e.g. QMidiArp) or other midi-out plugin
+               // pretending to be an "Instrument"
+               return false;
+       }
+
        if (!is_instrument ()) {
                        return false;
        }
@@ -445,7 +455,11 @@ PluginInsert::create_automatable_parameters ()
        set<Evoral::Parameter> a = _plugins.front()->automatable ();
 
        for (uint32_t i = 0; i < plugin->parameter_count(); ++i) {
-               if (!plugin->parameter_is_control (i) || !plugin->parameter_is_input (i)) {
+               if (!plugin->parameter_is_control (i)) {
+                       continue;
+               }
+               if (!plugin->parameter_is_input (i)) {
+                       _control_outputs[i] = boost::shared_ptr<ReadOnlyControl> (new ReadOnlyControl (plugin, i));
                        continue;
                }
                Evoral::Parameter param (PluginAutomation, 0, i);
@@ -483,6 +497,21 @@ PluginInsert::create_automatable_parameters ()
 
        _bypass_port = plugin->designated_bypass_port ();
 
+       /* special case VST effSetBypass */
+       if (_bypass_port == UINT32_MAX -1) {
+               // emulate VST Bypass
+               Evoral::Parameter param (PluginAutomation, 0, _bypass_port);
+               ParameterDescriptor desc;
+               desc.label = _("Plugin Enable");
+               desc.toggled  = true;
+               desc.normal = 1;
+               desc.lower  = 0;
+               desc.upper  = 1;
+               boost::shared_ptr<AutomationList> list(new AutomationList(param, desc));
+               boost::shared_ptr<AutomationControl> c (new PluginControl(this, param, desc, list));
+               add_control (c);
+       }
+
        if (_bypass_port != UINT32_MAX) {
                boost::shared_ptr<AutomationControl> ac = automation_control (Evoral::Parameter (PluginAutomation, 0, _bypass_port));
                if (0 == (ac->flags () & Controllable::NotAutomatable)) {
@@ -490,7 +519,9 @@ PluginInsert::create_automatable_parameters ()
                        ac->Changed.connect_same_thread (*this, boost::bind (&PluginInsert::enable_changed, this));
                }
        }
+       plugin->PresetPortSetValue.connect_same_thread (*this, boost::bind (&PluginInsert::preset_load_set_value, this, _1, _2));
 }
+
 /** Called when something outside of this host has modified a plugin
  * parameter. Responsible for propagating the change to two places:
  *
@@ -609,7 +640,27 @@ PluginInsert::enable (bool yn)
                        activate ();
                }
                boost::shared_ptr<AutomationControl> ac = automation_control (Evoral::Parameter (PluginAutomation, 0, _bypass_port));
-               ac->set_value (yn ? 1.0 : 0.0, Controllable::NoGroup);
+               const double val = yn ? 1.0 : 0.0;
+               ac->set_value (val, Controllable::NoGroup);
+
+#ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also vst_plugin.cc
+               /* special case VST.. bypass may fail */
+               if (_bypass_port == UINT32_MAX - 1) {
+                       /* check if bypass worked */
+                       if (ac->get_value () != val) {
+                               warning << _("PluginInsert: VST Bypass failed, falling back to host bypass.") << endmsg;
+                               // set plugin to enabled (not-byassed)
+                               ac->set_value (1.0, Controllable::NoGroup);
+                               // ..and use host-provided hard-bypass
+                               if (yn) {
+                                       activate ();
+                               } else {
+                                       deactivate ();
+                               }
+                               return;
+                       }
+               }
+#endif
                ActiveChanged ();
        }
 }
@@ -649,6 +700,23 @@ PluginInsert::bypassable_changed ()
        BypassableChanged ();
 }
 
+void
+PluginInsert::preset_load_set_value (uint32_t p, float v)
+{
+       boost::shared_ptr<AutomationControl> ac = automation_control (Evoral::Parameter(PluginAutomation, 0, p));
+       if (!ac) {
+               return;
+       }
+
+       if (ac->automation_state() & Play) {
+               return;
+       }
+
+       start_touch (p);
+       ac->set_value (v, Controllable::NoGroup);
+       end_touch (p);
+}
+
 void
 PluginInsert::inplace_silence_unconnected (BufferSet& bufs, const PinMappings& out_map, framecnt_t nframes, framecnt_t offset) const
 {
@@ -1816,11 +1884,9 @@ PluginInsert::configure_io (ChanCount in, ChanCount out)
                        && _in_map.size() == _out_map.size()
                        && _in_map.size() == get_count ()
                 ) {
-               assert (_maps_from_state == false);
                /* If the configuration has not changed, keep the mapping */
                mapping_changed = sanitize_maps ();
        } else if (_match.custom_cfg && _configured) {
-               assert (_maps_from_state == false);
                /* don't touch the map in manual mode */
                mapping_changed = sanitize_maps ();
        } else {
@@ -2279,9 +2345,9 @@ PluginInsert::state (bool full)
 {
        XMLNode& node = Processor::state (full);
 
-       node.add_property("type", _plugins[0]->state_node_name());
-       node.add_property("unique-id", _plugins[0]->unique_id());
-       node.add_property("count", string_compose("%1", _plugins.size()));
+       node.set_property("type", _plugins[0]->state_node_name());
+       node.set_property("unique-id", _plugins[0]->unique_id());
+       node.set_property("count", (uint32_t)_plugins.size());
 
        /* remember actual i/o configuration (for later placeholder
         * in case the plugin goes missing) */
@@ -2291,7 +2357,7 @@ PluginInsert::state (bool full)
        node.add_child_nocopy (* _preset_out.state (X_("PresetOutput")));
 
        /* save custom i/o config */
-       node.add_property("custom", _custom_cfg ? "yes" : "no");
+       node.set_property("custom", _custom_cfg);
        for (uint32_t pc = 0; pc < get_count(); ++pc) {
                char tmp[128];
                snprintf (tmp, sizeof(tmp), "InputMap-%d", pc);
@@ -2327,22 +2393,18 @@ PluginInsert::set_control_ids (const XMLNode& node, int version)
 
        for (iter = nlist.begin(); iter != nlist.end(); ++iter) {
                if ((*iter)->name() == Controllable::xml_node_name) {
-                       XMLProperty const * prop;
 
                        uint32_t p = (uint32_t)-1;
 #ifdef LV2_SUPPORT
-                       if ((prop = (*iter)->property (X_("symbol"))) != 0) {
+                       std::string str;
+                       if ((*iter)->get_property (X_("symbol"), str)) {
                                boost::shared_ptr<LV2Plugin> lv2plugin = boost::dynamic_pointer_cast<LV2Plugin> (_plugins[0]);
                                if (lv2plugin) {
-                                       p = lv2plugin->port_index(prop->value().c_str());
+                                       p = lv2plugin->port_index(str.c_str());
                                }
                        }
 #endif
-                       if (p == (uint32_t)-1 && (prop = (*iter)->property (X_("parameter"))) != 0) {
-                               p = atoi (prop->value());
-                       }
-
-                       if (p != (uint32_t)-1) {
+                       if (p == (uint32_t)-1 && (*iter)->get_property (X_("parameter"), p)) {
 
                                /* this may create the new controllable */
 
@@ -2368,42 +2430,38 @@ PluginInsert::set_state(const XMLNode& node, int version)
        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;
        XMLPropertyList plist;
-       XMLProperty const * prop;
        ARDOUR::PluginType type;
 
-       if ((prop = node.property ("type")) == 0) {
+       std::string str;
+       if (!node.get_property ("type", str)) {
                error << _("XML node describing plugin is missing the `type' field") << endmsg;
                return -1;
        }
 
-       if (prop->value() == X_("ladspa") || prop->value() == X_("Ladspa")) { /* handle old school sessions */
+       if (str == X_("ladspa") || str == X_("Ladspa")) { /* handle old school sessions */
                type = ARDOUR::LADSPA;
-       } else if (prop->value() == X_("lv2")) {
+       } else if (str == X_("lv2")) {
                type = ARDOUR::LV2;
-       } else if (prop->value() == X_("windows-vst")) {
+       } else if (str == X_("windows-vst")) {
                type = ARDOUR::Windows_VST;
-       } else if (prop->value() == X_("lxvst")) {
+       } else if (str == X_("lxvst")) {
                type = ARDOUR::LXVST;
-       } else if (prop->value() == X_("mac-vst")) {
+       } else if (str == X_("mac-vst")) {
                type = ARDOUR::MacVST;
-       } else if (prop->value() == X_("audiounit")) {
+       } else if (str == X_("audiounit")) {
                type = ARDOUR::AudioUnit;
-       } else if (prop->value() == X_("luaproc")) {
+       } else if (str == X_("luaproc")) {
                type = ARDOUR::Lua;
        } else {
-               error << string_compose (_("unknown plugin type %1 in plugin insert state"),
-                                 prop->value())
-                     << endmsg;
+               error << string_compose (_("unknown plugin type %1 in plugin insert state"), str) << endmsg;
                return -1;
        }
 
-       prop = node.property ("unique-id");
+       XMLProperty const * prop = node.property ("unique-id");
 
        if (prop == 0) {
 #ifdef WINDOWS_VST_SUPPORT
-               /* older sessions contain VST plugins with only an "id" field.
-                */
-
+               /* older sessions contain VST plugins with only an "id" field.  */
                if (type == ARDOUR::Windows_VST) {
                        prop = node.property ("id");
                }
@@ -2411,7 +2469,6 @@ PluginInsert::set_state(const XMLNode& node, int version)
 
 #ifdef LXVST_SUPPORT
                /*There shouldn't be any older sessions with linuxVST support.. but anyway..*/
-
                if (type == ARDOUR::LXVST) {
                        prop = node.property ("id");
                }
@@ -2427,24 +2484,24 @@ PluginInsert::set_state(const XMLNode& node, int version)
 
        boost::shared_ptr<Plugin> plugin = find_plugin (_session, prop->value(), type);
 
-       /* treat linux and windows VST plugins equivalent if they have the same uniqueID
+       /* treat VST plugins equivalent if they have the same uniqueID
         * allow to move sessions windows <> linux */
 #ifdef LXVST_SUPPORT
-       if (plugin == 0 && type == ARDOUR::Windows_VST) {
+       if (plugin == 0 && (type == ARDOUR::Windows_VST || type == ARDOUR::MacVST)) {
                type = ARDOUR::LXVST;
                plugin = find_plugin (_session, prop->value(), type);
        }
 #endif
 
 #ifdef WINDOWS_VST_SUPPORT
-       if (plugin == 0 && type == ARDOUR::LXVST) {
+       if (plugin == 0 && (type == ARDOUR::LXVST || type == ARDOUR::MacVST)) {
                type = ARDOUR::Windows_VST;
                plugin = find_plugin (_session, prop->value(), type);
        }
 #endif
 
 #ifdef MACVST_SUPPORT
-       if (plugin == 0 && type == ARDOUR::MacVST) {
+       if (plugin == 0 && (type == ARDOUR::Windows_VST || type == ARDOUR::LXVST)) {
                type = ARDOUR::MacVST;
                plugin = find_plugin (_session, prop->value(), type);
        }
@@ -2493,9 +2550,7 @@ PluginInsert::set_state(const XMLNode& node, int version)
                set_control_ids (node, version);
        }
 
-       if ((prop = node.property ("count")) != 0) {
-               sscanf (prop->value().c_str(), "%u", &count);
-       }
+       node.get_property ("count", count);
 
        if (_plugins.size() != count) {
                for (uint32_t n = 1; n < count; ++n) {
@@ -2508,9 +2563,7 @@ PluginInsert::set_state(const XMLNode& node, int version)
        PBD::ID new_id = this->id();
        PBD::ID old_id = this->id();
 
-       if ((prop = node.property ("id")) != 0) {
-               old_id = prop->value ();
-       }
+       node.get_property ("id", old_id);
 
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
@@ -2544,6 +2597,14 @@ PluginInsert::set_state(const XMLNode& node, int version)
                                }
                        }
 
+                       /* when copying plugin state, notify UI */
+                       for (Controls::const_iterator li = controls().begin(); li != controls().end(); ++li) {
+                               boost::shared_ptr<PBD::Controllable> c = boost::dynamic_pointer_cast<PBD::Controllable> (li->second);
+                               if (c) {
+                                       c->Changed (false, Controllable::NoGroup); /* EMIT SIGNAL */
+                               }
+                       }
+
                        break;
                }
        }
@@ -2565,9 +2626,7 @@ PluginInsert::set_state(const XMLNode& node, int version)
                set_parameter_state_2X (node, version);
        }
 
-       if ((prop = node.property (X_("custom"))) != 0) {
-               _custom_cfg = string_is_affirmative (prop->value());
-       }
+       node.get_property (X_("custom"), _custom_cfg);
 
        uint32_t in_maps = 0;
        uint32_t out_maps = 0;
@@ -2609,7 +2668,9 @@ PluginInsert::set_state(const XMLNode& node, int version)
                        if (!_sidechain) {
                                add_sidechain (0);
                        }
-                       _sidechain->set_state (**i, version);
+                       if (!regenerate_xml_or_string_ids ()) {
+                               _sidechain->set_state (**i, version);
+                       }
                }
        }
 
@@ -2669,10 +2730,8 @@ PluginInsert::set_parameter_state_2X (const XMLNode& node, int version)
                }
 
                XMLNodeList cnodes;
-               XMLProperty const * cprop;
                XMLNodeConstIterator iter;
                XMLNode *child;
-               const char *port;
                uint32_t port_id;
 
                cnodes = (*niter)->children ("port");
@@ -2681,15 +2740,11 @@ PluginInsert::set_parameter_state_2X (const XMLNode& node, int version)
 
                        child = *iter;
 
-                       if ((cprop = child->property("number")) != 0) {
-                               port = cprop->value().c_str();
-                       } else {
+                       if (!child->get_property("number", port_id)) {
                                warning << _("PluginInsert: Auto: no ladspa port number") << endmsg;
                                continue;
                        }
 
-                       sscanf (port, "%" PRIu32, &port_id);
-
                        if (port_id >= _plugins[0]->parameter_count()) {
                                warning << _("PluginInsert: Auto: port id out of range") << endmsg;
                                continue;
@@ -2737,6 +2792,16 @@ PluginInsert::set_parameter_state_2X (const XMLNode& node, int version)
        }
 }
 
+boost::shared_ptr<ReadOnlyControl>
+PluginInsert::control_output (uint32_t num) const
+{
+       CtrlOutMap::const_iterator i = _control_outputs.find (num);
+       if (i == _control_outputs.end ()) {
+               return boost::shared_ptr<ReadOnlyControl> ();
+       } else {
+               return (*i).second;
+       }
+}
 
 string
 PluginInsert::describe_parameter (Evoral::Parameter param)
@@ -2814,15 +2879,12 @@ PluginInsert::PluginControl::catch_up_with_external_value (double user_val)
 XMLNode&
 PluginInsert::PluginControl::get_state ()
 {
-       stringstream ss;
-
        XMLNode& node (AutomationControl::get_state());
-       ss << parameter().id();
-       node.add_property (X_("parameter"), ss.str());
+       node.set_property (X_("parameter"), parameter().id());
 #ifdef LV2_SUPPORT
        boost::shared_ptr<LV2Plugin> lv2plugin = boost::dynamic_pointer_cast<LV2Plugin> (_plugin->_plugins[0]);
        if (lv2plugin) {
-               node.add_property (X_("symbol"), lv2plugin->port_symbol (parameter().id()));
+               node.set_property (X_("symbol"), lv2plugin->port_symbol (parameter().id()));
        }
 #endif
 
@@ -2879,11 +2941,8 @@ PluginInsert::PluginPropertyControl::actually_set_value (double user_val, Contro
 XMLNode&
 PluginInsert::PluginPropertyControl::get_state ()
 {
-       stringstream ss;
-
        XMLNode& node (AutomationControl::get_state());
-       ss << parameter().id();
-       node.add_property (X_("property"), ss.str());
+       node.set_property (X_("property"), parameter().id());
        node.remove_property (X_("value"));
 
        return node;
@@ -2912,6 +2971,7 @@ PluginInsert::get_impulse_analysis_plugin()
                        assert (out == internal_output_streams ());
                }
                ret->configure_io (internal_input_streams (), out);
+               ret->set_owner (_owner);
                _impulseAnalysisPlugin = ret;
        } else {
                ret = _impulseAnalysisPlugin.lock();
@@ -3017,19 +3077,21 @@ PluginInsert::latency_changed ()
 void
 PluginInsert::start_touch (uint32_t param_id)
 {
-        boost::shared_ptr<AutomationControl> ac = automation_control (Evoral::Parameter (PluginAutomation, 0, param_id));
-        if (ac) {
-                ac->start_touch (session().audible_frame());
-        }
+       boost::shared_ptr<AutomationControl> ac = automation_control (Evoral::Parameter (PluginAutomation, 0, param_id));
+       if (ac) {
+               // ToDo subtract _plugin_signal_latency  from audible_frame() when rolling, assert > 0
+               ac->start_touch (session().audible_frame());
+       }
 }
 
 void
 PluginInsert::end_touch (uint32_t param_id)
 {
-        boost::shared_ptr<AutomationControl> ac = automation_control (Evoral::Parameter (PluginAutomation, 0, param_id));
-        if (ac) {
-                ac->stop_touch (true, session().audible_frame());
-        }
+       boost::shared_ptr<AutomationControl> ac = automation_control (Evoral::Parameter (PluginAutomation, 0, param_id));
+       if (ac) {
+               // ToDo subtract _plugin_signal_latency  from audible_frame() when rolling, assert > 0
+               ac->stop_touch (true, session().audible_frame());
+       }
 }
 
 std::ostream& operator<<(std::ostream& o, const ARDOUR::PluginInsert::Match& m)