Merge branch 'master' into cairocanvas
[ardour.git] / libs / ardour / plugin.cc
index 3bfb9e883f2b533bc425037b4a68d8bb6f66a7cb..11d859ed8c81fe3558d5effcd200dfb5781b0e1f 100644 (file)
 #include <cstdlib>
 #include <cstdio> // so libraptor doesn't complain
 #include <cmath>
+#ifndef COMPILER_MSVC
 #include <dirent.h>
+#endif
 #include <sys/stat.h>
 #include <cerrno>
 #include <utility>
 
+#ifdef HAVE_LRDF
 #include <lrdf.h>
+#endif
 
 #include "pbd/compose.h"
 #include "pbd/error.h"
 #include "pbd/xml++.h"
 
-#include "ardour/ardour.h"
-#include "ardour/session.h"
-#include "ardour/audioengine.h"
+#include "ardour/buffer_set.h"
+#include "ardour/chan_count.h"
+#include "ardour/chan_mapping.h"
+#include "ardour/data_type.h"
+#include "ardour/midi_buffer.h"
+#include "ardour/midi_state_tracker.h"
 #include "ardour/plugin.h"
-#include "ardour/ladspa_plugin.h"
 #include "ardour/plugin_manager.h"
+#include "ardour/session.h"
+#include "ardour/types.h"
 
-#ifdef HAVE_AUDIOUNITS
+#ifdef AUDIOUNIT_SUPPORT
 #include "ardour/audio_unit.h"
 #endif
 
-#ifdef HAVE_SLV2
+#ifdef LV2_SUPPORT
 #include "ardour/lv2_plugin.h"
 #endif
 
@@ -62,13 +70,28 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-PBD::Signal0<bool> Plugin::PresetFileExists;
+namespace ARDOUR { class AudioEngine; }
+
+#ifdef NO_PLUGIN_STATE
+static bool seen_get_state_message = false;
+static bool seen_set_state_message = false;
+#endif
+
+bool
+PluginInfo::is_instrument () const
+{
+       return (n_inputs.n_midi() != 0) && (n_outputs.n_audio() > 0);
+}
 
 Plugin::Plugin (AudioEngine& e, Session& s)
        : _engine (e)
        , _session (s)
        , _cycles (0)
+       , _have_presets (false)
+       , _have_pending_stop_events (false)
+       , _parameter_changed_since_last_preset (false)
 {
+       _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
 }
 
 Plugin::Plugin (const Plugin& other)
@@ -78,319 +101,318 @@ Plugin::Plugin (const Plugin& other)
        , _session (other._session)
        , _info (other._info)
        , _cycles (0)
-       , presets (other.presets)
+       , _have_presets (false)
+       , _have_pending_stop_events (false)
+       , _parameter_changed_since_last_preset (false)
 {
+       _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
 }
 
 Plugin::~Plugin ()
 {
 }
 
-const Plugin::PresetRecord*
-Plugin::preset_by_label(const string& label)
+void
+Plugin::remove_preset (string name)
 {
-       // FIXME: O(n)
-       for (map<string,PresetRecord>::const_iterator i = presets.begin(); i != presets.end(); ++i) {
-               if (i->second.label == label) {
-                       return &i->second;
-               }
-       }
-       return NULL;
+       do_remove_preset (name);
+       _presets.erase (preset_by_label (name)->uri);
+
+       _last_preset.uri = "";
+       _parameter_changed_since_last_preset = false;
+       PresetRemoved (); /* EMIT SIGNAL */
 }
 
