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_event.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();
83 // set_automatable ();
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 (Parameter which)
152 if (which.type() != PluginAutomation)
155 boost::shared_ptr<AutomationControl> c = control (which);
157 if (c && c->list()->automation_state() != Off) {
158 _plugins[0]->set_parameter (which.id(), c->list()->eval (_session.transport_frame()));
163 PluginInsert::output_streams() const
165 ChanCount out = _plugins.front()->get_info()->n_outputs;
167 if (out == ChanCount::INFINITE) {
169 return _plugins.front()->output_streams ();
173 out.set_audio (out.n_audio() * _plugins.size());
174 out.set_midi (out.n_midi() * _plugins.size());
181 PluginInsert::input_streams() const
183 ChanCount in = _plugins[0]->get_info()->n_inputs;
185 if (in == ChanCount::INFINITE) {
186 return _plugins[0]->input_streams ();
188 in.set_audio (in.n_audio() * _plugins.size());
189 in.set_midi (in.n_midi() * _plugins.size());
196 PluginInsert::natural_output_streams() const
198 return _plugins[0]->get_info()->n_outputs;
202 PluginInsert::natural_input_streams() const
204 return _plugins[0]->get_info()->n_inputs;
208 PluginInsert::is_generator() const
210 /* XXX more finesse is possible here. VST plugins have a
211 a specific "instrument" flag, for example.
214 return _plugins[0]->get_info()->n_inputs.n_audio() == 0;
218 PluginInsert::set_automatable ()
220 set<Parameter> a = _plugins.front()->automatable ();
222 Plugin::ParameterDescriptor desc;
224 for (set<Parameter>::iterator i = a.begin(); i != a.end(); ++i) {
225 if (i->type() == PluginAutomation) {
227 _plugins.front()->get_parameter_descriptor(i->id(), desc);
228 boost::shared_ptr<AutomationList> list(new AutomationList(
230 //(desc.min_unbound ? FLT_MIN : desc.lower),
231 //(desc.max_unbound ? FLT_MAX : desc.upper),
232 desc.lower, desc.upper,
233 _plugins.front()->default_value(i->id())));
235 add_control(boost::shared_ptr<AutomationControl>(
236 new PluginControl(*this, list)));
242 PluginInsert::parameter_changed (Parameter which, float val)
244 if (which.type() != PluginAutomation)
247 vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin();
249 /* don't set the first plugin, just all the slaves */
251 if (i != _plugins.end()) {
253 for (; i != _plugins.end(); ++i) {
254 (*i)->set_parameter (which, val);
260 PluginInsert::set_block_size (nframes_t nframes)
262 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
263 (*i)->set_block_size (nframes);
268 PluginInsert::activate ()
270 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
276 PluginInsert::deactivate ()
278 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
284 PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now)
286 uint32_t in_index = 0;
287 uint32_t out_index = 0;
289 /* Note that we've already required that plugins
290 be able to handle in-place processing.
297 for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li, ++n) {
299 boost::shared_ptr<AutomationControl> c = li->second;
301 if (c->parameter().type() == PluginAutomation && c->list()->automation_playback()) {
304 const float val = c->list()->rt_safe_eval (now, valid);
314 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
315 (*i)->connect_and_run (bufs, in_index, out_index, nframes, offset);
318 /* leave remaining channel buffers alone */
322 PluginInsert::silence (nframes_t nframes, nframes_t offset)
324 uint32_t in_index = 0;
325 uint32_t out_index = 0;
328 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
329 (*i)->connect_and_run (_session.get_silent_buffers ((*i)->get_info()->n_inputs), in_index, out_index, nframes, offset);
335 PluginInsert::run_in_place (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset)
339 if (_session.transport_rolling()) {
340 automation_run (bufs, nframes, offset);
342 connect_and_run (bufs, nframes, offset, false);
346 /* FIXME: type, audio only */
348 uint32_t in = _plugins[0]->get_info()->n_inputs.n_audio();
349 uint32_t out = _plugins[0]->get_info()->n_outputs.n_audio();
353 /* not active, but something has make up for any channel count increase */
355 for (uint32_t n = out - in; n < out; ++n) {
356 memcpy (bufs.get_audio(n).data(nframes, offset), bufs.get_audio(in - 1).data(nframes, offset), sizeof (Sample) * nframes);
360 bufs.count().set_audio(out);
365 PluginInsert::set_parameter (Parameter param, float val)
367 if (param.type() != PluginAutomation)
370 /* the others will be set from the event triggered by this */
372 _plugins[0]->set_parameter (param.id(), val);
374 boost::shared_ptr<AutomationControl> c = control (param);
379 _session.set_dirty();
383 PluginInsert::get_parameter (Parameter param)
385 if (param.type() != PluginAutomation)
389 _plugins[0]->get_parameter (param.id());
393 PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes, nframes_t offset)
395 ControlEvent next_event (0, 0.0f);
396 nframes_t now = _session.transport_frame ();
397 nframes_t end = now + nframes;
399 Glib::Mutex::Lock lm (_automation_lock, Glib::TRY_LOCK);
402 connect_and_run (bufs, nframes, offset, false);
406 if (!find_next_event (now, end, next_event)) {
408 /* no events have a time within the relevant range */
410 connect_and_run (bufs, nframes, offset, true, now);
416 nframes_t cnt = min (((nframes_t) ceil (next_event.when) - now), nframes);
418 connect_and_run (bufs, cnt, offset, true, now);
424 if (!find_next_event (now, end, next_event)) {
429 /* cleanup anything that is left to do */
432 connect_and_run (bufs, nframes, offset, true, now);
437 PluginInsert::default_parameter_value (Parameter param)
439 if (param.type() != PluginAutomation)
442 if (_plugins.empty()) {
443 fatal << _("programming error: ") << X_("PluginInsert::default_parameter_value() called with no plugin")
448 return _plugins[0]->default_value (param.id());
451 boost::shared_ptr<Plugin>
452 PluginInsert::plugin_factory (boost::shared_ptr<Plugin> other)
454 boost::shared_ptr<LadspaPlugin> lp;
456 boost::shared_ptr<LV2Plugin> lv2p;
459 boost::shared_ptr<VSTPlugin> vp;
461 #ifdef HAVE_AUDIOUNITS
462 boost::shared_ptr<AUPlugin> ap;
465 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
466 return boost::shared_ptr<Plugin> (new LadspaPlugin (*lp));
468 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin> (other)) != 0) {
469 return boost::shared_ptr<Plugin> (new LV2Plugin (*lv2p));
472 } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
473 return boost::shared_ptr<Plugin> (new VSTPlugin (*vp));
475 #ifdef HAVE_AUDIOUNITS
476 } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
477 return boost::shared_ptr<Plugin> (new AUPlugin (*ap));
481 fatal << string_compose (_("programming error: %1"),
482 X_("unknown plugin type in PluginInsert::plugin_factory"))
485 return boost::shared_ptr<Plugin> ((Plugin*) 0);
489 PluginInsert::configure_io (ChanCount in, ChanCount out)
491 if (set_count (count_for_configuration (in, out)) < 0) {
495 /* if we're running replicated plugins, each plugin has
496 the same i/o configuration and we may need to announce how many
497 output streams there are.
499 if we running a single plugin, we need to configure it.
502 if (_plugins.front()->configure_io (in, out) < 0) {
506 return Processor::configure_io (in, out);
510 PluginInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
512 if (_plugins.front()->reconfigurable_io()) {
513 /* plugin has flexible I/O, so delegate to it */
514 return _plugins.front()->can_support_io_configuration (in, out);
517 ChanCount outputs = _plugins[0]->get_info()->n_outputs;
518 ChanCount inputs = _plugins[0]->get_info()->n_inputs;
520 if ((inputs.n_total() == 0)
521 || (inputs.n_total() == 1 && outputs == inputs)
522 || (inputs.n_total() == 1 && outputs == inputs
523 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
524 || (inputs.n_midi() == 0 && in.n_midi() == 0)))
530 bool can_replicate = true;
532 /* if number of inputs is a factor of the requested input
533 configuration for every type, we can replicate.
535 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
536 if (inputs.get(*t) >= in.get(*t) || (inputs.get(*t) % in.get(*t) != 0)) {
537 can_replicate = false;
542 if (!can_replicate || (in.n_total() % inputs.n_total() != 0)) {
546 if (inputs.n_total() == 0) {
547 /* instrument plugin, always legal, but throws away any existing streams */
549 } else if (inputs.n_total() == 1 && outputs == inputs
550 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
551 || (inputs.n_midi() == 0 && in.n_midi() == 0))) {
552 /* mono, single-typed plugin, replicate as needed to match in */
554 } else if (inputs == in) {
558 /* replicate - note that we've already verified that
559 the replication count is constant across all data types.
561 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
562 out.set (*t, outputs.get(*t) * (in.get(*t) / inputs.get(*t)));
569 /* Number of plugin instances required to support a given channel configuration.
573 PluginInsert::count_for_configuration (ChanCount in, ChanCount out) const
575 if (_plugins.front()->reconfigurable_io()) {
576 /* plugin has flexible I/O, so the answer is always 1 */
577 /* this could change if we ever decide to replicate AU's */
581 // FIXME: take 'out' into consideration
583 ChanCount outputs = _plugins[0]->get_info()->n_outputs;
584 ChanCount inputs = _plugins[0]->get_info()->n_inputs;
586 if (inputs.n_total() == 0) {
587 /* instrument plugin, always legal, but throws away any existing streams */
591 if (inputs.n_total() == 1 && outputs == inputs
592 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
593 || (inputs.n_midi() == 0 && in.n_midi() == 0))) {
594 /* mono plugin, replicate as needed to match in */
603 // assumes in is valid, so we must be replicating
604 if (inputs.n_total() < in.n_total()
605 && (in.n_total() % inputs.n_total() == 0)) {
607 return in.n_total() / inputs.n_total();
615 PluginInsert::get_state(void)
621 PluginInsert::state (bool full)
623 XMLNode& node = Processor::state (full);
625 node.add_property ("type", _plugins[0]->state_node_name());
626 node.add_property("unique-id", _plugins[0]->unique_id());
627 node.add_property("count", string_compose("%1", _plugins.size()));
628 node.add_child_nocopy (_plugins[0]->get_state());
630 /* add port automation state */
631 XMLNode *autonode = new XMLNode(port_automation_node_name);
632 set<Parameter> automatable = _plugins[0]->automatable();
634 for (set<Parameter>::iterator x = automatable.begin(); x != automatable.end(); ++x) {
636 /*XMLNode* child = new XMLNode("port");
637 snprintf(buf, sizeof(buf), "%" PRIu32, *x);
638 child->add_property("number", string(buf));
640 child->add_child_nocopy (automation_list (*x).state (full));
641 autonode->add_child_nocopy (*child);
643 autonode->add_child_nocopy (control(*x)->list()->state (full));
646 node.add_child_nocopy (*autonode);
652 PluginInsert::set_state(const XMLNode& node)
654 XMLNodeList nlist = node.children();
655 XMLNodeIterator niter;
656 XMLPropertyList plist;
657 const XMLProperty *prop;
658 ARDOUR::PluginType type;
660 if ((prop = node.property ("type")) == 0) {
661 error << _("XML node describing insert is missing the `type' field") << endmsg;
665 if (prop->value() == X_("ladspa") || prop->value() == X_("Ladspa")) { /* handle old school sessions */
666 type = ARDOUR::LADSPA;
667 } else if (prop->value() == X_("lv2")) {
669 } else if (prop->value() == X_("vst")) {
672 error << string_compose (_("unknown plugin type %1 in plugin insert state"),
678 prop = node.property ("unique-id");
680 error << _("Plugin has no unique ID field") << endmsg;
684 boost::shared_ptr<Plugin> plugin;
686 plugin = find_plugin (_session, prop->value(), type);
689 error << string_compose(_("Found a reference to a plugin (\"%1\") that is unknown.\n"
690 "Perhaps it was removed or moved since it was last used."), prop->value())
697 if ((prop = node.property ("count")) != 0) {
698 sscanf (prop->value().c_str(), "%u", &count);
701 if (_plugins.size() != count) {
703 _plugins.push_back (plugin);
705 for (uint32_t n=1; n < count; ++n) {
706 _plugins.push_back (plugin_factory (plugin));
710 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
711 if ((*niter)->name() == plugin->state_node_name()) {
712 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
713 (*i)->set_state (**niter);
719 const XMLNode* insert_node = &node;
721 // legacy sessions: search for child IOProcessor node
722 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
723 if ((*niter)->name() == "IOProcessor") {
724 insert_node = *niter;
729 Processor::set_state (*insert_node);
731 /* look for port automation node */
733 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
735 if ((*niter)->name() != port_automation_node_name) {
741 XMLNodeConstIterator iter;
746 cnodes = (*niter)->children ("port");
748 for(iter = cnodes.begin(); iter != cnodes.end(); ++iter){
752 if ((cprop = child->property("number")) != 0) {
753 port = cprop->value().c_str();
755 warning << _("PluginInsert: Auto: no ladspa port number") << endmsg;
759 sscanf (port, "%" PRIu32, &port_id);
761 if (port_id >= _plugins[0]->parameter_count()) {
762 warning << _("PluginInsert: Auto: port id out of range") << endmsg;
766 if (!child->children().empty()) {
767 control (Parameter(PluginAutomation, port_id), true)->list()->set_state (*child->children().front());
769 if ((cprop = child->property("auto")) != 0) {
774 sscanf (cprop->value().c_str(), "0x%x", &x);
775 control (Parameter(PluginAutomation, port_id), true)->list()->set_automation_state (AutoState (x));
781 control (Parameter(PluginAutomation, port_id), true)->list()->set_automation_state (Off);
792 if (niter == nlist.end()) {
793 warning << string_compose(_("XML node describing a port automation is missing the `%1' information"), port_automation_node_name) << endmsg;
796 // The name of the PluginInsert comes from the plugin, nothing else
797 _name = plugin->get_info()->name;
803 PluginInsert::describe_parameter (Parameter param)
805 if (param.type() != PluginAutomation)
806 return Automatable::describe_parameter(param);
808 return _plugins[0]->describe_parameter (param);
812 PluginInsert::signal_latency() const
815 return _user_latency;
818 return _plugins[0]->signal_latency ();
822 PluginInsert::type ()
824 boost::shared_ptr<LadspaPlugin> lp;
826 boost::shared_ptr<VSTPlugin> vp;
828 #ifdef HAVE_AUDIOUNITS
829 boost::shared_ptr<AUPlugin> ap;
832 PluginPtr other = plugin ();
834 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
835 return ARDOUR::LADSPA;
837 } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
840 #ifdef HAVE_AUDIOUNITS
841 } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
842 return ARDOUR::AudioUnit;
846 return (ARDOUR::PluginType) 0;
850 PluginInsert::PluginControl::PluginControl (PluginInsert& p, boost::shared_ptr<AutomationList> list)
851 : AutomationControl (p.session(), list, p.describe_parameter(list->parameter()))
855 Plugin::ParameterDescriptor desc;
856 p.plugin(0)->get_parameter_descriptor (list->parameter().id(), desc);
857 _logarithmic = desc.logarithmic;
858 _toggled = desc.toggled;
862 PluginInsert::PluginControl::set_value (float val)
864 /* FIXME: probably should be taking out some lock here.. */
874 /*const float range = _list->get_max_y() - _list->get_min_y();
875 const float lower = _list->get_min_y();
878 val = lower + (range * val);
880 float log_lower = 0.0f;
882 log_lower = log(lower);
885 val = exp(log_lower + log(range) * val);
890 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugin._plugins.begin();
891 i != _plugin._plugins.end(); ++i) {
892 (*i)->set_parameter (_list->parameter().id(), val);
895 AutomationControl::set_value(val);
899 PluginInsert::PluginControl::get_value (void) const
901 /* FIXME: probably should be taking out some lock here.. */
903 float val = _plugin.get_parameter (_list->parameter());
917 return ((val - lower) / range);