Merge branch 'master' into windows
[ardour.git] / libs / ardour / ladspa_plugin.cc
index efbc97bc9165edea157b398e1976e156280a6d3a..8b089929b50c53ff021e59f64ea6b90de332d8d2 100644 (file)
 
 */
 
-#define __STDC_FORMAT_MACROS 1
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
 #include <inttypes.h>
 
 #include <vector>
 #include <cstdlib>
 #include <cstdio> // so libraptor doesn't complain
 #include <cmath>
+#ifndef COMPILER_MSVC
 #include <dirent.h>
+#endif
 #include <sys/stat.h>
 #include <cerrno>
 
+#ifdef HAVE_LRDF
 #include <lrdf.h>
+#endif
 
 #include "pbd/compose.h"
 #include "pbd/error.h"
 #include "pbd/xml++.h"
+#include "pbd/stacktrace.h"
 
-#include "midi++/manager.h"
-
-#include "ardour/ardour.h"
 #include "ardour/session.h"
-#include "ardour/audioengine.h"
 #include "ardour/ladspa_plugin.h"
 #include "ardour/buffer_set.h"
 #include "ardour/audio_buffer.h"
@@ -54,16 +58,16 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, nframes_t rate)
+LadspaPlugin::LadspaPlugin (string module_path, AudioEngine& e, Session& session, uint32_t index, framecnt_t rate)
        : Plugin (e, session)
 {
-       init (mod, index, rate);
+       init (module_path, index, rate);
 }
 
 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
        : Plugin (other)
 {
-       init (other._module, other._index, other._sample_rate);
+       init (other._module_path, other._index, other._sample_rate);
 
        for (uint32_t i = 0; i < parameter_count(); ++i) {
                _control_data[i] = other._shadow_data[i];
@@ -72,25 +76,32 @@ LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
 }
 
 void
-LadspaPlugin::init (void *mod, uint32_t index, nframes_t rate)
+LadspaPlugin::init (string module_path, uint32_t index, framecnt_t rate)
 {
+       void* func;
        LADSPA_Descriptor_Function dfunc;
        uint32_t i, port_cnt;
-       const char *errstr;
 
-       _module = mod;
+       _module_path = module_path;
+       _module = new Glib::Module(_module_path);
        _control_data = 0;
        _shadow_data = 0;
        _latency_control_port = 0;
        _was_activated = false;
 
-       dfunc = (LADSPA_Descriptor_Function) dlsym (_module, "ladspa_descriptor");
+       if (!(*_module)) {
+               error << _("LADSPA: Unable to open module: ") << Glib::Module::get_last_error() << endmsg;
+               delete _module;
+               throw failed_constructor();
+       }
 
-       if ((errstr = dlerror()) != NULL) {
+       if (!_module->get_symbol("ladspa_descriptor", func)) {
                error << _("LADSPA: module has no descriptor function.") << endmsg;
                throw failed_constructor();
        }
 
+       dfunc = (LADSPA_Descriptor_Function)func;
+
        if ((_descriptor = dfunc (index)) == 0) {
                error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
                throw failed_constructor();
@@ -116,7 +127,9 @@ LadspaPlugin::init (void *mod, uint32_t index, nframes_t rate)
        port_cnt = parameter_count();
 
        _control_data = new LADSPA_Data[port_cnt];
+       memset (_control_data, 0, sizeof (LADSPA_Data) * port_cnt);
        _shadow_data = new LADSPA_Data[port_cnt];
+       memset (_shadow_data, 0, sizeof (LADSPA_Data) * port_cnt);
 
        for (i = 0; i < port_cnt; ++i) {
                if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
@@ -144,9 +157,8 @@ LadspaPlugin::~LadspaPlugin ()
        deactivate ();
        cleanup ();
 
-       /* XXX who should close a plugin? */
-
-        // dlclose (module);
+       // glib has internal reference counting on modules so this is ok
+       delete _module;
 
        delete [] _control_data;
        delete [] _shadow_data;
@@ -179,32 +191,17 @@ LadspaPlugin::default_value (uint32_t port)
                }
 
                else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
-                       if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
-                               ret = exp(log(prh[port].LowerBound) * 0.75f + log(prh[port].UpperBound) * 0.25f);
-                       }
-                       else {
-                               ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
-                       }
+                       ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
                        bounds_given = true;
                        sr_scaling = true;
                }
                else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
-                       if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
-                               ret = exp(log(prh[port].LowerBound) * 0.5f + log(prh[port].UpperBound) * 0.5f);
-                       }
-                       else {
-                               ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
-                       }
+                       ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
                        bounds_given = true;
                        sr_scaling = true;
                }
                else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
