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.
24 #include <cstdio> // so libraptor doesn't complain
32 #include <pbd/compose.h>
33 #include <pbd/error.h>
34 #include <pbd/pathscanner.h>
35 #include <pbd/xml++.h>
37 #include <midi++/manager.h>
39 #include <ardour/ardour.h>
40 #include <ardour/session.h>
41 #include <ardour/audioengine.h>
42 #include <ardour/ladspa_plugin.h>
44 #include <pbd/stl_delete.h>
50 using namespace ARDOUR;
53 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, nframes_t rate)
56 init (mod, index, rate);
59 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
62 init (other._module, other._index, other._sample_rate);
64 for (uint32_t i = 0; i < parameter_count(); ++i) {
65 _control_data[i] = other._shadow_data[i];
66 _shadow_data[i] = other._shadow_data[i];
71 LadspaPlugin::init (void *mod, uint32_t index, nframes_t rate)
73 LADSPA_Descriptor_Function dfunc;
80 _latency_control_port = 0;
81 _was_activated = false;
83 dfunc = (LADSPA_Descriptor_Function) dlsym (_module, "ladspa_descriptor");
85 if ((errstr = dlerror()) != NULL) {
86 error << _("LADSPA: module has no descriptor function.") << endmsg;
87 throw failed_constructor();
90 if ((_descriptor = dfunc (index)) == 0) {
91 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
92 throw failed_constructor();
97 if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
98 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
99 throw failed_constructor();
104 if (_descriptor->instantiate == 0) {
105 throw failed_constructor();
108 if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
109 throw failed_constructor();
112 port_cnt = parameter_count();
114 _control_data = new LADSPA_Data[port_cnt];
115 _shadow_data = new LADSPA_Data[port_cnt];
117 for (i = 0; i < port_cnt; ++i) {
118 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
119 connect_port (i, &_control_data[i]);
121 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
122 strcmp (port_names()[i], X_("latency")) == 0) {
123 _latency_control_port = &_control_data[i];
124 *_latency_control_port = 0;
127 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
131 _shadow_data[i] = default_value (i);
135 Plugin::setup_controls ();
137 latency_compute_run ();
140 LadspaPlugin::~LadspaPlugin ()
145 GoingAway (); /* EMIT SIGNAL */
147 /* XXX who should close a plugin? */
152 delete [] _control_data;
156 delete [] _shadow_data;
161 LadspaPlugin::unique_id() const
164 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
170 LadspaPlugin::default_value (uint32_t port)
172 const LADSPA_PortRangeHint *prh = port_range_hints();
174 bool bounds_given = false;
175 bool sr_scaling = false;
176 bool earlier_hint = false;
178 /* defaults - case 1 */
180 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
181 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
182 ret = prh[port].LowerBound;
187 /* FIXME: add support for logarithmic defaults */
189 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
190 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
191 ret = exp(log(prh[port].LowerBound) * 0.75f + log(prh[port].UpperBound) * 0.25f);
194 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
199 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
200 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
201 ret = exp(log(prh[port].LowerBound) * 0.5f + log(prh[port].UpperBound) * 0.5f);
204 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
209 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
210 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
211 ret = exp(log(prh[port].LowerBound) * 0.25f + log(prh[port].UpperBound) * 0.75f);
214 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
219 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
220 ret = prh[port].UpperBound;
224 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
228 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
232 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
236 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
246 /* defaults - case 2 */
247 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
248 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
250 if (prh[port].LowerBound < 0) {
253 ret = prh[port].LowerBound;
260 /* defaults - case 3 */
261 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
262 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
264 if (prh[port].UpperBound > 0) {
267 ret = prh[port].UpperBound;
274 /* defaults - case 4 */
275 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
276 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
278 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
280 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
281 ret = prh[port].UpperBound;
283 ret = prh[port].LowerBound;
289 /* defaults - case 5 */
291 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
305 LadspaPlugin::set_parameter (uint32_t which, float val)
307 if (which < _descriptor->PortCount) {
308 _shadow_data[which] = (LADSPA_Data) val;
309 ParameterChanged (which, val); /* EMIT SIGNAL */
311 if (which < parameter_count() && controls[which]) {
312 controls[which]->Changed ();
316 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
317 "indicate a change in the plugin design, and presets may be"
324 LadspaPlugin::get_parameter (uint32_t which) const
326 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
327 return (float) _shadow_data[which];
329 return (float) _control_data[which];
334 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
340 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
341 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
352 LadspaPlugin::get_state()
354 XMLNode *root = new XMLNode(state_node_name());
357 LocaleGuard lg (X_("POSIX"));
359 for (uint32_t i = 0; i < parameter_count(); ++i){
361 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
362 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
364 child = new XMLNode("port");
365 snprintf(buf, sizeof(buf), "%u", i);
366 child->add_property("number", string(buf));
367 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
368 child->add_property("value", string(buf));
369 root->add_child_nocopy (*child);
371 if (i < controls.size() && controls[i]) {
372 root->add_child_nocopy (controls[i]->get_state());
381 LadspaPlugin::save_preset (string name)
383 return Plugin::save_preset (name, "ladspa");
387 LadspaPlugin::set_state(const XMLNode& node)
391 XMLNodeConstIterator iter;
396 LocaleGuard lg (X_("POSIX"));
398 if (node.name() != state_node_name()) {
399 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
403 nodes = node.children ("port");
405 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
409 if ((prop = child->property("number")) != 0) {
410 port = prop->value().c_str();
412 warning << _("LADSPA: no ladspa port number") << endmsg;
416 if ((prop = child->property("value")) != 0) {
417 data = prop->value().c_str();
419 warning << _("LADSPA: no ladspa port data") << endmsg;
423 sscanf (port, "%" PRIu32, &port_id);
424 set_parameter (port_id, atof(data));
427 latency_compute_run ();
433 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
435 LADSPA_PortRangeHint prh;
437 prh = port_range_hints()[which];
440 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
441 desc.min_unbound = false;
442 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
443 desc.lower = prh.LowerBound * _session.frame_rate();
445 desc.lower = prh.LowerBound;
448 desc.min_unbound = true;
453 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
454 desc.max_unbound = false;
455 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
456 desc.upper = prh.UpperBound * _session.frame_rate();
458 desc.upper = prh.UpperBound;
461 desc.max_unbound = true;
462 desc.upper = 4; /* completely arbitrary */
465 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
467 desc.smallstep = 0.1;
468 desc.largestep = 10.0;
470 float delta = desc.upper - desc.lower;
471 desc.step = delta / 1000.0f;
472 desc.smallstep = delta / 10000.0f;
473 desc.largestep = delta/10.0f;
476 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
477 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
478 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
479 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
481 desc.label = port_names()[which];
488 LadspaPlugin::describe_parameter (uint32_t which)
490 if (which < parameter_count()) {
491 return port_names()[which];
498 LadspaPlugin::latency () const
500 if (_latency_control_port) {
501 return (nframes_t) floor (*_latency_control_port);
508 LadspaPlugin::automatable () const
512 for (uint32_t i = 0; i < parameter_count(); ++i){
513 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
514 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
516 ret.insert (ret.end(), i);
524 LadspaPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t nbufs, int32_t& in_index, int32_t& out_index, nframes_t nframes, nframes_t offset)
531 then = get_cycles ();
533 while (port_index < parameter_count()) {
534 if (LADSPA_IS_PORT_AUDIO (port_descriptor(port_index))) {
535 if (LADSPA_IS_PORT_INPUT (port_descriptor(port_index))) {
536 connect_port (port_index, bufs[min((uint32_t) in_index,nbufs - 1)] + offset);
537 //cerr << this << ' ' << name() << " @ " << offset << " inport " << in_index << " = buf "
538 // << min((uint32_t)in_index,nbufs) << " = " << &bufs[min((uint32_t)in_index,nbufs)][offset] << endl;
542 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
543 connect_port (port_index, bufs[min((uint32_t) out_index,nbufs - 1)] + offset);
544 // cerr << this << ' ' << name() << " @ " << offset << " outport " << out_index << " = buf "
545 // << min((uint32_t)out_index,nbufs) << " = " << &bufs[min((uint32_t)out_index,nbufs)][offset] << endl;
554 set_cycles ((uint32_t) (now - then));
560 LadspaPlugin::parameter_is_control (uint32_t param) const
562 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
566 LadspaPlugin::parameter_is_audio (uint32_t param) const
568 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
572 LadspaPlugin::parameter_is_output (uint32_t param) const
574 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
578 LadspaPlugin::parameter_is_input (uint32_t param) const
580 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
584 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
587 if (param < parameter_count()) {
588 snprintf (buf, len, "%.3f", get_parameter (param));
596 LadspaPlugin::run (nframes_t nframes)
598 for (uint32_t i = 0; i < parameter_count(); ++i) {
599 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
600 _control_data[i] = _shadow_data[i];
603 _descriptor->run (_handle, nframes);
607 LadspaPlugin::latency_compute_run ()
609 if (!_latency_control_port) {
613 /* we need to run the plugin so that it can set its latency
619 uint32_t port_index = 0;
620 uint32_t in_index = 0;
621 uint32_t out_index = 0;
622 const nframes_t bufsize = 1024;
623 LADSPA_Data buffer[bufsize];
625 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
627 /* Note that we've already required that plugins
628 be able to handle in-place processing.
633 while (port_index < parameter_count()) {
634 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
635 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
636 connect_port (port_index, buffer);
638 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
639 connect_port (port_index, buffer);
651 LadspaPluginInfo::load (Session& session)
657 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
658 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
659 error << dlerror() << endmsg;
661 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
664 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
668 catch (failed_constructor &err) {
669 return PluginPtr ((Plugin*) 0);
674 LadspaPluginInfo::LadspaPluginInfo()
676 type = ARDOUR::LADSPA;