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;
188 /* FIXME: add support for logarithmic defaults */
190 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
191 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
196 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
197 ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
202 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
203 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
208 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
209 ret = prh[port].UpperBound;
214 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
218 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
222 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
226 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
236 /* defaults - case 2 */
237 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
238 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
240 if (prh[port].LowerBound < 0) {
243 ret = prh[port].LowerBound;
250 /* defaults - case 3 */
251 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
252 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
254 if (prh[port].UpperBound > 0) {
257 ret = prh[port].UpperBound;
264 /* defaults - case 4 */
265 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
266 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
268 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
270 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
271 ret = prh[port].UpperBound;
273 ret = prh[port].LowerBound;
279 /* defaults - case 5 */
281 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
295 LadspaPlugin::set_parameter (uint32_t which, float val)
297 if (which < descriptor->PortCount) {
298 shadow_data[which] = (LADSPA_Data) val;
299 ParameterChanged (which, val); /* EMIT SIGNAL */
301 if (which < parameter_count() && controls[which]) {
302 controls[which]->Changed ();
306 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
307 "indicate a change in the plugin design, and presets may be"
314 LadspaPlugin::get_parameter (uint32_t which) const
316 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
317 return (float) shadow_data[which];
319 return (float) control_data[which];
324 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
330 for (c = 0, x = 0; x < descriptor->PortCount; ++x) {
331 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
342 LadspaPlugin::get_state()
344 XMLNode *root = new XMLNode(state_node_name());
347 LocaleGuard lg (X_("POSIX"));
349 for (uint32_t i = 0; i < parameter_count(); ++i){
351 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
352 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
354 child = new XMLNode("port");
355 snprintf(buf, sizeof(buf), "%u", i);
356 child->add_property("number", string(buf));
357 snprintf(buf, sizeof(buf), "%+f", shadow_data[i]);
358 child->add_property("value", string(buf));
359 root->add_child_nocopy (*child);
361 if (i < controls.size() && controls[i]) {
362 root->add_child_nocopy (controls[i]->get_state());
371 LadspaPlugin::save_preset (string name)
373 return Plugin::save_preset (name, "ladspa");
377 LadspaPlugin::set_state(const XMLNode& node)
381 XMLNodeConstIterator iter;
386 LocaleGuard lg (X_("POSIX"));
388 if (node.name() != state_node_name()) {
389 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
393 nodes = node.children ("port");
395 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
399 if ((prop = child->property("number")) != 0) {
400 port = prop->value().c_str();
402 warning << _("LADSPA: no ladspa port number") << endmsg;
406 if ((prop = child->property("value")) != 0) {
407 data = prop->value().c_str();
409 warning << _("LADSPA: no ladspa port data") << endmsg;
413 sscanf (port, "%" PRIu32, &port_id);
414 set_parameter (port_id, atof(data));
417 latency_compute_run ();
423 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
425 LADSPA_PortRangeHint prh;
427 prh = port_range_hints()[which];
430 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
431 desc.min_unbound = false;
432 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
433 desc.lower = prh.LowerBound * _session.frame_rate();
435 desc.lower = prh.LowerBound;
438 desc.min_unbound = true;
443 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
444 desc.max_unbound = false;
445 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
446 desc.upper = prh.UpperBound * _session.frame_rate();
448 desc.upper = prh.UpperBound;
451 desc.max_unbound = true;
452 desc.upper = 4; /* completely arbitrary */
455 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
457 desc.smallstep = 0.1;
458 desc.largestep = 10.0;
460 float delta = desc.upper - desc.lower;
461 desc.step = delta / 1000.0f;
462 desc.smallstep = delta / 10000.0f;
463 desc.largestep = delta/10.0f;
466 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
467 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
468 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
469 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
471 desc.label = port_names()[which];
479 LadspaPlugin::describe_parameter (uint32_t which)
481 if (which < parameter_count()) {
482 return port_names()[which];
489 LadspaPlugin::latency () const
491 if (latency_control_port) {
492 return (nframes_t) floor (*latency_control_port);
499 LadspaPlugin::automatable () const
503 for (uint32_t i = 0; i < parameter_count(); ++i){
504 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
505 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
507 ret.insert (ret.end(), i);
515 LadspaPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t nbufs, int32_t& in_index, int32_t& out_index, nframes_t nframes, nframes_t offset)
522 then = get_cycles ();
524 while (port_index < parameter_count()) {
525 if (LADSPA_IS_PORT_AUDIO (port_descriptor(port_index))) {
526 if (LADSPA_IS_PORT_INPUT (port_descriptor(port_index))) {
527 connect_port (port_index, bufs[min((uint32_t) in_index,nbufs - 1)] + offset);
528 //cerr << this << ' ' << name() << " @ " << offset << " inport " << in_index << " = buf "
529 // << min((uint32_t)in_index,nbufs) << " = " << &bufs[min((uint32_t)in_index,nbufs)][offset] << endl;
533 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
534 connect_port (port_index, bufs[min((uint32_t) out_index,nbufs - 1)] + offset);
535 // cerr << this << ' ' << name() << " @ " << offset << " outport " << out_index << " = buf "
536 // << min((uint32_t)out_index,nbufs) << " = " << &bufs[min((uint32_t)out_index,nbufs)][offset] << endl;
545 set_cycles ((uint32_t) (now - then));
551 LadspaPlugin::parameter_is_control (uint32_t param) const
553 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
557 LadspaPlugin::parameter_is_audio (uint32_t param) const
559 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
563 LadspaPlugin::parameter_is_output (uint32_t param) const
565 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
569 LadspaPlugin::parameter_is_input (uint32_t param) const
571 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
575 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
578 if (param < parameter_count()) {
579 snprintf (buf, len, "%.3f", get_parameter (param));
587 LadspaPlugin::run (nframes_t nframes)
589 for (uint32_t i = 0; i < parameter_count(); ++i) {
590 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
591 control_data[i] = shadow_data[i];
594 descriptor->run (handle, nframes);
598 LadspaPlugin::latency_compute_run ()
600 if (!latency_control_port) {
604 /* we need to run the plugin so that it can set its latency
610 uint32_t port_index = 0;
611 uint32_t in_index = 0;
612 uint32_t out_index = 0;
613 const nframes_t bufsize = 1024;
614 LADSPA_Data buffer[bufsize];
616 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
618 /* Note that we've already required that plugins
619 be able to handle in-place processing.
624 while (port_index < parameter_count()) {
625 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
626 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
627 connect_port (port_index, buffer);
629 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
630 connect_port (port_index, buffer);
642 LadspaPluginInfo::load (Session& session)
648 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
649 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
650 error << dlerror() << endmsg;
652 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
655 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
659 catch (failed_constructor &err) {
660 return PluginPtr ((Plugin*) 0);