-                       if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
-                               ret = exp(log(prh[port].LowerBound) * 0.25f + log(prh[port].UpperBound) * 0.75f);
-                       }
-                       else {
-                               ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
-                       }
+                       ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
                        bounds_given = true;
                        sr_scaling = true;
                }
@@ -297,23 +294,30 @@ void
 LadspaPlugin::set_parameter (uint32_t which, float val)
 {
        if (which < _descriptor->PortCount) {
+
+               if (get_parameter (which) == val) {
+                       return;
+               }
+
                _shadow_data[which] = (LADSPA_Data) val;
-#if 0
-               ParameterChanged (Parameter(PluginAutomation, 0, which), val); /* EMIT SIGNAL */
 
+#if 0
                if (which < parameter_count() && controls[which]) {
                        controls[which]->Changed ();
                }
 #endif
 
        } else {
-               warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
-                                            "indicate a change in the plugin design, and presets may be"
+               warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may "
+                                            "indicate a change in the plugin design, and presets may be "
                                             "invalid"), name())
                        << endmsg;
        }
+
+       Plugin::set_parameter (which, val);
 }
 
+/** @return `plugin' value */
 float
 LadspaPlugin::get_parameter (uint32_t which) const
 {
@@ -342,10 +346,9 @@ LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
        return 0;
 }
 
-XMLNode&
-LadspaPlugin::get_state()
+void
+LadspaPlugin::add_state (XMLNode* root) const
 {
-       XMLNode *root = new XMLNode(state_node_name());
        XMLNode *child;
        char buf[16];
        LocaleGuard lg (X_("POSIX"));
@@ -363,14 +366,6 @@ LadspaPlugin::get_state()
                        root->add_child_nocopy (*child);
                }
        }
-
-       return *root;
-}
-
-bool
-LadspaPlugin::save_preset (string name)
-{
-       return Plugin::save_preset (name, "ladspa");
 }
 
 int
@@ -379,7 +374,8 @@ LadspaPlugin::set_state (const XMLNode& node, int version)
        if (version < 3000) {
                return set_state_2X (node, version);
        }
-       
+
+#ifndef NO_PLUGIN_STATE
        XMLNodeList nodes;
        XMLProperty *prop;
        XMLNodeConstIterator iter;
@@ -387,6 +383,7 @@ LadspaPlugin::set_state (const XMLNode& node, int version)
        const char *port;
        const char *data;
        uint32_t port_id;
+#endif
        LocaleGuard lg (X_("POSIX"));
 
        if (node.name() != state_node_name()) {
@@ -394,9 +391,11 @@ LadspaPlugin::set_state (const XMLNode& node, int version)
                return -1;
        }
 
+#ifndef NO_PLUGIN_STATE
+
        nodes = node.children ("Port");
 
-       for(iter = nodes.begin(); iter != nodes.end(); ++iter){
+       for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
 
                child = *iter;
 
@@ -416,15 +415,17 @@ LadspaPlugin::set_state (const XMLNode& node, int version)
                sscanf (port, "%" PRIu32, &port_id);
                set_parameter (port_id, atof(data));
        }
+#endif
 
        latency_compute_run ();
 
-       return 0;
+       return Plugin::set_state (node, version);
 }
 
 int
 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
 {
+#ifndef NO_PLUGIN_STATE
        XMLNodeList nodes;
        XMLProperty *prop;
        XMLNodeConstIterator iter;
@@ -432,6 +433,7 @@ LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
        const char *port;
        const char *data;
        uint32_t port_id;
+#endif
        LocaleGuard lg (X_("POSIX"));
 
        if (node.name() != state_node_name()) {
@@ -439,6 +441,7 @@ LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
                return -1;
        }
 
+#ifndef NO_PLUGIN_STATE
        nodes = node.children ("port");
 
        for(iter = nodes.begin(); iter != nodes.end(); ++iter){
@@ -463,6 +466,7 @@ LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
        }
 
        latency_compute_run ();
+#endif
 
        return 0;
 }
@@ -531,7 +535,7 @@ LadspaPlugin::describe_parameter (Evoral::Parameter which)
        }
 }
 
