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.
26 #include <cstdio> // so libraptor doesn't complain
34 #include "pbd/compose.h"
35 #include "pbd/error.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"
44 #include "ardour/buffer_set.h"
45 #include "ardour/audio_buffer.h"
47 #include "pbd/stl_delete.h"
53 using namespace ARDOUR;
56 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, framecnt_t rate)
59 init (mod, index, rate);
62 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
65 init (other._module, other._index, other._sample_rate);
67 for (uint32_t i = 0; i < parameter_count(); ++i) {
68 _control_data[i] = other._shadow_data[i];
69 _shadow_data[i] = other._shadow_data[i];
74 LadspaPlugin::init (void *mod, uint32_t index, framecnt_t rate)
76 LADSPA_Descriptor_Function dfunc;
83 _latency_control_port = 0;
84 _was_activated = false;
86 dfunc = (LADSPA_Descriptor_Function) dlsym (_module, "ladspa_descriptor");
88 if ((errstr = dlerror()) != NULL) {
89 error << _("LADSPA: module has no descriptor function.") << endmsg;
90 throw failed_constructor();
93 if ((_descriptor = dfunc (index)) == 0) {
94 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
95 throw failed_constructor();
100 if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
101 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
102 throw failed_constructor();
107 if (_descriptor->instantiate == 0) {
108 throw failed_constructor();
111 if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
112 throw failed_constructor();
115 port_cnt = parameter_count();
117 _control_data = new LADSPA_Data[port_cnt];
118 _shadow_data = new LADSPA_Data[port_cnt];
120 for (i = 0; i < port_cnt; ++i) {
121 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
122 connect_port (i, &_control_data[i]);
124 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
125 strcmp (port_names()[i], X_("latency")) == 0) {
126 _latency_control_port = &_control_data[i];
127 *_latency_control_port = 0;
130 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
134 _shadow_data[i] = default_value (i);
138 latency_compute_run ();
141 LadspaPlugin::~LadspaPlugin ()
146 /* XXX who should close a plugin? */
150 delete [] _control_data;
151 delete [] _shadow_data;
155 LadspaPlugin::unique_id() const
158 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
163 LadspaPlugin::default_value (uint32_t port)
165 const LADSPA_PortRangeHint *prh = port_range_hints();
167 bool bounds_given = false;
168 bool sr_scaling = false;
169 bool earlier_hint = false;
171 /* defaults - case 1 */
173 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
174 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
175 ret = prh[port].LowerBound;
180 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
181 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
182 ret = exp(log(prh[port].LowerBound) * 0.75f + log(prh[port].UpperBound) * 0.25f);
185 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
190 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
191 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
192 ret = exp(log(prh[port].LowerBound) * 0.5f + log(prh[port].UpperBound) * 0.5f);
195 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
200 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
201 if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
202 ret = exp(log(prh[port].LowerBound) * 0.25f + log(prh[port].UpperBound) * 0.75f);
205 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
210 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
211 ret = prh[port].UpperBound;
215 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
219 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
223 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
227 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
237 /* defaults - case 2 */
238 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
239 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
241 if (prh[port].LowerBound < 0) {
244 ret = prh[port].LowerBound;
251 /* defaults - case 3 */
252 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
253 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
255 if (prh[port].UpperBound > 0) {
258 ret = prh[port].UpperBound;
265 /* defaults - case 4 */
266 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
267 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
269 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
271 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
272 ret = prh[port].UpperBound;
274 ret = prh[port].LowerBound;
280 /* defaults - case 5 */
282 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
296 LadspaPlugin::set_parameter (uint32_t which, float val)
298 if (which < _descriptor->PortCount) {
299 _shadow_data[which] = (LADSPA_Data) val;
302 if (which < parameter_count() && controls[which]) {
303 controls[which]->Changed ();
308 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
309 "indicate a change in the plugin design, and presets may be"
314 Plugin::set_parameter (which, val);
318 LadspaPlugin::get_parameter (uint32_t which) const
320 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
321 return (float) _shadow_data[which];
323 return (float) _control_data[which];
328 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
334 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
335 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
346 LadspaPlugin::add_state (XMLNode* root) const
350 LocaleGuard lg (X_("POSIX"));
352 for (uint32_t i = 0; i < parameter_count(); ++i){
354 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
355 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
357 child = new XMLNode("Port");
358 snprintf(buf, sizeof(buf), "%u", i);
359 child->add_property("number", string(buf));
360 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
361 child->add_property("value", string(buf));
362 root->add_child_nocopy (*child);
368 LadspaPlugin::set_state (const XMLNode& node, int version)
370 if (version < 3000) {
371 return set_state_2X (node, version);
376 XMLNodeConstIterator iter;
381 LocaleGuard lg (X_("POSIX"));
383 if (node.name() != state_node_name()) {
384 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
388 nodes = node.children ("Port");
390 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
394 if ((prop = child->property("number")) != 0) {
395 port = prop->value().c_str();
397 warning << _("LADSPA: no ladspa port number") << endmsg;
400 if ((prop = child->property("value")) != 0) {
401 data = prop->value().c_str();
403 warning << _("LADSPA: no ladspa port data") << endmsg;
407 sscanf (port, "%" PRIu32, &port_id);
408 set_parameter (port_id, atof(data));
411 latency_compute_run ();
413 return Plugin::set_state (node, version);
417 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
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));
456 latency_compute_run ();
462 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
464 LADSPA_PortRangeHint prh;
466 prh = port_range_hints()[which];
469 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
470 desc.min_unbound = false;
471 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
472 desc.lower = prh.LowerBound * _session.frame_rate();
474 desc.lower = prh.LowerBound;
477 desc.min_unbound = true;
482 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
483 desc.max_unbound = false;
484 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
485 desc.upper = prh.UpperBound * _session.frame_rate();
487 desc.upper = prh.UpperBound;
490 desc.max_unbound = true;
491 desc.upper = 4; /* completely arbitrary */
494 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
496 desc.smallstep = 0.1;
497 desc.largestep = 10.0;
499 float delta = desc.upper - desc.lower;
500 desc.step = delta / 1000.0f;
501 desc.smallstep = delta / 10000.0f;
502 desc.largestep = delta/10.0f;
505 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
506 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
507 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
508 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
510 desc.label = port_names()[which];
516 LadspaPlugin::describe_parameter (Evoral::Parameter which)
518 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
519 return port_names()[which.id()];
526 LadspaPlugin::signal_latency () const
529 return _user_latency;
532 if (_latency_control_port) {
533 return (framecnt_t) floor (*_latency_control_port);
539 set<Evoral::Parameter>
540 LadspaPlugin::automatable () const
542 set<Evoral::Parameter> ret;
544 for (uint32_t i = 0; i < parameter_count(); ++i){
545 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
546 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
548 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
556 LadspaPlugin::connect_and_run (BufferSet& bufs,
557 ChanMapping in_map, ChanMapping out_map,
558 pframes_t nframes, framecnt_t offset)
560 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
563 cycles_t then = get_cycles ();
565 uint32_t audio_in_index = 0;
566 uint32_t audio_out_index = 0;
567 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
568 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
569 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
570 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
571 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
572 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
573 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
574 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
579 run_in_place (nframes);
581 set_cycles ((uint32_t) (now - then));
587 LadspaPlugin::parameter_is_control (uint32_t param) const
589 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
593 LadspaPlugin::parameter_is_audio (uint32_t param) const
595 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
599 LadspaPlugin::parameter_is_output (uint32_t param) const
601 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
605 LadspaPlugin::parameter_is_input (uint32_t param) const
607 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
611 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
614 if (param < parameter_count()) {
615 snprintf (buf, len, "%.3f", get_parameter (param));
623 LadspaPlugin::run_in_place (pframes_t nframes)
625 for (uint32_t i = 0; i < parameter_count(); ++i) {
626 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
627 _control_data[i] = _shadow_data[i];
631 assert (_was_activated);
633 _descriptor->run (_handle, nframes);
637 LadspaPlugin::latency_compute_run ()
639 if (!_latency_control_port) {
643 /* we need to run the plugin so that it can set its latency
649 uint32_t port_index = 0;
650 uint32_t in_index = 0;
651 uint32_t out_index = 0;
652 const framecnt_t bufsize = 1024;
653 LADSPA_Data buffer[bufsize];
655 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
657 /* Note that we've already required that plugins
658 be able to handle in-place processing.
663 while (port_index < parameter_count()) {
664 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
665 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
666 connect_port (port_index, buffer);
668 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
669 connect_port (port_index, buffer);
676 run_in_place (bufsize);
681 LadspaPluginInfo::load (Session& session)
687 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
688 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
689 error << dlerror() << endmsg;
690 return PluginPtr ((Plugin*) 0);
692 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
695 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
699 catch (failed_constructor &err) {
700 return PluginPtr ((Plugin*) 0);
704 LadspaPluginInfo::LadspaPluginInfo()
706 type = ARDOUR::LADSPA;
711 LadspaPlugin::find_presets ()
714 std::string unique (unique_id());
716 if (!isdigit (unique[0])) {
720 id = atol (unique.c_str());
722 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
725 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
726 if (char* label = lrdf_get_label(set_uris->items[i])) {
727 PresetRecord rec (set_uris->items[i], label);
728 _presets.insert (make_pair (set_uris->items[i], rec));
731 lrdf_free_uris(set_uris);
737 LadspaPlugin::load_preset (PresetRecord r)
739 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
742 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
743 if (parameter_is_input (defs->items[i].pid)) {
744 set_parameter(defs->items[i].pid, defs->items[i].value);
747 lrdf_free_setting_values(defs);
750 Plugin::load_preset (r);
754 /* XXX: should be in liblrdf */
756 lrdf_remove_preset (const char *source, const char *setting_uri)
761 char setting_uri_copy[64];
764 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
766 p.subject = setting_uri_copy;
767 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
770 q = lrdf_matches(&p);
774 for (i = q; i; i = i->next) {
775 p.subject = i->object;
776 lrdf_remove_matches(&p);
779 lrdf_free_statements(q);
782 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
784 p.object = setting_uri_copy;
785 lrdf_remove_matches(&p);
787 p.subject = setting_uri_copy;
790 lrdf_remove_matches (&p);
794 LadspaPlugin::do_remove_preset (string name)
796 string const envvar = preset_envvar ();
797 if (envvar.empty()) {
798 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
802 Plugin::PresetRecord const * p = preset_by_label (name);
807 string const source = preset_source (envvar);
808 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
810 write_preset_file (envvar);
814 LadspaPlugin::preset_envvar () const
817 if ((envvar = getenv ("HOME")) == 0) {
825 LadspaPlugin::preset_source (string envvar) const
827 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
831 LadspaPlugin::write_preset_file (string envvar)
833 string path = string_compose("%1/.ladspa", envvar);
834 if (g_mkdir_with_parents (path.c_str(), 0775)) {
835 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
840 if (g_mkdir_with_parents (path.c_str(), 0775)) {
841 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
845 string const source = preset_source (envvar);
847 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
848 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
856 LadspaPlugin::do_save_preset (string name)
858 /* make a vector of pids that are input parameters */
859 vector<int> input_parameter_pids;
860 for (uint32_t i = 0; i < parameter_count(); ++i) {
861 if (parameter_is_input (i)) {
862 input_parameter_pids.push_back (i);
866 std::string unique (unique_id());
868 if (!isdigit (unique[0])) {
872 uint32_t const id = atol (unique.c_str());
874 lrdf_defaults defaults;
875 defaults.count = input_parameter_pids.size ();
876 lrdf_portvalue portvalues[input_parameter_pids.size()];
877 defaults.items = portvalues;
879 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
880 portvalues[i].pid = input_parameter_pids[i];
881 portvalues[i].value = get_parameter (input_parameter_pids[i]);
884 string const envvar = preset_envvar ();
885 if (envvar.empty()) {
886 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
890 string const source = preset_source (envvar);
892 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
893 string uri (uri_char);
896 if (!write_preset_file (envvar)) {