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/locale_guard.h"
45 #include "pbd/xml++.h"
46 #include "pbd/stacktrace.h"
48 #include "ardour/session.h"
49 #include "ardour/ladspa_plugin.h"
50 #include "ardour/buffer_set.h"
51 #include "ardour/audio_buffer.h"
53 #include "pbd/stl_delete.h"
59 using namespace ARDOUR;
62 LadspaPlugin::LadspaPlugin (string module_path, AudioEngine& e, Session& session, uint32_t index, samplecnt_t rate)
65 init (module_path, index, rate);
68 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
71 init (other._module_path, other._index, other._sample_rate);
73 for (uint32_t i = 0; i < parameter_count(); ++i) {
74 _control_data[i] = other._shadow_data[i];
75 _shadow_data[i] = other._shadow_data[i];
80 LadspaPlugin::init (string module_path, uint32_t index, samplecnt_t rate)
83 LADSPA_Descriptor_Function dfunc;
86 _module_path = module_path;
87 _module = new Glib::Module(_module_path);
90 _latency_control_port = 0;
91 _was_activated = false;
94 error << _("LADSPA: Unable to open module: ") << Glib::Module::get_last_error() << endmsg;
96 throw failed_constructor();
99 if (!_module->get_symbol("ladspa_descriptor", func)) {
100 error << _("LADSPA: module has no descriptor function.") << endmsg;
101 throw failed_constructor();
104 dfunc = (LADSPA_Descriptor_Function)func;
106 if ((_descriptor = dfunc (index)) == 0) {
107 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
108 throw failed_constructor();
113 if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
114 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
115 throw failed_constructor();
120 if (_descriptor->instantiate == 0) {
121 throw failed_constructor();
124 if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
125 throw failed_constructor();
128 port_cnt = parameter_count();
130 _control_data = new LADSPA_Data[port_cnt];
131 memset (_control_data, 0, sizeof (LADSPA_Data) * port_cnt);
132 _shadow_data = new LADSPA_Data[port_cnt];
133 memset (_shadow_data, 0, sizeof (LADSPA_Data) * port_cnt);
135 for (i = 0; i < port_cnt; ++i) {
136 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
137 connect_port (i, &_control_data[i]);
139 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
140 strcmp (port_names()[i], X_("latency")) == 0) {
141 _latency_control_port = &_control_data[i];
142 *_latency_control_port = 0;
145 _shadow_data[i] = _default_value (i);
146 _control_data[i] = _shadow_data[i];
150 latency_compute_run ();
153 LadspaPlugin::~LadspaPlugin ()
158 // glib has internal reference counting on modules so this is ok
161 delete [] _control_data;
162 delete [] _shadow_data;
166 LadspaPlugin::unique_id() const
169 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
174 LadspaPlugin::_default_value (uint32_t port) const
176 const LADSPA_PortRangeHint *prh = port_range_hints();
178 bool bounds_given = false;
179 bool sr_scaling = false;
180 bool earlier_hint = false;
182 /* defaults - case 1 */
184 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
185 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
186 ret = prh[port].LowerBound;
191 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
192 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
196 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
197 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
201 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
202 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
206 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
207 ret = prh[port].UpperBound;
211 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
215 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
219 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
223 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
233 /* defaults - case 2 */
234 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
235 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
237 if (prh[port].LowerBound < 0) {
240 ret = prh[port].LowerBound;
247 /* defaults - case 3 */
248 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
249 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
251 if (prh[port].UpperBound > 0) {
254 ret = prh[port].UpperBound;
261 /* defaults - case 4 */
262 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
263 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
265 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
267 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
268 ret = prh[port].UpperBound;
270 ret = prh[port].LowerBound;
276 /* defaults - case 5 */
278 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
292 LadspaPlugin::set_parameter (uint32_t which, float val)
294 if (which < _descriptor->PortCount) {
296 if (get_parameter (which) == val) {
300 _shadow_data[which] = (LADSPA_Data) val;
303 if (which < parameter_count() && controls[which]) {
304 controls[which]->Changed ();
309 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may "
310 "indicate a change in the plugin design, and presets may be "
315 Plugin::set_parameter (which, val);
318 /** @return `plugin' value */
320 LadspaPlugin::get_parameter (uint32_t which) const
322 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
323 return (float) _shadow_data[which];
325 return (float) _control_data[which];
330 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
336 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
337 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
348 LadspaPlugin::add_state (XMLNode* root) const
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 child->set_property("number", i);
359 child->set_property("value", _shadow_data[i]);
360 root->add_child_nocopy (*child);
366 LadspaPlugin::set_state (const XMLNode& node, int version)
368 if (version < 3000) {
369 return set_state_2X (node, version);
372 #ifndef NO_PLUGIN_STATE
374 XMLNodeConstIterator iter;
378 if (node.name() != state_node_name()) {
379 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
383 #ifndef NO_PLUGIN_STATE
385 nodes = node.children ("Port");
387 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
394 if (!child->get_property ("number", port_id)) {
395 warning << _("LADSPA: no ladspa port number") << endmsg;
399 if (!child->get_property ("value", value)) {
400 warning << _("LADSPA: no ladspa port data") << endmsg;
404 set_parameter (port_id, value);
408 latency_compute_run ();
410 return Plugin::set_state (node, version);
414 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
416 #ifndef NO_PLUGIN_STATE
418 XMLProperty const * prop;
419 XMLNodeConstIterator iter;
427 if (node.name() != state_node_name()) {
428 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
432 #ifndef NO_PLUGIN_STATE
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 ();
463 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
465 LADSPA_PortRangeHint prh;
467 prh = port_range_hints()[which];
470 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
471 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
472 desc.lower = prh.LowerBound * _session.sample_rate();
474 desc.lower = prh.LowerBound;
481 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
482 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
483 desc.upper = prh.UpperBound * _session.sample_rate();
485 desc.upper = prh.UpperBound;
488 if (LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor)) {
491 desc.upper = 4; /* completely arbitrary */
495 if (LADSPA_IS_HINT_HAS_DEFAULT (prh.HintDescriptor)) {
496 desc.normal = _default_value(which);
498 /* if there is no explicit hint for the default
499 * value, use lower bound. This is not great but
500 * better than just assuming '0' which may be out-of range.
502 desc.normal = desc.lower;
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];
512 desc.scale_points = get_scale_points(which);
519 LadspaPlugin::describe_parameter (Evoral::Parameter which)
521 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
522 return port_names()[which.id()];
529 LadspaPlugin::signal_latency () const
532 return _user_latency;
535 if (_latency_control_port) {
536 return (samplecnt_t) floor (*_latency_control_port);
542 set<Evoral::Parameter>
543 LadspaPlugin::automatable () const
545 set<Evoral::Parameter> ret;
547 for (uint32_t i = 0; i < parameter_count(); ++i){
548 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
549 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
551 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
559 LadspaPlugin::connect_and_run (BufferSet& bufs,
560 samplepos_t start, samplepos_t end, double speed,
561 ChanMapping in_map, ChanMapping out_map,
562 pframes_t nframes, samplecnt_t offset)
564 Plugin::connect_and_run (bufs, start, end, speed, in_map, out_map, nframes, offset);
567 cycles_t then = get_cycles ();
569 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
570 BufferSet& scratch_bufs = _session.get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
572 uint32_t audio_in_index = 0;
573 uint32_t audio_out_index = 0;
575 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
576 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
577 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
578 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
579 connect_port(port_index,
580 valid ? bufs.get_audio(buf_index).data(offset)
581 : silent_bufs.get_audio(0).data(offset));
582 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
583 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
584 connect_port(port_index,
585 valid ? bufs.get_audio(buf_index).data(offset)
586 : scratch_bufs.get_audio(0).data(offset));
591 run_in_place (nframes);
593 set_cycles ((uint32_t) (now - then));
599 LadspaPlugin::parameter_is_control (uint32_t param) const
601 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
605 LadspaPlugin::parameter_is_audio (uint32_t param) const
607 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
611 LadspaPlugin::parameter_is_output (uint32_t param) const
613 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
617 LadspaPlugin::parameter_is_input (uint32_t param) const
619 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
623 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
626 if (param < parameter_count()) {
627 snprintf (buf, len, "%.3f", get_parameter (param));
634 boost::shared_ptr<ScalePoints>
635 LadspaPlugin::get_scale_points(uint32_t port_index) const
637 boost::shared_ptr<ScalePoints> ret;
639 const uint32_t id = atol(unique_id().c_str());
640 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
646 ret = boost::shared_ptr<ScalePoints>(new ScalePoints());
648 for (uint32_t i = 0; i < points->count; ++i) {
649 ret->insert(make_pair(points->items[i].label,
650 points->items[i].value));
653 lrdf_free_setting_values(points);
659 LadspaPlugin::run_in_place (pframes_t nframes)
661 for (uint32_t i = 0; i < parameter_count(); ++i) {
662 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
663 _control_data[i] = _shadow_data[i];
667 assert (_was_activated);
669 _descriptor->run (_handle, nframes);
673 LadspaPlugin::latency_compute_run ()
675 if (!_latency_control_port) {
679 /* we need to run the plugin so that it can set its latency
685 uint32_t port_index = 0;
686 uint32_t in_index = 0;
687 uint32_t out_index = 0;
688 const samplecnt_t bufsize = 1024;
689 LADSPA_Data buffer[bufsize];
691 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
693 /* Note that we've already required that plugins
694 be able to handle in-place processing.
699 while (port_index < parameter_count()) {
700 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
701 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
702 connect_port (port_index, buffer);
704 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
705 connect_port (port_index, buffer);
712 run_in_place (bufsize);
717 LadspaPluginInfo::load (Session& session)
720 PluginPtr plugin (new LadspaPlugin (path, session.engine(), session, index, session.sample_rate()));
721 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
725 catch (failed_constructor &err) {
726 return PluginPtr ((Plugin*) 0);
730 std::vector<Plugin::PresetRecord>
731 LadspaPluginInfo::get_presets (bool /*user_only*/) const
733 std::vector<Plugin::PresetRecord> p;
734 #if (defined HAVE_LRDF && !defined NO_PLUGIN_STATE)
735 if (!isdigit (unique_id[0])) {
738 uint32_t id = atol (unique_id);
739 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
742 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
743 if (char* label = lrdf_get_label (set_uris->items[i])) {
744 p.push_back (Plugin::PresetRecord (set_uris->items[i], label));
747 lrdf_free_uris(set_uris);
753 LadspaPluginInfo::LadspaPluginInfo()
755 type = ARDOUR::LADSPA;
760 LadspaPlugin::find_presets ()
764 std::string unique (unique_id());
766 if (!isdigit (unique[0])) {
770 id = atol (unique.c_str());
772 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
775 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
776 if (char* label = lrdf_get_label(set_uris->items[i])) {
777 PresetRecord rec (set_uris->items[i], label);
778 _presets.insert (make_pair (set_uris->items[i], rec));
781 lrdf_free_uris(set_uris);
788 LadspaPlugin::load_preset (PresetRecord r)
791 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
794 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
795 if (parameter_is_input (defs->items[i].pid)) {
796 set_parameter(defs->items[i].pid, defs->items[i].value);
797 PresetPortSetValue (defs->items[i].pid, defs->items[i].value); /* EMIT SIGNAL */
800 lrdf_free_setting_values(defs);
803 Plugin::load_preset (r);
809 /* XXX: should be in liblrdf */
811 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
816 char setting_uri_copy[64];
819 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
821 p.subject = setting_uri_copy;
822 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
825 q = lrdf_matches(&p);
829 for (i = q; i; i = i->next) {
830 p.subject = i->object;
831 lrdf_remove_matches(&p);
834 lrdf_free_statements(q);
837 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
839 p.object = setting_uri_copy;
840 lrdf_remove_matches(&p);
842 p.subject = setting_uri_copy;
845 lrdf_remove_matches (&p);
850 LadspaPlugin::do_remove_preset (string name)
853 string const envvar = preset_envvar ();
854 if (envvar.empty()) {
855 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
859 Plugin::PresetRecord const * p = preset_by_label (name);
864 string const source = preset_source (envvar);
865 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
867 write_preset_file (envvar);
872 LadspaPlugin::preset_envvar () const
875 if ((envvar = getenv ("HOME")) == 0) {
883 LadspaPlugin::preset_source (string envvar) const
885 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
889 LadspaPlugin::write_preset_file (string envvar)
892 string path = string_compose("%1/.ladspa", envvar);
893 if (g_mkdir_with_parents (path.c_str(), 0775)) {
894 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
899 if (g_mkdir_with_parents (path.c_str(), 0775)) {
900 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
904 string const source = preset_source (envvar);
906 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
907 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
918 LadspaPlugin::do_save_preset (string name)
921 /* make a vector of pids that are input parameters */
922 vector<int> input_parameter_pids;
923 for (uint32_t i = 0; i < parameter_count(); ++i) {
924 if (parameter_is_input (i)) {
925 input_parameter_pids.push_back (i);
929 std::string unique (unique_id());
931 if (!isdigit (unique[0])) {
935 uint32_t const id = atol (unique.c_str());
937 lrdf_defaults defaults;
938 defaults.count = input_parameter_pids.size ();
939 std::vector<lrdf_portvalue> portvalues(input_parameter_pids.size());
940 defaults.items = &portvalues[0];
942 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
943 portvalues[i].pid = input_parameter_pids[i];
944 portvalues[i].value = get_parameter (input_parameter_pids[i]);
947 string const envvar = preset_envvar ();
948 if (envvar.empty()) {
949 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
953 string const source = preset_source (envvar);
955 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
956 string uri (uri_char);
959 if (!write_preset_file (envvar)) {
969 LADSPA_PortDescriptor
970 LadspaPlugin::port_descriptor (uint32_t i) const
972 if (i < _descriptor->PortCount) {
973 return _descriptor->PortDescriptors[i];
976 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;