vestige-based VST support, back-ported from 2.0-ongoing
[ardour.git] / libs / ardour / vst_plugin.cc
index 2f3653a16af626a1788a24184cfbc542fc7dd0fc..cd2531d52296882feeb3abb9aa7e6794298ca8da 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #include <algorithm>
 #include <vector>
 #include <string>
-#include <ctype.h>
+#include <cctype>
 
 #include <cstdlib>
 #include <cstdio> // so libraptor doesn't complain
 #include <cmath>
 #include <dirent.h>
-#include <string.h> // for memmove
+#include <cstring> // for memmove
 #include <sys/stat.h>
 #include <cerrno>
 
+#include <glibmm/ustring.h>
+#include <glibmm/miscutils.h>
+
 #include <lrdf.h>
 #include <fst.h>
 
-#include <pbd/compose.h>
-#include <pbd/error.h>
-#include <pbd/pathscanner.h>
-#include <pbd/xml++.h>
+#include "pbd/compose.h"
+#include "pbd/error.h"
+#include "pbd/pathscanner.h"
+#include "pbd/xml++.h"
 
 #include <vst/aeffectx.h>
 
-#include <midi++/manager.h>
-
-#include <ardour/ardour.h>
-#include <ardour/session.h>
-#include <ardour/audioengine.h>
-#include <ardour/vst_plugin.h>
+#include "ardour/session.h"
+#include "ardour/audioengine.h"
+#include "ardour/filesystem_paths.h"
+#include "ardour/vst_plugin.h"
+#include "ardour/buffer_set.h"
 
-#include <pbd/stl_delete.h>
+#include "pbd/stl_delete.h"
 
 #include "i18n.h"
 #include <locale.h>
 
 using namespace ARDOUR;
+using namespace PBD;
 using std::min;
 using std::max;
 
@@ -80,7 +82,7 @@ VSTPlugin::VSTPlugin (AudioEngine& e, Session& session, FSTHandle* h)
 
        _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
        
-       Plugin::setup_midi_controls ();
+       Plugin::setup_controls ();
 }
 
 VSTPlugin::VSTPlugin (const VSTPlugin &other)
@@ -93,34 +95,24 @@ VSTPlugin::VSTPlugin (const VSTPlugin &other)
        }
        _plugin = _fst->plugin;
 
-       Plugin::setup_midi_controls ();
+       Plugin::setup_controls ();
 }
 
 VSTPlugin::~VSTPlugin ()
 {
        deactivate ();
-       GoingAway (this); /* EMIT SIGNAL */
+       GoingAway (); /* EMIT SIGNAL */
        fst_close (_fst);
 }
 
 void
-VSTPlugin::set_block_size (jack_nframes_t nframes)
+VSTPlugin::set_block_size (nframes_t nframes)
 {
        deactivate ();
        _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
        activate ();
 }
 