-const Plugin::PresetRecord*
-Plugin::preset_by_uri(const string& uri)
+/** @return PresetRecord with empty URI on failure */
+Plugin::PresetRecord
+Plugin::save_preset (string name)
 {
-       map<string,PresetRecord>::const_iterator pr = presets.find(uri);
-       if (pr != presets.end()) {
-               return &pr->second;
-       } else {
-               return NULL;
+       string const uri = do_save_preset (name);
+
+       if (!uri.empty()) {
+               _presets.insert (make_pair (uri, PresetRecord (uri, name)));
+               PresetAdded (); /* EMIT SIGNAL */
        }
+
+       return PresetRecord (uri, name);
 }
 
-vector<Plugin::PresetRecord>
-Plugin::get_presets()
+PluginPtr
+ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
 {
-       vector<PresetRecord> result;
-       uint32_t id;
-       std::string unique (unique_id());
+       PluginManager& mgr (PluginManager::instance());
+       PluginInfoList plugs;
 
-       /* XXX problem: AU plugins don't have numeric ID's.
-          Solution: they have a different method of providing presets.
-          XXX sub-problem: implement it.
-       */
+       switch (type) {
+       case ARDOUR::LADSPA:
+               plugs = mgr.ladspa_plugin_info();
+               break;
+
+#ifdef LV2_SUPPORT
+       case ARDOUR::LV2:
+               plugs = mgr.lv2_plugin_info();
+               break;
+#endif
+
+#ifdef WINDOWS_VST_SUPPORT
+       case ARDOUR::Windows_VST:
+               plugs = mgr.windows_vst_plugin_info();
+               break;
+#endif
 
-       if (!isdigit (unique[0])) {
-               return result;
+#ifdef LXVST_SUPPORT
+       case ARDOUR::LXVST:
+               plugs = mgr.lxvst_plugin_info();
+               break;
+#endif
+
+#ifdef AUDIOUNIT_SUPPORT
+       case ARDOUR::AudioUnit:
+               plugs = mgr.au_plugin_info();
+               break;
+#endif
+
+       default:
+               return PluginPtr ((Plugin *) 0);
        }
 
-       id = atol (unique.c_str());
+       PluginInfoList::iterator i;
 
-       lrdf_uris* set_uris = lrdf_get_setting_uris(id);
+       for (i = plugs.begin(); i != plugs.end(); ++i) {
+               if (identifier == (*i)->unique_id){
+                       return (*i)->load (session);
+               }
+       }
+
+#ifdef WINDOWS_VST_SUPPORT
+       /* hmm, we didn't find it. could be because in older versions of Ardour.
+          we used to store the name of a VST plugin, not its unique ID. so try
+          again.
+       */
 
-       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);
-                               result.push_back(rec);
-                               presets.insert(std::make_pair(set_uris->items[i], rec));
-                       }
+       for (i = plugs.begin(); i != plugs.end(); ++i) {
+               if (identifier == (*i)->name){
+                       return (*i)->load (session);
                }
-               lrdf_free_uris(set_uris);
        }
+#endif
 
-       return result;
-}
+#ifdef LXVST_SUPPORT
+       /* hmm, we didn't find it. could be because in older versions of Ardour.
+          we used to store the name of a VST plugin, not its unique ID. so try
+          again.
+       */
 
-bool
-Plugin::load_preset(const string& preset_uri)
-{
-       lrdf_defaults* defs = lrdf_get_setting_values(preset_uri.c_str());
-
-       if (defs) {
-               for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
-                       // The defs->items[i].pid < defs->count check is to work around
-                       // a bug in liblrdf that saves invalid values into the presets file.
-                       if (((uint32_t) defs->items[i].pid < (uint32_t) defs->count) && parameter_is_input (defs->items[i].pid)) {
-                               set_parameter(defs->items[i].pid, defs->items[i].value);
-                       }
+       for (i = plugs.begin(); i != plugs.end(); ++i) {
+               if (identifier == (*i)->name){
+                       return (*i)->load (session);
                }
-               lrdf_free_setting_values(defs);
        }
+#endif
 
-       return true;
+       return PluginPtr ((Plugin*) 0);
 }
 
-/* XXX: should be in liblrdf */
-static void
-lrdf_remove_preset (const char *source, const char *setting_uri)
+ChanCount
+Plugin::output_streams () const
 {
-       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);
-       }
+       /* LADSPA & VST should not get here because they do not
+          return "infinite" i/o counts.
+       */
+       return ChanCount::ZERO;
+}
 
-       lrdf_free_statements(q);
+ChanCount
+Plugin::input_streams () const
+{
+       /* LADSPA & VST should not get here because they do not
+          return "infinite" i/o counts.
+       */
+       return ChanCount::ZERO;
+}
 
-       p.subject = NULL;
-       strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
-       p.predicate = buf;
-       p.object = setting_uri_copy;
-       lrdf_remove_matches(&p);
+const Plugin::PresetRecord *
+Plugin::preset_by_label (const string& label)
+{
+       // FIXME: O(n)
+       for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
+               if (i->second.label == label) {
+                       return &i->second;
+               }
+       }
 
-       p.subject = setting_uri_copy;
-       p.predicate = NULL;
-       p.object = NULL;
-       lrdf_remove_matches (&p);
+       return 0;
 }
 
