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 if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
148 _shadow_data[i] = default_value (i);
152 latency_compute_run ();
155 LadspaPlugin::~LadspaPlugin ()
160 // glib has internal reference counting on modules so this is ok
163 delete [] _control_data;
164 delete [] _shadow_data;
168 LadspaPlugin::unique_id() const
171 snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
176 LadspaPlugin::default_value (uint32_t port)
178 const LADSPA_PortRangeHint *prh = port_range_hints();
180 bool bounds_given = false;
181 bool sr_scaling = false;
182 bool earlier_hint = false;
184 /* defaults - case 1 */
186 if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
187 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
188 ret = prh[port].LowerBound;
193 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
194 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
198 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
199 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
203 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
204 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
208 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
209 ret = prh[port].UpperBound;
213 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
217 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
221 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
225 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
235 /* defaults - case 2 */
236 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
237 !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
239 if (prh[port].LowerBound < 0) {
242 ret = prh[port].LowerBound;
249 /* defaults - case 3 */
250 else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
251 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
253 if (prh[port].UpperBound > 0) {
256 ret = prh[port].UpperBound;
263 /* defaults - case 4 */
264 else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
265 LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
267 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
269 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
270 ret = prh[port].UpperBound;
272 ret = prh[port].LowerBound;
278 /* defaults - case 5 */
280 if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
294 LadspaPlugin::set_parameter (uint32_t which, float val)
296 if (which < _descriptor->PortCount) {
298 if (get_parameter (which) == val) {
302 _shadow_data[which] = (LADSPA_Data) val;
305 if (which < parameter_count() && controls[which]) {
306 controls[which]->Changed ();
311 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may "
312 "indicate a change in the plugin design, and presets may be "
317 Plugin::set_parameter (which, val);
320 /** @return `plugin' value */
322 LadspaPlugin::get_parameter (uint32_t which) const
324 if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
325 return (float) _shadow_data[which];
327 return (float) _control_data[which];
332 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
338 for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
339 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
350 LadspaPlugin::add_state (XMLNode* root) const
354 LocaleGuard lg (X_("POSIX"));
356 for (uint32_t i = 0; i < parameter_count(); ++i){
358 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
359 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
361 child = new XMLNode("Port");
362 snprintf(buf, sizeof(buf), "%u", i);
363 child->add_property("number", string(buf));
364 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
365 child->add_property("value", string(buf));
366 root->add_child_nocopy (*child);
372 LadspaPlugin::set_state (const XMLNode& node, int version)
374 if (version < 3000) {
375 return set_state_2X (node, version);
378 #ifndef NO_PLUGIN_STATE
381 XMLNodeConstIterator iter;
387 LocaleGuard lg (X_("POSIX"));
389 if (node.name() != state_node_name()) {
390 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
394 #ifndef NO_PLUGIN_STATE
396 nodes = node.children ("Port");
398 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
402 if ((prop = child->property("number")) != 0) {
403 port = prop->value().c_str();
405 warning << _("LADSPA: no ladspa port number") << endmsg;
408 if ((prop = child->property("value")) != 0) {
409 data = prop->value().c_str();
411 warning << _("LADSPA: no ladspa port data") << endmsg;
415 sscanf (port, "%" PRIu32, &port_id);
416 set_parameter (port_id, atof(data));
420 latency_compute_run ();
422 return Plugin::set_state (node, version);
426 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
428 #ifndef NO_PLUGIN_STATE
431 XMLNodeConstIterator iter;
437 LocaleGuard lg (X_("POSIX"));
439 if (node.name() != state_node_name()) {
440 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
444 #ifndef NO_PLUGIN_STATE
445 nodes = node.children ("port");
447 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
451 if ((prop = child->property("number")) != 0) {
452 port = prop->value().c_str();
454 warning << _("LADSPA: no ladspa port number") << endmsg;
457 if ((prop = child->property("value")) != 0) {
458 data = prop->value().c_str();
460 warning << _("LADSPA: no ladspa port data") << endmsg;
464 sscanf (port, "%" PRIu32, &port_id);
465 set_parameter (port_id, atof(data));
468 latency_compute_run ();
475 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
477 LADSPA_PortRangeHint prh;
479 prh = port_range_hints()[which];
482 if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
483 desc.min_unbound = false;
484 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
485 desc.lower = prh.LowerBound * _session.frame_rate();
487 desc.lower = prh.LowerBound;
490 desc.min_unbound = true;
495 if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
496 desc.max_unbound = false;
497 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
498 desc.upper = prh.UpperBound * _session.frame_rate();
500 desc.upper = prh.UpperBound;
503 desc.max_unbound = true;
504 desc.upper = 4; /* completely arbitrary */
507 if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
509 desc.smallstep = 0.1;
510 desc.largestep = 10.0;
512 float delta = desc.upper - desc.lower;
513 desc.step = delta / 1000.0f;
514 desc.smallstep = delta / 10000.0f;
515 desc.largestep = delta/10.0f;
518 desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
519 desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
520 desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
521 desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
523 desc.label = port_names()[which];
529 LadspaPlugin::describe_parameter (Evoral::Parameter which)
531 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
532 return port_names()[which.id()];
539 LadspaPlugin::signal_latency () const
542 return _user_latency;
545 if (_latency_control_port) {
546 return (framecnt_t) floor (*_latency_control_port);
552 set<Evoral::Parameter>
553 LadspaPlugin::automatable () const
555 set<Evoral::Parameter> ret;
557 for (uint32_t i = 0; i < parameter_count(); ++i){
558 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
559 LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
561 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
569 LadspaPlugin::connect_and_run (BufferSet& bufs,
570 ChanMapping in_map, ChanMapping out_map,
571 pframes_t nframes, framecnt_t offset)
573 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
576 cycles_t then = get_cycles ();
578 BufferSet& silent_bufs = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
579 BufferSet& scratch_bufs = _session.get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
581 uint32_t audio_in_index = 0;
582 uint32_t audio_out_index = 0;
584 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
585 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
586 if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
587 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
588 connect_port(port_index,
589 valid ? bufs.get_audio(buf_index).data(offset)
590 : silent_bufs.get_audio(0).data(offset));
591 } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
592 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
593 connect_port(port_index,
594 valid ? bufs.get_audio(buf_index).data(offset)
595 : scratch_bufs.get_audio(0).data(offset));
600 run_in_place (nframes);
602 set_cycles ((uint32_t) (now - then));
608 LadspaPlugin::parameter_is_control (uint32_t param) const
610 return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
614 LadspaPlugin::parameter_is_audio (uint32_t param) const
616 return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
620 LadspaPlugin::parameter_is_output (uint32_t param) const
622 return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
626 LadspaPlugin::parameter_is_input (uint32_t param) const
628 return LADSPA_IS_PORT_INPUT(port_descriptor (param));
632 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
635 if (param < parameter_count()) {
636 snprintf (buf, len, "%.3f", get_parameter (param));
643 boost::shared_ptr<Plugin::ScalePoints>
644 LadspaPlugin::get_scale_points(uint32_t port_index) const
646 boost::shared_ptr<Plugin::ScalePoints> ret;
648 const uint32_t id = atol(unique_id().c_str());
649 lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
655 ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
657 for (uint32_t i = 0; i < points->count; ++i) {
658 ret->insert(make_pair(points->items[i].label,
659 points->items[i].value));
662 lrdf_free_setting_values(points);
668 LadspaPlugin::run_in_place (pframes_t nframes)
670 for (uint32_t i = 0; i < parameter_count(); ++i) {
671 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
672 _control_data[i] = _shadow_data[i];
676 assert (_was_activated);
678 _descriptor->run (_handle, nframes);
682 LadspaPlugin::latency_compute_run ()
684 if (!_latency_control_port) {
688 /* we need to run the plugin so that it can set its latency
694 uint32_t port_index = 0;
695 uint32_t in_index = 0;
696 uint32_t out_index = 0;
697 const framecnt_t bufsize = 1024;
698 LADSPA_Data buffer[bufsize];
700 memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
702 /* Note that we've already required that plugins
703 be able to handle in-place processing.
708 while (port_index < parameter_count()) {
709 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
710 if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
711 connect_port (port_index, buffer);
713 } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
714 connect_port (port_index, buffer);
721 run_in_place (bufsize);
726 LadspaPluginInfo::load (Session& session)
729 PluginPtr plugin (new LadspaPlugin (path, session.engine(), session, index, session.frame_rate()));
730 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
734 catch (failed_constructor &err) {
735 return PluginPtr ((Plugin*) 0);
739 LadspaPluginInfo::LadspaPluginInfo()
741 type = ARDOUR::LADSPA;
746 LadspaPlugin::find_presets ()
750 std::string unique (unique_id());
752 if (!isdigit (unique[0])) {
756 id = atol (unique.c_str());
758 lrdf_uris* set_uris = lrdf_get_setting_uris(id);
761 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
762 if (char* label = lrdf_get_label(set_uris->items[i])) {
763 PresetRecord rec (set_uris->items[i], label);
764 _presets.insert (make_pair (set_uris->items[i], rec));
767 lrdf_free_uris(set_uris);
774 LadspaPlugin::load_preset (PresetRecord r)
777 lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
780 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
781 if (parameter_is_input (defs->items[i].pid)) {
782 set_parameter(defs->items[i].pid, defs->items[i].value);
785 lrdf_free_setting_values(defs);
788 Plugin::load_preset (r);
793 /* XXX: should be in liblrdf */
795 lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
801 char setting_uri_copy[64];
804 strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
806 p.subject = setting_uri_copy;
807 strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
810 q = lrdf_matches(&p);
814 for (i = q; i; i = i->next) {
815 p.subject = i->object;
816 lrdf_remove_matches(&p);
819 lrdf_free_statements(q);
822 strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
824 p.object = setting_uri_copy;
825 lrdf_remove_matches(&p);
827 p.subject = setting_uri_copy;
830 lrdf_remove_matches (&p);
835 LadspaPlugin::do_remove_preset (string name)
838 string const envvar = preset_envvar ();
839 if (envvar.empty()) {
840 warning << _("Could not locate HOME. Preset not removed.") << endmsg;
844 Plugin::PresetRecord const * p = preset_by_label (name);
849 string const source = preset_source (envvar);
850 lrdf_remove_preset (source.c_str(), p->uri.c_str ());
852 write_preset_file (envvar);
857 LadspaPlugin::preset_envvar () const
860 if ((envvar = getenv ("HOME")) == 0) {
868 LadspaPlugin::preset_source (string envvar) const
870 return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
874 LadspaPlugin::write_preset_file (string envvar)
877 string path = string_compose("%1/.ladspa", envvar);
878 if (g_mkdir_with_parents (path.c_str(), 0775)) {
879 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
884 if (g_mkdir_with_parents (path.c_str(), 0775)) {
885 warning << string_compose(_("Could not create %1. Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
889 string const source = preset_source (envvar);
891 if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
892 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
903 LadspaPlugin::do_save_preset (string name)
906 /* make a vector of pids that are input parameters */
907 vector<int> input_parameter_pids;
908 for (uint32_t i = 0; i < parameter_count(); ++i) {
909 if (parameter_is_input (i)) {
910 input_parameter_pids.push_back (i);
914 std::string unique (unique_id());
916 if (!isdigit (unique[0])) {
920 uint32_t const id = atol (unique.c_str());
922 lrdf_defaults defaults;
923 defaults.count = input_parameter_pids.size ();
924 std::vector<lrdf_portvalue> portvalues(input_parameter_pids.size());
925 defaults.items = &portvalues[0];
927 for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
928 portvalues[i].pid = input_parameter_pids[i];
929 portvalues[i].value = get_parameter (input_parameter_pids[i]);
932 string const envvar = preset_envvar ();
933 if (envvar.empty()) {
934 warning << _("Could not locate HOME. Preset not saved.") << endmsg;
938 string const source = preset_source (envvar);
940 char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
941 string uri (uri_char);
944 if (!write_preset_file (envvar)) {
954 LADSPA_PortDescriptor
955 LadspaPlugin::port_descriptor (uint32_t i) const
957 if (i < _descriptor->PortCount) {
958 return _descriptor->PortDescriptors[i];
961 warning << "LADSPA plugin port index " << i << " out of range." << endmsg;