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.
25 #include <cstdio> // so libraptor doesn't complain
33 #include <pbd/compose.h>
34 #include <pbd/error.h>
35 #include <pbd/pathscanner.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>
45 #include <pbd/stl_delete.h>
51 using namespace ARDOUR;
54 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, nframes_t rate)
57 init (mod, index, rate);
60 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
63 init (other.module, other._index, other.sample_rate);
65 for (uint32_t i = 0; i < parameter_count(); ++i) {
66 control_data[i] = other.shadow_data[i];
67 shadow_data[i] = other.shadow_data[i];
72 LadspaPlugin::init (void *mod, uint32_t index, nframes_t rate)
74 LADSPA_Descriptor_Function dfunc;
81 latency_control_port = 0;
82 was_activated = false;
84 dfunc = (LADSPA_Descriptor_Function) dlsym (module, "ladspa_descriptor");
86 if ((errstr = dlerror()) != NULL) {
87 error << _("LADSPA: module has no descriptor function.") << endmsg;
88 throw failed_constructor();
91 if ((descriptor = dfunc (index)) == 0) {
92 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
93 throw failed_constructor();
98 if (LADSPA_IS_INPLACE_BROKEN(descriptor->Properties)) {
99 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), descriptor->Name) << endmsg;
100 throw failed_constructor();
105 if (descriptor->instantiate == 0) {
106 throw failed_constructor();
109 if ((handle = descriptor->instantiate (descriptor, rate)) == 0) {
110 throw failed_constructor();
113 port_cnt = parameter_count();
115 control_data = new LADSPA_Data[port_cnt];
116 shadow_data = new LADSPA_Data[port_cnt];
118 for (i = 0; i < port_cnt; ++i) {
119 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
120 connect_port (i, &control_data[i]);
122 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
123 strcmp (port_names()[i], X_("latency")) == 0) {
124 latency_control_port = &control_data[i];
125 *latency_control_port = 0;
128 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
132 shadow_data[i] = default_value (i);
136 Plugin::setup_controls ();
138 latency_compute_run ();
141 LadspaPlugin::~LadspaPlugin ()
146 GoingAway (); /* EMIT SIGNAL */
148 /* XXX who should close a plugin? */
153 delete [] control_data;
157 delete [] shadow_data;
162 LadspaPlugin::store_state (PluginState& state)
164 state.parameters.clear ();
166 for (uint32_t i = 0; i < parameter_count(); ++i){
168 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
169 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
170 pair<uint32_t,float> datum;
173 datum.second = shadow_data[i];
175 state.parameters.insert (datum);
181 LadspaPlugin::restore_state (PluginState& state)
183 for (map<uint32_t,float>::iterator i = state.parameters.begin(); i != state.parameters.end(); ++i) {
184 set_parameter (i->first, i->second);
189 LadspaPlugin::default_value (uint32_t port)
191 const LADSPA_PortRangeHint *prh = port_range_hints();
193 bool bounds_given = false;
194 bool sr_scaling = false;
196 /* defaults - case 1 */
198 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
199 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
200 ret = prh[port].LowerBound;
205 /* FIXME: add support for logarithmic defaults */
207 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
208 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
212 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
213 ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
217 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
218 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
222 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
223 ret = prh[port].UpperBound;
227 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
230 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
233 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
236 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
245 /* defaults - case 2 */
246 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
247 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
249 if (prh[port].LowerBound < 0) {
252 ret = prh[port].LowerBound;
259 /* defaults - case 3 */
260 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
261 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
263 if (prh[port].UpperBound > 0) {
266 ret = prh[port].UpperBound;
273 /* defaults - case 4 */
274 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
275 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
277 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
279 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
280 ret = prh[port].UpperBound;
282 ret = prh[port].LowerBound;
288 /* defaults - case 5 */
290 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor)) {
304 LadspaPlugin::set_parameter (uint32_t which, float val)
306 if (which < descriptor->PortCount) {
307 shadow_data[which] = (LADSPA_Data) val;
308 ParameterChanged (which, val); /* EMIT SIGNAL */
310 if (which < parameter_count() && controls[which]) {
311 controls[which]->Changed ();
315 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
316 "indicate a change in the plugin design, and presets may be"
323 LadspaPlugin::get_parameter (uint32_t which) const
325 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
326 return (float) shadow_data[which];
328 return (float) control_data[which];
333 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
339 for (c = 0, x = 0; x < descriptor->PortCount; ++x) {
340 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
351 LadspaPlugin::get_state()
353 XMLNode *root = new XMLNode(state_node_name());
356 LocaleGuard lg (X_("POSIX"));
358 for (uint32_t i = 0; i < parameter_count(); ++i){
360 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
361 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
363 child = new XMLNode("port");
364 snprintf(buf, sizeof(buf), "%u", i);
365 child->add_property("number", string(buf));
366 snprintf(buf, sizeof(buf), "%+f", shadow_data[i]);
367 child->add_property("value", string(buf));
368 root->add_child_nocopy (*child);
376 LadspaPlugin::save_preset (string name)
378 return Plugin::save_preset (name, "ladspa");
382 LadspaPlugin::set_state(const XMLNode& node)
386 XMLNodeConstIterator iter;
391 LocaleGuard lg (X_("POSIX"));
393 if (node.name() != state_node_name()) {
394 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
398 nodes = node.children ("port");
400 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
404 if ((prop = child->property("number")) != 0) {
405 port = prop->value().c_str();
407 warning << _("LADSPA: no ladspa port number") << endmsg;
410 if ((prop = child->property("value")) != 0) {
411 data = prop->value().c_str();
413 warning << _("LADSPA: no ladspa port data") << endmsg;
417 sscanf (port, "%" PRIu32, &port_id);
418 set_parameter (port_id, atof(data));
421 latency_compute_run ();
427 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
429 LADSPA_PortRangeHint prh;
431 prh = port_range_hints()[which];
434 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
435 desc.min_unbound = false;
436 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
437 desc.lower = prh.LowerBound * _session.frame_rate();
439 desc.lower = prh.LowerBound;
442 desc.min_unbound = true;
447 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
448 desc.max_unbound = false;
449 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
450 desc.upper = prh.UpperBound * _session.frame_rate();
452 desc.upper = prh.UpperBound;
455 desc.max_unbound = true;
456 desc.upper = 4; /* completely arbitrary */
459 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
461 desc.smallstep = 0.1;
462 desc.largestep = 10.0;
464 float delta = desc.upper - desc.lower;
465 desc.step = delta / 1000.0f;
466 desc.smallstep = delta / 10000.0f;
467 desc.largestep = delta/10.0f;
470 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
471 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
472 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
473 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
475 desc.label = port_names()[which];
483 LadspaPlugin::describe_parameter (uint32_t which)
485 if (which < parameter_count()) {
486 return port_names()[which];
493 LadspaPlugin::latency () const
495 if (latency_control_port) {
496 return (nframes_t) floor (*latency_control_port);
503 LadspaPlugin::automatable () const
507 for (uint32_t i = 0; i < parameter_count(); ++i){
508 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
509 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
511 ret.insert (ret.end(), i);
519 LadspaPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t nbufs, int32_t& in_index, int32_t& out_index, nframes_t nframes, nframes_t offset)
526 then = get_cycles ();
528 while (port_index < parameter_count()) {
529 if (LADSPA_IS_PORT_AUDIO (port_descriptor(port_index))) {
530 if (LADSPA_IS_PORT_INPUT (port_descriptor(port_index))) {
531 connect_port (port_index, bufs[min((uint32_t) in_index,nbufs - 1)] + offset);
532 //cerr << this << ' ' << name() << " @ " << offset << " inport " << in_index << " = buf "
533 // << min((uint32_t)in_index,nbufs) << " = " << &bufs[min((uint32_t)in_index,nbufs)][offset] << endl;
537 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
538 connect_port (port_index, bufs[min((uint32_t) out_index,nbufs - 1)] + offset);
539 // cerr << this << ' ' << name() << " @ " << offset << " outport " << out_index << " = buf "
540 // << min((uint32_t)out_index,nbufs) << " = " << &bufs[min((uint32_t)out_index,nbufs)][offset] << endl;
549 set_cycles ((uint32_t) (now - then));
555 LadspaPlugin::parameter_is_control (uint32_t param) const
557 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
561 LadspaPlugin::parameter_is_audio (uint32_t param) const
563 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
567 LadspaPlugin::parameter_is_output (uint32_t param) const
569 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
573 LadspaPlugin::parameter_is_input (uint32_t param) const
575 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
579 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
582 if (param < parameter_count()) {
583 snprintf (buf, len, "%.3f", get_parameter (param));
591 LadspaPlugin::run (nframes_t nframes)
593 for (uint32_t i = 0; i < parameter_count(); ++i) {
594 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
595 control_data[i] = shadow_data[i];
598 descriptor->run (handle, nframes);
602 LadspaPlugin::latency_compute_run ()
604 if (!latency_control_port) {
608 /* we need to run the plugin so that it can set its latency
614 uint32_t port_index = 0;
615 uint32_t in_index = 0;
616 uint32_t out_index = 0;
617 const nframes_t bufsize = 1024;
618 LADSPA_Data buffer[bufsize];
620 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
622 /* Note that we've already required that plugins
623 be able to handle in-place processing.
628 while (port_index < parameter_count()) {
629 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
630 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
631 connect_port (port_index, buffer);
633 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
634 connect_port (port_index, buffer);
646 LadspaPluginInfo::load (Session& session)
652 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
653 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
654 error << dlerror() << endmsg;
656 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
659 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
663 catch (failed_constructor &err) {
664 return PluginPtr ((Plugin*) 0);