431 lines
12 KiB
C++
431 lines
12 KiB
C++
/*
|
|
* Copyright (C) 2022 Robin Gareus <robin@gareus.org>
|
|
*
|
|
* 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.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#include "ardour/plug_insert_base.h"
|
|
#include "ardour/ardour.h"
|
|
#include "ardour/automation_control.h"
|
|
#include "ardour/ladspa_plugin.h"
|
|
#include "ardour/luaproc.h"
|
|
#include "ardour/lv2_plugin.h"
|
|
|
|
#ifdef WINDOWS_VST_SUPPORT
|
|
#include "ardour/windows_vst_plugin.h"
|
|
#endif
|
|
|
|
#ifdef LXVST_SUPPORT
|
|
#include "ardour/lxvst_plugin.h"
|
|
#endif
|
|
|
|
#ifdef MACVST_SUPPORT
|
|
#include "ardour/mac_vst_plugin.h"
|
|
#endif
|
|
|
|
#ifdef VST3_SUPPORT
|
|
#include "ardour/vst3_plugin.h"
|
|
#endif
|
|
|
|
#ifdef AUDIOUNIT_SUPPORT
|
|
#include "ardour/audio_unit.h"
|
|
#endif
|
|
|
|
#include "pbd/i18n.h"
|
|
|
|
using namespace PBD;
|
|
using namespace ARDOUR;
|
|
|
|
bool
|
|
PlugInsertBase::parse_plugin_type (XMLNode const& node, PluginType& type, std::string& id) const
|
|
{
|
|
std::string str;
|
|
if (!node.get_property ("type", str)) {
|
|
error << _("XML node describing plugin is missing the `type' field") << endmsg;
|
|
return false;
|
|
}
|
|
|
|
if (str == X_("ladspa") || str == X_("Ladspa")) { /* handle old school sessions */
|
|
type = ARDOUR::LADSPA;
|
|
} else if (str == X_("lv2")) {
|
|
type = ARDOUR::LV2;
|
|
} else if (str == X_("windows-vst")) {
|
|
type = ARDOUR::Windows_VST;
|
|
} else if (str == X_("lxvst")) {
|
|
type = ARDOUR::LXVST;
|
|
} else if (str == X_("mac-vst")) {
|
|
type = ARDOUR::MacVST;
|
|
} else if (str == X_("audiounit")) {
|
|
type = ARDOUR::AudioUnit;
|
|
} else if (str == X_("luaproc")) {
|
|
type = ARDOUR::Lua;
|
|
} else if (str == X_("vst3")) {
|
|
type = ARDOUR::VST3;
|
|
} else {
|
|
error << string_compose (_("unknown plugin type %1 in plugin insert state"), str) << endmsg;
|
|
return false;
|
|
}
|
|
|
|
XMLProperty const* prop = node.property ("unique-id");
|
|
|
|
if (prop == 0) {
|
|
#ifdef WINDOWS_VST_SUPPORT
|
|
/* older sessions contain VST plugins with only an "id" field. */
|
|
if (type == ARDOUR::Windows_VST) {
|
|
prop = node.property ("id");
|
|
}
|
|
#endif
|
|
|
|
#ifdef LXVST_SUPPORT
|
|
/*There shouldn't be any older sessions with linuxVST support.. but anyway..*/
|
|
if (type == ARDOUR::LXVST) {
|
|
prop = node.property ("id");
|
|
}
|
|
#endif
|
|
|
|
/* recheck */
|
|
if (prop == 0) {
|
|
error << _("Plugin has no unique ID field") << endmsg;
|
|
return false;
|
|
}
|
|
}
|
|
|
|
id = prop->value();
|
|
return true;
|
|
}
|
|
|
|
std::shared_ptr<Plugin>
|
|
PlugInsertBase::find_and_load_plugin (Session& s, XMLNode const& node, PluginType& type, std::string const& unique_id, bool& any_vst)
|
|
{
|
|
/* Find and load plugin module */
|
|
std::shared_ptr<Plugin> plugin = find_plugin (s, unique_id, type);
|
|
|
|
/* 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 || type == ARDOUR::MacVST)) {
|
|
type = ARDOUR::LXVST;
|
|
plugin = find_plugin (s, unique_id, type);
|
|
if (plugin) {
|
|
any_vst = true;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
#ifdef WINDOWS_VST_SUPPORT
|
|
if (plugin == 0 && (type == ARDOUR::LXVST || type == ARDOUR::MacVST)) {
|
|
type = ARDOUR::Windows_VST;
|
|
plugin = find_plugin (s, unique_id, type);
|
|
if (plugin) { any_vst = true; }
|
|
}
|
|
#endif
|
|
|
|
#ifdef MACVST_SUPPORT
|
|
if (plugin == 0 && (type == ARDOUR::Windows_VST || type == ARDOUR::LXVST)) {
|
|
type = ARDOUR::MacVST;
|
|
plugin = find_plugin (s, unique_id, type);
|
|
if (plugin) { any_vst = true; }
|
|
}
|
|
#endif
|
|
|
|
if (plugin == 0 && type == ARDOUR::Lua) {
|
|
/* unique ID (sha1 of script) was not found,
|
|
* load the plugin from the serialized version in the
|
|
* session-file instead.
|
|
*/
|
|
std::shared_ptr<LuaProc> lp (new LuaProc (s.engine(), s, ""));
|
|
XMLNode *ls = node.child (lp->state_node_name().c_str());
|
|
if (ls && lp) {
|
|
if (0 == lp->set_script_from_state (*ls)) {
|
|
plugin = lp;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (plugin == 0) {
|
|
error << string_compose(
|
|
_("Found a reference to a plugin (\"%1\") that is unknown.\n"
|
|
"Perhaps it was removed or moved since it was last used."),
|
|
unique_id)
|
|
<< endmsg;
|
|
return std::shared_ptr<Plugin> ();
|
|
}
|
|
return plugin;
|
|
}
|
|
|
|
void
|
|
PlugInsertBase::set_control_ids (const XMLNode& node, int version, bool by_value)
|
|
{
|
|
const XMLNodeList& nlist = node.children();
|
|
for (XMLNodeConstIterator iter = nlist.begin(); iter != nlist.end(); ++iter) {
|
|
if ((*iter)->name() != Controllable::xml_node_name) {
|
|
continue;
|
|
}
|
|
|
|
uint32_t p = (uint32_t)-1;
|
|
std::string str;
|
|
if ((*iter)->get_property (X_("symbol"), str)) {
|
|
std::shared_ptr<LV2Plugin> lv2plugin = std::dynamic_pointer_cast<LV2Plugin> (plugin ());
|
|
if (lv2plugin) {
|
|
p = lv2plugin->port_index(str.c_str());
|
|
}
|
|
}
|
|
if (p == (uint32_t)-1) {
|
|
(*iter)->get_property (X_("parameter"), p);
|
|
}
|
|
|
|
if (p == (uint32_t)-1) {
|
|
continue;
|
|
}
|
|
|
|
std::shared_ptr<Evoral::Control> c = control (Evoral::Parameter (PluginAutomation, 0, p));
|
|
if (!c) {
|
|
continue;
|
|
}
|
|
std::shared_ptr<AutomationControl> ac = std::dynamic_pointer_cast<AutomationControl> (c);
|
|
if (!ac) {
|
|
continue;
|
|
}
|
|
|
|
if (by_value) {
|
|
float val;
|
|
if ((*iter)->get_property (X_("value"), val)) {
|
|
ac->set_value (val, Controllable::NoGroup);
|
|
}
|
|
} else {
|
|
ac->set_state (**iter, version);
|
|
}
|
|
}
|
|
}
|
|
|
|
void
|
|
PlugInsertBase::preset_load_set_value (uint32_t p, float v)
|
|
{
|
|
std::shared_ptr<AutomationControl> ac = std::dynamic_pointer_cast<AutomationControl> (Evoral::ControlSet::control (Evoral::Parameter(PluginAutomation, 0, p), false));
|
|
if (!ac) {
|
|
return;
|
|
}
|
|
|
|
if (ac->automation_state() & Play) {
|
|
return;
|
|
}
|
|
|
|
ac->start_touch (timepos_t (ac->session ().audible_sample()));
|
|
ac->set_value (v, Controllable::NoGroup);
|
|
ac->stop_touch (timepos_t (ac->session ().audible_sample()));
|
|
}
|
|
|
|
/* ****************************************************************************/
|
|
|
|
std::shared_ptr<Plugin>
|
|
PlugInsertBase::plugin_factory (std::shared_ptr<Plugin> other)
|
|
{
|
|
std::shared_ptr<LadspaPlugin> lp;
|
|
std::shared_ptr<LuaProc> lua;
|
|
std::shared_ptr<LV2Plugin> lv2p;
|
|
#ifdef WINDOWS_VST_SUPPORT
|
|
std::shared_ptr<WindowsVSTPlugin> vp;
|
|
#endif
|
|
#ifdef LXVST_SUPPORT
|
|
std::shared_ptr<LXVSTPlugin> lxvp;
|
|
#endif
|
|
#ifdef MACVST_SUPPORT
|
|
std::shared_ptr<MacVSTPlugin> mvp;
|
|
#endif
|
|
#ifdef VST3_SUPPORT
|
|
std::shared_ptr<VST3Plugin> vst3;
|
|
#endif
|
|
#ifdef AUDIOUNIT_SUPPORT
|
|
std::shared_ptr<AUPlugin> ap;
|
|
#endif
|
|
|
|
if ((lp = std::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new LadspaPlugin (*lp));
|
|
} else if ((lua = std::dynamic_pointer_cast<LuaProc> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new LuaProc (*lua));
|
|
} else if ((lv2p = std::dynamic_pointer_cast<LV2Plugin> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new LV2Plugin (*lv2p));
|
|
#ifdef WINDOWS_VST_SUPPORT
|
|
} else if ((vp = std::dynamic_pointer_cast<WindowsVSTPlugin> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new WindowsVSTPlugin (*vp));
|
|
#endif
|
|
#ifdef LXVST_SUPPORT
|
|
} else if ((lxvp = std::dynamic_pointer_cast<LXVSTPlugin> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new LXVSTPlugin (*lxvp));
|
|
#endif
|
|
#ifdef MACVST_SUPPORT
|
|
} else if ((mvp = std::dynamic_pointer_cast<MacVSTPlugin> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new MacVSTPlugin (*mvp));
|
|
#endif
|
|
#ifdef VST3_SUPPORT
|
|
} else if ((vst3 = std::dynamic_pointer_cast<VST3Plugin> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new VST3Plugin (*vst3));
|
|
#endif
|
|
#ifdef AUDIOUNIT_SUPPORT
|
|
} else if ((ap = std::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
|
|
return std::shared_ptr<Plugin> (new AUPlugin (*ap));
|
|
#endif
|
|
}
|
|
|
|
fatal << string_compose (_("programming error: %1"),
|
|
X_("unknown plugin type in PlugInsertBase::plugin_factory"))
|
|
<< endmsg;
|
|
abort(); /*NOTREACHED*/
|
|
return std::shared_ptr<Plugin> ((Plugin*) 0);
|
|
}
|
|
|
|
/* ****************************************************************************/
|
|
|
|
PlugInsertBase::PluginControl::PluginControl (Session& s,
|
|
PlugInsertBase* p,
|
|
const Evoral::Parameter& param,
|
|
const ParameterDescriptor& desc,
|
|
std::shared_ptr<AutomationList> list)
|
|
: AutomationControl (s, param, desc, list, p->describe_parameter (param))
|
|
, _pib (p)
|
|
{
|
|
if (alist ()) {
|
|
if (desc.toggled) {
|
|
list->set_interpolation (Evoral::ControlList::Discrete);
|
|
}
|
|
}
|
|
}
|
|
|
|
/** @param val `user' value */
|
|
|
|
void
|
|
PlugInsertBase::PluginControl::actually_set_value (double user_val, PBD::Controllable::GroupControlDisposition group_override)
|
|
{
|
|
for (uint32_t i = 0; i < _pib->get_count (); ++i) {
|
|
_pib->plugin (i)->set_parameter (parameter ().id (), user_val, 0);
|
|
}
|
|
|
|
AutomationControl::actually_set_value (user_val, group_override);
|
|
}
|
|
|
|
void
|
|
PlugInsertBase::PluginControl::catch_up_with_external_value (double user_val)
|
|
{
|
|
AutomationControl::actually_set_value (user_val, Controllable::NoGroup);
|
|
}
|
|
|
|
XMLNode&
|
|
PlugInsertBase::PluginControl::get_state () const
|
|
{
|
|
XMLNode& node (AutomationControl::get_state ());
|
|
node.set_property (X_("parameter"), parameter ().id ());
|
|
|
|
std::shared_ptr<LV2Plugin> lv2plugin = std::dynamic_pointer_cast<LV2Plugin> (_pib->plugin (0));
|
|
if (lv2plugin) {
|
|
node.set_property (X_("symbol"), lv2plugin->port_symbol (parameter ().id ()));
|
|
}
|
|
|
|
return node;
|
|
}
|
|
|
|
/** @return `user' val */
|
|
double
|
|
PlugInsertBase::PluginControl::get_value () const
|
|
{
|
|
std::shared_ptr<Plugin> plugin = _pib->plugin ();
|
|
|
|
if (!plugin) {
|
|
return 0.0;
|
|
}
|
|
|
|
return plugin->get_parameter (parameter ().id ());
|
|
}
|
|
|
|
std::string
|
|
PlugInsertBase::PluginControl::get_user_string () const
|
|
{
|
|
std::shared_ptr<Plugin> plugin = _pib->plugin ();
|
|
if (plugin) {
|
|
std::string pp;
|
|
if (plugin->print_parameter (parameter ().id (), pp) && pp.size () > 0) {
|
|
return pp;
|
|
}
|
|
}
|
|
return AutomationControl::get_user_string ();
|
|
}
|
|
|
|
PlugInsertBase::PluginPropertyControl::PluginPropertyControl (Session& s,
|
|
PlugInsertBase* p,
|
|
const Evoral::Parameter& param,
|
|
const ParameterDescriptor& desc,
|
|
std::shared_ptr<AutomationList> list)
|
|
: AutomationControl (s, param, desc, list)
|
|
, _pib (p)
|
|
{
|
|
}
|
|
|
|
void
|
|
PlugInsertBase::PluginPropertyControl::actually_set_value (double user_val, Controllable::GroupControlDisposition gcd)
|
|
{
|
|
/* Old numeric set_value(), coerce to appropriate datatype if possible.
|
|
* This is lossy, but better than nothing until Ardour's automation system
|
|
* can handle various datatypes all the way down.
|
|
*/
|
|
const Variant value (_desc.datatype, user_val);
|
|
if (value.type () == Variant::NOTHING) {
|
|
error << "set_value(double) called for non-numeric property" << endmsg;
|
|
return;
|
|
}
|
|
|
|
for (uint32_t i = 0; i < _pib->get_count (); ++i) {
|
|
_pib->plugin (i)->set_property (parameter ().id (), value);
|
|
}
|
|
|
|
_value = value;
|
|
|
|
AutomationControl::actually_set_value (user_val, gcd);
|
|
}
|
|
|
|
XMLNode&
|
|
PlugInsertBase::PluginPropertyControl::get_state () const
|
|
{
|
|
XMLNode& node (AutomationControl::get_state ());
|
|
node.set_property (X_("property"), parameter ().id ());
|
|
node.remove_property (X_("value"));
|
|
return node;
|
|
}
|
|
|
|
double
|
|
PlugInsertBase::PluginPropertyControl::get_value () const
|
|
{
|
|
return _value.to_double ();
|
|
}
|
|
|
|
std::ostream& operator<<(std::ostream& o, const ARDOUR::PlugInsertBase::Match& m)
|
|
{
|
|
switch (m.method) {
|
|
case PlugInsertBase::Impossible: o << "Impossible"; break;
|
|
case PlugInsertBase::Delegate: o << "Delegate"; break;
|
|
case PlugInsertBase::NoInputs: o << "NoInputs"; break;
|
|
case PlugInsertBase::ExactMatch: o << "ExactMatch"; break;
|
|
case PlugInsertBase::Replicate: o << "Replicate"; break;
|
|
case PlugInsertBase::Split: o << "Split"; break;
|
|
case PlugInsertBase::Hide: o << "Hide"; break;
|
|
}
|
|
o << " cnt: " << m.plugins
|
|
<< (m.strict_io ? " strict-io" : "")
|
|
<< (m.custom_cfg ? " custom-cfg" : "");
|
|
if (m.method == PlugInsertBase::Hide) {
|
|
o << " hide: " << m.hide;
|
|
}
|
|
o << "\n";
|
|
return o;
|
|
}
|