-void
-VSTPlugin::store_state (PluginState& state)
-{
-}
-
-void
-VSTPlugin::restore_state (PluginState& state)
-{
-}
-
 float
 VSTPlugin::default_value (uint32_t port)
 {
@@ -131,14 +123,7 @@ void
 VSTPlugin::set_parameter (uint32_t which, float val)
 {
        _plugin->setParameter (_plugin, which, val);
-       ParameterChanged (which, val); /* EMIT SIGNAL */
-
-       if (session().get_midi_feedback()) {
-               
-               if (which < parameter_count() && midi_controls[which]) {
-                       midi_controls[which]->send_feedback (val);
-               }
-       }
+       //ParameterChanged (which, val); /* EMIT SIGNAL */
 }
 
 float
@@ -160,40 +145,41 @@ VSTPlugin::get_state()
 {
        XMLNode *root = new XMLNode (state_node_name());
        LocaleGuard lg (X_("POSIX"));
-       
-       if (_plugin->flags & effFlagsProgramChunks) {
+
+       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
                /* fetch the current chunk */
                
                void* data;
                long  data_size;
                
-               if ((data_size = _plugin->dispatcher (_plugin, effGetChunk, 0, 0, &data, false)) == 0) {
+               if ((data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, 0, 0, &data, false)) == 0) {
                        return *root;
                }
 
                /* save it to a file */
 
-               string path;
+               Glib::ustring path = Glib::build_filename (get_user_ardour_path (), "vst");
                struct stat sbuf;
 
-               path = getenv ("HOME");
-               path += "/.ardour/vst";
+               sys::path user_vst_directory(user_config_directory());
+       
+               user_vst_directory /= "vst";
+               path = user_vst_directory.to_string();
 
                if (stat (path.c_str(), &sbuf)) {
                        if (errno == ENOENT) {
-                               if (mkdir (path.c_str(), 0600)) {
+                               if (g_mkdir_with_parents (path.c_str(), 0600)) {
                                        error << string_compose (_("cannot create VST chunk directory: %1"),
-                                                         strerror (errno))
+                                                                strerror (errno))
                                              << endmsg;
                                        return *root;
                                }
 
                        } else {
 
-                               error << string_compose (_("cannot check VST chunk directory: %1"),
-                                                 strerror (errno))
-                                     << endmsg;
+                               warning << string_compose (_("cannot check VST chunk directory: %1"), strerror (errno))
+                                       << endmsg;
                                return *root;
                        }
 
@@ -203,7 +189,7 @@ VSTPlugin::get_state()
                        return *root;
                }
                
-               path += "something";
+               path = Glib::build_filename (path, "something");
                
                /* store information */
 
@@ -220,7 +206,7 @@ VSTPlugin::get_state()
                        char index[64];
                        char val[32];
                        snprintf (index, sizeof (index), "param_%ld", n);
-                       snprintf (val, sizeof (val), "%f", _plugin->getParameter (_plugin, n));
+                       snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
                        parameters->add_property (index, val);
                }
 
@@ -253,6 +239,7 @@ VSTPlugin::set_state(const XMLNode& node)
                for (i = child->properties().begin(); i != child->properties().end(); ++i) {
                        long param;
                        float val;
+
                        sscanf ((*i)->name().c_str(), "param_%ld", &param);
                        sscanf ((*i)->value().c_str(), "%f", &val);
 
@@ -275,6 +262,8 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
 
        if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
 
+#ifdef VESTIGE_COMPLETE
+
                /* i have yet to find or hear of a VST plugin that uses this */
 
                if (prop.flags & kVstParameterUsesIntegerMinMax) {
@@ -310,6 +299,7 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
                desc.logarithmic = false;
                desc.sr_dependent = false;
                desc.label = prop.label;
+#endif
 
        } else {
 
@@ -338,7 +328,7 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
 bool
 VSTPlugin::load_preset (string name)
 {
-       if (_plugin->flags & effFlagsProgramChunks) {
+       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
                error << _("no support for presets using chunks at this time")
                      << endmsg;
                return false;
@@ -349,7 +339,7 @@ VSTPlugin::load_preset (string name)
 bool
 VSTPlugin::save_preset (string name)
 {
-       if (_plugin->flags & effFlagsProgramChunks) {
+       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
                error << _("no support for presets using chunks at this time")
                      << endmsg;
                return false;
@@ -365,10 +355,18 @@ VSTPlugin::describe_parameter (uint32_t param)
        return name;
 }
 
-jack_nframes_t
-VSTPlugin::latency () const
+nframes_t
+VSTPlugin::signal_latency () const
 {
-       return _plugin->initialDelay;
+       if (_user_latency) {
+               return _user_latency;
+       }
+
+#ifdef VESTIGE_HEADER
+        return *((nframes_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
+#else
+       return _plugin->initial_delay;
+#endif
 }
 
 set<uint32_t>
@@ -384,19 +382,21 @@ VSTPlugin::automatable () const
 }
 
 int
-VSTPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in_index, int32_t& out_index, jack_nframes_t nframes, jack_nframes_t offset)
+VSTPlugin::connect_and_run (BufferSet& bufs, uint32_t& in_index, uint32_t& out_index, nframes_t nframes, nframes_t offset)
 {
        float *ins[_plugin->numInputs];
        float *outs[_plugin->numOutputs];
        int32_t i;
 
+       const uint32_t nbufs = bufs.count().n_audio();
+
        for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
-               ins[i] = bufs[min((uint32_t) in_index,maxbuf - 1)] + offset;
+               ins[i] = bufs.get_audio(min((uint32_t) in_index, nbufs - 1)).data() + offset;
                in_index++;
        }
 
        for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
-               outs[i] = bufs[min((uint32_t) out_index,maxbuf - 1)] + offset;
+               outs[i] = bufs.get_audio(min((uint32_t) out_index, nbufs - 1)).data() + offset;
 
                /* unbelievably, several VST plugins still rely on Cubase
                   behaviour and do not silence the buffer in processReplacing 
@@ -427,10 +427,17 @@ VSTPlugin::activate ()
        _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
 }
 
-uint32_t 
+string
 VSTPlugin::unique_id() const
 {
-       return _plugin->uniqueID;
+       char buf[32];
+
+#ifdef VESTIGE_HEADER
+       snprintf (buf, sizeof (buf), "%d", *((int32_t*) &_plugin->unused_id));
+#else
+       snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
+#endif
+       return string (buf);
 }
 
 
@@ -487,3 +494,33 @@ VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 
        memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
 }
+
+PluginPtr
+VSTPluginInfo::load (Session& session)
+{
+       try {
+               PluginPtr plugin;
+
+               if (Config->get_use_vst()) {
+                       FSTHandle* handle;
+                       
+                       handle = fst_load(path.c_str());
+       
+                       if ( (int)handle == -1) {
+                               error << string_compose(_("VST: cannot load module from \"%1\""), path) << endmsg;
+                       } else {
+                               plugin.reset (new VSTPlugin (session.engine(), session, handle));
+                       }
+               } else {
+                       error << _("You asked ardour to not use any VST plugins") << endmsg;
+                       return PluginPtr ((Plugin*) 0);
+               }
+
+               plugin->set_info(PluginInfoPtr(new VSTPluginInfo(*this)));
+               return plugin;
+       }       
+
+       catch (failed_constructor &err) {
+               return PluginPtr ((Plugin*) 0);
+       }
+}