Merge remote-tracking branch 'remotes/origin/cairocanvas' into windows
[ardour.git] / libs / ardour / plugin.cc
index 042e1561304a6faeb6267c9f9404f815290ee70b..11d859ed8c81fe3558d5effcd200dfb5781b0e1f 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2002 Paul Davis 
+    Copyright (C) 2000-2002 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
 #include <vector>
 #include <string>
 
 #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 <pbd/compose.h>
-#include <pbd/error.h>
-#include <pbd/pathscanner.h>
-#include <pbd/xml++.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/plugin_manager.h"
+#include "ardour/session.h"
+#include "ardour/types.h"
 
-#include <midi++/manager.h>
+#ifdef AUDIOUNIT_SUPPORT
+#include "ardour/audio_unit.h"
+#endif
 
-#include <ardour/ardour.h>
-#include <ardour/session.h>
-#include <ardour/audioengine.h>
-#include <ardour/plugin.h>
+#ifdef LV2_SUPPORT
+#include "ardour/lv2_plugin.h"
+#endif
 
-#include <pbd/stl_delete.h>
+#include "pbd/stl_delete.h"
 
 #include "i18n.h"
 #include <locale.h>
 
+using namespace std;
 using namespace ARDOUR;
+using namespace PBD;
+
+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)
+       : _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)
-       : _engine (other._engine), _session (other._session), _info (other._info)
+       : StatefulDestructible()
+       , Latent()
+       , _engine (other._engine)
+       , _session (other._session)
+       , _info (other._info)
+       , _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 ()
 {
 }
 
 void
-Plugin::setup_midi_controls ()
+Plugin::remove_preset (string name)
 {
-       uint32_t port_cnt;
+       do_remove_preset (name);
+       _presets.erase (preset_by_label (name)->uri);
 
-       port_cnt = parameter_count();
+       _last_preset.uri = "";
+       _parameter_changed_since_last_preset = false;
+       PresetRemoved (); /* EMIT SIGNAL */
+}
 
