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;
53 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, jack_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, jack_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_midi_controls ();
137 latency_compute_run ();
139 MIDI::Controllable *mcontrol;
141 for (uint32_t i = 0; i < parameter_count(); ++i) {
142 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
143 LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
144 if ((mcontrol = get_nth_midi_control (i)) != 0) {
145 mcontrol->midi_rebind (_session.midi_port(), 0);
151 LadspaPlugin::~LadspaPlugin ()
156 GoingAway (this); /* EMIT SIGNAL */
158 /* XXX who should close a plugin? */
163 delete [] control_data;
167 delete [] shadow_data;
172 LadspaPlugin::store_state (PluginState& state)
174 state.parameters.clear ();
176 for (uint32_t i = 0; i < parameter_count(); ++i){
178 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
179 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
180 pair<uint32_t,float> datum;
183 datum.second = shadow_data[i];
185 state.parameters.insert (datum);
191 LadspaPlugin::restore_state (PluginState& state)
193 for (map<uint32_t,float>::iterator i = state.parameters.begin(); i != state.parameters.end(); ++i) {
194 set_parameter (i->first, i->second);
199 LadspaPlugin::default_value (uint32_t port)
201 const LADSPA_PortRangeHint *prh = port_range_hints();
203 bool bounds_given = false;
204 bool sr_scaling = false;
206 /* defaults - case 1 */
208 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
209 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
210 ret = prh[port].LowerBound;
215 /* FIXME: add support for logarithmic defaults */
217 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
218 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
222 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
223 ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
227 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
228 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
232 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
233 ret = prh[port].UpperBound;
237 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
240 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
243 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
246 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
255 /* defaults - case 2 */
256 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
257 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
259 if (prh[port].LowerBound < 0) {
262 ret = prh[port].LowerBound;
269 /* defaults - case 3 */
270 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
271 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
273 if (prh[port].UpperBound > 0) {
276 ret = prh[port].UpperBound;
283 /* defaults - case 4 */
284 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
285 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
287 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
289 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
290 ret = prh[port].UpperBound;
292 ret = prh[port].LowerBound;
298 /* defaults - case 5 */
300 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor)) {
314 LadspaPlugin::set_parameter (uint32_t which, float val)
316 if (which < descriptor->PortCount) {
317 shadow_data[which] = (LADSPA_Data) val;
318 ParameterChanged (which, val); /* EMIT SIGNAL */
320 if (session().get_midi_feedback()) {
322 if (which < parameter_count() && midi_controls[which]) {
323 midi_controls[which]->send_feedback (val);
328 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
329 "indicate a change in the plugin design, and presets may be"
336 LadspaPlugin::get_parameter (uint32_t which) const
338 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
339 return (float) shadow_data[which];
341 return (float) control_data[which];
346 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
352 for (c = 0, x = 0; x < descriptor->PortCount; ++x) {
353 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
364 LadspaPlugin::get_state()
366 XMLNode *root = new XMLNode(state_node_name());
369 LocaleGuard lg (X_("POSIX"));
371 for (uint32_t i = 0; i < parameter_count(); ++i){
373 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
374 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
376 child = new XMLNode("port");
377 snprintf(buf, sizeof(buf), "%u", i);
378 child->add_property("number", string(buf));
379 snprintf(buf, sizeof(buf), "%+f", shadow_data[i]);
380 child->add_property("value", string(buf));
381 root->add_child_nocopy (*child);
383 MIDI::Controllable *pcontrol = get_nth_midi_control (i);
388 MIDI::byte additional;
392 if (pcontrol->get_control_info (chn, ev, additional)) {
394 midi_node = child->add_child ("midi-control");
396 snprintf (buf, sizeof(buf), "0x%x", ev);
397 midi_node->add_property ("event", buf);
398 snprintf (buf, sizeof(buf), "%d", chn);
399 midi_node->add_property ("channel", buf);
400 snprintf (buf, sizeof(buf), "0x%x", additional);
401 midi_node->add_property ("additional", buf);
411 LadspaPlugin::save_preset (string name)
413 return Plugin::save_preset (name, "ladspa");
417 LadspaPlugin::set_state(const XMLNode& node)
421 XMLNodeConstIterator iter;
426 LocaleGuard lg (X_("POSIX"));
428 if (node.name() != state_node_name()) {
429 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
433 nodes = node.children ("port");
435 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
439 if ((prop = child->property("number")) != 0) {
440 port = prop->value().c_str();
442 warning << _("LADSPA: no ladspa port number") << endmsg;
445 if ((prop = child->property("value")) != 0) {
446 data = prop->value().c_str();
448 warning << _("LADSPA: no ladspa port data") << endmsg;
452 sscanf (port, "%" PRIu32, &port_id);
453 set_parameter (port_id, atof(data));
455 XMLNodeList midi_kids;
456 XMLNodeConstIterator iter;
458 midi_kids = child->children ("midi-control");
460 for (iter = midi_kids.begin(); iter != midi_kids.end(); ++iter) {
464 MIDI::eventType ev = MIDI::on; /* initialize to keep gcc happy */
465 MIDI::byte additional = 0; /* initialize to keep gcc happy */
466 MIDI::channel_t chn = 0; /* initialize to keep gcc happy */
470 if ((prop = child->property ("event")) != 0) {
471 sscanf (prop->value().c_str(), "0x%x", &xx);
472 ev = (MIDI::eventType) xx;
477 if (ok && ((prop = child->property ("channel")) != 0)) {
478 sscanf (prop->value().c_str(), "%d", &xx);
479 chn = (MIDI::channel_t) xx;
484 if (ok && ((prop = child->property ("additional")) != 0)) {
485 sscanf (prop->value().c_str(), "0x%x", &xx);
486 additional = (MIDI::byte) xx;
490 MIDI::Controllable* pcontrol = get_nth_midi_control (port_id);
493 pcontrol->set_control_type (chn, ev, additional);
497 error << string_compose(_("LADSPA LadspaPlugin MIDI control specification for port %1 is incomplete, so it has been ignored"), port) << endl;
502 latency_compute_run ();
508 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
510 LADSPA_PortRangeHint prh;
512 prh = port_range_hints()[which];
515 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
516 desc.min_unbound = false;
517 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
518 desc.lower = prh.LowerBound * _session.frame_rate();
520 desc.lower = prh.LowerBound;
523 desc.min_unbound = true;
528 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
529 desc.max_unbound = false;
530 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
531 desc.upper = prh.UpperBound * _session.frame_rate();
533 desc.upper = prh.UpperBound;
536 desc.max_unbound = true;
537 desc.upper = 4; /* completely arbitrary */
540 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
542 desc.smallstep = 0.1;
543 desc.largestep = 10.0;
545 float delta = desc.upper - desc.lower;
546 desc.step = delta / 1000.0f;
547 desc.smallstep = delta / 10000.0f;
548 desc.largestep = delta/10.0f;
551 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
552 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
553 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
554 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
556 desc.label = port_names()[which];
564 LadspaPlugin::describe_parameter (uint32_t which)
566 if (which < parameter_count()) {
567 return port_names()[which];
574 LadspaPlugin::latency () const
576 if (latency_control_port) {
577 return (jack_nframes_t) floor (*latency_control_port);
584 LadspaPlugin::automatable () const
588 for (uint32_t i = 0; i < parameter_count(); ++i){
589 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
590 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
592 ret.insert (ret.end(), i);
600 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)
607 then = get_cycles ();
609 while (port_index < parameter_count()) {
610 if (LADSPA_IS_PORT_AUDIO (port_descriptor(port_index))) {
611 if (LADSPA_IS_PORT_INPUT (port_descriptor(port_index))) {
612 connect_port (port_index, bufs[min((uint32_t) in_index,nbufs)] + offset);
613 //cerr << this << ' ' << name() << " @ " << offset << " inport " << in_index << " = buf "
614 // << min((uint32_t)in_index,nbufs) << " = " << &bufs[min((uint32_t)in_index,nbufs)][offset] << endl;
618 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
619 connect_port (port_index, bufs[min((uint32_t) out_index,nbufs)] + offset);
620 // cerr << this << ' ' << name() << " @ " << offset << " outport " << out_index << " = buf "
621 // << min((uint32_t)out_index,nbufs) << " = " << &bufs[min((uint32_t)out_index,nbufs)][offset] << endl;
630 set_cycles ((uint32_t) (now - then));
636 LadspaPlugin::parameter_is_control (uint32_t param) const
638 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
642 LadspaPlugin::parameter_is_audio (uint32_t param) const
644 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
648 LadspaPlugin::parameter_is_output (uint32_t param) const
650 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
654 LadspaPlugin::parameter_is_input (uint32_t param) const
656 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
660 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
663 if (param < parameter_count()) {
664 snprintf (buf, len, "%.3f", get_parameter (param));
672 LadspaPlugin::run (jack_nframes_t nframes)
674 for (uint32_t i = 0; i < parameter_count(); ++i) {
675 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
676 control_data[i] = shadow_data[i];
679 descriptor->run (handle, nframes);
683 LadspaPlugin::latency_compute_run ()
685 if (!latency_control_port) {
689 /* we need to run the plugin so that it can set its latency
695 uint32_t port_index = 0;
696 uint32_t in_index = 0;
697 uint32_t out_index = 0;
698 const jack_nframes_t bufsize = 1024;
699 LADSPA_Data buffer[bufsize];
701 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
703 /* Note that we've already required that plugins
704 be able to handle in-place processing.
709 while (port_index < parameter_count()) {
710 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
711 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
712 connect_port (port_index, buffer);
714 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
715 connect_port (port_index, buffer);