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 GoingAway (); /* EMIT SIGNAL */
149 /* XXX who should close a plugin? */
153 delete [] _control_data;
154 delete [] _shadow_data;
158 LadspaPlugin::unique_id() const
161 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
166 LadspaPlugin::default_value (uint32_t port)
168 const LADSPA_PortRangeHint *prh = port_range_hints();
170 bool bounds_given = false;
171 bool sr_scaling = false;
172 bool earlier_hint = false;
174 /* defaults - case 1 */
176 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
177 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
178 ret = prh[port].LowerBound;
184 /* FIXME: add support for logarithmic defaults */
186 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
187 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
192 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
193 ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
198 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
199 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
204 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
205 ret = prh[port].UpperBound;
210 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
214 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
218 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
222 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
232 /* defaults - case 2 */
233 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
234 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
236 if (prh[port].LowerBound < 0) {
239 ret = prh[port].LowerBound;
246 /* defaults - case 3 */
247 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
248 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
250 if (prh[port].UpperBound > 0) {
253 ret = prh[port].UpperBound;
260 /* defaults - case 4 */
261 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
262 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
264 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
266 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
267 ret = prh[port].UpperBound;
269 ret = prh[port].LowerBound;
275 /* defaults - case 5 */
277 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
291 LadspaPlugin::set_parameter (uint32_t which, float val)
293 if (which < _descriptor->PortCount) {
294 _shadow_data[which] = (LADSPA_Data) val;
296 ParameterChanged (Parameter(PluginAutomation, 0, which), val); /* EMIT SIGNAL */
298 if (which < parameter_count() && controls[which]) {
299 controls[which]->Changed ();
304 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
305 "indicate a change in the plugin design, and presets may be"
312 LadspaPlugin::get_parameter (uint32_t which) const
314 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
315 return (float) _shadow_data[which];
317 return (float) _control_data[which];
322 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
328 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
329 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
340 LadspaPlugin::get_state()
342 XMLNode *root = new XMLNode(state_node_name());
345 LocaleGuard lg (X_("POSIX"));
347 for (uint32_t i = 0; i < parameter_count(); ++i){
349 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
350 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
352 child = new XMLNode("Port");
353 snprintf(buf, sizeof(buf), "%u", i);
354 child->add_property("number", string(buf));
355 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
356 child->add_property("value", string(buf));
357 root->add_child_nocopy (*child);
365 LadspaPlugin::save_preset (string name)
367 return Plugin::save_preset (name, "ladspa");
371 LadspaPlugin::set_state(const XMLNode& node)
375 XMLNodeConstIterator iter;
380 LocaleGuard lg (X_("POSIX"));
382 if (node.name() != state_node_name()) {
383 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
387 nodes = node.children ("Port");
389 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
393 if ((prop = child->property("number")) != 0) {
394 port = prop->value().c_str();
396 warning << _("LADSPA: no ladspa port number") << endmsg;
399 if ((prop = child->property("value")) != 0) {
400 data = prop->value().c_str();
402 warning << _("LADSPA: no ladspa port data") << endmsg;
406 sscanf (port, "%" PRIu32, &port_id);
407 set_parameter (port_id, atof(data));
410 latency_compute_run ();
416 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
418 LADSPA_PortRangeHint prh;
420 prh = port_range_hints()[which];
423 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
424 desc.min_unbound = false;
425 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
426 desc.lower = prh.LowerBound * _session.frame_rate();
428 desc.lower = prh.LowerBound;
431 desc.min_unbound = true;
436 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
437 desc.max_unbound = false;
438 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
439 desc.upper = prh.UpperBound * _session.frame_rate();
441 desc.upper = prh.UpperBound;
444 desc.max_unbound = true;
445 desc.upper = 4; /* completely arbitrary */
448 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
450 desc.smallstep = 0.1;
451 desc.largestep = 10.0;
453 float delta = desc.upper - desc.lower;
454 desc.step = delta / 1000.0f;
455 desc.smallstep = delta / 10000.0f;
456 desc.largestep = delta/10.0f;
459 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
460 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
461 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
462 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
464 desc.label = port_names()[which];
470 LadspaPlugin::describe_parameter (Evoral::Parameter which)
472 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
473 return port_names()[which.id()];
480 LadspaPlugin::signal_latency () const
483 return _user_latency;
486 if (_latency_control_port) {
487 return (nframes_t) floor (*_latency_control_port);
493 set<Evoral::Parameter>
494 LadspaPlugin::automatable () const
496 set<Evoral::Parameter> ret;
498 for (uint32_t i = 0; i < parameter_count(); ++i){
499 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
500 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
502 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
510 LadspaPlugin::connect_and_run (BufferSet& bufs,
511 ChanMapping in_map, ChanMapping out_map,
512 nframes_t nframes, nframes_t offset)
515 cycles_t then = get_cycles ();
517 uint32_t audio_in_index = 0;
518 uint32_t audio_out_index = 0;
519 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
520 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
521 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
522 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
523 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
524 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
525 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
526 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
531 run_in_place (nframes);
533 set_cycles ((uint32_t) (now - then));
539 LadspaPlugin::parameter_is_control (uint32_t param) const
541 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
545 LadspaPlugin::parameter_is_audio (uint32_t param) const
547 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
551 LadspaPlugin::parameter_is_output (uint32_t param) const
553 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
557 LadspaPlugin::parameter_is_input (uint32_t param) const
559 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
563 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
566 if (param < parameter_count()) {
567 snprintf (buf, len, "%.3f", get_parameter (param));
575 LadspaPlugin::run_in_place (nframes_t nframes)
577 for (uint32_t i = 0; i < parameter_count(); ++i) {
578 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
579 _control_data[i] = _shadow_data[i];
582 _descriptor->run (_handle, nframes);
586 LadspaPlugin::latency_compute_run ()
588 if (!_latency_control_port) {
592 /* we need to run the plugin so that it can set its latency
598 uint32_t port_index = 0;
599 uint32_t in_index = 0;
600 uint32_t out_index = 0;
601 const nframes_t bufsize = 1024;
602 LADSPA_Data buffer[bufsize];
604 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
606 /* Note that we've already required that plugins
607 be able to handle in-place processing.
612 while (port_index < parameter_count()) {
613 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
614 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
615 connect_port (port_index, buffer);
617 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
618 connect_port (port_index, buffer);
625 run_in_place (bufsize);
630 LadspaPluginInfo::load (Session& session)
636 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
637 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
638 error << dlerror() << endmsg;
640 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
643 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
647 catch (failed_constructor &err) {
648 return PluginPtr ((Plugin*) 0);