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
40 #include "pbd/compose.h"
41 #include "pbd/error.h"
42 #include "pbd/xml++.h"
43 #include "pbd/stacktrace.h"
45 #include "midi++/manager.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 _shadow_data = new LADSPA_Data[port_cnt];
132 for (i = 0; i < port_cnt; ++i) {
133 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
134 connect_port (i, &_control_data[i]);
136 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
137 strcmp (port_names()[i], X_("latency")) == 0) {
138 _latency_control_port = &_control_data[i];
139 *_latency_control_port = 0;
142 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
146 _shadow_data[i] = default_value (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)
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 LocaleGuard lg (X_("POSIX"));
354 for (uint32_t i = 0; i < parameter_count(); ++i){
356 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
357 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
359 child = new XMLNode("Port");
360 snprintf(buf, sizeof(buf), "%u", i);
361 child->add_property("number", string(buf));
362 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
363 child->add_property("value", string(buf));
364 root->add_child_nocopy (*child);
370 LadspaPlugin::set_state (const XMLNode& node, int version)
372 if (version < 3000) {
373 return set_state_2X (node, version);
376 #ifndef NO_PLUGIN_STATE
379 XMLNodeConstIterator iter;
385 LocaleGuard lg (X_("POSIX"));
387 if (node.name() != state_node_name()) {
388 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
392 #ifndef NO_PLUGIN_STATE
394 nodes = node.children ("Port");
396 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
400 if ((prop = child->property("number")) != 0) {
401 port = prop->value().c_str();
403 warning << _("LADSPA: no ladspa port number") << endmsg;
406 if ((prop = child->property("value")) != 0) {
407 data = prop->value().c_str();
409 warning << _("LADSPA: no ladspa port data") << endmsg;
413 sscanf (port, "%" PRIu32, &port_id);
414 set_parameter (port_id, atof(data));
418 latency_compute_run ();
420 return Plugin::set_state (node, version);
424 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
426 #ifndef NO_PLUGIN_STATE
429 XMLNodeConstIterator iter;
435 LocaleGuard lg (X_("POSIX"));
437 if (node.name() != state_node_name()) {
438 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
442 #ifndef NO_PLUGIN_STATE
443 nodes = node.children ("port");
445 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
449 if ((prop = child->property("number")) != 0) {
450 port = prop->value().c_str();
452 warning << _("LADSPA: no ladspa port number") << endmsg;
455 if ((prop = child->property("value")) != 0) {
456 data = prop->value().c_str();
458 warning << _("LADSPA: no ladspa port data") << endmsg;
462 sscanf (port, "%" PRIu32, &port_id);
463 set_parameter (port_id, atof(data));
466 latency_compute_run ();
473 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
475 LADSPA_PortRangeHint prh;
477 prh = port_range_hints()[which];
480 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
481 desc.min_unbound = false;
482 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
483 desc.lower = prh.LowerBound * _session.frame_rate();
485 desc.lower = prh.LowerBound;
488 desc.min_unbound = true;
493 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
494 desc.max_unbound = false;
495 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
496 desc.upper = prh.UpperBound * _session.frame_rate();
498 desc.upper = prh.UpperBound;
501 desc.max_unbound = true;
502 desc.upper = 4; /* completely arbitrary */
505 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
507 desc.smallstep = 0.1;
508 desc.largestep = 10.0;
510 float delta = desc.upper - desc.lower;
511 desc.step = delta / 1000.0f;
512 desc.smallstep = delta / 10000.0f;
513 desc.largestep = delta/10.0f;
516 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
517 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
518 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
519 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
521 desc.label = port_names()[which];
527 LadspaPlugin::describe_parameter (Evoral::Parameter which)
529 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
530 return port_names()[which.id()];
537 LadspaPlugin::signal_latency () const
540 return _user_latency;
543 if (_latency_control_port) {
544 return (framecnt_t) floor (*_latency_control_port);
550 set<Evoral::Parameter>
551 LadspaPlugin::automatable () const
553 set<Evoral::Parameter> ret;
555 for (uint32_t i = 0; i < parameter_count(); ++i){
556 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
557 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
559 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
567 LadspaPlugin::connect_and_run (BufferSet& bufs,
568 ChanMapping in_map, ChanMapping out_map,
569 pframes_t nframes, framecnt_t offset)
571 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
574 cycles_t then = get_cycles ();
576 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
577 BufferSet& scratch_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
579 uint32_t audio_in_index = 0;
580 uint32_t audio_out_index = 0;
582 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
583 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
584 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
585 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
586 connect_port(port_index,
587 valid ? bufs.get_audio(buf_index).data(offset)
588 : silent_bufs.get_audio(0).data(offset));
589 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
590 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
591 connect_port(port_index,
592 valid ? bufs.get_audio(buf_index).data(offset)
593 : scratch_bufs.get_audio(0).data(offset));
598 run_in_place (nframes);
600 set_cycles ((uint32_t) (now - then));
606 LadspaPlugin::parameter_is_control (uint32_t param) const
608 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
612 LadspaPlugin::parameter_is_audio (uint32_t param) const
614 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
618 LadspaPlugin::parameter_is_output (uint32_t param) const
620 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
624 LadspaPlugin::parameter_is_input (uint32_t param) const
626 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
630 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
633 if (param < parameter_count()) {
634 snprintf (buf, len, "%.3f", get_parameter (param));
641 boost::shared_ptr<Plugin::ScalePoints>
642 LadspaPlugin::get_scale_points(uint32_t port_index) const
644 boost::shared_ptr<Plugin::ScalePoints> ret;
646 const uint32_t id = atol(unique_id().c_str());
647 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
653 ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
655 for (uint32_t i = 0; i < points->count; ++i) {
656 ret->insert(make_pair(points->items[i].label,
657 points->items[i].value));
660 lrdf_free_setting_values(points);
666 LadspaPlugin::run_in_place (pframes_t nframes)
668 for (uint32_t i = 0; i < parameter_count(); ++i) {
669 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
670 _control_data[i] = _shadow_data[i];
674 assert (_was_activated);
676 _descriptor->run (_handle, nframes);
680 LadspaPlugin::latency_compute_run ()
682 if (!_latency_control_port) {
686 /* we need to run the plugin so that it can set its latency
692 uint32_t port_index = 0;
693 uint32_t in_index = 0;
694 uint32_t out_index = 0;
695 const framecnt_t bufsize = 1024;
696 LADSPA_Data buffer[bufsize];
698 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
700 /* Note that we've already required that plugins
701 be able to handle in-place processing.
706 while (port_index < parameter_count()) {
707 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
708 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
709 connect_port (port_index, buffer);
711 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
712 connect_port (port_index, buffer);
719 run_in_place (bufsize);
724 LadspaPluginInfo::load (Session& session)
727 PluginPtr plugin (new LadspaPlugin (path, session.engine(), session, index, session.frame_rate()));
728 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
732 catch (failed_constructor &err) {
733 return PluginPtr ((Plugin*) 0);
737 LadspaPluginInfo::LadspaPluginInfo()
739 type = ARDOUR::LADSPA;
744 LadspaPlugin::find_presets ()
748 std::string unique (unique_id());
750 if (!isdigit (unique[0])) {
754 id = atol (unique.c_str());
756 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
759 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
760 if (char* label = lrdf_get_label(set_uris->items[i])) {
761 PresetRecord rec (set_uris->items[i], label);
762 _presets.insert (make_pair (set_uris->items[i], rec));
765 lrdf_free_uris(set_uris);
772 LadspaPlugin::load_preset (PresetRecord r)
775 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
778 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
779 if (parameter_is_input (defs->items[i].pid)) {
780 set_parameter(defs->items[i].pid, defs->items[i].value);
783 lrdf_free_setting_values(defs);
786 Plugin::load_preset (r);
791 /* XXX: should be in liblrdf */
793 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
799 char setting_uri_copy[64];
802 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
804 p.subject = setting_uri_copy;
805 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
808 q = lrdf_matches(&p);
812 for (i = q; i; i = i->next) {
813 p.subject = i->object;
814 lrdf_remove_matches(&p);
817 lrdf_free_statements(q);
820 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
822 p.object = setting_uri_copy;
823 lrdf_remove_matches(&p);
825 p.subject = setting_uri_copy;
828 lrdf_remove_matches (&p);
833 LadspaPlugin::do_remove_preset (string name)
836 string const envvar = preset_envvar ();
837 if (envvar.empty()) {
838 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
842 Plugin::PresetRecord const * p = preset_by_label (name);
847 string const source = preset_source (envvar);
848 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
850 write_preset_file (envvar);
855 LadspaPlugin::preset_envvar () const
858 if ((envvar = getenv ("HOME")) == 0) {
866 LadspaPlugin::preset_source (string envvar) const
868 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
872 LadspaPlugin::write_preset_file (string envvar)
875 string path = string_compose("%1/.ladspa", envvar);
876 if (g_mkdir_with_parents (path.c_str(), 0775)) {
877 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
882 if (g_mkdir_with_parents (path.c_str(), 0775)) {
883 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
887 string const source = preset_source (envvar);
889 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
890 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
901 LadspaPlugin::do_save_preset (string name)
904 /* make a vector of pids that are input parameters */
905 vector<int> input_parameter_pids;
906 for (uint32_t i = 0; i < parameter_count(); ++i) {
907 if (parameter_is_input (i)) {
908 input_parameter_pids.push_back (i);
912 std::string unique (unique_id());
914 if (!isdigit (unique[0])) {
918 uint32_t const id = atol (unique.c_str());
920 lrdf_defaults defaults;
921 defaults.count = input_parameter_pids.size ();
922 lrdf_portvalue portvalues[input_parameter_pids.size()];
923 defaults.items = portvalues;
925 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
926 portvalues[i].pid = input_parameter_pids[i];
927 portvalues[i].value = get_parameter (input_parameter_pids[i]);
930 string const envvar = preset_envvar ();
931 if (envvar.empty()) {
932 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
936 string const source = preset_source (envvar);
938 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
939 string uri (uri_char);
942 if (!write_preset_file (envvar)) {
952 LADSPA_PortDescriptor
953 LadspaPlugin::port_descriptor (uint32_t i) const
955 if (i < _descriptor->PortCount) {
956 return _descriptor->PortDescriptors[i];
959 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;