-ARDOUR::nframes_t
+ARDOUR::framecnt_t
 LadspaPlugin::signal_latency () const
 {
        if (_user_latency) {
@@ -539,7 +543,7 @@ LadspaPlugin::signal_latency () const
        }
 
        if (_latency_control_port) {
-               return (nframes_t) floor (*_latency_control_port);
+               return (framecnt_t) floor (*_latency_control_port);
        } else {
                return 0;
        }
@@ -564,21 +568,31 @@ LadspaPlugin::automatable () const
 int
 LadspaPlugin::connect_and_run (BufferSet& bufs,
                ChanMapping in_map, ChanMapping out_map,
-               nframes_t nframes, nframes_t offset)
+               pframes_t nframes, framecnt_t offset)
 {
+       Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
+
        cycles_t now;
        cycles_t then = get_cycles ();
 
+       BufferSet& silent_bufs  = _session.get_silent_buffers(ChanCount(DataType::AUDIO, 1));
+       BufferSet& scratch_bufs = _session.get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
+
        uint32_t audio_in_index  = 0;
        uint32_t audio_out_index = 0;
+       bool valid;
        for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
                if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
                        if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
-                               const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
-                               connect_port(port_index, bufs.get_audio(buf_index).data(offset));
+                               const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
+                               connect_port(port_index,
+                                            valid ? bufs.get_audio(buf_index).data(offset)
+                                                  : silent_bufs.get_audio(0).data(offset));
                        } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
-                               const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
-                               connect_port(port_index, bufs.get_audio(buf_index).data(offset));
+                               const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
+                               connect_port(port_index,
+                                            valid ? bufs.get_audio(buf_index).data(offset)
+                                                  : scratch_bufs.get_audio(0).data(offset));
                        }
                }
        }
@@ -626,14 +640,41 @@ LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
        }
 }
 
+boost::shared_ptr<Plugin::ScalePoints>
+LadspaPlugin::get_scale_points(uint32_t port_index) const
+{
+       boost::shared_ptr<Plugin::ScalePoints> ret;
+#ifdef HAVE_LRDF
+       const uint32_t id     = atol(unique_id().c_str());
+       lrdf_defaults* points = lrdf_get_scale_values(id, port_index);
+
+       if (!points) {
+               return ret;
+       }
+
+       ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
+
+       for (uint32_t i = 0; i < points->count; ++i) {
+               ret->insert(make_pair(points->items[i].label,
+                                     points->items[i].value));
+       }
+
+       lrdf_free_setting_values(points);
+#endif
+       return ret;
+}
+
 void
-LadspaPlugin::run_in_place (nframes_t nframes)
+LadspaPlugin::run_in_place (pframes_t nframes)
 {
        for (uint32_t i = 0; i < parameter_count(); ++i) {
                if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
                        _control_data[i] = _shadow_data[i];
                }
        }
+
+       assert (_was_activated);
+
        _descriptor->run (_handle, nframes);
 }
 
@@ -653,7 +694,7 @@ LadspaPlugin::latency_compute_run ()
        uint32_t port_index = 0;
        uint32_t in_index = 0;
        uint32_t out_index = 0;
-       const nframes_t bufsize = 1024;
+       const framecnt_t bufsize = 1024;
        LADSPA_Data buffer[bufsize];
 
        memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
@@ -685,16 +726,7 @@ PluginPtr
 LadspaPluginInfo::load (Session& session)
 {
        try {
-               PluginPtr plugin;
-               void *module;
-
-               if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
-                       error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
-                       error << dlerror() << endmsg;
-               } else {
-                       plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
-               }
-
+               PluginPtr plugin (new LadspaPlugin (path, session.engine(), session, index, session.frame_rate()));
                plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
                return plugin;
        }
@@ -703,3 +735,232 @@ LadspaPluginInfo::load (Session& session)
                return PluginPtr ((Plugin*) 0);
        }
 }
