2 Copyright (C) 2000-2002 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, jack_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, jack_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_midi_controls ();
138 latency_compute_run ();
140 MIDI::Controllable *mcontrol;
142 for (uint32_t i = 0; i < parameter_count(); ++i) {
143 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
144 LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
145 if ((mcontrol = get_nth_midi_control (i)) != 0) {
146 mcontrol->midi_rebind (_session.midi_port(), 0);
152 LadspaPlugin::~LadspaPlugin ()
157 GoingAway (this); /* EMIT SIGNAL */
159 /* XXX who should close a plugin? */
164 delete [] control_data;
168 delete [] shadow_data;
173 LadspaPlugin::store_state (PluginState& state)
175 state.parameters.clear ();
177 for (uint32_t i = 0; i < parameter_count(); ++i){
179 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
180 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
181 pair<uint32_t,float> datum;
184 datum.second = shadow_data[i];
186 state.parameters.insert (datum);
192 LadspaPlugin::restore_state (PluginState& state)
194 for (map<uint32_t,float>::iterator i = state.parameters.begin(); i != state.parameters.end(); ++i) {
195 set_parameter (i->first, i->second);
200 LadspaPlugin::default_value (uint32_t port)
202 const LADSPA_PortRangeHint *prh = port_range_hints();
204 bool bounds_given = false;
205 bool sr_scaling = false;
207 /* defaults - case 1 */
209 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
210 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
211 ret = prh[port].LowerBound;
216 /* FIXME: add support for logarithmic defaults */
218 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
219 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
223 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
224 ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
228 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
229 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
233 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
234 ret = prh[port].UpperBound;
238 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
241 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
244 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
247 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
256 /* defaults - case 2 */
257 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
258 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
260 if (prh[port].LowerBound < 0) {
263 ret = prh[port].LowerBound;
270 /* defaults - case 3 */
271 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
272 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
274 if (prh[port].UpperBound > 0) {
277 ret = prh[port].UpperBound;
284 /* defaults - case 4 */
285 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
286 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
288 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
290 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
291 ret = prh[port].UpperBound;
293 ret = prh[port].LowerBound;
299 /* defaults - case 5 */
301 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor)) {
315 LadspaPlugin::set_parameter (uint32_t which, float val)
317 if (which < descriptor->PortCount) {
318 shadow_data[which] = (LADSPA_Data) val;
319 ParameterChanged (which, val); /* EMIT SIGNAL */
321 if (session().get_midi_feedback()) {
323 if (which < parameter_count() && midi_controls[which]) {
324 midi_controls[which]->send_feedback (val);
329 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
330 "indicate a change in the plugin design, and presets may be"
337 LadspaPlugin::get_parameter (uint32_t which) const
339 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
340 return (float) shadow_data[which];
342 return (float) control_data[which];
347 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
353 for (c = 0, x = 0; x < descriptor->PortCount; ++x) {
354 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
365 LadspaPlugin::get_state()
367 XMLNode *root = new XMLNode(state_node_name());
370 LocaleGuard lg (X_("POSIX"));
372 for (uint32_t i = 0; i < parameter_count(); ++i){
374 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
375 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
377 child = new XMLNode("port");
378 snprintf(buf, sizeof(buf), "%u", i);
379 child->add_property("number", string(buf));
380 snprintf(buf, sizeof(buf), "%+f", shadow_data[i]);
381 child->add_property("value", string(buf));
382 root->add_child_nocopy (*child);
384 MIDI::Controllable *pcontrol = get_nth_midi_control (i);
389 MIDI::byte additional;
393 if (pcontrol->get_control_info (chn, ev, additional)) {
395 midi_node = child->add_child ("midi-control");
397 snprintf (buf, sizeof(buf), "0x%x", ev);
398 midi_node->add_property ("event", buf);
399 snprintf (buf, sizeof(buf), "%d", chn);
400 midi_node->add_property ("channel", buf);
401 snprintf (buf, sizeof(buf), "0x%x", additional);
402 midi_node->add_property ("additional", buf);
412 LadspaPlugin::save_preset (string name)
414 return Plugin::save_preset (name, "ladspa");
418 LadspaPlugin::set_state(const XMLNode& node)
422 XMLNodeConstIterator iter;
427 LocaleGuard lg (X_("POSIX"));
429 if (node.name() != state_node_name()) {
430 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
434 nodes = node.children ("port");
436 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
440 if ((prop = child->property("number")) != 0) {
441 port = prop->value().c_str();
443 warning << _("LADSPA: no ladspa port number") << endmsg;
446 if ((prop = child->property("value")) != 0) {
447 data = prop->value().c_str();
449 warning << _("LADSPA: no ladspa port data") << endmsg;
453 sscanf (port, "%" PRIu32, &port_id);
454 set_parameter (port_id, atof(data));
456 XMLNodeList midi_kids;
457 XMLNodeConstIterator iter;
459 midi_kids = child->children ("midi-control");
461 for (iter = midi_kids.begin(); iter != midi_kids.end(); ++iter) {
465 MIDI::eventType ev = MIDI::on; /* initialize to keep gcc happy */
466 MIDI::byte additional = 0; /* initialize to keep gcc happy */
467 MIDI::channel_t chn = 0; /* initialize to keep gcc happy */
471 if ((prop = child->property ("event")) != 0) {
472 sscanf (prop->value().c_str(), "0x%x", &xx);
473 ev = (MIDI::eventType) xx;
478 if (ok && ((prop = child->property ("channel")) != 0)) {
479 sscanf (prop->value().c_str(), "%d", &xx);
480 chn = (MIDI::channel_t) xx;
485 if (ok && ((prop = child->property ("additional")) != 0)) {
486 sscanf (prop->value().c_str(), "0x%x", &xx);
487 additional = (MIDI::byte) xx;
491 MIDI::Controllable* pcontrol = get_nth_midi_control (port_id);
494 pcontrol->set_control_type (chn, ev, additional);
498 error << string_compose(_("LADSPA LadspaPlugin MIDI control specification for port %1 is incomplete, so it has been ignored"), port) << endl;
503 latency_compute_run ();
509 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
511 LADSPA_PortRangeHint prh;
513 prh = port_range_hints()[which];
516 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
517 desc.min_unbound = false;
518 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
519 desc.lower = prh.LowerBound * _session.frame_rate();
521 desc.lower = prh.LowerBound;
524 desc.min_unbound = true;
529 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
530 desc.max_unbound = false;
531 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
532 desc.upper = prh.UpperBound * _session.frame_rate();
534 desc.upper = prh.UpperBound;
537 desc.max_unbound = true;
538 desc.upper = 4; /* completely arbitrary */
541 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
543 desc.smallstep = 0.1;
544 desc.largestep = 10.0;
546 float delta = desc.upper - desc.lower;
547 desc.step = delta / 1000.0f;
548 desc.smallstep = delta / 10000.0f;
549 desc.largestep = delta/10.0f;
552 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
553 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
554 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
555 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
557 desc.label = port_names()[which];
565 LadspaPlugin::describe_parameter (uint32_t which)
567 if (which < parameter_count()) {
568 return port_names()[which];
575 LadspaPlugin::latency () const
577 if (latency_control_port) {
578 return (jack_nframes_t) floor (*latency_control_port);
585 LadspaPlugin::automatable () const
589 for (uint32_t i = 0; i < parameter_count(); ++i){
590 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
591 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
593 ret.insert (ret.end(), i);
601 LadspaPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t nbufs, int32_t& in_index, int32_t& out_index, jack_nframes_t nframes, jack_nframes_t offset)
608 then = get_cycles ();
610 while (port_index < parameter_count()) {
611 if (LADSPA_IS_PORT_AUDIO (port_descriptor(port_index))) {
612 if (LADSPA_IS_PORT_INPUT (port_descriptor(port_index))) {
613 connect_port (port_index, bufs[min((uint32_t) in_index,nbufs - 1)] + offset);
614 //cerr << this << ' ' << name() << " @ " << offset << " inport " << in_index << " = buf "
615 // << min((uint32_t)in_index,nbufs) << " = " << &bufs[min((uint32_t)in_index,nbufs)][offset] << endl;
619 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
620 connect_port (port_index, bufs[min((uint32_t) out_index,nbufs - 1)] + offset);
621 // cerr << this << ' ' << name() << " @ " << offset << " outport " << out_index << " = buf "
622 // << min((uint32_t)out_index,nbufs) << " = " << &bufs[min((uint32_t)out_index,nbufs)][offset] << endl;
631 set_cycles ((uint32_t) (now - then));
637 LadspaPlugin::parameter_is_control (uint32_t param) const
639 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
643 LadspaPlugin::parameter_is_audio (uint32_t param) const
645 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
649 LadspaPlugin::parameter_is_output (uint32_t param) const
651 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
655 LadspaPlugin::parameter_is_input (uint32_t param) const
657 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
661 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
664 if (param < parameter_count()) {
665 snprintf (buf, len, "%.3f", get_parameter (param));
673 LadspaPlugin::run (jack_nframes_t nframes)
675 for (uint32_t i = 0; i < parameter_count(); ++i) {
676 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
677 control_data[i] = shadow_data[i];
680 descriptor->run (handle, nframes);
684 LadspaPlugin::latency_compute_run ()
686 if (!latency_control_port) {
690 /* we need to run the plugin so that it can set its latency
696 uint32_t port_index = 0;
697 uint32_t in_index = 0;
698 uint32_t out_index = 0;
699 const jack_nframes_t bufsize = 1024;
700 LADSPA_Data buffer[bufsize];
702 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
704 /* Note that we've already required that plugins
705 be able to handle in-place processing.
710 while (port_index < parameter_count()) {
711 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
712 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
713 connect_port (port_index, buffer);
715 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
716 connect_port (port_index, buffer);