Fix MIDI port offsets.
[ardour.git] / libs / ardour / plugin.cc
index 12760e5d6e269665f2513fa6255ad07f8bf9d4fe..e0ba0f00f7fabc31a9e2dcd8c7c20fd1b726ac68 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/luaproc.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/port.h"
+#include "ardour/session.h"
+#include "ardour/types.h"
 
-#ifdef HAVE_AUDIOUNITS
+#ifdef AUDIOUNIT_SUPPORT
 #include "ardour/audio_unit.h"
 #endif
 
 
 #include "pbd/stl_delete.h"
 
-#include "i18n.h"
+#include "pbd/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
+
+PBD::Signal2<void, std::string, Plugin*> Plugin::PresetsChanged;
+
+bool
+PluginInfo::needs_midi_input () const
+{
+       return (n_inputs.n_midi() != 0);
+}
+
+bool
+PluginInfo::is_instrument () const
+{
+       return (n_inputs.n_midi() != 0) && (n_outputs.n_audio() > 0) && (n_inputs.n_audio() == 0);
+}
+
 Plugin::Plugin (AudioEngine& e, Session& s)
        : _engine (e)
        , _session (s)
        , _cycles (0)
+       , _owner (0)
        , _have_presets (false)
        , _have_pending_stop_events (false)
        , _parameter_changed_since_last_preset (false)
+       , _immediate_events(6096) // FIXME: size?
 {
+       _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
 }
 
 Plugin::Plugin (const Plugin& other)
@@ -79,26 +113,39 @@ Plugin::Plugin (const Plugin& other)
        , _session (other._session)
        , _info (other._info)
        , _cycles (0)
+       , _owner (other._owner)
        , _have_presets (false)
        , _have_pending_stop_events (false)
        , _parameter_changed_since_last_preset (false)
+       , _immediate_events(6096) // FIXME: size?
 {
-
+       _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
 }
 
 Plugin::~Plugin ()
 {
-
 }
 
 void
 Plugin::remove_preset (string name)
 {
+       Plugin::PresetRecord const * p = preset_by_label (name);
+       if (!p) {
+               PBD::error << _("Trying to remove nonexistent preset.") << endmsg;
+               return;
+       }
+       if (!p->user) {
+               PBD::error << _("Cannot remove plugin factory preset.") << endmsg;
+               return;
+       }
+
        do_remove_preset (name);
-       _presets.erase (preset_by_label (name)->uri);
+       _presets.erase (p->uri);
 
        _last_preset.uri = "";
        _parameter_changed_since_last_preset = false;
+       _have_presets = false;
+       PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
        PresetRemoved (); /* EMIT SIGNAL */
 }
 
@@ -106,10 +153,17 @@ Plugin::remove_preset (string name)
 Plugin::PresetRecord
 Plugin::save_preset (string name)
 {
+       if (preset_by_label (name)) {
+               PBD::error << _("Preset with given name already exists.") << endmsg;
+               return Plugin::PresetRecord ();
+       }
+
        string const uri = do_save_preset (name);
 
        if (!uri.empty()) {
                _presets.insert (make_pair (uri, PresetRecord (uri, name)));
+               _have_presets = false;
+               PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
                PresetAdded (); /* EMIT SIGNAL */
        }
 
@@ -119,35 +173,45 @@ Plugin::save_preset (string name)
 PluginPtr
 ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
 {
-       PluginManager *mgr = PluginManager::the_manager();
+       PluginManager& mgr (PluginManager::instance());
        PluginInfoList plugs;
 
        switch (type) {
+       case ARDOUR::Lua:
+               plugs = mgr.lua_plugin_info();
+               break;
+
        case ARDOUR::LADSPA:
-               plugs = mgr->ladspa_plugin_info();
+               plugs = mgr.ladspa_plugin_info();
                break;
 
 #ifdef LV2_SUPPORT
        case ARDOUR::LV2:
-               plugs = mgr->lv2_plugin_info();
+               plugs = mgr.lv2_plugin_info();
                break;
 #endif
 
-#ifdef VST_SUPPORT
-       case ARDOUR::VST:
-               plugs = mgr->vst_plugin_info();
+#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();
+               plugs = mgr.lxvst_plugin_info();
                break;
 #endif
 
-#ifdef HAVE_AUDIOUNITS
+#ifdef MACVST_SUPPORT
+       case ARDOUR::MacVST:
+               plugs = mgr.mac_vst_plugin_info();
+               break;
+#endif
+
+#ifdef AUDIOUNIT_SUPPORT
        case ARDOUR::AudioUnit:
-               plugs = mgr->au_plugin_info();
+               plugs = mgr.au_plugin_info();
                break;
 #endif
 
@@ -163,7 +227,7 @@ ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
                }
        }
 
-#ifdef VST_SUPPORT
+#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.
@@ -210,9 +274,52 @@ Plugin::input_streams () const
        return ChanCount::ZERO;
 }
 
