2 Copyright (C) 2000-2006 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.
26 #include <cstdio> // so libraptor doesn't complain
34 #include "pbd/compose.h"
35 #include "pbd/error.h"
36 #include "pbd/xml++.h"
38 #include "midi++/manager.h"
40 #include "ardour/ardour.h"
41 #include "ardour/session.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/ladspa_plugin.h"
44 #include "ardour/buffer_set.h"
45 #include "ardour/audio_buffer.h"
47 #include "pbd/stl_delete.h"
53 using namespace ARDOUR;
56 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, framecnt_t rate)
59 init (mod, index, rate);
62 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
65 init (other._module, other._index, other._sample_rate);
67 for (uint32_t i = 0; i < parameter_count(); ++i) {
68 _control_data[i] = other._shadow_data[i];
69 _shadow_data[i] = other._shadow_data[i];
74 LadspaPlugin::init (void *mod, uint32_t index, framecnt_t rate)
76 LADSPA_Descriptor_Function dfunc;
83 _latency_control_port = 0;
84 _was_activated = false;
86 dfunc = (LADSPA_Descriptor_Function) dlsym (_module, "ladspa_descriptor");
88 if ((errstr = dlerror()) != NULL) {
89 error << _("LADSPA: module has no descriptor function.") << endmsg;
90 throw failed_constructor();
93 if ((_descriptor = dfunc (index)) == 0) {
94 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
95 throw failed_constructor();
100 if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
101 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
102 throw failed_constructor();
107 if (_descriptor->instantiate == 0) {
108 throw failed_constructor();
111 if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
112 throw failed_constructor();
115 port_cnt = parameter_count();
117 _control_data = new LADSPA_Data[port_cnt];
118 _shadow_data = new LADSPA_Data[port_cnt];
120 for (i = 0; i < port_cnt; ++i) {
121 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
122 connect_port (i, &_control_data[i]);
124 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
125 strcmp (port_names()[i], X_("latency")) == 0) {
126 _latency_control_port = &_control_data[i];
127 *_latency_control_port = 0;
130 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
134 _shadow_data[i] = default_value (i);
138 latency_compute_run ();
141 LadspaPlugin::~LadspaPlugin ()
146 /* XXX who should close a plugin? */
150 delete [] _control_data;
151 delete [] _shadow_data;
155 LadspaPlugin::unique_id() const
158 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
163 LadspaPlugin::default_value (uint32_t port)
165 const LADSPA_PortRangeHint *prh = port_range_hints();
167 bool bounds_given = false;
168 bool sr_scaling = false;
169 bool earlier_hint = false;
171 /* defaults - case 1 */
173 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
174 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
175 ret = prh[port].LowerBound;
180 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
181 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
182 ret = exp(log(prh[port].LowerBound) * 0.75f + log(prh[port].UpperBound) * 0.25f);
185 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
190 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
191 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
192 ret = exp(log(prh[port].LowerBound) * 0.5f + log(prh[port].UpperBound) * 0.5f);
195 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
200 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
201 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
202 ret = exp(log(prh[port].LowerBound) * 0.25f + log(prh[port].UpperBound) * 0.75f);
205 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
210 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
211 ret = prh[port].UpperBound;
215 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
219 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
223 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
227 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
237 /* defaults - case 2 */
238 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
239 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
241 if (prh[port].LowerBound < 0) {
244 ret = prh[port].LowerBound;
251 /* defaults - case 3 */
252 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
253 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
255 if (prh[port].UpperBound > 0) {
258 ret = prh[port].UpperBound;
265 /* defaults - case 4 */
266 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
267 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
269 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
271 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
272 ret = prh[port].UpperBound;
274 ret = prh[port].LowerBound;
280 /* defaults - case 5 */
282 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
296 LadspaPlugin::set_parameter (uint32_t which, float val)
298 if (which < _descriptor->PortCount) {
299 _shadow_data[which] = (LADSPA_Data) val;
301 ParameterChanged (Parameter(PluginAutomation, 0, which), val); /* EMIT SIGNAL */
303 if (which < parameter_count() && controls[which]) {
304 controls[which]->Changed ();
309 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
310 "indicate a change in the plugin design, and presets may be"
317 LadspaPlugin::get_parameter (uint32_t which) const
319 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
320 return (float) _shadow_data[which];
322 return (float) _control_data[which];
327 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
333 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
334 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
345 LadspaPlugin::get_state()
347 XMLNode *root = new XMLNode(state_node_name());
350 LocaleGuard lg (X_("POSIX"));
352 for (uint32_t i = 0; i < parameter_count(); ++i){
354 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
355 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
357 child = new XMLNode("Port");
358 snprintf(buf, sizeof(buf), "%u", i);
359 child->add_property("number", string(buf));
360 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
361 child->add_property("value", string(buf));
362 root->add_child_nocopy (*child);
370 LadspaPlugin::save_preset (string name)
372 return Plugin::save_preset (name, "ladspa");
376 LadspaPlugin::remove_preset (string name)
378 return Plugin::remove_preset (name, "ladspa");
382 LadspaPlugin::set_state (const XMLNode& node, int version)
384 if (version < 3000) {
385 return set_state_2X (node, version);
390 XMLNodeConstIterator iter;
395 LocaleGuard lg (X_("POSIX"));
397 if (node.name() != state_node_name()) {
398 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
402 nodes = node.children ("Port");
404 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
408 if ((prop = child->property("number")) != 0) {
409 port = prop->value().c_str();
411 warning << _("LADSPA: no ladspa port number") << endmsg;
414 if ((prop = child->property("value")) != 0) {
415 data = prop->value().c_str();
417 warning << _("LADSPA: no ladspa port data") << endmsg;
421 sscanf (port, "%" PRIu32, &port_id);
422 set_parameter (port_id, atof(data));
425 latency_compute_run ();
431 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
435 XMLNodeConstIterator iter;
440 LocaleGuard lg (X_("POSIX"));
442 if (node.name() != state_node_name()) {
443 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
447 nodes = node.children ("port");
449 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
453 if ((prop = child->property("number")) != 0) {
454 port = prop->value().c_str();
456 warning << _("LADSPA: no ladspa port number") << endmsg;
459 if ((prop = child->property("value")) != 0) {
460 data = prop->value().c_str();
462 warning << _("LADSPA: no ladspa port data") << endmsg;
466 sscanf (port, "%" PRIu32, &port_id);
467 set_parameter (port_id, atof(data));
470 latency_compute_run ();
476 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
478 LADSPA_PortRangeHint prh;
480 prh = port_range_hints()[which];
483 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
484 desc.min_unbound = false;
485 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
486 desc.lower = prh.LowerBound * _session.frame_rate();
488 desc.lower = prh.LowerBound;
491 desc.min_unbound = true;
496 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
497 desc.max_unbound = false;
498 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
499 desc.upper = prh.UpperBound * _session.frame_rate();
501 desc.upper = prh.UpperBound;
504 desc.max_unbound = true;
505 desc.upper = 4; /* completely arbitrary */
508 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
510 desc.smallstep = 0.1;
511 desc.largestep = 10.0;
513 float delta = desc.upper - desc.lower;
514 desc.step = delta / 1000.0f;
515 desc.smallstep = delta / 10000.0f;
516 desc.largestep = delta/10.0f;
519 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
520 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
521 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
522 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
524 desc.label = port_names()[which];
530 LadspaPlugin::describe_parameter (Evoral::Parameter which)
532 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
533 return port_names()[which.id()];
540 LadspaPlugin::signal_latency () const
543 return _user_latency;
546 if (_latency_control_port) {
547 return (framecnt_t) floor (*_latency_control_port);
553 set<Evoral::Parameter>
554 LadspaPlugin::automatable () const
556 set<Evoral::Parameter> ret;
558 for (uint32_t i = 0; i < parameter_count(); ++i){
559 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
560 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
562 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
570 LadspaPlugin::connect_and_run (BufferSet& bufs,
571 ChanMapping in_map, ChanMapping out_map,
572 pframes_t nframes, framecnt_t offset)
575 cycles_t then = get_cycles ();
577 uint32_t audio_in_index = 0;
578 uint32_t audio_out_index = 0;
579 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
580 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
581 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
582 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
583 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
584 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
585 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
586 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
591 run_in_place (nframes);
593 set_cycles ((uint32_t) (now - then));
599 LadspaPlugin::parameter_is_control (uint32_t param) const
601 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
605 LadspaPlugin::parameter_is_audio (uint32_t param) const
607 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
611 LadspaPlugin::parameter_is_output (uint32_t param) const
613 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
617 LadspaPlugin::parameter_is_input (uint32_t param) const
619 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
623 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
626 if (param < parameter_count()) {
627 snprintf (buf, len, "%.3f", get_parameter (param));
635 LadspaPlugin::run_in_place (pframes_t nframes)
637 for (uint32_t i = 0; i < parameter_count(); ++i) {
638 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
639 _control_data[i] = _shadow_data[i];
643 assert (_was_activated);
645 _descriptor->run (_handle, nframes);
649 LadspaPlugin::latency_compute_run ()
651 if (!_latency_control_port) {
655 /* we need to run the plugin so that it can set its latency
661 uint32_t port_index = 0;
662 uint32_t in_index = 0;
663 uint32_t out_index = 0;
664 const framecnt_t bufsize = 1024;
665 LADSPA_Data buffer[bufsize];
667 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
669 /* Note that we've already required that plugins
670 be able to handle in-place processing.
675 while (port_index < parameter_count()) {
676 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
677 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
678 connect_port (port_index, buffer);
680 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
681 connect_port (port_index, buffer);
688 run_in_place (bufsize);
693 LadspaPluginInfo::load (Session& session)
699 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
700 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
701 error << dlerror() << endmsg;
702 return PluginPtr ((Plugin*) 0);
704 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
707 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
711 catch (failed_constructor &err) {
712 return PluginPtr ((Plugin*) 0);
716 LadspaPluginInfo::LadspaPluginInfo()
718 type = ARDOUR::LADSPA;