+
+LadspaPluginInfo::LadspaPluginInfo()
+{
+       type = ARDOUR::LADSPA;
+}
+
+
+void
+LadspaPlugin::find_presets ()
+{
+#ifdef HAVE_LRDF
+       uint32_t id;
+       std::string unique (unique_id());
+
+       if (!isdigit (unique[0])) {
+               return;
+       }
+
+       id = atol (unique.c_str());
+
+       lrdf_uris* set_uris = lrdf_get_setting_uris(id);
+
+       if (set_uris) {
+               for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
+                       if (char* label = lrdf_get_label(set_uris->items[i])) {
+                               PresetRecord rec (set_uris->items[i], label);
+                               _presets.insert (make_pair (set_uris->items[i], rec));
+                       }
+               }
+               lrdf_free_uris(set_uris);
+       }
+#endif
+}
+
+
+bool
+LadspaPlugin::load_preset (PresetRecord r)
+{
+#ifdef HAVE_LRDF
+       lrdf_defaults* defs = lrdf_get_setting_values (r.uri.c_str());
+
+       if (defs) {
+               for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
+                       if (parameter_is_input (defs->items[i].pid)) {
+                               set_parameter(defs->items[i].pid, defs->items[i].value);
+                       }
+               }
+               lrdf_free_setting_values(defs);
+       }
+
+       Plugin::load_preset (r);
+#endif
+       return true;
+}
+
+/* XXX: should be in liblrdf */
+static void
+lrdf_remove_preset (const char* /*source*/, const char *setting_uri)
+{
+#ifdef HAVE_LRDF
+       lrdf_statement p;
+       lrdf_statement *q;
+       lrdf_statement *i;
+       char setting_uri_copy[64];
+       char buf[64];
+
+       strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
+
+       p.subject = setting_uri_copy;
+       strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
+       p.predicate = buf;
+       p.object = NULL;
+       q = lrdf_matches(&p);
+
+       p.predicate = NULL;
+       p.object = NULL;
+       for (i = q; i; i = i->next) {
+               p.subject = i->object;
+               lrdf_remove_matches(&p);
+       }
+
+       lrdf_free_statements(q);
+
+       p.subject = NULL;
+       strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
+       p.predicate = buf;
+       p.object = setting_uri_copy;
+       lrdf_remove_matches(&p);
+
+       p.subject = setting_uri_copy;
+       p.predicate = NULL;
+       p.object = NULL;
+       lrdf_remove_matches (&p);
+#endif
+}
+
+void
+LadspaPlugin::do_remove_preset (string name)
+{
+#ifdef HAVE_LRDF
+       string const envvar = preset_envvar ();
+       if (envvar.empty()) {
+               warning << _("Could not locate HOME.  Preset not removed.") << endmsg;
+               return;
+       }
+
+       Plugin::PresetRecord const * p = preset_by_label (name);
+       if (!p) {
+               return;
+       }
+
+       string const source = preset_source (envvar);
+       lrdf_remove_preset (source.c_str(), p->uri.c_str ());
+
+       write_preset_file (envvar);
+#endif
+}
+
+string
+LadspaPlugin::preset_envvar () const
+{
+       char* envvar;
+       if ((envvar = getenv ("HOME")) == 0) {
+               return "";
+       }
+
+       return envvar;
+}
+
+string
+LadspaPlugin::preset_source (string envvar) const
+{
+       return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
+}
+
+bool
+LadspaPlugin::write_preset_file (string envvar)
+{
+#ifdef HAVE_LRDF
+       string path = string_compose("%1/.ladspa", envvar);
+       if (g_mkdir_with_parents (path.c_str(), 0775)) {
+               warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
+               return false;
+       }
+
+       path += "/rdf";
+       if (g_mkdir_with_parents (path.c_str(), 0775)) {
+               warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
+               return false;
+       }
+
+       string const source = preset_source (envvar);
+
+       if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
+               warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
+               return false;
+       }
+
+       return true;
+#else
+       return false;
+#endif
+}
+
+string
+LadspaPlugin::do_save_preset (string name)
+{
+#ifdef HAVE_LRDF
+       /* make a vector of pids that are input parameters */
+       vector<int> input_parameter_pids;
+       for (uint32_t i = 0; i < parameter_count(); ++i) {
+               if (parameter_is_input (i)) {
+                       input_parameter_pids.push_back (i);
+               }
+       }
+
+       std::string unique (unique_id());
+
+       if (!isdigit (unique[0])) {
+               return "";
+       }
+
+       uint32_t const id = atol (unique.c_str());
+
+       lrdf_defaults defaults;
+       defaults.count = input_parameter_pids.size ();
+       std::vector<lrdf_portvalue> portvalues(input_parameter_pids.size());
+       defaults.items = &portvalues[0];
+
+       for (vector<int>::size_type i = 0; i < input_parameter_pids.size(); ++i) {
+               portvalues[i].pid = input_parameter_pids[i];
+               portvalues[i].value = get_parameter (input_parameter_pids[i]);
+       }
+
+       string const envvar = preset_envvar ();
+       if (envvar.empty()) {
+               warning << _("Could not locate HOME.  Preset not saved.") << endmsg;
+               return "";
+       }
+
+       string const source = preset_source (envvar);
+
+       char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
+       string uri (uri_char);
+       free (uri_char);
+
+       if (!write_preset_file (envvar)) {
+               return "";
+       }
+
+       return uri;
+#else
+       return string();
+#endif
+}
+
+LADSPA_PortDescriptor
+LadspaPlugin::port_descriptor (uint32_t i) const
+{
+       if (i < _descriptor->PortCount) {               
+               return _descriptor->PortDescriptors[i];
+       }
+       
+       warning << "LADSPA plugin port index " << i << " out of range." << endmsg;
+       return 0;
+}
+
+               
+