-void
-Plugin::remove_preset (string name, string domain)
+const Plugin::PresetRecord *
+Plugin::preset_by_uri (const string& uri)
 {
-       string const envvar = preset_envvar ();
-       if (envvar.empty()) {
-               warning << _("Could not locate HOME.  Preset not removed.") << endmsg;
-               return;
+       map<string, PresetRecord>::const_iterator pr = _presets.find (uri);
+       if (pr != _presets.end()) {
+               return &pr->second;
+       } else {
+               return 0;
        }
+}
 
-       Plugin::PresetRecord const * p = preset_by_label (name);
-       if (!p) {
-               return;
-       }
-       
-       string const source = preset_source (envvar, domain);
-       lrdf_remove_preset (source.c_str(), p->uri.c_str ());
+int
+Plugin::connect_and_run (BufferSet& bufs,
+                        ChanMapping /*in_map*/, ChanMapping /*out_map*/,
+                        pframes_t /* nframes */, framecnt_t /*offset*/)
+{
+       if (bufs.count().n_midi() > 0) {
 
-       presets.erase (p->uri);
+               /* Track notes that we are sending to the plugin */
 
-       write_preset_file (envvar, domain);
+               MidiBuffer& b = bufs.get_midi (0);
 
-       PresetRemoved (); /* EMIT SIGNAL */
-}
+               _tracker.track (b.begin(), b.end());
 
-string
-Plugin::preset_envvar () const
-{
-       char* envvar;
-       if ((envvar = getenv ("HOME")) == 0) {
-               return "";
+               if (_have_pending_stop_events) {
+                       /* Transmit note-offs that are pending from the last transport stop */
+                       bufs.merge_from (_pending_stop_events, 0);
+                       _have_pending_stop_events = false;
+               }
        }
-       
-       return envvar;
+
+       return 0;
 }
 
-string
-Plugin::preset_source (string envvar, string domain) const
+void
+Plugin::realtime_handle_transport_stopped ()
 {
-       return string_compose ("file:%1/.%2/rdf/ardour-presets.n3", envvar, domain);
+       resolve_midi ();
 }
 
-bool
-Plugin::write_preset_file (string envvar, string domain)
+void
+Plugin::realtime_locate ()
 {
-       string path = string_compose("%1/.%2", envvar, domain);
-       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, domain);
-
-       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;
-       }
+       resolve_midi ();
+}
 
-       return true;
+void
+Plugin::monitoring_changed ()
+{
+       resolve_midi ();
 }
 
-bool
-Plugin::save_preset (string name, string domain)
+void
+Plugin::resolve_midi ()
 {
-       lrdf_portvalue portvalues[parameter_count()];
-       lrdf_defaults defaults;
-       uint32_t id;
-       std::string unique (unique_id());
-
-       /* XXX problem: AU plugins don't have numeric ID's.
-          Solution: they have a different method of providing/saving presets.
-          XXX sub-problem: implement it.
+       /* Create note-offs for any active notes and put them in _pending_stop_events, to be picked
+          up on the next call to connect_and_run ().
        */
 
-       if (!isdigit (unique[0])) {
-               return false;
-       }
+       _pending_stop_events.get_midi(0).clear ();
+       _tracker.resolve_notes (_pending_stop_events.get_midi (0), 0);
+       _have_pending_stop_events = true;
+}
 
-       id = atol (unique.c_str());
 
-       defaults.count = parameter_count();
-       defaults.items = portvalues;
+vector<Plugin::PresetRecord>
+Plugin::get_presets ()
+{
+       vector<PresetRecord> p;
 
-       for (uint32_t i = 0; i < parameter_count(); ++i) {
-               if (parameter_is_input (i)) {
-                       portvalues[i].pid = i;
-                       portvalues[i].value = get_parameter(i);
-               }
+#ifndef NO_PLUGIN_STATE
+       if (!_have_presets) {
+               find_presets ();
+               _have_presets = true;
        }
 
-       string const envvar = preset_envvar ();
-       if (envvar.empty()) {
-               warning << _("Could not locate HOME.  Preset not saved.") << endmsg;
-               return false;
+       for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
+               p.push_back (i->second);
        }
+#else
+       if (!seen_set_state_message) {
+               info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a full version"),
+                                       PROGRAM_NAME)
+                    << endmsg;
+       }
+#endif
 
-       string const source = preset_source (envvar, domain);
-
-       char* uri = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
-       
-       /* XXX: why is the uri apparently kept as the key in the `presets' map and also in the PresetRecord? */
-
-       presets.insert (make_pair (uri, PresetRecord (uri, name)));
-       free (uri);
-
-       bool const r = write_preset_file (envvar, domain);
-
-       PresetAdded (); /* EMIT SIGNAL */
-
-       return r;
+       return p;
 }
 
