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
166 return output_for_input_configuration(_configured_input);
168 return natural_output_streams();
172 PluginInsert::input_streams() const
175 return _configured_input;
177 return natural_input_streams();
181 PluginInsert::natural_output_streams() const
183 return _plugins[0]->get_info()->n_outputs;
187 PluginInsert::natural_input_streams() const
189 return _plugins[0]->get_info()->n_inputs;
193 PluginInsert::is_generator() const
195 /* XXX more finesse is possible here. VST plugins have a
196 a specific "instrument" flag, for example.
199 return _plugins[0]->get_info()->n_inputs.n_audio() == 0;
203 PluginInsert::set_automatable ()
205 set<Parameter> a = _plugins.front()->automatable ();
207 Plugin::ParameterDescriptor desc;
209 for (set<Parameter>::iterator i = a.begin(); i != a.end(); ++i) {
210 if (i->type() == PluginAutomation) {
212 _plugins.front()->get_parameter_descriptor(i->id(), desc);
213 boost::shared_ptr<AutomationList> list(new AutomationList(
215 //(desc.min_unbound ? FLT_MIN : desc.lower),
216 //(desc.max_unbound ? FLT_MAX : desc.upper),
217 desc.lower, desc.upper,
218 _plugins.front()->default_value(i->id())));
220 add_control(boost::shared_ptr<AutomationControl>(
221 new PluginControl(*this, list)));
227 PluginInsert::parameter_changed (Parameter which, float val)
229 if (which.type() != PluginAutomation)
232 vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin();
234 /* don't set the first plugin, just all the slaves */
236 if (i != _plugins.end()) {
238 for (; i != _plugins.end(); ++i) {
239 (*i)->set_parameter (which, val);
245 PluginInsert::set_block_size (nframes_t nframes)
247 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
248 (*i)->set_block_size (nframes);
253 PluginInsert::activate ()
255 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
261 PluginInsert::deactivate ()
263 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
269 PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now)
271 uint32_t in_index = 0;
272 uint32_t out_index = 0;
274 /* Note that we've already required that plugins
275 be able to handle in-place processing.
282 for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li, ++n) {
284 boost::shared_ptr<AutomationControl> c = li->second;
286 if (c->parameter().type() == PluginAutomation && c->list()->automation_playback()) {
289 const float val = c->list()->rt_safe_eval (now, valid);
299 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
300 (*i)->connect_and_run (bufs, in_index, out_index, nframes, offset);
303 /* leave remaining channel buffers alone */
307 PluginInsert::silence (nframes_t nframes, nframes_t offset)
309 uint32_t in_index = 0;
310 uint32_t out_index = 0;
313 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
314 (*i)->connect_and_run (_session.get_silent_buffers ((*i)->get_info()->n_inputs), in_index, out_index, nframes, offset);
320 PluginInsert::run_in_place (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset)
324 if (_session.transport_rolling()) {
325 automation_run (bufs, nframes, offset);
327 connect_and_run (bufs, nframes, offset, false);
331 /* FIXME: type, audio only */
333 uint32_t in = _plugins[0]->get_info()->n_inputs.n_audio();
334 uint32_t out = _plugins[0]->get_info()->n_outputs.n_audio();
338 /* not active, but something has make up for any channel count increase */
340 for (uint32_t n = out - in; n < out; ++n) {
341 memcpy (bufs.get_audio(n).data(nframes, offset), bufs.get_audio(in - 1).data(nframes, offset), sizeof (Sample) * nframes);
345 bufs.count().set_audio(out);
350 PluginInsert::set_parameter (Parameter param, float val)
352 if (param.type() != PluginAutomation)
355 /* the others will be set from the event triggered by this */
357 _plugins[0]->set_parameter (param.id(), val);
359 boost::shared_ptr<AutomationControl> c = control (param);
364 _session.set_dirty();
368 PluginInsert::get_parameter (Parameter param)
370 if (param.type() != PluginAutomation)
374 _plugins[0]->get_parameter (param.id());
378 PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes, nframes_t offset)
380 ControlEvent next_event (0, 0.0f);
381 nframes_t now = _session.transport_frame ();
382 nframes_t end = now + nframes;
384 Glib::Mutex::Lock lm (_automation_lock, Glib::TRY_LOCK);
387 connect_and_run (bufs, nframes, offset, false);
391 if (!find_next_event (now, end, next_event)) {
393 /* no events have a time within the relevant range */
395 connect_and_run (bufs, nframes, offset, true, now);
401 nframes_t cnt = min (((nframes_t) ceil (next_event.when) - now), nframes);
403 connect_and_run (bufs, cnt, offset, true, now);
409 if (!find_next_event (now, end, next_event)) {
414 /* cleanup anything that is left to do */
417 connect_and_run (bufs, nframes, offset, true, now);
422 PluginInsert::default_parameter_value (Parameter param)
424 if (param.type() != PluginAutomation)
427 if (_plugins.empty()) {
428 fatal << _("programming error: ") << X_("PluginInsert::default_parameter_value() called with no plugin")
433 return _plugins[0]->default_value (param.id());
436 boost::shared_ptr<Plugin>
437 PluginInsert::plugin_factory (boost::shared_ptr<Plugin> other)
439 boost::shared_ptr<LadspaPlugin> lp;
441 boost::shared_ptr<LV2Plugin> lv2p;
444 boost::shared_ptr<VSTPlugin> vp;
446 #ifdef HAVE_AUDIOUNITS
447 boost::shared_ptr<AUPlugin> ap;
450 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
451 return boost::shared_ptr<Plugin> (new LadspaPlugin (*lp));
453 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin> (other)) != 0) {
454 return boost::shared_ptr<Plugin> (new LV2Plugin (*lv2p));
457 } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
458 return boost::shared_ptr<Plugin> (new VSTPlugin (*vp));
460 #ifdef HAVE_AUDIOUNITS
461 } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
462 return boost::shared_ptr<Plugin> (new AUPlugin (*ap));
466 fatal << string_compose (_("programming error: %1"),
467 X_("unknown plugin type in PluginInsert::plugin_factory"))
470 return boost::shared_ptr<Plugin> ((Plugin*) 0);
474 PluginInsert::configure_io (ChanCount in, ChanCount out)
476 ChanCount matching_out = output_for_input_configuration(out);
477 if (matching_out != out) {
481 bool success = set_count (count_for_configuration(in, out));
483 Processor::configure_io(in, out);
489 PluginInsert::can_support_input_configuration (ChanCount in) const
491 ChanCount outputs = _plugins[0]->get_info()->n_outputs;
492 ChanCount inputs = _plugins[0]->get_info()->n_inputs;
494 /* see output_for_input_configuration below */
495 if ((inputs.n_total() == 0)
496 || (inputs.n_total() == 1 && outputs == inputs)
497 || (inputs.n_total() == 1 && outputs == inputs
498 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
499 || (inputs.n_midi() == 0 && in.n_midi() == 0)))
504 bool can_replicate = true;
506 /* if number of inputs is a factor of the requested input
507 configuration for every type, we can replicate.
509 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
510 if (inputs.get(*t) >= in.get(*t) || (inputs.get(*t) % in.get(*t) != 0)) {
511 can_replicate = false;
516 if (can_replicate && (in.n_total() % inputs.n_total() == 0)) {
524 PluginInsert::output_for_input_configuration (ChanCount in) const
526 ChanCount outputs = _plugins[0]->get_info()->n_outputs;
527 ChanCount inputs = _plugins[0]->get_info()->n_inputs;
529 if (inputs.n_total() == 0) {
530 /* instrument plugin, always legal, but throws away any existing streams */
534 if (inputs.n_total() == 1 && outputs == inputs
535 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
536 || (inputs.n_midi() == 0 && in.n_midi() == 0))) {
537 /* mono plugin, replicate as needed to match in */
546 bool can_replicate = true;
548 /* if number of inputs is a factor of the requested input
549 configuration for every type, we can replicate.
551 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
552 if (inputs.get(*t) >= in.get(*t) || (in.get(*t) % inputs.get(*t) != 0)) {
553 can_replicate = false;
558 if (can_replicate && (inputs.n_total() % in.n_total() == 0)) {
561 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
562 output.set(*t, outputs.get(*t) * (in.get(*t) / inputs.get(*t)));
572 /* Number of plugin instances required to support a given channel configuration.
576 PluginInsert::count_for_configuration (ChanCount in, ChanCount out) const
578 // FIXME: take 'out' into consideration
580 ChanCount outputs = _plugins[0]->get_info()->n_outputs;
581 ChanCount inputs = _plugins[0]->get_info()->n_inputs;
583 if (inputs.n_total() == 0) {
584 /* instrument plugin, always legal, but throws away any existing streams */
588 if (inputs.n_total() == 1 && outputs == inputs
589 && ((inputs.n_audio() == 0 && in.n_audio() == 0)
590 || (inputs.n_midi() == 0 && in.n_midi() == 0))) {
591 /* mono plugin, replicate as needed to match in */
600 // assumes in is valid, so we must be replicating
601 if (inputs.n_total() < in.n_total()
602 && (in.n_total() % inputs.n_total() == 0)) {
604 return in.n_total() / inputs.n_total();
612 PluginInsert::get_state(void)
618 PluginInsert::state (bool full)
620 XMLNode& node = Processor::state (full);
622 node.add_property ("type", _plugins[0]->state_node_name());
623 node.add_property("unique-id", _plugins[0]->unique_id());
624 node.add_property("count", string_compose("%1", _plugins.size()));
625 node.add_child_nocopy (_plugins[0]->get_state());
627 /* add port automation state */
628 XMLNode *autonode = new XMLNode(port_automation_node_name);
629 set<Parameter> automatable = _plugins[0]->automatable();
631 for (set<Parameter>::iterator x = automatable.begin(); x != automatable.end(); ++x) {
633 /*XMLNode* child = new XMLNode("port");
634 snprintf(buf, sizeof(buf), "%" PRIu32, *x);
635 child->add_property("number", string(buf));
637 child->add_child_nocopy (automation_list (*x).state (full));
638 autonode->add_child_nocopy (*child);
640 autonode->add_child_nocopy (control(*x)->list()->state (full));
643 node.add_child_nocopy (*autonode);
649 PluginInsert::set_state(const XMLNode& node)
651 XMLNodeList nlist = node.children();
652 XMLNodeIterator niter;
653 XMLPropertyList plist;
654 const XMLProperty *prop;
655 ARDOUR::PluginType type;
657 if ((prop = node.property ("type")) == 0) {
658 error << _("XML node describing insert is missing the `type' field") << endmsg;
662 if (prop->value() == X_("ladspa") || prop->value() == X_("Ladspa")) { /* handle old school sessions */
663 type = ARDOUR::LADSPA;
664 } else if (prop->value() == X_("lv2")) {
666 } else if (prop->value() == X_("vst")) {
669 error << string_compose (_("unknown plugin type %1 in plugin insert state"),
675 prop = node.property ("unique-id");
677 error << _("Plugin has no unique ID field") << endmsg;
681 boost::shared_ptr<Plugin> plugin;
683 plugin = find_plugin (_session, prop->value(), type);
686 error << string_compose(_("Found a reference to a plugin (\"%1\") that is unknown.\n"
687 "Perhaps it was removed or moved since it was last used."), prop->value())
694 if ((prop = node.property ("count")) != 0) {
695 sscanf (prop->value().c_str(), "%u", &count);
698 if (_plugins.size() != count) {
700 _plugins.push_back (plugin);
702 for (uint32_t n=1; n < count; ++n) {
703 _plugins.push_back (plugin_factory (plugin));
707 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
708 if ((*niter)->name() == plugin->state_node_name()) {
709 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
710 (*i)->set_state (**niter);
716 const XMLNode* insert_node = &node;
718 // legacy sessions: search for child IOProcessor node
719 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
720 if ((*niter)->name() == "IOProcessor") {
721 insert_node = *niter;
726 Processor::set_state (*insert_node);
728 /* look for port automation node */
730 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
732 if ((*niter)->name() != port_automation_node_name) {
738 XMLNodeConstIterator iter;
743 cnodes = (*niter)->children ("port");
745 for(iter = cnodes.begin(); iter != cnodes.end(); ++iter){
749 if ((cprop = child->property("number")) != 0) {
750 port = cprop->value().c_str();
752 warning << _("PluginInsert: Auto: no ladspa port number") << endmsg;
756 sscanf (port, "%" PRIu32, &port_id);
758 if (port_id >= _plugins[0]->parameter_count()) {
759 warning << _("PluginInsert: Auto: port id out of range") << endmsg;
763 if (!child->children().empty()) {
764 control (Parameter(PluginAutomation, port_id), true)->list()->set_state (*child->children().front());
766 if ((cprop = child->property("auto")) != 0) {
771 sscanf (cprop->value().c_str(), "0x%x", &x);
772 control (Parameter(PluginAutomation, port_id), true)->list()->set_automation_state (AutoState (x));
778 control (Parameter(PluginAutomation, port_id), true)->list()->set_automation_state (Off);
789 if (niter == nlist.end()) {
790 warning << string_compose(_("XML node describing a port automation is missing the `%1' information"), port_automation_node_name) << endmsg;
793 // The name of the PluginInsert comes from the plugin, nothing else
794 _name = plugin->get_info()->name;
800 PluginInsert::describe_parameter (Parameter param)
802 if (param.type() != PluginAutomation)
803 return Automatable::describe_parameter(param);
805 return _plugins[0]->describe_parameter (param);
809 PluginInsert::signal_latency() const
812 return _user_latency;
815 return _plugins[0]->signal_latency ();
819 PluginInsert::type ()
821 boost::shared_ptr<LadspaPlugin> lp;
823 boost::shared_ptr<VSTPlugin> vp;
825 #ifdef HAVE_AUDIOUNITS
826 boost::shared_ptr<AUPlugin> ap;
829 PluginPtr other = plugin ();
831 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
832 return ARDOUR::LADSPA;
834 } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
837 #ifdef HAVE_AUDIOUNITS
838 } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
839 return ARDOUR::AudioUnit;
843 return (ARDOUR::PluginType) 0;
847 PluginInsert::PluginControl::PluginControl (PluginInsert& p, boost::shared_ptr<AutomationList> list)
848 : AutomationControl (p.session(), list, p.describe_parameter(list->parameter()))
852 Plugin::ParameterDescriptor desc;
853 p.plugin(0)->get_parameter_descriptor (list->parameter().id(), desc);
854 _logarithmic = desc.logarithmic;
855 _toggled = desc.toggled;
859 PluginInsert::PluginControl::set_value (float val)
861 /* FIXME: probably should be taking out some lock here.. */
871 /*const float range = _list->get_max_y() - _list->get_min_y();
872 const float lower = _list->get_min_y();
875 val = lower + (range * val);
877 float log_lower = 0.0f;
879 log_lower = log(lower);
882 val = exp(log_lower + log(range) * val);
887 for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugin._plugins.begin();
888 i != _plugin._plugins.end(); ++i) {
889 (*i)->set_parameter (_list->parameter().id(), val);
892 AutomationControl::set_value(val);
896 PluginInsert::PluginControl::get_value (void) const
898 /* FIXME: probably should be taking out some lock here.. */
900 float val = _plugin.get_parameter (_list->parameter());
914 return ((val - lower) / range);