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
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;
379 if (node.name() != state_node_name()) {
380 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
384 #ifndef NO_PLUGIN_STATE
386 nodes = node.children ("Port");
388 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
395 if (!child->get_property ("number", port_id)) {
396 warning << _("LADSPA: no ladspa port number") << endmsg;
400 if (!child->get_property ("value", value)) {
401 warning << _("LADSPA: no ladspa port data") << endmsg;
405 set_parameter (port_id, value);
409 latency_compute_run ();
411 return Plugin::set_state (node, version);
415 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
417 #ifndef NO_PLUGIN_STATE
419 XMLProperty const * prop;
420 XMLNodeConstIterator iter;
428 if (node.name() != state_node_name()) {
429 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
433 #ifndef NO_PLUGIN_STATE
434 nodes = node.children ("port");
436 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
440 if ((prop = child->property("number")) != 0) {
441 port = prop->value().c_str();
443 warning << _("LADSPA: no ladspa port number") << endmsg;
446 if ((prop = child->property("value")) != 0) {
447 data = prop->value().c_str();
449 warning << _("LADSPA: no ladspa port data") << endmsg;
453 sscanf (port, "%" PRIu32, &port_id);
454 set_parameter (port_id, atof(data));
457 latency_compute_run ();
464 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
466 LADSPA_PortRangeHint prh;
468 prh = port_range_hints()[which];
471 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
472 desc.min_unbound = false;
473 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
474 desc.lower = prh.LowerBound * _session.frame_rate();
476 desc.lower = prh.LowerBound;
479 desc.min_unbound = true;
484 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
485 desc.max_unbound = false;
486 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
487 desc.upper = prh.UpperBound * _session.frame_rate();
489 desc.upper = prh.UpperBound;
492 if (LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor)) {
493 desc.max_unbound = false;
496 desc.max_unbound = true;
497 desc.upper = 4; /* completely arbitrary */
501 if (LADSPA_IS_HINT_HAS_DEFAULT (prh.HintDescriptor)) {
502 desc.normal = _default_value(which);
504 /* if there is no explicit hint for the default
505 * value, use lower bound. This is not great but
506 * better than just assuming '0' which may be out-of range.
508 desc.normal = desc.lower;
511 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
512 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
513 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
514 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
516 desc.label = port_names()[which];
518 desc.scale_points = get_scale_points(which);
525 LadspaPlugin::describe_parameter (Evoral::Parameter which)
527 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
528 return port_names()[which.id()];
535 LadspaPlugin::signal_latency () const
538 return _user_latency;
541 if (_latency_control_port) {
542 return (framecnt_t) floor (*_latency_control_port);
548 set<Evoral::Parameter>
549 LadspaPlugin::automatable () const
551 set<Evoral::Parameter> ret;
553 for (uint32_t i = 0; i < parameter_count(); ++i){
554 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
555 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
557 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
565 LadspaPlugin::connect_and_run (BufferSet& bufs,
566 framepos_t start, framepos_t end, double speed,
567 ChanMapping in_map, ChanMapping out_map,
568 pframes_t nframes, framecnt_t offset)
570 Plugin::connect_and_run (bufs, start, end, speed, in_map, out_map, nframes, offset);
573 cycles_t then = get_cycles ();
575 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
576 BufferSet& scratch_bufs = _session.get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
578 uint32_t audio_in_index = 0;
579 uint32_t audio_out_index = 0;
581 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
582 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
583 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
584 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
585 connect_port(port_index,
586 valid ? bufs.get_audio(buf_index).data(offset)
587 : silent_bufs.get_audio(0).data(offset));
588 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
589 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
590 connect_port(port_index,
591 valid ? bufs.get_audio(buf_index).data(offset)
592 : scratch_bufs.get_audio(0).data(offset));
597 run_in_place (nframes);
599 set_cycles ((uint32_t) (now - then));
605 LadspaPlugin::parameter_is_control (uint32_t param) const
607 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
611 LadspaPlugin::parameter_is_audio (uint32_t param) const
613 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
617 LadspaPlugin::parameter_is_output (uint32_t param) const
619 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
623 LadspaPlugin::parameter_is_input (uint32_t param) const
625 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
629 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
632 if (param < parameter_count()) {
633 snprintf (buf, len, "%.3f", get_parameter (param));
640 boost::shared_ptr<ScalePoints>
641 LadspaPlugin::get_scale_points(uint32_t port_index) const
643 boost::shared_ptr<ScalePoints> ret;
645 const uint32_t id = atol(unique_id().c_str());
646 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
652 ret = boost::shared_ptr<ScalePoints>(new ScalePoints());
654 for (uint32_t i = 0; i < points->count; ++i) {
655 ret->insert(make_pair(points->items[i].label,
656 points->items[i].value));
659 lrdf_free_setting_values(points);
665 LadspaPlugin::run_in_place (pframes_t nframes)
667 for (uint32_t i = 0; i < parameter_count(); ++i) {
668 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
669 _control_data[i] = _shadow_data[i];
673 assert (_was_activated);
675 _descriptor->run (_handle, nframes);
679 LadspaPlugin::latency_compute_run ()
681 if (!_latency_control_port) {
685 /* we need to run the plugin so that it can set its latency
691 uint32_t port_index = 0;
692 uint32_t in_index = 0;
693 uint32_t out_index = 0;
694 const framecnt_t bufsize = 1024;
695 LADSPA_Data buffer[bufsize];
697 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
699 /* Note that we've already required that plugins
700 be able to handle in-place processing.
705 while (port_index < parameter_count()) {
706 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
707 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
708 connect_port (port_index, buffer);
710 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
711 connect_port (port_index, buffer);
718 run_in_place (bufsize);
723 LadspaPluginInfo::load (Session& session)
726 PluginPtr plugin (new LadspaPlugin (path, session.engine(), session, index, session.frame_rate()));
727 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
731 catch (failed_constructor &err) {
732 return PluginPtr ((Plugin*) 0);
736 std::vector<Plugin::PresetRecord>
737 LadspaPluginInfo::get_presets (bool /*user_only*/) const
739 std::vector<Plugin::PresetRecord> p;
740 #if (defined HAVE_LRDF && !defined NO_PLUGIN_STATE)
741 if (!isdigit (unique_id[0])) {
744 uint32_t id = atol (unique_id);
745 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
748 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
749 if (char* label = lrdf_get_label (set_uris->items[i])) {
750 p.push_back (Plugin::PresetRecord (set_uris->items[i], label));
753 lrdf_free_uris(set_uris);
759 LadspaPluginInfo::LadspaPluginInfo()
761 type = ARDOUR::LADSPA;
766 LadspaPlugin::find_presets ()
770 std::string unique (unique_id());
772 if (!isdigit (unique[0])) {
776 id = atol (unique.c_str());
778 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
781 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
782 if (char* label = lrdf_get_label(set_uris->items[i])) {
783 PresetRecord rec (set_uris->items[i], label);
784 _presets.insert (make_pair (set_uris->items[i], rec));
787 lrdf_free_uris(set_uris);
794 LadspaPlugin::load_preset (PresetRecord r)
797 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
800 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
801 if (parameter_is_input (defs->items[i].pid)) {
802 set_parameter(defs->items[i].pid, defs->items[i].value);
803 PresetPortSetValue (defs->items[i].pid, defs->items[i].value); /* EMIT SIGNAL */
806 lrdf_free_setting_values(defs);
809 Plugin::load_preset (r);
815 /* XXX: should be in liblrdf */
817 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
822 char setting_uri_copy[64];
825 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
827 p.subject = setting_uri_copy;
828 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
831 q = lrdf_matches(&p);
835 for (i = q; i; i = i->next) {
836 p.subject = i->object;
837 lrdf_remove_matches(&p);
840 lrdf_free_statements(q);
843 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
845 p.object = setting_uri_copy;
846 lrdf_remove_matches(&p);
848 p.subject = setting_uri_copy;
851 lrdf_remove_matches (&p);
856 LadspaPlugin::do_remove_preset (string name)
859 string const envvar = preset_envvar ();
860 if (envvar.empty()) {
861 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
865 Plugin::PresetRecord const * p = preset_by_label (name);
870 string const source = preset_source (envvar);
871 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
873 write_preset_file (envvar);
878 LadspaPlugin::preset_envvar () const
881 if ((envvar = getenv ("HOME")) == 0) {
889 LadspaPlugin::preset_source (string envvar) const
891 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
895 LadspaPlugin::write_preset_file (string envvar)
898 string path = string_compose("%1/.ladspa", envvar);
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;
905 if (g_mkdir_with_parents (path.c_str(), 0775)) {
906 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
910 string const source = preset_source (envvar);
912 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
913 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
924 LadspaPlugin::do_save_preset (string name)
927 /* make a vector of pids that are input parameters */
928 vector<int> input_parameter_pids;
929 for (uint32_t i = 0; i < parameter_count(); ++i) {
930 if (parameter_is_input (i)) {
931 input_parameter_pids.push_back (i);
935 std::string unique (unique_id());
937 if (!isdigit (unique[0])) {
941 uint32_t const id = atol (unique.c_str());
943 lrdf_defaults defaults;
944 defaults.count = input_parameter_pids.size ();
945 std::vector<lrdf_portvalue> portvalues(input_parameter_pids.size());
946 defaults.items = &portvalues[0];
948 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
949 portvalues[i].pid = input_parameter_pids[i];
950 portvalues[i].value = get_parameter (input_parameter_pids[i]);
953 string const envvar = preset_envvar ();
954 if (envvar.empty()) {
955 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
959 string const source = preset_source (envvar);
961 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
962 string uri (uri_char);
965 if (!write_preset_file (envvar)) {
975 LADSPA_PortDescriptor
976 LadspaPlugin::port_descriptor (uint32_t i) const
978 if (i < _descriptor->PortCount) {
979 return _descriptor->PortDescriptors[i];
982 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;