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"
44 #include "midi++/manager.h"
46 #include "ardour/session.h"
47 #include "ardour/ladspa_plugin.h"
48 #include "ardour/buffer_set.h"
49 #include "ardour/audio_buffer.h"
51 #include "pbd/stl_delete.h"
57 using namespace ARDOUR;
60 LadspaPlugin::LadspaPlugin (string module_path, AudioEngine& e, Session& session, uint32_t index, framecnt_t rate)
63 init (module_path, index, rate);
66 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
69 init (other._module_path, other._index, other._sample_rate);
71 for (uint32_t i = 0; i < parameter_count(); ++i) {
72 _control_data[i] = other._shadow_data[i];
73 _shadow_data[i] = other._shadow_data[i];
78 LadspaPlugin::init (string module_path, uint32_t index, framecnt_t rate)
81 LADSPA_Descriptor_Function dfunc;
84 _module_path = module_path;
85 _module = new Glib::Module(_module_path);
88 _latency_control_port = 0;
89 _was_activated = false;
92 error << _("LADSPA: Unable to open module: ") << Glib::Module::get_last_error() << endmsg;
94 throw failed_constructor();
97 if (!_module->get_symbol("ladspa_descriptor", func)) {
98 error << _("LADSPA: module has no descriptor function.") << endmsg;
99 throw failed_constructor();
102 dfunc = (LADSPA_Descriptor_Function)func;
104 if ((_descriptor = dfunc (index)) == 0) {
105 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
106 throw failed_constructor();
111 if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
112 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
113 throw failed_constructor();
118 if (_descriptor->instantiate == 0) {
119 throw failed_constructor();
122 if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
123 throw failed_constructor();
126 port_cnt = parameter_count();
128 _control_data = new LADSPA_Data[port_cnt];
129 _shadow_data = new LADSPA_Data[port_cnt];
131 for (i = 0; i < port_cnt; ++i) {
132 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
133 connect_port (i, &_control_data[i]);
135 if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
136 strcmp (port_names()[i], X_("latency")) == 0) {
137 _latency_control_port = &_control_data[i];
138 *_latency_control_port = 0;
141 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
145 _shadow_data[i] = default_value (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)
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
351 LocaleGuard lg (X_("POSIX"));
353 for (uint32_t i = 0; i < parameter_count(); ++i){
355 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
356 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
358 child = new XMLNode("Port");
359 snprintf(buf, sizeof(buf), "%u", i);
360 child->add_property("number", string(buf));
361 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
362 child->add_property("value", string(buf));
363 root->add_child_nocopy (*child);
369 LadspaPlugin::set_state (const XMLNode& node, int version)
371 if (version < 3000) {
372 return set_state_2X (node, version);
377 XMLNodeConstIterator iter;
382 LocaleGuard lg (X_("POSIX"));
384 if (node.name() != state_node_name()) {
385 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
389 nodes = node.children ("Port");
391 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
395 if ((prop = child->property("number")) != 0) {
396 port = prop->value().c_str();
398 warning << _("LADSPA: no ladspa port number") << endmsg;
401 if ((prop = child->property("value")) != 0) {
402 data = prop->value().c_str();
404 warning << _("LADSPA: no ladspa port data") << endmsg;
408 sscanf (port, "%" PRIu32, &port_id);
409 set_parameter (port_id, atof(data));
412 latency_compute_run ();
414 return Plugin::set_state (node, version);
418 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
422 XMLNodeConstIterator iter;
427 LocaleGuard lg (X_("POSIX"));
429 if (node.name() != state_node_name()) {
430 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
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 ();
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 desc.min_unbound = false;
472 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
473 desc.lower = prh.LowerBound * _session.frame_rate();
475 desc.lower = prh.LowerBound;
478 desc.min_unbound = true;
483 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
484 desc.max_unbound = false;
485 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
486 desc.upper = prh.UpperBound * _session.frame_rate();
488 desc.upper = prh.UpperBound;
491 desc.max_unbound = true;
492 desc.upper = 4; /* completely arbitrary */
495 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
497 desc.smallstep = 0.1;
498 desc.largestep = 10.0;
500 float delta = desc.upper - desc.lower;
501 desc.step = delta / 1000.0f;
502 desc.smallstep = delta / 10000.0f;
503 desc.largestep = delta/10.0f;
506 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
507 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
508 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
509 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
511 desc.label = port_names()[which];
517 LadspaPlugin::describe_parameter (Evoral::Parameter which)
519 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
520 return port_names()[which.id()];
527 LadspaPlugin::signal_latency () const
530 return _user_latency;
533 if (_latency_control_port) {
534 return (framecnt_t) floor (*_latency_control_port);
540 set<Evoral::Parameter>
541 LadspaPlugin::automatable () const
543 set<Evoral::Parameter> ret;
545 for (uint32_t i = 0; i < parameter_count(); ++i){
546 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
547 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
549 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
557 LadspaPlugin::connect_and_run (BufferSet& bufs,
558 ChanMapping in_map, ChanMapping out_map,
559 pframes_t nframes, framecnt_t offset)
561 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
564 cycles_t then = get_cycles ();
566 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
567 BufferSet& scratch_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
569 uint32_t audio_in_index = 0;
570 uint32_t audio_out_index = 0;
572 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
573 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
574 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
575 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
576 connect_port(port_index,
577 valid ? bufs.get_audio(buf_index).data(offset)
578 : silent_bufs.get_audio(0).data(offset));
579 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
580 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
581 connect_port(port_index,
582 valid ? bufs.get_audio(buf_index).data(offset)
583 : scratch_bufs.get_audio(0).data(offset));
588 run_in_place (nframes);
590 set_cycles ((uint32_t) (now - then));
596 LadspaPlugin::parameter_is_control (uint32_t param) const
598 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
602 LadspaPlugin::parameter_is_audio (uint32_t param) const
604 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
608 LadspaPlugin::parameter_is_output (uint32_t param) const
610 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
614 LadspaPlugin::parameter_is_input (uint32_t param) const
616 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
620 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
623 if (param < parameter_count()) {
624 snprintf (buf, len, "%.3f", get_parameter (param));
631 boost::shared_ptr<Plugin::ScalePoints>
632 LadspaPlugin::get_scale_points(uint32_t port_index) const
634 boost::shared_ptr<Plugin::ScalePoints> ret;
636 const uint32_t id = atol(unique_id().c_str());
637 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
643 ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
645 for (uint32_t i = 0; i < points->count; ++i) {
646 ret->insert(make_pair(points->items[i].label,
647 points->items[i].value));
650 lrdf_free_setting_values(points);
656 LadspaPlugin::run_in_place (pframes_t nframes)
658 for (uint32_t i = 0; i < parameter_count(); ++i) {
659 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
660 _control_data[i] = _shadow_data[i];
664 assert (_was_activated);
666 _descriptor->run (_handle, nframes);
670 LadspaPlugin::latency_compute_run ()
672 if (!_latency_control_port) {
676 /* we need to run the plugin so that it can set its latency
682 uint32_t port_index = 0;
683 uint32_t in_index = 0;
684 uint32_t out_index = 0;
685 const framecnt_t bufsize = 1024;
686 LADSPA_Data buffer[bufsize];
688 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
690 /* Note that we've already required that plugins
691 be able to handle in-place processing.
696 while (port_index < parameter_count()) {
697 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
698 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
699 connect_port (port_index, buffer);
701 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
702 connect_port (port_index, buffer);
709 run_in_place (bufsize);
714 LadspaPluginInfo::load (Session& session)
717 PluginPtr plugin (new LadspaPlugin (path, session.engine(), session, index, session.frame_rate()));
718 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
722 catch (failed_constructor &err) {
723 return PluginPtr ((Plugin*) 0);
727 LadspaPluginInfo::LadspaPluginInfo()
729 type = ARDOUR::LADSPA;
734 LadspaPlugin::find_presets ()
738 std::string unique (unique_id());
740 if (!isdigit (unique[0])) {
744 id = atol (unique.c_str());
746 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
749 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
750 if (char* label = lrdf_get_label(set_uris->items[i])) {
751 PresetRecord rec (set_uris->items[i], label);
752 _presets.insert (make_pair (set_uris->items[i], rec));
755 lrdf_free_uris(set_uris);
762 LadspaPlugin::load_preset (PresetRecord r)
765 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
768 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
769 if (parameter_is_input (defs->items[i].pid)) {
770 set_parameter(defs->items[i].pid, defs->items[i].value);
773 lrdf_free_setting_values(defs);
776 Plugin::load_preset (r);
781 /* XXX: should be in liblrdf */
783 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
789 char setting_uri_copy[64];
792 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
794 p.subject = setting_uri_copy;
795 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
798 q = lrdf_matches(&p);
802 for (i = q; i; i = i->next) {
803 p.subject = i->object;
804 lrdf_remove_matches(&p);
807 lrdf_free_statements(q);
810 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
812 p.object = setting_uri_copy;
813 lrdf_remove_matches(&p);
815 p.subject = setting_uri_copy;
818 lrdf_remove_matches (&p);
823 LadspaPlugin::do_remove_preset (string name)
826 string const envvar = preset_envvar ();
827 if (envvar.empty()) {
828 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
832 Plugin::PresetRecord const * p = preset_by_label (name);
837 string const source = preset_source (envvar);
838 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
840 write_preset_file (envvar);
845 LadspaPlugin::preset_envvar () const
848 if ((envvar = getenv ("HOME")) == 0) {
856 LadspaPlugin::preset_source (string envvar) const
858 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
862 LadspaPlugin::write_preset_file (string envvar)
865 string path = string_compose("%1/.ladspa", envvar);
866 if (g_mkdir_with_parents (path.c_str(), 0775)) {
867 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
872 if (g_mkdir_with_parents (path.c_str(), 0775)) {
873 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
877 string const source = preset_source (envvar);
879 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
880 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
891 LadspaPlugin::do_save_preset (string name)
894 /* make a vector of pids that are input parameters */
895 vector<int> input_parameter_pids;
896 for (uint32_t i = 0; i < parameter_count(); ++i) {
897 if (parameter_is_input (i)) {
898 input_parameter_pids.push_back (i);
902 std::string unique (unique_id());
904 if (!isdigit (unique[0])) {
908 uint32_t const id = atol (unique.c_str());
910 lrdf_defaults defaults;
911 defaults.count = input_parameter_pids.size ();
912 lrdf_portvalue portvalues[input_parameter_pids.size()];
913 defaults.items = portvalues;
915 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
916 portvalues[i].pid = input_parameter_pids[i];
917 portvalues[i].value = get_parameter (input_parameter_pids[i]);
920 string const envvar = preset_envvar ();
921 if (envvar.empty()) {
922 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
926 string const source = preset_source (envvar);
928 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
929 string uri (uri_char);
932 if (!write_preset_file (envvar)) {
942 LADSPA_PortDescriptor
943 LadspaPlugin::port_descriptor (uint32_t i) const
945 if (i < _descriptor->PortCount) {
946 return _descriptor->PortDescriptors[i];
949 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;