-PluginPtr
-ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
+/** Set parameters using a preset */
+bool
+Plugin::load_preset (PresetRecord r)
 {
-       PluginManager *mgr = PluginManager::the_manager();
-       PluginInfoList plugs;
+       _last_preset = r;
+       _parameter_changed_since_last_preset = false;
 
-       switch (type) {
-       case ARDOUR::LADSPA:
-               plugs = mgr->ladspa_plugin_info();
-               break;
+       PresetLoaded (); /* EMIT SIGNAL */
+       return true;
+}
 
-#ifdef HAVE_SLV2
-       case ARDOUR::LV2:
-               plugs = mgr->lv2_plugin_info();
-               break;
-#endif
+void
+Plugin::clear_preset ()
+{
+       _last_preset.uri = "";
+       _last_preset.label = "";
+       _parameter_changed_since_last_preset = false;
 
-#ifdef VST_SUPPORT
-       case ARDOUR::VST:
-               plugs = mgr->vst_plugin_info();
-               break;
-#endif
+       PresetLoaded (); /* EMIT SIGNAL */
+}
 
-#ifdef HAVE_AUDIOUNITS
-       case ARDOUR::AudioUnit:
-               plugs = mgr->au_plugin_info();
-               break;
-#endif
+/** @param val `plugin' value */
+void
+Plugin::set_parameter (uint32_t which, float)
+{
+       _parameter_changed_since_last_preset = true;
+       _session.set_dirty ();
+       ParameterChanged (which, get_parameter (which)); /* EMIT SIGNAL */
+}
 
-       default:
-               return PluginPtr ((Plugin *) 0);
+int
+Plugin::set_state (const XMLNode& node, int /*version*/)
+{
+       XMLProperty const * p = node.property (X_("last-preset-uri"));
+       if (p) {
+               _last_preset.uri = p->value ();
        }
 
-       PluginInfoList::iterator i;
-
-       for (i = plugs.begin(); i != plugs.end(); ++i) {
-               if (identifier == (*i)->unique_id){
-                       return (*i)->load (session);
-               }
+       p = node.property (X_("last-preset-label"));
+       if (p) {
+               _last_preset.label = p->value ();
        }
 
-#ifdef VST_SUPPORT
-       /* hmm, we didn't find it. could be because in older versions of Ardour.
-          we used to store the name of a VST plugin, not its unique ID. so try
-          again.
-       */
-
-       for (i = plugs.begin(); i != plugs.end(); ++i) {
-               if (identifier == (*i)->name){
-                       return (*i)->load (session);
-               }
+       p = node.property (X_("parameter-changed-since-last-preset"));
+       if (p) {
+               _parameter_changed_since_last_preset = string_is_affirmative (p->value ());
        }
-#endif
 
-       return PluginPtr ((Plugin*) 0);
+       return 0;
 }
 
-ChanCount
-Plugin::output_streams () const
+XMLNode &
+Plugin::get_state ()
 {
-       /* LADSPA & VST should not get here because they do not
-          return "infinite" i/o counts.
-       */
-       return ChanCount::ZERO;
+       XMLNode* root = new XMLNode (state_node_name ());
+       LocaleGuard lg (X_("POSIX"));
+
+       root->add_property (X_("last-preset-uri"), _last_preset.uri);
+       root->add_property (X_("last-preset-label"), _last_preset.label);
+       root->add_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset ? X_("yes") : X_("no"));
+
+#ifndef NO_PLUGIN_STATE        
+       add_state (root);
+#else
+       if (!seen_get_state_message) {
+               info << string_compose (_("Saving plugin settings is not supported in this build of %1. Consider paying for the full version"),
+                                       PROGRAM_NAME)
+                    << endmsg;
+               seen_get_state_message = true;
+       }
+#endif
+
+       return *root;
 }
 
-ChanCount
-Plugin::input_streams () const
+void
+Plugin::set_info (PluginInfoPtr info)
 {
-       /* LADSPA & VST should not get here because they do not
-          return "infinite" i/o counts.
-       */
-       return ChanCount::ZERO;
+       _info = info;
 }