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/session.h"
41 #include "ardour/ladspa_plugin.h"
42 #include "ardour/buffer_set.h"
43 #include "ardour/audio_buffer.h"
45 #include "pbd/stl_delete.h"
51 using namespace ARDOUR;
54 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, framecnt_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, framecnt_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 latency_compute_run ();
139 LadspaPlugin::~LadspaPlugin ()
144 /* XXX who should close a plugin? */
148 delete [] _control_data;
149 delete [] _shadow_data;
153 LadspaPlugin::unique_id() const
156 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
161 LadspaPlugin::default_value (uint32_t port)
163 const LADSPA_PortRangeHint *prh = port_range_hints();
165 bool bounds_given = false;
166 bool sr_scaling = false;
167 bool earlier_hint = false;
169 /* defaults - case 1 */
171 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
172 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
173 ret = prh[port].LowerBound;
178 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
179 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
183 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
184 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
188 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
189 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
193 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
194 ret = prh[port].UpperBound;
198 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
202 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
206 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
210 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
220 /* defaults - case 2 */
221 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
222 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
224 if (prh[port].LowerBound < 0) {
227 ret = prh[port].LowerBound;
234 /* defaults - case 3 */
235 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
236 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
238 if (prh[port].UpperBound > 0) {
241 ret = prh[port].UpperBound;
248 /* defaults - case 4 */
249 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
250 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
252 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
254 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
255 ret = prh[port].UpperBound;
257 ret = prh[port].LowerBound;
263 /* defaults - case 5 */
265 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
279 LadspaPlugin::set_parameter (uint32_t which, float val)
281 if (which < _descriptor->PortCount) {
283 if (get_parameter (which) == val) {
287 _shadow_data[which] = (LADSPA_Data) val;
290 if (which < parameter_count() && controls[which]) {
291 controls[which]->Changed ();
296 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may "
297 "indicate a change in the plugin design, and presets may be "
302 Plugin::set_parameter (which, val);
305 /** @return `plugin' value */
307 LadspaPlugin::get_parameter (uint32_t which) const
309 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
310 return (float) _shadow_data[which];
312 return (float) _control_data[which];
317 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
323 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
324 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
335 LadspaPlugin::add_state (XMLNode* root) const
339 LocaleGuard lg (X_("POSIX"));
341 for (uint32_t i = 0; i < parameter_count(); ++i){
343 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
344 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
346 child = new XMLNode("Port");
347 snprintf(buf, sizeof(buf), "%u", i);
348 child->add_property("number", string(buf));
349 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
350 child->add_property("value", string(buf));
351 root->add_child_nocopy (*child);
357 LadspaPlugin::set_state (const XMLNode& node, int version)
359 if (version < 3000) {
360 return set_state_2X (node, version);
365 XMLNodeConstIterator iter;
370 LocaleGuard lg (X_("POSIX"));
372 if (node.name() != state_node_name()) {
373 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
377 nodes = node.children ("Port");
379 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
383 if ((prop = child->property("number")) != 0) {
384 port = prop->value().c_str();
386 warning << _("LADSPA: no ladspa port number") << endmsg;
389 if ((prop = child->property("value")) != 0) {
390 data = prop->value().c_str();
392 warning << _("LADSPA: no ladspa port data") << endmsg;
396 sscanf (port, "%" PRIu32, &port_id);
397 set_parameter (port_id, atof(data));
400 latency_compute_run ();
402 return Plugin::set_state (node, version);
406 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
410 XMLNodeConstIterator iter;
415 LocaleGuard lg (X_("POSIX"));
417 if (node.name() != state_node_name()) {
418 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
422 nodes = node.children ("port");
424 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
428 if ((prop = child->property("number")) != 0) {
429 port = prop->value().c_str();
431 warning << _("LADSPA: no ladspa port number") << endmsg;
434 if ((prop = child->property("value")) != 0) {
435 data = prop->value().c_str();
437 warning << _("LADSPA: no ladspa port data") << endmsg;
441 sscanf (port, "%" PRIu32, &port_id);
442 set_parameter (port_id, atof(data));
445 latency_compute_run ();
451 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
453 LADSPA_PortRangeHint prh;
455 prh = port_range_hints()[which];
458 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
459 desc.min_unbound = false;
460 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
461 desc.lower = prh.LowerBound * _session.frame_rate();
463 desc.lower = prh.LowerBound;
466 desc.min_unbound = true;
471 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
472 desc.max_unbound = false;
473 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
474 desc.upper = prh.UpperBound * _session.frame_rate();
476 desc.upper = prh.UpperBound;
479 desc.max_unbound = true;
480 desc.upper = 4; /* completely arbitrary */
483 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
485 desc.smallstep = 0.1;
486 desc.largestep = 10.0;
488 float delta = desc.upper - desc.lower;
489 desc.step = delta / 1000.0f;
490 desc.smallstep = delta / 10000.0f;
491 desc.largestep = delta/10.0f;
494 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
495 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
496 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
497 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
499 desc.label = port_names()[which];
505 LadspaPlugin::describe_parameter (Evoral::Parameter which)
507 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
508 return port_names()[which.id()];
515 LadspaPlugin::signal_latency () const
518 return _user_latency;
521 if (_latency_control_port) {
522 return (framecnt_t) floor (*_latency_control_port);
528 set<Evoral::Parameter>
529 LadspaPlugin::automatable () const
531 set<Evoral::Parameter> ret;
533 for (uint32_t i = 0; i < parameter_count(); ++i){
534 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
535 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
537 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
545 LadspaPlugin::connect_and_run (BufferSet& bufs,
546 ChanMapping in_map, ChanMapping out_map,
547 pframes_t nframes, framecnt_t offset)
549 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
552 cycles_t then = get_cycles ();
554 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
555 BufferSet& scratch_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
557 uint32_t audio_in_index = 0;
558 uint32_t audio_out_index = 0;
560 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
561 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
562 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
563 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
564 connect_port(port_index,
565 valid ? bufs.get_audio(buf_index).data(offset)
566 : silent_bufs.get_audio(0).data(offset));
567 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
568 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
569 connect_port(port_index,
570 valid ? bufs.get_audio(buf_index).data(offset)
571 : scratch_bufs.get_audio(0).data(offset));
576 run_in_place (nframes);
578 set_cycles ((uint32_t) (now - then));
584 LadspaPlugin::parameter_is_control (uint32_t param) const
586 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
590 LadspaPlugin::parameter_is_audio (uint32_t param) const
592 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
596 LadspaPlugin::parameter_is_output (uint32_t param) const
598 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
602 LadspaPlugin::parameter_is_input (uint32_t param) const
604 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
608 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
611 if (param < parameter_count()) {
612 snprintf (buf, len, "%.3f", get_parameter (param));
619 boost::shared_ptr<Plugin::ScalePoints>
620 LadspaPlugin::get_scale_points(uint32_t port_index) const
622 const uint32_t id = atol(unique_id().c_str());
623 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
625 boost::shared_ptr<Plugin::ScalePoints> ret;
630 ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
632 for (uint32_t i = 0; i < points->count; ++i) {
633 ret->insert(make_pair(points->items[i].label,
634 points->items[i].value));
637 lrdf_free_setting_values(points);
642 LadspaPlugin::run_in_place (pframes_t nframes)
644 for (uint32_t i = 0; i < parameter_count(); ++i) {
645 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
646 _control_data[i] = _shadow_data[i];
650 assert (_was_activated);
652 _descriptor->run (_handle, nframes);
656 LadspaPlugin::latency_compute_run ()
658 if (!_latency_control_port) {
662 /* we need to run the plugin so that it can set its latency
668 uint32_t port_index = 0;
669 uint32_t in_index = 0;
670 uint32_t out_index = 0;
671 const framecnt_t bufsize = 1024;
672 LADSPA_Data buffer[bufsize];
674 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
676 /* Note that we've already required that plugins
677 be able to handle in-place processing.
682 while (port_index < parameter_count()) {
683 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
684 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
685 connect_port (port_index, buffer);
687 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
688 connect_port (port_index, buffer);
695 run_in_place (bufsize);
700 LadspaPluginInfo::load (Session& session)
706 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
707 error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
708 error << dlerror() << endmsg;
709 return PluginPtr ((Plugin*) 0);
711 plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
714 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
718 catch (failed_constructor &err) {
719 return PluginPtr ((Plugin*) 0);
723 LadspaPluginInfo::LadspaPluginInfo()
725 type = ARDOUR::LADSPA;
730 LadspaPlugin::find_presets ()
733 std::string unique (unique_id());
735 if (!isdigit (unique[0])) {
739 id = atol (unique.c_str());
741 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
744 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
745 if (char* label = lrdf_get_label(set_uris->items[i])) {
746 PresetRecord rec (set_uris->items[i], label);
747 _presets.insert (make_pair (set_uris->items[i], rec));
750 lrdf_free_uris(set_uris);
756 LadspaPlugin::load_preset (PresetRecord r)
758 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
761 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
762 if (parameter_is_input (defs->items[i].pid)) {
763 set_parameter(defs->items[i].pid, defs->items[i].value);
766 lrdf_free_setting_values(defs);
769 Plugin::load_preset (r);
773 /* XXX: should be in liblrdf */
775 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
780 char setting_uri_copy[64];
783 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
785 p.subject = setting_uri_copy;
786 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
789 q = lrdf_matches(&p);
793 for (i = q; i; i = i->next) {
794 p.subject = i->object;
795 lrdf_remove_matches(&p);
798 lrdf_free_statements(q);
801 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
803 p.object = setting_uri_copy;
804 lrdf_remove_matches(&p);
806 p.subject = setting_uri_copy;
809 lrdf_remove_matches (&p);
813 LadspaPlugin::do_remove_preset (string name)
815 string const envvar = preset_envvar ();
816 if (envvar.empty()) {
817 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
821 Plugin::PresetRecord const * p = preset_by_label (name);
826 string const source = preset_source (envvar);
827 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
829 write_preset_file (envvar);
833 LadspaPlugin::preset_envvar () const
836 if ((envvar = getenv ("HOME")) == 0) {
844 LadspaPlugin::preset_source (string envvar) const
846 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
850 LadspaPlugin::write_preset_file (string envvar)
852 string path = string_compose("%1/.ladspa", envvar);
853 if (g_mkdir_with_parents (path.c_str(), 0775)) {
854 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
859 if (g_mkdir_with_parents (path.c_str(), 0775)) {
860 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
864 string const source = preset_source (envvar);
866 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
867 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
875 LadspaPlugin::do_save_preset (string name)
877 /* make a vector of pids that are input parameters */
878 vector<int> input_parameter_pids;
879 for (uint32_t i = 0; i < parameter_count(); ++i) {
880 if (parameter_is_input (i)) {
881 input_parameter_pids.push_back (i);
885 std::string unique (unique_id());
887 if (!isdigit (unique[0])) {
891 uint32_t const id = atol (unique.c_str());
893 lrdf_defaults defaults;
894 defaults.count = input_parameter_pids.size ();
895 lrdf_portvalue portvalues[input_parameter_pids.size()];
896 defaults.items = portvalues;
898 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
899 portvalues[i].pid = input_parameter_pids[i];
900 portvalues[i].value = get_parameter (input_parameter_pids[i]);
903 string const envvar = preset_envvar ();
904 if (envvar.empty()) {
905 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
909 string const source = preset_source (envvar);
911 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
912 string uri (uri_char);
915 if (!write_preset_file (envvar)) {
922 LADSPA_PortDescriptor
923 LadspaPlugin::port_descriptor (uint32_t i) const
925 if (i < _descriptor->PortCount) {
926 return _descriptor->PortDescriptors[i];
929 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;