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.
20 #define __STDC_FORMAT_MACROS 1
27 #include <cstdio> // so libraptor doesn't complain
35 #include "pbd/compose.h"
36 #include "pbd/error.h"
37 #include "pbd/xml++.h"
39 #include "midi++/manager.h"
41 #include "ardour/ardour.h"
42 #include "ardour/session.h"
43 #include "ardour/audioengine.h"
44 #include "ardour/ladspa_plugin.h"
45 #include "ardour/buffer_set.h"
46 #include "ardour/audio_buffer.h"
48 #include "pbd/stl_delete.h"
54 using namespace ARDOUR;
57 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, nframes_t rate)
60 init (mod, index, rate);
63 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
66 init (other._module, other._index, other._sample_rate);
68 for (uint32_t i = 0; i < parameter_count(); ++i) {
69 _control_data[i] = other._shadow_data[i];
70 _shadow_data[i] = other._shadow_data[i];
75 LadspaPlugin::init (void *mod, uint32_t index, nframes_t rate)
77 LADSPA_Descriptor_Function dfunc;
84 _latency_control_port = 0;
85 _was_activated = false;
87 dfunc = (LADSPA_Descriptor_Function) dlsym (_module, "ladspa_descriptor");
89 if ((errstr = dlerror()) != NULL) {
90 error << _("LADSPA: module has no descriptor function.") << endmsg;
91 throw failed_constructor();
94 if ((_descriptor = dfunc (index)) == 0) {
95 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
96 throw failed_constructor();
101 if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
102 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
103 throw failed_constructor();
108 if (_descriptor->instantiate == 0) {
109 throw failed_constructor();
112 if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
113 throw failed_constructor();
116 port_cnt = parameter_count();
118 _control_data = new LADSPA_Data[port_cnt];
119 _shadow_data = new LADSPA_Data[port_cnt];
121 for (i = 0; i < port_cnt; ++i) {
122 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
123 connect_port (i, &_control_data[i]);
125 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
126 strcmp (port_names()[i], X_("latency")) == 0) {
127 _latency_control_port = &_control_data[i];
128 *_latency_control_port = 0;
131 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
135 _shadow_data[i] = default_value (i);
139 latency_compute_run ();
142 LadspaPlugin::~LadspaPlugin ()
147 /* XXX who should close a plugin? */
151 delete [] _control_data;
152 delete [] _shadow_data;
156 LadspaPlugin::unique_id() const
159 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
164 LadspaPlugin::default_value (uint32_t port)
166 const LADSPA_PortRangeHint *prh = port_range_hints();
168 bool bounds_given = false;
169 bool sr_scaling = false;
170 bool earlier_hint = false;
172 /* defaults - case 1 */
174 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
175 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
176 ret = prh[port].LowerBound;
181 /* FIXME: add support for logarithmic defaults */
183 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
184 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
185 ret = exp(log(prh[port].LowerBound) * 0.75f + log(prh[port].UpperBound) * 0.25f);
188 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
193 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
194 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
195 ret = exp(log(prh[port].LowerBound) * 0.5f + log(prh[port].UpperBound) * 0.5f);
198 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
203 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
204 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
205 ret = exp(log(prh[port].LowerBound) * 0.25f + log(prh[port].UpperBound) * 0.75f);
208 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
213 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
214 ret = prh[port].UpperBound;
218 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
222 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
226 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
230 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
240 /* defaults - case 2 */
241 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
242 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
244 if (prh[port].LowerBound < 0) {
247 ret = prh[port].LowerBound;
254 /* defaults - case 3 */
255 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
256 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
258 if (prh[port].UpperBound > 0) {
261 ret = prh[port].UpperBound;
268 /* defaults - case 4 */
269 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
270 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
272 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
274 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
275 ret = prh[port].UpperBound;
277 ret = prh[port].LowerBound;
283 /* defaults - case 5 */
285 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
299 LadspaPlugin::set_parameter (uint32_t which, float val)
301 if (which < _descriptor->PortCount) {
302 _shadow_data[which] = (LADSPA_Data) val;
304 ParameterChanged (Parameter(PluginAutomation, 0, which), val); /* EMIT SIGNAL */
306 if (which < parameter_count() && controls[which]) {
307 controls[which]->Changed ();
312 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
313 "indicate a change in the plugin design, and presets may be"
320 LadspaPlugin::get_parameter (uint32_t which) const
322 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
323 return (float) _shadow_data[which];
325 return (float) _control_data[which];
330 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
336 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
337 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
348 LadspaPlugin::get_state()
350 XMLNode *root = new XMLNode(state_node_name());
353 LocaleGuard lg (X_("POSIX"));
355 for (uint32_t i = 0; i < parameter_count(); ++i){
357 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
358 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
360 child = new XMLNode("Port");
361 snprintf(buf, sizeof(buf), "%u", i);
362 child->add_property("number", string(buf));
363 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
364 child->add_property("value", string(buf));
365 root->add_child_nocopy (*child);
373 LadspaPlugin::save_preset (string name)
375 return Plugin::save_preset (name, "ladspa");
379 LadspaPlugin::set_state (const XMLNode& node, int version)
381 if (version < 3000) {
382 return set_state_2X (node, version);
387 XMLNodeConstIterator iter;
392 LocaleGuard lg (X_("POSIX"));
394 if (node.name() != state_node_name()) {
395 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
399 nodes = node.children ("Port");
401 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
405 if ((prop = child->property("number")) != 0) {
406 port = prop->value().c_str();
408 warning << _("LADSPA: no ladspa port number") << endmsg;
411 if ((prop = child->property("value")) != 0) {
412 data = prop->value().c_str();
414 warning << _("LADSPA: no ladspa port data") << endmsg;
418 sscanf (port, "%" PRIu32, &port_id);
419 set_parameter (port_id, atof(data));
422 latency_compute_run ();
428 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
432 XMLNodeConstIterator iter;
437 LocaleGuard lg (X_("POSIX"));
439 if (node.name() != state_node_name()) {
440 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
444 nodes = node.children ("port");
446 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
450 if ((prop = child->property("number")) != 0) {
451 port = prop->value().c_str();
453 warning << _("LADSPA: no ladspa port number") << endmsg;
456 if ((prop = child->property("value")) != 0) {
457 data = prop->value().c_str();
459 warning << _("LADSPA: no ladspa port data") << endmsg;
463 sscanf (port, "%" PRIu32, &port_id);
464 set_parameter (port_id, atof(data));
467 latency_compute_run ();
473 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
475 LADSPA_PortRangeHint prh;
477 prh = port_range_hints()[which];
480 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
481 desc.min_unbound = false;
482 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
483 desc.lower = prh.LowerBound * _session.frame_rate();
485 desc.lower = prh.LowerBound;
488 desc.min_unbound = true;
493 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
494 desc.max_unbound = false;
495 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
496 desc.upper = prh.UpperBound * _session.frame_rate();
498 desc.upper = prh.UpperBound;
501 desc.max_unbound = true;
502 desc.upper = 4; /* completely arbitrary */
505 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
507 desc.smallstep = 0.1;
508 desc.largestep = 10.0;
510 float delta = desc.upper - desc.lower;
511 desc.step = delta / 1000.0f;
512 desc.smallstep = delta / 10000.0f;
513 desc.largestep = delta/10.0f;
516 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
517 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
518 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
519 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
521 desc.label = port_names()[which];
527 LadspaPlugin::describe_parameter (Evoral::Parameter which)
529 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
530 return port_names()[which.id()];
537 LadspaPlugin::signal_latency () const
540 return _user_latency;
543 if (_latency_control_port) {
544 return (nframes_t) floor (*_latency_control_port);
550 set<Evoral::Parameter>
551 LadspaPlugin::automatable () const
553 set<Evoral::Parameter> ret;
555 for (uint32_t i = 0; i < parameter_count(); ++i){
556 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
557 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
559 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
567 LadspaPlugin::connect_and_run (BufferSet& bufs,
568 ChanMapping in_map, ChanMapping out_map,
569 nframes_t nframes, nframes_t offset)
572 cycles_t then = get_cycles ();
574 uint32_t audio_in_index = 0;
575 uint32_t audio_out_index = 0;
576 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
577 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
578 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
579 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
580 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
581 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
582 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
583 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
588 run_in_place (nframes);
590 set_cycles ((uint32_t) (now - then));
596 LadspaPlugin::parameter_is_control (uint32_t param) const
598 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
602 LadspaPlugin::parameter_is_audio (uint32_t param) const
604 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
608 LadspaPlugin::parameter_is_output (uint32_t param) const
610 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
614 LadspaPlugin::parameter_is_input (uint32_t param) const
616 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
620 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
623 if (param < parameter_count()) {
624 snprintf (buf, len, "%.3f", get_parameter (param));
632 LadspaPlugin::run_in_place (nframes_t nframes)
634 for (uint32_t i = 0; i < parameter_count(); ++i) {
635 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
636 _control_data[i] = _shadow_data[i];
639 _descriptor->run (_handle, nframes);
643 LadspaPlugin::latency_compute_run ()
645 if (!_latency_control_port) {
649 /* we need to run the plugin so that it can set its latency
655 uint32_t port_index = 0;
656 uint32_t in_index = 0;
657 uint32_t out_index = 0;
658 const nframes_t bufsize = 1024;
659 LADSPA_Data buffer[bufsize];
661 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
663 /* Note that we've already required that plugins
664 be able to handle in-place processing.
669 while (port_index < parameter_count()) {
670 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
671 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
672 connect_port (port_index, buffer);
674 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
675 connect_port (port_index, buffer);
682 run_in_place (bufsize);
687 LadspaPluginInfo::load (Session& session)
693 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
694 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
695 error << dlerror() << endmsg;
697 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
700 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
704 catch (failed_constructor &err) {
705 return PluginPtr ((Plugin*) 0);