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"
37 #include "pbd/stacktrace.h"
39 #include "ardour/session.h"
40 #include "ardour/ladspa_plugin.h"
41 #include "ardour/buffer_set.h"
42 #include "ardour/audio_buffer.h"
44 #include "pbd/stl_delete.h"
50 using namespace ARDOUR;
53 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, framecnt_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, framecnt_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 memset (_control_data, 0, sizeof (LADSPA_Data) * port_cnt);
116 _shadow_data = new LADSPA_Data[port_cnt];
117 memset (_shadow_data, 0, sizeof (LADSPA_Data) * port_cnt);
119 for (i = 0; i < port_cnt; ++i) {
120 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
121 connect_port (i, &_control_data[i]);
123 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
124 strcmp (port_names()[i], X_("latency")) == 0) {
125 _latency_control_port = &_control_data[i];
126 *_latency_control_port = 0;
129 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
133 _shadow_data[i] = default_value (i);
137 latency_compute_run ();
140 LadspaPlugin::~LadspaPlugin ()
145 /* XXX who should close a plugin? */
149 delete [] _control_data;
150 delete [] _shadow_data;
154 LadspaPlugin::unique_id() const
157 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
162 LadspaPlugin::default_value (uint32_t port)
164 const LADSPA_PortRangeHint *prh = port_range_hints();
166 bool bounds_given = false;
167 bool sr_scaling = false;
168 bool earlier_hint = false;
170 /* defaults - case 1 */
172 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
173 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
174 ret = prh[port].LowerBound;
179 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
180 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
184 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
185 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
189 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
190 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
194 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
195 ret = prh[port].UpperBound;
199 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
203 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
207 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
211 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
221 /* defaults - case 2 */
222 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
223 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
225 if (prh[port].LowerBound < 0) {
228 ret = prh[port].LowerBound;
235 /* defaults - case 3 */
236 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
237 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
239 if (prh[port].UpperBound > 0) {
242 ret = prh[port].UpperBound;
249 /* defaults - case 4 */
250 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
251 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
253 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
255 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
256 ret = prh[port].UpperBound;
258 ret = prh[port].LowerBound;
264 /* defaults - case 5 */
266 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
280 LadspaPlugin::set_parameter (uint32_t which, float val)
282 if (which < _descriptor->PortCount) {
284 if (get_parameter (which) == val) {
288 _shadow_data[which] = (LADSPA_Data) val;
291 if (which < parameter_count() && controls[which]) {
292 controls[which]->Changed ();
297 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may "
298 "indicate a change in the plugin design, and presets may be "
303 Plugin::set_parameter (which, val);
306 /** @return `plugin' value */
308 LadspaPlugin::get_parameter (uint32_t which) const
310 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
311 return (float) _shadow_data[which];
313 return (float) _control_data[which];
318 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
324 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
325 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
336 LadspaPlugin::add_state (XMLNode* root) const
340 LocaleGuard lg (X_("POSIX"));
342 for (uint32_t i = 0; i < parameter_count(); ++i){
344 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
345 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
347 child = new XMLNode("Port");
348 snprintf(buf, sizeof(buf), "%u", i);
349 child->add_property("number", string(buf));
350 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
351 child->add_property("value", string(buf));
352 root->add_child_nocopy (*child);
358 LadspaPlugin::set_state (const XMLNode& node, int version)
360 if (version < 3000) {
361 return set_state_2X (node, version);
364 #ifndef NO_PLUGIN_STATE
367 XMLNodeConstIterator iter;
373 LocaleGuard lg (X_("POSIX"));
375 if (node.name() != state_node_name()) {
376 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
380 #ifndef NO_PLUGIN_STATE
382 nodes = node.children ("Port");
384 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
388 if ((prop = child->property("number")) != 0) {
389 port = prop->value().c_str();
391 warning << _("LADSPA: no ladspa port number") << endmsg;
394 if ((prop = child->property("value")) != 0) {
395 data = prop->value().c_str();
397 warning << _("LADSPA: no ladspa port data") << endmsg;
401 sscanf (port, "%" PRIu32, &port_id);
402 set_parameter (port_id, atof(data));
406 latency_compute_run ();
408 return Plugin::set_state (node, version);
412 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
414 #ifndef NO_PLUGIN_STATE
417 XMLNodeConstIterator iter;
423 LocaleGuard lg (X_("POSIX"));
425 if (node.name() != state_node_name()) {
426 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
430 #ifndef NO_PLUGIN_STATE
431 nodes = node.children ("port");
433 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
437 if ((prop = child->property("number")) != 0) {
438 port = prop->value().c_str();
440 warning << _("LADSPA: no ladspa port number") << endmsg;
443 if ((prop = child->property("value")) != 0) {
444 data = prop->value().c_str();
446 warning << _("LADSPA: no ladspa port data") << endmsg;
450 sscanf (port, "%" PRIu32, &port_id);
451 set_parameter (port_id, atof(data));
454 latency_compute_run ();
461 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
463 LADSPA_PortRangeHint prh;
465 prh = port_range_hints()[which];
468 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
469 desc.min_unbound = false;
470 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
471 desc.lower = prh.LowerBound * _session.frame_rate();
473 desc.lower = prh.LowerBound;
476 desc.min_unbound = true;
481 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
482 desc.max_unbound = false;
483 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
484 desc.upper = prh.UpperBound * _session.frame_rate();
486 desc.upper = prh.UpperBound;
489 desc.max_unbound = true;
490 desc.upper = 4; /* completely arbitrary */
493 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
495 desc.smallstep = 0.1;
496 desc.largestep = 10.0;
498 float delta = desc.upper - desc.lower;
499 desc.step = delta / 1000.0f;
500 desc.smallstep = delta / 10000.0f;
501 desc.largestep = delta/10.0f;
504 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
505 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
506 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
507 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
509 desc.label = port_names()[which];
515 LadspaPlugin::describe_parameter (Evoral::Parameter which)
517 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
518 return port_names()[which.id()];
525 LadspaPlugin::signal_latency () const
528 return _user_latency;
531 if (_latency_control_port) {
532 return (framecnt_t) floor (*_latency_control_port);
538 set<Evoral::Parameter>
539 LadspaPlugin::automatable () const
541 set<Evoral::Parameter> ret;
543 for (uint32_t i = 0; i < parameter_count(); ++i){
544 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
545 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
547 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
555 LadspaPlugin::connect_and_run (BufferSet& bufs,
556 ChanMapping in_map, ChanMapping out_map,
557 pframes_t nframes, framecnt_t offset)
559 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
562 cycles_t then = get_cycles ();
564 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
565 BufferSet& scratch_bufs = _session.get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
567 uint32_t audio_in_index = 0;
568 uint32_t audio_out_index = 0;
570 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
571 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
572 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
573 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
574 connect_port(port_index,
575 valid ? bufs.get_audio(buf_index).data(offset)
576 : silent_bufs.get_audio(0).data(offset));
577 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
578 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
579 connect_port(port_index,
580 valid ? bufs.get_audio(buf_index).data(offset)
581 : scratch_bufs.get_audio(0).data(offset));
586 run_in_place (nframes);
588 set_cycles ((uint32_t) (now - then));
594 LadspaPlugin::parameter_is_control (uint32_t param) const
596 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
600 LadspaPlugin::parameter_is_audio (uint32_t param) const
602 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
606 LadspaPlugin::parameter_is_output (uint32_t param) const
608 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
612 LadspaPlugin::parameter_is_input (uint32_t param) const
614 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
618 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
621 if (param < parameter_count()) {
622 snprintf (buf, len, "%.3f", get_parameter (param));
629 boost::shared_ptr<Plugin::ScalePoints>
630 LadspaPlugin::get_scale_points(uint32_t port_index) const
632 const uint32_t id = atol(unique_id().c_str());
633 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
635 boost::shared_ptr<Plugin::ScalePoints> ret;
640 ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
642 for (uint32_t i = 0; i < points->count; ++i) {
643 ret->insert(make_pair(points->items[i].label,
644 points->items[i].value));
647 lrdf_free_setting_values(points);
652 LadspaPlugin::run_in_place (pframes_t nframes)
654 for (uint32_t i = 0; i < parameter_count(); ++i) {
655 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
656 _control_data[i] = _shadow_data[i];
660 assert (_was_activated);
662 _descriptor->run (_handle, nframes);
666 LadspaPlugin::latency_compute_run ()
668 if (!_latency_control_port) {
672 /* we need to run the plugin so that it can set its latency
678 uint32_t port_index = 0;
679 uint32_t in_index = 0;
680 uint32_t out_index = 0;
681 const framecnt_t bufsize = 1024;
682 LADSPA_Data buffer[bufsize];
684 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
686 /* Note that we've already required that plugins
687 be able to handle in-place processing.
692 while (port_index < parameter_count()) {
693 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
694 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
695 connect_port (port_index, buffer);
697 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
698 connect_port (port_index, buffer);
705 run_in_place (bufsize);
710 LadspaPluginInfo::load (Session& session)
716 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
717 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
718 error << dlerror() << endmsg;
719 return PluginPtr ((Plugin*) 0);
721 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
724 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
728 catch (failed_constructor &err) {
729 return PluginPtr ((Plugin*) 0);
733 LadspaPluginInfo::LadspaPluginInfo()
735 type = ARDOUR::LADSPA;
740 LadspaPlugin::find_presets ()
743 std::string unique (unique_id());
745 if (!isdigit (unique[0])) {
749 id = atol (unique.c_str());
751 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
754 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
755 if (char* label = lrdf_get_label(set_uris->items[i])) {
756 PresetRecord rec (set_uris->items[i], label);
757 _presets.insert (make_pair (set_uris->items[i], rec));
760 lrdf_free_uris(set_uris);
766 LadspaPlugin::load_preset (PresetRecord r)
768 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
771 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
772 if (parameter_is_input (defs->items[i].pid)) {
773 set_parameter(defs->items[i].pid, defs->items[i].value);
776 lrdf_free_setting_values(defs);
779 Plugin::load_preset (r);
783 /* XXX: should be in liblrdf */
785 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
790 char setting_uri_copy[64];
793 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
795 p.subject = setting_uri_copy;
796 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
799 q = lrdf_matches(&p);
803 for (i = q; i; i = i->next) {
804 p.subject = i->object;
805 lrdf_remove_matches(&p);
808 lrdf_free_statements(q);
811 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
813 p.object = setting_uri_copy;
814 lrdf_remove_matches(&p);
816 p.subject = setting_uri_copy;
819 lrdf_remove_matches (&p);
823 LadspaPlugin::do_remove_preset (string name)
825 string const envvar = preset_envvar ();
826 if (envvar.empty()) {
827 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
831 Plugin::PresetRecord const * p = preset_by_label (name);
836 string const source = preset_source (envvar);
837 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
839 write_preset_file (envvar);
843 LadspaPlugin::preset_envvar () const
846 if ((envvar = getenv ("HOME")) == 0) {
854 LadspaPlugin::preset_source (string envvar) const
856 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
860 LadspaPlugin::write_preset_file (string envvar)
862 string path = string_compose("%1/.ladspa", envvar);
863 if (g_mkdir_with_parents (path.c_str(), 0775)) {
864 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
869 if (g_mkdir_with_parents (path.c_str(), 0775)) {
870 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
874 string const source = preset_source (envvar);
876 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
877 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
885 LadspaPlugin::do_save_preset (string name)
887 /* make a vector of pids that are input parameters */
888 vector<int> input_parameter_pids;
889 for (uint32_t i = 0; i < parameter_count(); ++i) {
890 if (parameter_is_input (i)) {
891 input_parameter_pids.push_back (i);
895 std::string unique (unique_id());
897 if (!isdigit (unique[0])) {
901 uint32_t const id = atol (unique.c_str());
903 lrdf_defaults defaults;
904 defaults.count = input_parameter_pids.size ();
905 lrdf_portvalue portvalues[input_parameter_pids.size()];
906 defaults.items = portvalues;
908 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
909 portvalues[i].pid = input_parameter_pids[i];
910 portvalues[i].value = get_parameter (input_parameter_pids[i]);
913 string const envvar = preset_envvar ();
914 if (envvar.empty()) {
915 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
919 string const source = preset_source (envvar);
921 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
922 string uri (uri_char);
925 if (!write_preset_file (envvar)) {
932 LADSPA_PortDescriptor
933 LadspaPlugin::port_descriptor (uint32_t i) const
935 if (i < _descriptor->PortCount) {
936 return _descriptor->PortDescriptors[i];
939 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;