-       /* set up a vector of null pointers for the MIDI controls.
-          we'll fill this in on an as-needed basis.
-       */
+/** @return PresetRecord with empty URI on failure */
+Plugin::PresetRecord
+Plugin::save_preset (string name)
+{
+       string const uri = do_save_preset (name);
 
-       for (uint32_t i = 0; i < port_cnt; ++i) {
-               midi_controls.push_back (0);
+       if (!uri.empty()) {
+               _presets.insert (make_pair (uri, PresetRecord (uri, name)));
+               PresetAdded (); /* EMIT SIGNAL */
        }
+
+       return PresetRecord (uri, name);
 }
 
-Plugin::~Plugin ()
+PluginPtr
+ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
 {
-       for (vector<MIDIPortControl*>::iterator i = midi_controls.begin(); i != midi_controls.end(); ++i) {
-               if (*i) {
-                       delete *i;
-               }
+       PluginManager& mgr (PluginManager::instance());
+       PluginInfoList plugs;
+
+       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
+
+#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);
        }
-}
 
-MIDI::Controllable *
-Plugin::get_nth_midi_control (uint32_t n)
-{
-       if (n >= parameter_count()) {
-               return 0;
+       PluginInfoList::iterator i;
+
+       for (i = plugs.begin(); i != plugs.end(); ++i) {
+               if (identifier == (*i)->unique_id){
+                       return (*i)->load (session);
+               }
        }
 
-       if (midi_controls[n] == 0) {
+#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.
+       */
 
-               Plugin::ParameterDescriptor desc;
+       for (i = plugs.begin(); i != plugs.end(); ++i) {
+               if (identifier == (*i)->name){
+                       return (*i)->load (session);
+               }
+       }
+#endif
 
-               get_parameter_descriptor (n, desc);
+#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.
+       */
 
-               midi_controls[n] = new MIDIPortControl (*this, n, _session.midi_port(), desc.lower, desc.upper, desc.toggled, desc.logarithmic);
-       } 
+       for (i = plugs.begin(); i != plugs.end(); ++i) {
+               if (identifier == (*i)->name){
+                       return (*i)->load (session);
+               }
+       }
+#endif
 
-       return midi_controls[n];
+       return PluginPtr ((Plugin*) 0);
 }
 
-Plugin::MIDIPortControl::MIDIPortControl (Plugin& p, uint32_t port_id, MIDI::Port *port,
-                                         float low, float up, bool t, bool loga)
-       : MIDI::Controllable (port, 0), plugin (p), absolute_port (port_id)
+ChanCount
+Plugin::output_streams () const
 {
-       toggled = t;
-       logarithmic = loga;
-       lower = low;
-       upper = up;
-       range = upper - lower;
-       last_written = 0; /* XXX need a good out-of-bound-value */
-       setting = false;
+       /* LADSPA & VST should not get here because they do not
+          return "infinite" i/o counts.
+       */
+       return ChanCount::ZERO;
 }
 
-void
-Plugin::MIDIPortControl::set_value (float value)
+ChanCount
+Plugin::input_streams () const
 {
-       if (toggled) {
-               if (value > 0.5) {
-                       value = 1.0;
-               } else {
-                       value = 0.0;
-               }
-       } else {
-               value = lower + (range * value);
-               
-               if (logarithmic) {
-                       value = exp(value);
+       /* LADSPA & VST should not get here because they do not
+          return "infinite" i/o counts.
+       */
+       return ChanCount::ZERO;
+}
+
+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;
                }
        }
 
-       setting = true;
-       plugin.set_parameter (absolute_port, value);
-       setting = false;
+       return 0;
 }
 
-void
-Plugin::MIDIPortControl::send_feedback (float value)
+const Plugin::PresetRecord *
+Plugin::preset_by_uri (const string& uri)
 {
-
-       if (!setting && get_midi_feedback()) {
-               MIDI::byte val;
-               MIDI::channel_t ch = 0;
-               MIDI::eventType ev = MIDI::none;
-               MIDI::byte additional = 0;
-               MIDI::EventTwoBytes data;
-
-               if (toggled) {
-                       val = (MIDI::byte) (value * 127.0f);
-               } else {
-                       if (logarithmic) {
-                               value = log(value);
-                       }
-
-                       val = (MIDI::byte) (((value - lower) / range) * 127.0f);
-               }
-               
-               if (get_control_info (ch, ev, additional)) {
-                       data.controller_number = additional;
-                       data.value = val;
-
-                       plugin.session().send_midi_message (get_port(), ev, ch, data);
-               }
+       map<string, PresetRecord>::const_iterator pr = _presets.find (uri);
+       if (pr != _presets.end()) {
+               return &pr->second;
+       } else {
+               return 0;
        }
-       
 }
 
-MIDI::byte*
-Plugin::MIDIPortControl::write_feedback (MIDI::byte* buf, int32_t& bufsize, float value, bool force)
+int
+Plugin::connect_and_run (BufferSet& bufs,
+                        ChanMapping /*in_map*/, ChanMapping /*out_map*/,
+                        pframes_t /* nframes */, framecnt_t /*offset*/)
 {
-       if (get_midi_feedback() && bufsize > 2) {
-               MIDI::channel_t ch = 0;
-               MIDI::eventType ev = MIDI::none;
-               MIDI::byte additional = 0;
-
-               if (get_control_info (ch, ev, additional)) {
+       if (bufs.count().n_midi() > 0) {
 
-                       MIDI::byte val;
+               /* Track notes that we are sending to the plugin */
 
-                       if (toggled) {
+               MidiBuffer& b = bufs.get_midi (0);
 
-                               val = (MIDI::byte) (value * 127.0f);
+               _tracker.track (b.begin(), b.end());
 
-                       } else {
-
-                               if (logarithmic) {
-                                       value = log(value);
-                               }
-                               
-                               val = (MIDI::byte) (((value - lower) / range) * 127.0f);
-                       }
-
-                       if (val != last_written || force)  {
-                               *buf++ = MIDI::controller & ch;
-                               *buf++ = additional; /* controller number */
-                               *buf++ = val;
-                               last_written = val;
-                               bufsize -= 3;
-                       }
+               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 buf;
+       return 0;
 }
 
+void
+Plugin::realtime_handle_transport_stopped ()
+{
+       resolve_midi ();
+}
 
 void
-Plugin::reset_midi_control (MIDI::Port* port, bool on)
+Plugin::realtime_locate ()
 {
-       MIDI::channel_t chn;
-       MIDI::eventType ev;
-       MIDI::byte extra;
-       
-       for (vector<MIDIPortControl*>::iterator i = midi_controls.begin(); i != midi_controls.end(); ++i) {
-               if (*i == 0)
-                       continue;
-               (*i)->get_control_info (chn, ev, extra);
-               if (!on) {
-                       chn = -1;
-               }
-               (*i)->midi_rebind (port, chn);
-       }
+       resolve_midi ();
 }
 
 void
-Plugin::send_all_midi_feedback ()
+Plugin::monitoring_changed ()
 {
-       if (_session.get_midi_feedback()) {
-               float val = 0.0;
-               uint32_t n = 0;
-               
-               for (vector<MIDIPortControl*>::iterator i = midi_controls.begin(); i != midi_controls.end(); ++i, ++n) {
-                       if (*i == 0) {
-                               continue;
-                       }
-
-                       val = (*i)->plugin.get_parameter (n);
-                       (*i)->send_feedback (val);
-               }
-               
-       }
+       resolve_midi ();
 }
 
-MIDI::byte*
-Plugin::write_midi_feedback (MIDI::byte* buf, int32_t& bufsize)
+void
+Plugin::resolve_midi ()
 {
-       if (_session.get_midi_feedback()) {
-               float val = 0.0;
-               uint32_t n = 0;
-               
-               for (vector<MIDIPortControl*>::iterator i = midi_controls.begin(); i != midi_controls.end(); ++i, ++n) {
-                       if (*i == 0) {
-                               continue;
-                       }
-
-                       val = (*i)->plugin.get_parameter (n);
-                       buf = (*i)->write_feedback (buf, bufsize, val);
-               }
-       }
+       /* 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 ().
+       */
 
-       return buf;
+       _pending_stop_events.get_midi(0).clear ();
+       _tracker.resolve_notes (_pending_stop_events.get_midi (0), 0);
+       _have_pending_stop_events = true;
 }
 
-vector<string>
-Plugin::get_presets()
+
+vector<Plugin::PresetRecord>
+Plugin::get_presets ()
 {
-       vector<string> labels;
-       lrdf_uris* set_uris = lrdf_get_setting_uris(unique_id());
-
-       if (set_uris) {
-               for (uint32_t i = 0; i < set_uris->count; ++i) {
-                       if (char* label = lrdf_get_label(set_uris->items[i])) {
-                               labels.push_back(label);
-                               presets[label] = set_uris->items[i];
-                       }
-               }
-               lrdf_free_uris(set_uris);
+       vector<PresetRecord> p;
+
+#ifndef NO_PLUGIN_STATE
+       if (!_have_presets) {
+               find_presets ();
+               _have_presets = true;
        }
 
-       // GTK2FIX find an equivalent way to do this with a vector (needed by GUI apis)
-       // labels.unique();
+       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
 
-       return labels;
+       return p;
 }
 
+/** Set parameters using a preset */
 bool
-Plugin::load_preset(const string preset_label)
+Plugin::load_preset (PresetRecord r)
 {
-       lrdf_defaults* defs = lrdf_get_setting_values(presets[preset_label].c_str());
-
-       if (defs) {
-               for (uint32_t i = 0; i < 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 < defs->count) && parameter_is_input (defs->items[i].pid)) {
-                               set_parameter(defs->items[i].pid, defs->items[i].value);
-                       }
-               }
-               lrdf_free_setting_values(defs);
-       }
+       _last_preset = r;
+       _parameter_changed_since_last_preset = false;
 
+       PresetLoaded (); /* EMIT SIGNAL */
        return true;
 }
 
-bool
-Plugin::save_preset (string name, string domain)
+void
+Plugin::clear_preset ()
 {
-       lrdf_portvalue portvalues[parameter_count()];
-       lrdf_defaults defaults;
-       defaults.count = parameter_count();
-       defaults.items = portvalues;
-
-       for (uint32_t i = 0; i < parameter_count(); ++i) {
-               if (parameter_is_input (i)) {
-                       portvalues[i].pid = i;
-                       portvalues[i].value = get_parameter(i);
-               }
-       }
+       _last_preset.uri = "";
+       _last_preset.label = "";
+       _parameter_changed_since_last_preset = false;
 
-       char* envvar;
-       if ((envvar = getenv ("HOME")) == 0) {
-               warning << _("Could not locate HOME.  Preset not saved.") << endmsg;
-               return false;
-       }
-       
-       string source(string_compose("file:%1/.%2/rdf/ardour-presets.n3", envvar, domain));
+       PresetLoaded (); /* EMIT SIGNAL */
+}
 
-       free(lrdf_add_preset(source.c_str(), name.c_str(), unique_id(), &defaults));
+/** @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 */
+}
 
-       string path = string_compose("%1/.%2", envvar, domain);
-       if (mkdir(path.c_str(), 0775) && errno != EEXIST) {
-               warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
-               return false;
+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 ();
        }
-       
-       path += "/rdf";
-       if (mkdir(path.c_str(), 0775) && errno != EEXIST) {
-               warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
-               return false;
+
+       p = node.property (X_("last-preset-label"));
+       if (p) {
+               _last_preset.label = p->value ();
        }
-       
-       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;
+
+       p = node.property (X_("parameter-changed-since-last-preset"));
+       if (p) {
+               _parameter_changed_since_last_preset = string_is_affirmative (p->value ());
        }
 
-       return true;
+       return 0;
 }
+
+XMLNode &
+Plugin::get_state ()
+{
+       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;
+}
+
+void
+Plugin::set_info (PluginInfoPtr info)
+{
+       _info = info;
+}
+
+