+Plugin::IOPortDescription
+Plugin::describe_io_port (ARDOUR::DataType dt, bool input, uint32_t id) const
+{
+       std::stringstream ss;
+       switch (dt) {
+               case DataType::AUDIO:
+                       ss << _("Audio") << " ";
+                       break;
+               case DataType::MIDI:
+                       ss << _("Midi") << " ";
+                       break;
+               default:
+                       ss << _("?") << " ";
+                       break;
+       }
+       if (input) {
+               ss << _("In") << " ";
+       } else {
+               ss << _("Out") << " ";
+       }
+
+       ss << (id + 1);
+
+       Plugin::IOPortDescription iod (ss.str());
+       return iod;
+}
+
+PluginOutputConfiguration
+Plugin::possible_output () const
+{
+       PluginOutputConfiguration oc;
+       if (_info) {
+               oc.insert (_info->n_outputs.n_audio ());
+       }
+       return oc;
+}
+
 const Plugin::PresetRecord *
 Plugin::preset_by_label (const string& label)
 {
+#ifndef NO_PLUGIN_STATE
+       if (!_have_presets) {
+               find_presets ();
+               _have_presets = true;
+       }
+#endif
        // FIXME: O(n)
        for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
                if (i->second.label == label) {
@@ -226,6 +333,12 @@ Plugin::preset_by_label (const string& label)
 const Plugin::PresetRecord *
 Plugin::preset_by_uri (const string& uri)
 {
+#ifndef NO_PLUGIN_STATE
+       if (!_have_presets) {
+               find_presets ();
+               _have_presets = true;
+       }
+#endif
        map<string, PresetRecord>::const_iterator pr = _presets.find (uri);
        if (pr != _presets.end()) {
                return &pr->second;
@@ -234,17 +347,31 @@ Plugin::preset_by_uri (const string& uri)
        }
 }
 
+bool
+Plugin::write_immediate_event (size_t size, const uint8_t* buf)
+{
+       if (!Evoral::midi_event_is_valid (buf, size)) {
+               return false;
+       }
+       return (_immediate_events.write (0, Evoral::MIDI_EVENT, size, buf) == size);
+}
+
 int
 Plugin::connect_and_run (BufferSet& bufs,
-                        ChanMapping /*in_map*/, ChanMapping /*out_map*/,
-                        pframes_t nframes, framecnt_t offset)
+               samplepos_t /*start*/, samplepos_t /*end*/, double /*speed*/,
+               ChanMapping /*in_map*/, ChanMapping /*out_map*/,
+               pframes_t nframes, samplecnt_t /*offset*/)
 {
        if (bufs.count().n_midi() > 0) {
 
+               if (_immediate_events.read_space() && nframes > 0) {
+                       _immediate_events.read (bufs.get_midi (0), 0, 1, nframes - 1, true);
+               }
+
                /* Track notes that we are sending to the plugin */
-               MidiBuffer& b = bufs.get_midi (0);
-               bool looped;
-               _tracker.track (b.begin(), b.end(), looped);
+               const MidiBuffer& b = bufs.get_midi (0);
+
+               _tracker.track (b.begin(), b.end());
 
                if (_have_pending_stop_events) {
                        /* Transmit note-offs that are pending from the last transport stop */
@@ -258,12 +385,29 @@ Plugin::connect_and_run (BufferSet& bufs,
 
 void
 Plugin::realtime_handle_transport_stopped ()
+{
+       resolve_midi ();
+}
+
+void
+Plugin::realtime_locate ()
+{
+       resolve_midi ();
+}
+
+void
+Plugin::monitoring_changed ()
+{
+       resolve_midi ();
+}
+
+void
+Plugin::resolve_midi ()
 {
        /* 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 ().
        */
 
-       _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
        _pending_stop_events.get_midi(0).clear ();
        _tracker.resolve_notes (_pending_stop_events.get_midi (0), 0);
        _have_pending_stop_events = true;
@@ -272,15 +416,25 @@ Plugin::realtime_handle_transport_stopped ()
 vector<Plugin::PresetRecord>
 Plugin::get_presets ()
 {
+       vector<PresetRecord> p;
+
+#ifndef NO_PLUGIN_STATE
        if (!_have_presets) {
                find_presets ();
                _have_presets = true;
        }
 
-       vector<PresetRecord> p;
        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;
+               seen_set_state_message = true;
+       }
+#endif
 
        return p;
 }
@@ -292,37 +446,44 @@ Plugin::load_preset (PresetRecord r)
        _last_preset = r;
        _parameter_changed_since_last_preset = false;
 
+       _session.set_dirty ();
        PresetLoaded (); /* EMIT SIGNAL */
        return true;
 }
 
-/** @param val `plugin' value */
 void
-Plugin::set_parameter (uint32_t which, float val)
+Plugin::clear_preset ()
+{
+       _last_preset.uri = "";
+       _last_preset.label = "";
+       _parameter_changed_since_last_preset = false;
+
+       _session.set_dirty ();
+       PresetLoaded (); /* EMIT SIGNAL */
+}
+
+void
+Plugin::set_parameter (uint32_t /* which */, float /* value */)
+{
+       _parameter_changed_since_last_preset = true;
+       PresetDirty (); /* EMIT SIGNAL */
+}
+
+void
+Plugin::parameter_changed_externally (uint32_t which, float /* value */)
 {
        _parameter_changed_since_last_preset = true;
        _session.set_dirty ();
-       ParameterChanged (which, val); /* EMIT SIGNAL */
+       ParameterChangedExternally (which, get_parameter (which)); /* EMIT SIGNAL */
+       PresetDirty (); /* EMIT SIGNAL */
 }
 
 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 ();
-       }
-
-       p = node.property (X_("last-preset-label"));
-       if (p) {
-               _last_preset.label = p->value ();
-       }
-
-       p = node.property (X_("parameter-changed-since-last-preset"));
-       if (p) {
-               _parameter_changed_since_last_preset = string_is_affirmative (p->value ());
-       }
-
+       node.get_property (X_("last-preset-uri"), _last_preset.uri);
+       node.get_property (X_("last-preset-label"), _last_preset.label);
+       node.get_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset);
        return 0;
 }
 
@@ -330,12 +491,38 @@ 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"));
+       root->set_property (X_("last-preset-uri"), _last_preset.uri);
+       root->set_property (X_("last-preset-label"), _last_preset.label);
+       root->set_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset);
 
+#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;
+}
+
+std::string
+Plugin::parameter_label (uint32_t which) const
+{
+       if (which >= parameter_count ()) {
+               return "";
+       }
+       ParameterDescriptor pd;
+       get_parameter_descriptor (which, pd);
+       return pd.label;
+}