2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <sigc++/bind.h>
24 #include <pbd/failed_constructor.h>
25 #include <pbd/xml++.h>
27 #include <ardour/plugin_insert.h>
28 #include <ardour/plugin.h>
29 #include <ardour/port.h>
30 #include <ardour/route.h>
31 #include <ardour/ladspa_plugin.h>
32 #include <ardour/buffer_set.h>
33 #include <ardour/automation_list.h>
36 #include <ardour/lv2_plugin.h>
40 #include <ardour/vst_plugin.h>
43 #ifdef HAVE_AUDIOUNITS
44 #include <ardour/audio_unit.h>
47 #include <ardour/audioengine.h>
48 #include <ardour/session.h>
49 #include <ardour/types.h>
54 using namespace ARDOUR;
57 const string PluginInsert::port_automation_node_name = "PortAutomation";
59 PluginInsert::PluginInsert (Session& s, boost::shared_ptr<Plugin> plug, Placement placement)
60 : Processor (s, plug->name(), placement)
62 /* the first is the master */
64 _plugins.push_back (plug);
69 Glib::Mutex::Lock em (_session.engine().process_lock());
70 IO::PortCountChanged (max(input_streams(), output_streams()));
73 ProcessorCreated (this); /* EMIT SIGNAL */
76 PluginInsert::PluginInsert (Session& s, const XMLNode& node)
77 : Processor (s, "unnamed plugin insert", PreFader)
79 if (set_state (node)) {
80 throw failed_constructor();
86 Glib::Mutex::Lock em (_session.engine().process_lock());
87 IO::PortCountChanged (max(input_streams(), output_streams()));
91 PluginInsert::PluginInsert (const PluginInsert& other)
92 : Processor (other._session, other._name, other.placement())
94 uint32_t count = other._plugins.size();
96 /* make as many copies as requested */
97 for (uint32_t n = 0; n < count; ++n) {
98 _plugins.push_back (plugin_factory (other.plugin (n)));
103 ProcessorCreated (this); /* EMIT SIGNAL */
107 PluginInsert::set_count (uint32_t num)
109 bool require_state = !_plugins.empty();
111 /* this is a bad idea.... we shouldn't do this while active.
112 only a route holding their redirect_lock should be calling this
117 } else if (num > _plugins.size()) {
118 uint32_t diff = num - _plugins.size();
120 for (uint32_t n = 0; n < diff; ++n) {
121 _plugins.push_back (plugin_factory (_plugins[0]));
124 /* XXX do something */
128 } else if (num < _plugins.size()) {
129 uint32_t diff = _plugins.size() - num;
130 for (uint32_t n= 0; n < diff; ++n) {
139 PluginInsert::init ()
144 PluginInsert::~PluginInsert ()
146 GoingAway (); /* EMIT SIGNAL */
150 PluginInsert::auto_state_changed (Evoral::Parameter which)
152 if (which.type() != PluginAutomation)
155 boost::shared_ptr<AutomationControl> c
156 = boost::dynamic_pointer_cast<AutomationControl>(data().control (which));
158 if (c && ((AutomationList*)c->list().get())->automation_state() != Off) {
159 _plugins[0]->set_parameter (which.id(), c->list()->eval (_session.transport_frame()));
164 PluginInsert::output_streams() const
166 ChanCount out = _plugins.front()->get_info()->n_outputs;
168 if (out == ChanCount::INFINITE) {
170 return _plugins.front()->output_streams ();
174 out.set_audio (out.n_audio() * _plugins.size());
175 out.set_midi (out.n_midi() * _plugins.size());
182 PluginInsert::input_streams() const
184 ChanCount in = _plugins[0]->get_info()->n_inputs;
186 if (in == ChanCount::INFINITE) {
187 return _plugins[0]->input_streams ();
189 in.set_audio (in.n_audio() * _plugins.size());
190 in.set_midi (in.n_midi() * _plugins.size());
197 PluginInsert::natural_output_streams() const
199 return _plugins[0]->get_info()->n_outputs;
203 PluginInsert::natural_input_streams() const
205 return _plugins[0]->get_info()->n_inputs;
209 PluginInsert::is_generator() const
211 /* XXX more finesse is possible here. VST plugins have a
212 a specific "instrument" flag, for example.
215 return _plugins[0]->get_info()->n_inputs.n_audio() == 0;
219 PluginInsert::set_automatable ()
221 set<Evoral::Parameter> a = _plugins.front()->automatable ();
223 Plugin::ParameterDescriptor desc;
225 for (set<Evoral::Parameter>::iterator i = a.begin(); i != a.end(); ++i) {
226 if (i->type() == PluginAutomation) {
228 _plugins.front()->get_parameter_descriptor(i->id(), desc);
229 Evoral::Parameter param(*i);
230 param.set_range(desc.lower, desc.upper, _plugins.front()->default_value(i->id()));
231 boost::shared_ptr<AutomationList> list(new AutomationList(param));
232 add_control(boost::shared_ptr<AutomationControl>(new PluginControl(this, *i, list)));
238 PluginInsert::parameter_changed (Evoral::Parameter which, float val)
240 if (which.type() != PluginAutomation)
243 vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin();
245 /* don't set the first plugin, just all the slaves */
247 if (i != _plugins.end()) {
249 for (; i != _plugins.end(); ++i) {
250 (*i)->set_parameter (which, val);
256 PluginInsert::set_block_size (nframes_t nframes)
258 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
259 (*i)->set_block_size (nframes);
264 PluginInsert::activate ()
266 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
272 PluginInsert::deactivate ()
274 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
280 PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now)
282 uint32_t in_index = 0;
283 uint32_t out_index = 0;
285 /* Note that we've already required that plugins
286 be able to handle in-place processing.
293 for (Controls::iterator li = data().controls().begin(); li != data().controls().end(); ++li, ++n) {
295 boost::shared_ptr<AutomationControl> c
296 = boost::dynamic_pointer_cast<AutomationControl>(li->second);
298 if (c->parameter().type() == PluginAutomation && c->automation_playback()) {
301 const float val = c->list()->rt_safe_eval (now, valid);
311 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
312 (*i)->connect_and_run (bufs, in_index, out_index, nframes, offset);
315 /* leave remaining channel buffers alone */
319 PluginInsert::silence (nframes_t nframes, nframes_t offset)
321 uint32_t in_index = 0;
322 uint32_t out_index = 0;
325 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
326 (*i)->connect_and_run (_session.get_silent_buffers ((*i)->get_info()->n_inputs), in_index, out_index, nframes, offset);
332 PluginInsert::run_in_place (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset)
336 if (_session.transport_rolling()) {
337 automation_run (bufs, nframes, offset);
339 connect_and_run (bufs, nframes, offset, false);
343 /* FIXME: type, audio only */
345 uint32_t in = _plugins[0]->get_info()->n_inputs.n_audio();
346 uint32_t out = _plugins[0]->get_info()->n_outputs.n_audio();
350 /* not active, but something has make up for any channel count increase */
352 for (uint32_t n = out - in; n < out; ++n) {
353 memcpy (bufs.get_audio(n).data(nframes, offset), bufs.get_audio(in - 1).data(nframes, offset), sizeof (Sample) * nframes);
357 bufs.count().set_audio(out);
362 PluginInsert::set_parameter (Evoral::Parameter param, float val)
364 if (param.type() != PluginAutomation)
367 /* the others will be set from the event triggered by this */
369 _plugins[0]->set_parameter (param.id(), val);
371 boost::shared_ptr<AutomationControl> ac
372 = boost::dynamic_pointer_cast<AutomationControl>(data().control(param));
377 warning << "set_parameter called for nonexistant parameter "
378 << EventTypeMap::instance().to_symbol(param) << endmsg;
381 _session.set_dirty();
385 PluginInsert::get_parameter (Evoral::Parameter param)
387 if (param.type() != PluginAutomation)
391 _plugins[0]->get_parameter (param.id());
395 PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes, nframes_t offset)
397 Evoral::ControlEvent next_event (0, 0.0f);
398 nframes_t now = _session.transport_frame ();
399 nframes_t end = now + nframes;
401 Glib::Mutex::Lock lm (data().control_lock(), Glib::TRY_LOCK);
404 connect_and_run (bufs, nframes, offset, false);
408 if (!data().find_next_event (now, end, next_event)) {
410 /* no events have a time within the relevant range */
412 connect_and_run (bufs, nframes, offset, true, now);
418 nframes_t cnt = min (((nframes_t) ceil (next_event.when) - now), nframes);
420 connect_and_run (bufs, cnt, offset, true, now);
426 if (!data().find_next_event (now, end, next_event)) {
431 /* cleanup anything that is left to do */
434 connect_and_run (bufs, nframes, offset, true, now);
439 PluginInsert::default_parameter_value (const Evoral::Parameter& param)
441 if (param.type() != PluginAutomation)
444 if (_plugins.empty()) {
445 fatal << _("programming error: ") << X_("PluginInsert::default_parameter_value() called with no plugin")
450 return _plugins[0]->default_value (param.id());
453 boost::shared_ptr<Plugin>
454 PluginInsert::plugin_factory (boost::shared_ptr<Plugin> other)
456 boost::shared_ptr<LadspaPlugin> lp;
458 boost::shared_ptr<LV2Plugin> lv2p;
461 boost::shared_ptr<VSTPlugin> vp;
463 #ifdef HAVE_AUDIOUNITS
464 boost::shared_ptr<AUPlugin> ap;
467 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
468 return boost::shared_ptr<Plugin> (new LadspaPlugin (*lp));
470 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin> (other)) != 0) {
471 return boost::shared_ptr<Plugin> (new LV2Plugin (*lv2p));
474 } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
475 return boost::shared_ptr<Plugin> (new VSTPlugin (*vp));
477 #ifdef HAVE_AUDIOUNITS
478 } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
479 return boost::shared_ptr<Plugin> (new AUPlugin (*ap));
483 fatal << string_compose (_("programming error: %1"),
484 X_("unknown plugin type in PluginInsert::plugin_factory"))
487 return boost::shared_ptr<Plugin> ((Plugin*) 0);
491 PluginInsert::configure_io (ChanCount in, ChanCount out)
493 if (set_count (count_for_configuration (in, out)) < 0) {
497 /* if we're running replicated plugins, each plugin has
498 the same i/o configuration and we may need to announce how many
499 output streams there are.
501 if we running a single plugin, we need to configure it.
504 if (_plugins.front()->configure_io (in, out) < 0) {
508 return Processor::configure_io (in, out);
512 PluginInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
514 if (_plugins.front()->reconfigurable_io()) {
515 /* plugin has flexible I/O, so delegate to it */
516 return _plugins.front()->can_support_io_configuration (in, out);
519 ChanCount outputs = _plugins[0]->get_info()->n_outputs;
520 ChanCount inputs = _plugins[0]->get_info()->n_inputs;
522 if ((inputs.n_total() == 0)
523 || (inputs.n_total() == 1 && outputs == inputs)
524 || (inputs.n_total() == 1 && outputs == inputs
525 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
526 || (inputs.n_midi() == 0 && in.n_midi() == 0)))
532 bool can_replicate = true;
534 /* if number of inputs is a factor of the requested input
535 configuration for every type, we can replicate.
537 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
538 if (inputs.get(*t) >= in.get(*t) || (inputs.get(*t) % in.get(*t) != 0)) {
539 can_replicate = false;
544 if (!can_replicate || (in.n_total() % inputs.n_total() != 0)) {
548 if (inputs.n_total() == 0) {
549 /* instrument plugin, always legal, but throws away any existing streams */
551 } else if (inputs.n_total() == 1 && outputs == inputs
552 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
553 || (inputs.n_midi() == 0 && in.n_midi() == 0))) {
554 /* mono, single-typed plugin, replicate as needed to match in */
556 } else if (inputs == in) {
560 /* replicate - note that we've already verified that
561 the replication count is constant across all data types.
563 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
564 out.set (*t, outputs.get(*t) * (in.get(*t) / inputs.get(*t)));
571 /* Number of plugin instances required to support a given channel configuration.
575 PluginInsert::count_for_configuration (ChanCount in, ChanCount out) const
577 if (_plugins.front()->reconfigurable_io()) {
578 /* plugin has flexible I/O, so the answer is always 1 */
579 /* this could change if we ever decide to replicate AU's */
583 // FIXME: take 'out' into consideration
585 ChanCount outputs = _plugins[0]->get_info()->n_outputs;
586 ChanCount inputs = _plugins[0]->get_info()->n_inputs;
588 if (inputs.n_total() == 0) {
589 /* instrument plugin, always legal, but throws away any existing streams */
593 if (inputs.n_total() == 1 && outputs == inputs
594 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
595 || (inputs.n_midi() == 0 && in.n_midi() == 0))) {
596 /* mono plugin, replicate as needed to match in */
605 // assumes in is valid, so we must be replicating
606 if (inputs.n_total() < in.n_total()
607 && (in.n_total() % inputs.n_total() == 0)) {
609 return in.n_total() / inputs.n_total();
617 PluginInsert::get_state(void)
623 PluginInsert::state (bool full)
625 XMLNode& node = Processor::state (full);
627 node.add_property ("type", _plugins[0]->state_node_name());
628 node.add_property("unique-id", _plugins[0]->unique_id());
629 node.add_property("count", string_compose("%1", _plugins.size()));
630 node.add_child_nocopy (_plugins[0]->get_state());
632 /* add port automation state */
633 XMLNode *autonode = new XMLNode(port_automation_node_name);
634 set<Evoral::Parameter> automatable = _plugins[0]->automatable();
636 for (set<Evoral::Parameter>::iterator x = automatable.begin(); x != automatable.end(); ++x) {
638 /*XMLNode* child = new XMLNode("port");
639 snprintf(buf, sizeof(buf), "%" PRIu32, *x);
640 child->add_property("number", string(buf));
642 child->add_child_nocopy (automation_list (*x).state (full));
643 autonode->add_child_nocopy (*child);
645 autonode->add_child_nocopy (((AutomationList*)data().control(*x)->list().get())->state (full));
648 node.add_child_nocopy (*autonode);
654 PluginInsert::set_state(const XMLNode& node)
656 XMLNodeList nlist = node.children();
657 XMLNodeIterator niter;
658 XMLPropertyList plist;
659 const XMLProperty *prop;
660 ARDOUR::PluginType type;
662 if ((prop = node.property ("type")) == 0) {
663 error << _("XML node describing insert is missing the `type' field") << endmsg;
667 if (prop->value() == X_("ladspa") || prop->value() == X_("Ladspa")) { /* handle old school sessions */
668 type = ARDOUR::LADSPA;
669 } else if (prop->value() == X_("lv2")) {
671 } else if (prop->value() == X_("vst")) {
674 error << string_compose (_("unknown plugin type %1 in plugin insert state"),
680 prop = node.property ("unique-id");
682 error << _("Plugin has no unique ID field") << endmsg;
686 boost::shared_ptr<Plugin> plugin;
688 plugin = find_plugin (_session, prop->value(), type);
691 error << string_compose(_("Found a reference to a plugin (\"%1\") that is unknown.\n"
692 "Perhaps it was removed or moved since it was last used."), prop->value())
699 if ((prop = node.property ("count")) != 0) {
700 sscanf (prop->value().c_str(), "%u", &count);
703 if (_plugins.size() != count) {
705 _plugins.push_back (plugin);
707 for (uint32_t n=1; n < count; ++n) {
708 _plugins.push_back (plugin_factory (plugin));
712 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
713 if ((*niter)->name() == plugin->state_node_name()) {
714 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
715 (*i)->set_state (**niter);
721 const XMLNode* insert_node = &node;
723 // legacy sessions: search for child IOProcessor node
724 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
725 if ((*niter)->name() == "IOProcessor") {
726 insert_node = *niter;
731 Processor::set_state (*insert_node);
733 /* look for port automation node */
735 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
737 if ((*niter)->name() != port_automation_node_name) {
743 XMLNodeConstIterator iter;
748 cnodes = (*niter)->children ("port");
750 for(iter = cnodes.begin(); iter != cnodes.end(); ++iter){
754 if ((cprop = child->property("number")) != 0) {
755 port = cprop->value().c_str();
757 warning << _("PluginInsert: Auto: no ladspa port number") << endmsg;
761 sscanf (port, "%" PRIu32, &port_id);
763 if (port_id >= _plugins[0]->parameter_count()) {
764 warning << _("PluginInsert: Auto: port id out of range") << endmsg;
768 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(
769 data().control(Evoral::Parameter(PluginAutomation, port_id), true));
771 if (!child->children().empty()) {
772 c->alist()->set_state (*child->children().front());
774 if ((cprop = child->property("auto")) != 0) {
779 sscanf (cprop->value().c_str(), "0x%x", &x);
780 c->alist()->set_automation_state (AutoState (x));
786 c->alist()->set_automation_state (Off);
797 if (niter == nlist.end()) {
798 warning << string_compose(_("XML node describing a port automation is missing the `%1' information"), port_automation_node_name) << endmsg;
801 // The name of the PluginInsert comes from the plugin, nothing else
802 _name = plugin->get_info()->name;
808 PluginInsert::describe_parameter (Evoral::Parameter param)
810 if (param.type() != PluginAutomation)
811 return Automatable::describe_parameter(param);
813 return _plugins[0]->describe_parameter (param);
817 PluginInsert::signal_latency() const
820 return _user_latency;
823 return _plugins[0]->signal_latency ();
827 PluginInsert::type ()
829 boost::shared_ptr<LadspaPlugin> lp;
831 boost::shared_ptr<VSTPlugin> vp;
833 #ifdef HAVE_AUDIOUNITS
834 boost::shared_ptr<AUPlugin> ap;
837 PluginPtr other = plugin ();
839 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
840 return ARDOUR::LADSPA;
842 } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
845 #ifdef HAVE_AUDIOUNITS
846 } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
847 return ARDOUR::AudioUnit;
851 return (ARDOUR::PluginType) 0;
855 PluginInsert::PluginControl::PluginControl (PluginInsert* p, const Evoral::Parameter ¶m, boost::shared_ptr<AutomationList> list)
856 : AutomationControl (p->session(), param, list, p->describe_parameter(param))
859 Plugin::ParameterDescriptor desc;
860 p->plugin(0)->get_parameter_descriptor (param.id(), desc);
861 _logarithmic = desc.logarithmic;
862 _toggled = desc.toggled;
866 PluginInsert::PluginControl::set_value (float val)
868 /* FIXME: probably should be taking out some lock here.. */
878 /*const float range = _list->get_max_y() - _list->get_min_y();
879 const float lower = _list->get_min_y();
882 val = lower + (range * val);
884 float log_lower = 0.0f;
886 log_lower = log(lower);
889 val = exp(log_lower + log(range) * val);
894 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugin->_plugins.begin();
895 i != _plugin->_plugins.end(); ++i) {
896 (*i)->set_parameter (_list->parameter().id(), val);
899 AutomationControl::set_value(val);
903 PluginInsert::PluginControl::get_value (void) const
905 /* FIXME: probably should be taking out some lock here.. */
907 float val = _plugin->get_parameter (_list->parameter());
921 return ((val - lower) / range);