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.
21 #include "libardour-config.h"
30 #include <cstdio> // so libraptor doesn't complain
42 #include "pbd/compose.h"
43 #include "pbd/error.h"
44 #include "pbd/xml++.h"
45 #include "pbd/stacktrace.h"
47 #include "ardour/session.h"
48 #include "ardour/ladspa_plugin.h"
49 #include "ardour/buffer_set.h"
50 #include "ardour/audio_buffer.h"
52 #include "pbd/stl_delete.h"
58 using namespace ARDOUR;
61 LadspaPlugin::LadspaPlugin (string module_path, AudioEngine& e, Session& session, uint32_t index, framecnt_t rate)
64 init (module_path, index, rate);
67 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
70 init (other._module_path, other._index, other._sample_rate);
72 for (uint32_t i = 0; i < parameter_count(); ++i) {
73 _control_data[i] = other._shadow_data[i];
74 _shadow_data[i] = other._shadow_data[i];
79 LadspaPlugin::init (string module_path, uint32_t index, framecnt_t rate)
82 LADSPA_Descriptor_Function dfunc;
85 _module_path = module_path;
86 _module = new Glib::Module(_module_path);
89 _latency_control_port = 0;
90 _was_activated = false;
93 error << _("LADSPA: Unable to open module: ") << Glib::Module::get_last_error() << endmsg;
95 throw failed_constructor();
98 if (!_module->get_symbol("ladspa_descriptor", func)) {
99 error << _("LADSPA: module has no descriptor function.") << endmsg;
100 throw failed_constructor();
103 dfunc = (LADSPA_Descriptor_Function)func;
105 if ((_descriptor = dfunc (index)) == 0) {
106 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
107 throw failed_constructor();
112 if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
113 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
114 throw failed_constructor();
119 if (_descriptor->instantiate == 0) {
120 throw failed_constructor();
123 if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
124 throw failed_constructor();
127 port_cnt = parameter_count();
129 _control_data = new LADSPA_Data[port_cnt];
130 memset (_control_data, 0, sizeof (LADSPA_Data) * port_cnt);
131 _shadow_data = new LADSPA_Data[port_cnt];
132 memset (_shadow_data, 0, sizeof (LADSPA_Data) * port_cnt);
134 for (i = 0; i < port_cnt; ++i) {
135 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
136 connect_port (i, &_control_data[i]);
138 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
139 strcmp (port_names()[i], X_("latency")) == 0) {
140 _latency_control_port = &_control_data[i];
141 *_latency_control_port = 0;
144 _shadow_data[i] = _default_value (i);
145 _control_data[i] = _shadow_data[i];
149 latency_compute_run ();
152 LadspaPlugin::~LadspaPlugin ()
157 // glib has internal reference counting on modules so this is ok
160 delete [] _control_data;
161 delete [] _shadow_data;
165 LadspaPlugin::unique_id() const
168 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
173 LadspaPlugin::_default_value (uint32_t port) const
175 const LADSPA_PortRangeHint *prh = port_range_hints();
177 bool bounds_given = false;
178 bool sr_scaling = false;
179 bool earlier_hint = false;
181 /* defaults - case 1 */
183 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
184 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
185 ret = prh[port].LowerBound;
190 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
191 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
195 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
196 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
200 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
201 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
205 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
206 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) {
295 if (get_parameter (which) == val) {
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);
317 /** @return `plugin' value */
319 LadspaPlugin::get_parameter (uint32_t which) const
321 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
322 return (float) _shadow_data[which];
324 return (float) _control_data[which];
329 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
335 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
336 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
347 LadspaPlugin::add_state (XMLNode* root) const
353 for (uint32_t i = 0; i < parameter_count(); ++i){
355 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
356 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
358 child = new XMLNode("Port");
359 snprintf(buf, sizeof(buf), "%u", i);
360 child->add_property("number", string(buf));
361 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
362 child->add_property("value", string(buf));
363 root->add_child_nocopy (*child);
369 LadspaPlugin::set_state (const XMLNode& node, int version)
371 if (version < 3000) {
372 return set_state_2X (node, version);
375 #ifndef NO_PLUGIN_STATE
377 XMLProperty const * prop;
378 XMLNodeConstIterator iter;
386 if (node.name() != state_node_name()) {
387 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
391 #ifndef NO_PLUGIN_STATE
393 nodes = node.children ("Port");
395 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
399 if ((prop = child->property("number")) != 0) {
400 port = prop->value().c_str();
402 warning << _("LADSPA: no ladspa port number") << endmsg;
405 if ((prop = child->property("value")) != 0) {
406 data = prop->value().c_str();
408 warning << _("LADSPA: no ladspa port data") << endmsg;
412 sscanf (port, "%" PRIu32, &port_id);
413 set_parameter (port_id, atof(data));
417 latency_compute_run ();
419 return Plugin::set_state (node, version);
423 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
425 #ifndef NO_PLUGIN_STATE
427 XMLProperty const * prop;
428 XMLNodeConstIterator iter;
436 if (node.name() != state_node_name()) {
437 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
441 #ifndef NO_PLUGIN_STATE
442 nodes = node.children ("port");
444 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
448 if ((prop = child->property("number")) != 0) {
449 port = prop->value().c_str();
451 warning << _("LADSPA: no ladspa port number") << endmsg;
454 if ((prop = child->property("value")) != 0) {
455 data = prop->value().c_str();
457 warning << _("LADSPA: no ladspa port data") << endmsg;
461 sscanf (port, "%" PRIu32, &port_id);
462 set_parameter (port_id, atof(data));
465 latency_compute_run ();
472 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
474 LADSPA_PortRangeHint prh;
476 prh = port_range_hints()[which];
479 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
480 desc.min_unbound = false;
481 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
482 desc.lower = prh.LowerBound * _session.frame_rate();
484 desc.lower = prh.LowerBound;
487 desc.min_unbound = true;
492 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
493 desc.max_unbound = false;
494 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
495 desc.upper = prh.UpperBound * _session.frame_rate();
497 desc.upper = prh.UpperBound;
500 desc.max_unbound = true;
501 desc.upper = 4; /* completely arbitrary */
504 if (LADSPA_IS_HINT_HAS_DEFAULT (prh.HintDescriptor)) {
505 desc.normal = _default_value(which);
507 /* if there is no explicit hint for the default
508 * value, use lower bound. This is not great but
509 * better than just assuming '0' which may be out-of range.
511 desc.normal = desc.lower;
514 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
515 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
516 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
517 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
519 desc.label = port_names()[which];
521 desc.scale_points = get_scale_points(which);
528 LadspaPlugin::describe_parameter (Evoral::Parameter which)
530 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
531 return port_names()[which.id()];
538 LadspaPlugin::signal_latency () const
541 return _user_latency;
544 if (_latency_control_port) {
545 return (framecnt_t) floor (*_latency_control_port);
551 set<Evoral::Parameter>
552 LadspaPlugin::automatable () const
554 set<Evoral::Parameter> ret;
556 for (uint32_t i = 0; i < parameter_count(); ++i){
557 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
558 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
560 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
568 LadspaPlugin::connect_and_run (BufferSet& bufs,
569 ChanMapping in_map, ChanMapping out_map,
570 pframes_t nframes, framecnt_t offset)
572 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
575 cycles_t then = get_cycles ();
577 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
578 BufferSet& scratch_bufs = _session.get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
580 uint32_t audio_in_index = 0;
581 uint32_t audio_out_index = 0;
583 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
584 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
585 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
586 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
587 connect_port(port_index,
588 valid ? bufs.get_audio(buf_index).data(offset)
589 : silent_bufs.get_audio(0).data(offset));
590 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
591 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
592 connect_port(port_index,
593 valid ? bufs.get_audio(buf_index).data(offset)
594 : scratch_bufs.get_audio(0).data(offset));
599 run_in_place (nframes);
601 set_cycles ((uint32_t) (now - then));
607 LadspaPlugin::parameter_is_control (uint32_t param) const
609 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
613 LadspaPlugin::parameter_is_audio (uint32_t param) const
615 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
619 LadspaPlugin::parameter_is_output (uint32_t param) const
621 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
625 LadspaPlugin::parameter_is_input (uint32_t param) const
627 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
631 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
634 if (param < parameter_count()) {
635 snprintf (buf, len, "%.3f", get_parameter (param));
642 boost::shared_ptr<ScalePoints>
643 LadspaPlugin::get_scale_points(uint32_t port_index) const
645 boost::shared_ptr<ScalePoints> ret;
647 const uint32_t id = atol(unique_id().c_str());
648 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
654 ret = boost::shared_ptr<ScalePoints>(new ScalePoints());
656 for (uint32_t i = 0; i < points->count; ++i) {
657 ret->insert(make_pair(points->items[i].label,
658 points->items[i].value));
661 lrdf_free_setting_values(points);
667 LadspaPlugin::run_in_place (pframes_t nframes)
669 for (uint32_t i = 0; i < parameter_count(); ++i) {
670 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
671 _control_data[i] = _shadow_data[i];
675 assert (_was_activated);
677 _descriptor->run (_handle, nframes);
681 LadspaPlugin::latency_compute_run ()
683 if (!_latency_control_port) {
687 /* we need to run the plugin so that it can set its latency
693 uint32_t port_index = 0;
694 uint32_t in_index = 0;
695 uint32_t out_index = 0;
696 const framecnt_t bufsize = 1024;
697 LADSPA_Data buffer[bufsize];
699 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
701 /* Note that we've already required that plugins
702 be able to handle in-place processing.
707 while (port_index < parameter_count()) {
708 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
709 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
710 connect_port (port_index, buffer);
712 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
713 connect_port (port_index, buffer);
720 run_in_place (bufsize);
725 LadspaPluginInfo::load (Session& session)
728 PluginPtr plugin (new LadspaPlugin (path, session.engine(), session, index, session.frame_rate()));
729 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
733 catch (failed_constructor &err) {
734 return PluginPtr ((Plugin*) 0);
738 std::vector<Plugin::PresetRecord>
739 LadspaPluginInfo::get_presets (bool /*user_only*/) const
741 std::vector<Plugin::PresetRecord> p;
742 #if (defined HAVE_LRDF && !defined NO_PLUGIN_STATE)
743 if (!isdigit (unique_id[0])) {
746 uint32_t id = atol (unique_id);
747 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
750 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
751 if (char* label = lrdf_get_label (set_uris->items[i])) {
752 p.push_back (Plugin::PresetRecord (set_uris->items[i], label));
755 lrdf_free_uris(set_uris);
761 LadspaPluginInfo::LadspaPluginInfo()
763 type = ARDOUR::LADSPA;
768 LadspaPlugin::find_presets ()
772 std::string unique (unique_id());
774 if (!isdigit (unique[0])) {
778 id = atol (unique.c_str());
780 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
783 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
784 if (char* label = lrdf_get_label(set_uris->items[i])) {
785 PresetRecord rec (set_uris->items[i], label);
786 _presets.insert (make_pair (set_uris->items[i], rec));
789 lrdf_free_uris(set_uris);
796 LadspaPlugin::load_preset (PresetRecord r)
799 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
802 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
803 if (parameter_is_input (defs->items[i].pid)) {
804 set_parameter(defs->items[i].pid, defs->items[i].value);
807 lrdf_free_setting_values(defs);
810 Plugin::load_preset (r);
816 /* XXX: should be in liblrdf */
818 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
823 char setting_uri_copy[64];
826 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
828 p.subject = setting_uri_copy;
829 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
832 q = lrdf_matches(&p);
836 for (i = q; i; i = i->next) {
837 p.subject = i->object;
838 lrdf_remove_matches(&p);
841 lrdf_free_statements(q);
844 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
846 p.object = setting_uri_copy;
847 lrdf_remove_matches(&p);
849 p.subject = setting_uri_copy;
852 lrdf_remove_matches (&p);
857 LadspaPlugin::do_remove_preset (string name)
860 string const envvar = preset_envvar ();
861 if (envvar.empty()) {
862 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
866 Plugin::PresetRecord const * p = preset_by_label (name);
871 string const source = preset_source (envvar);
872 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
874 write_preset_file (envvar);
879 LadspaPlugin::preset_envvar () const
882 if ((envvar = getenv ("HOME")) == 0) {
890 LadspaPlugin::preset_source (string envvar) const
892 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
896 LadspaPlugin::write_preset_file (string envvar)
899 string path = string_compose("%1/.ladspa", envvar);
900 if (g_mkdir_with_parents (path.c_str(), 0775)) {
901 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
906 if (g_mkdir_with_parents (path.c_str(), 0775)) {
907 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
911 string const source = preset_source (envvar);
913 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
914 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
925 LadspaPlugin::do_save_preset (string name)
928 /* make a vector of pids that are input parameters */
929 vector<int> input_parameter_pids;
930 for (uint32_t i = 0; i < parameter_count(); ++i) {
931 if (parameter_is_input (i)) {
932 input_parameter_pids.push_back (i);
936 std::string unique (unique_id());
938 if (!isdigit (unique[0])) {
942 uint32_t const id = atol (unique.c_str());
944 lrdf_defaults defaults;
945 defaults.count = input_parameter_pids.size ();
946 std::vector<lrdf_portvalue> portvalues(input_parameter_pids.size());
947 defaults.items = &portvalues[0];
949 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
950 portvalues[i].pid = input_parameter_pids[i];
951 portvalues[i].value = get_parameter (input_parameter_pids[i]);
954 string const envvar = preset_envvar ();
955 if (envvar.empty()) {
956 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
960 string const source = preset_source (envvar);
962 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
963 string uri (uri_char);
966 if (!write_preset_file (envvar)) {
976 LADSPA_PortDescriptor
977 LadspaPlugin::port_descriptor (uint32_t i) const
979 if (i < _descriptor->PortCount) {
980 return _descriptor->PortDescriptors[i];
983 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;