libs/ardour/plugin_manager.cc

   1 /*
   2     Copyright (C) 2000-2004 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18     $Id$
  19 */
  20
  21 #include <sys/types.h>
  22 #include <cstdio>
  23 #include <lrdf.h>
  24 #include <dlfcn.h>
  25
  26 #ifdef VST_SUPPORT
  27 #include <fst.h>
  28 #include <pbd/basename.h>
  29 #include <string.h>
  30 #endif
  31
  32 #include <pbd/pathscanner.h>
  33
  34 #include <ardour/ladspa.h>
  35 #include <ardour/session.h>
  36 #include <ardour/plugin_manager.h>
  37 #include <ardour/plugin.h>
  38 #include <ardour/ladspa_plugin.h>
  39 #include <ardour/vst_plugin.h>
  40
  41 #include <pbd/error.h>
  42 #include <pbd/stl_delete.h>
  43
  44 #include "i18n.h"
  45
  46 using namespace ARDOUR;
  47
  48 PluginManager* PluginManager::_manager = 0;
  49
  50 PluginManager::PluginManager (AudioEngine& e)
  51         : _engine (e)
  52 {
  53         char* s;
  54         string lrdf_path;
  55
  56         if ((s = getenv ("LADSPA_RDF_PATH"))){
  57                 lrdf_path = s;
  58         }
  59
  60         if (lrdf_path.length() == 0) {
  61                 lrdf_path = "/usr/local/share/ladspa/rdf:/usr/share/ladspa/rdf";
  62         }
  63
  64         add_lrdf_data(lrdf_path);
  65         add_ladspa_presets();
  66 #ifdef VST_SUPPORT
  67         if (Config->get_use_vst()) {
  68                 add_vst_presets();
  69         }
  70 #endif /* VST_SUPPORT */
  71
  72         if ((s = getenv ("LADSPA_PATH"))) {
  73                 ladspa_path = s;
  74         }
  75
  76         if ((s = getenv ("VST_PATH"))) {
  77                 vst_path = s;
  78         } else if ((s = getenv ("VST_PLUGINS"))) {
  79                 vst_path = s;
  80         }
  81
  82         refresh ();
  83
  84         if (_manager == 0) {
  85                 _manager = this;
  86         }
  87 }
  88
  89 void
  90 PluginManager::refresh ()
  91 {
  92         ladspa_refresh ();
  93 #ifdef VST_SUPPORT
  94         if (Config->get_use_vst()) {
  95                 vst_refresh ();
  96         }
  97 #endif
  98 }
  99
 100 void
 101 PluginManager::ladspa_refresh ()
 102 {
 103         for (std::list<PluginInfo*>::iterator i = _ladspa_plugin_info.begin(); i != _ladspa_plugin_info.end(); ++i) {
 104                 delete *i;
 105         }
 106
 107         _ladspa_plugin_info.clear ();
 108
 109         if (ladspa_path.length() == 0) {
 110                 ladspa_path = "/usr/local/lib/ladspa:/usr/lib/ladspa";
 111         }
 112
 113         ladspa_discover_from_path (ladspa_path);
 114 }
 115
 116 int
 117 PluginManager::add_ladspa_directory (string path)
 118 {
 119         if (ladspa_discover_from_path (path) == 0) {
 120                 ladspa_path += ':';
 121                 ladspa_path += path;
 122                 return 0;
 123         }
 124         return -1;
 125 }
 126
 127 static bool ladspa_filter (const string& str, void *arg)
 128 {
 129         /* Not a dotfile, has a prefix before a period, suffix is "so" */
 130
 131         return str[0] != '.' && (str.length() > 3 && str.find (".so") == (str.length() - 3));
 132 }
 133
 134 int
 135 PluginManager::ladspa_discover_from_path (string path)
 136 {
 137         PathScanner scanner;
 138         vector<string *> *plugin_objects;
 139         vector<string *>::iterator x;
 140         int ret = 0;
 141
 142         plugin_objects = scanner (ladspa_path, ladspa_filter, 0, true, true);
 143
 144         if (plugin_objects) {
 145                 for (x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
 146                         ladspa_discover (**x);
 147                 }
 148         }
 149
 150         vector_delete (plugin_objects);
 151         return ret;
 152 }
 153
 154 static bool rdf_filter (const string &str, void *arg)
 155 {
 156         return str[0] != '.' &&
 157                    ((str.find(".rdf")  == (str.length() - 4)) ||
 158             (str.find(".rdfs") == (str.length() - 5)) ||
 159                     (str.find(".n3")   == (str.length() - 3)));
 160 }
 161
 162 void
 163 PluginManager::add_ladspa_presets()
 164 {
 165         add_presets ("ladspa");
 166 }
 167
 168 void
 169 PluginManager::add_vst_presets()
 170 {
 171         add_presets ("vst");
 172 }
 173 void
 174 PluginManager::add_presets(string domain)
 175 {
 176
 177         PathScanner scanner;
 178         vector<string *> *presets;
 179         vector<string *>::iterator x;
 180
 181         char* envvar;
 182         if ((envvar = getenv ("HOME")) == 0) {
 183                 return;
 184         }
 185
 186         string path = string_compose("%1/.%2/rdf", envvar, domain);
 187         presets = scanner (path, rdf_filter, 0, true, true);
 188
 189         if (presets) {
 190                 for (x = presets->begin(); x != presets->end (); ++x) {
 191                         string file = "file:" + **x;
 192                         if (lrdf_read_file(file.c_str())) {
 193                                 warning << string_compose(_("Could not parse rdf file: %1"), *x) << endmsg;
 194                         }
 195                 }
 196         }
 197
 198         vector_delete (presets);
 199 }
 200
 201
 202 void
 203 PluginManager::add_lrdf_data (const string &path)
 204 {
 205         PathScanner scanner;
 206         vector<string *>* rdf_files;
 207         vector<string *>::iterator x;
 208         string uri;
 209
 210         rdf_files = scanner (path, rdf_filter, 0, true, true);
 211
 212         if (rdf_files) {
 213                 for (x = rdf_files->begin(); x != rdf_files->end (); ++x) {
 214                         uri = "file://" + **x;
 215
 216                         if (lrdf_read_file(uri.c_str())) {
 217                                 warning << "Could not parse rdf file: " << uri << endmsg;
 218                         }
 219                 }
 220         }
 221
 222         vector_delete (rdf_files);
 223 }
 224
 225 int
 226 PluginManager::ladspa_discover (string path)
 227 {
 228         PluginInfo *info;
 229         void *module;
 230         const LADSPA_Descriptor *descriptor;
 231         LADSPA_Descriptor_Function dfunc;
 232         const char *errstr;
 233
 234         if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
 235                 error << string_compose(_("LADSPA: cannot load module \"%1\" (%2)"), path, dlerror()) << endmsg;
 236                 return -1;
 237         }
 238
 239         dfunc = (LADSPA_Descriptor_Function) dlsym (module, "ladspa_descriptor");
 240
 241         if ((errstr = dlerror()) != 0) {
 242                 error << string_compose(_("LADSPA: module \"%1\" has no descriptor function."), path) << endmsg;
 243                 error << errstr << endmsg;
 244                 dlclose (module);
 245                 return -1;
 246         }
 247
 248         for (uint32_t i = 0; ; ++i) {
 249                 if ((descriptor = dfunc (i)) == 0) {
 250                         break;
 251                 }
 252
 253                 info = new PluginInfo;
 254                 info->name = descriptor->Name;
 255                 info->category = get_ladspa_category(descriptor->UniqueID);
 256                 info->path = path;
 257                 info->index = i;
 258                 info->n_inputs = 0;
 259                 info->n_outputs = 0;
 260                 info->type = PluginInfo::LADSPA;
 261                 info->unique_id = descriptor->UniqueID;
 262
 263                 for (uint32_t n=0; n < descriptor->PortCount; ++n) {
 264                         if ( LADSPA_IS_PORT_AUDIO (descriptor->PortDescriptors[n]) ) {
 265                                 if ( LADSPA_IS_PORT_INPUT (descriptor->PortDescriptors[n]) ) {
 266                                         info->n_inputs++;
 267                                 }
 268                                 else if ( LADSPA_IS_PORT_OUTPUT (descriptor->PortDescriptors[n]) ) {
 269                                         info->n_outputs++;
 270                                 }
 271                         }
 272                 }
 273
 274                 _ladspa_plugin_info.push_back (info);
 275         }
 276
 277 // GDB WILL NOT LIKE YOU IF YOU DO THIS
 278 //      dlclose (module);
 279
 280         return 0;
 281 }
 282
 283 Plugin *
 284 PluginManager::load (Session& session, PluginInfo *info)
 285 {
 286         void *module;
 287         Plugin *plugin = 0;
 288
 289         try {
 290                 if (info->type == PluginInfo::VST) {
 291
 292 #ifdef VST_SUPPORT
 293                         if (Config->get_use_vst()) {
 294                                 FSTHandle* handle;
 295
 296                                 if ((handle = fst_load (info->path.c_str())) == 0) {
 297                                         error << string_compose(_("VST: cannot load module from \"%1\""), info->path) << endmsg;
 298                                 } else {
 299                                         plugin = new VSTPlugin (_engine, session, handle);
 300                                 }
 301                         } else {
 302                                 error << _("You asked ardour to not use any VST plugins") << endmsg;
 303                         }
 304 #else
 305                         error << _("This version of ardour has no support for VST plugins") << endmsg;
 306                         return 0;
 307 #endif
 308
 309                 } else {
 310
 311                         if ((module = dlopen (info->path.c_str(), RTLD_NOW)) == 0) {
 312                                 error << string_compose(_("LADSPA: cannot load module from \"%1\""), info->path) << endmsg;
 313                                 error << dlerror() << endmsg;
 314                         } else {
 315                                 plugin = new LadspaPlugin (module, _engine, session, info->index, session.frame_rate());
 316                         }
 317                 }
 318
 319                 plugin->set_info(*info);
 320         }
 321
 322         catch (failed_constructor &err) {
 323                 plugin = 0;
 324         }
 325
 326         return plugin;
 327 }
 328
 329 Plugin *
 330 ARDOUR::find_plugin(Session& session, string name, long unique_id, PluginInfo::Type type)
 331 {
 332         PluginManager *mgr = PluginManager::the_manager();
 333         list<PluginInfo *>::iterator i;
 334         list<PluginInfo *>* plugs = 0;
 335
 336         switch (type) {
 337         case PluginInfo::LADSPA:
 338                 plugs = &mgr->ladspa_plugin_info();
 339                 break;
 340         case PluginInfo::VST:
 341                 plugs = &mgr->vst_plugin_info();
 342                 unique_id = 0; // VST plugins don't have a unique id.
 343                 break;
 344         }
 345
 346         for (i = plugs->begin(); i != plugs->end(); ++i) {
 347                 if ((name == ""     || (*i)->name == name) &&
 348                         (unique_id == 0 || (*i)->unique_id == unique_id)) {
 349                         return mgr->load (session, *i);
 350                 }
 351         }
 352
 353         return 0;
 354 }
 355
 356 string
 357 PluginManager::get_ladspa_category (uint32_t plugin_id)
 358 {
 359         char buf[256];
 360         lrdf_statement pattern;
 361
 362         snprintf(buf, sizeof(buf), "%s%" PRIu32, LADSPA_BASE, plugin_id);
 363         pattern.subject = buf;
 364         pattern.predicate = RDF_TYPE;
 365         pattern.object = 0;
 366         pattern.object_type = lrdf_uri;
 367
 368         lrdf_statement* matches1 = lrdf_matches (&pattern);
 369
 370         if (!matches1) {
 371                 return _("Unknown");
 372         }
 373
 374         pattern.subject = matches1->object;
 375         pattern.predicate = LADSPA_BASE "hasLabel";
 376         pattern.object = 0;
 377         pattern.object_type = lrdf_literal;
 378
 379         lrdf_statement* matches2 = lrdf_matches (&pattern);
 380         lrdf_free_statements(matches1);
 381
 382         if (!matches2) {
 383                 return _("Unknown");
 384         }
 385
 386         string label = matches2->object;
 387         lrdf_free_statements(matches2);
 388
 389         return label;
 390 }
 391
 392 #ifdef VST_SUPPORT
 393
 394 void
 395 PluginManager::vst_refresh ()
 396 {
 397         for (std::list<PluginInfo*>::iterator i = _vst_plugin_info.begin(); i != _vst_plugin_info.end(); ++i) {
 398                 delete *i;
 399         }
 400
 401         _vst_plugin_info.clear ();
 402
 403         if (vst_path.length() == 0) {
 404                 vst_path = "/usr/local/lib/vst:/usr/lib/vst";
 405         }
 406
 407         vst_discover_from_path (vst_path);
 408 }
 409
 410 int
 411 PluginManager::add_vst_directory (string path)
 412 {
 413         if (vst_discover_from_path (path) == 0) {
 414                 vst_path += ':';
 415                 vst_path += path;
 416                 return 0;
 417         }
 418         return -1;
 419 }
 420
 421 static bool vst_filter (const string& str, void *arg)
 422 {
 423         /* Not a dotfile, has a prefix before a period, suffix is "dll" */
 424
 425         return str[0] != '.' && (str.length() > 4 && str.find (".dll") == (str.length() - 4));
 426 }
 427
 428 int
 429 PluginManager::vst_discover_from_path (string path)
 430 {
 431         PathScanner scanner;
 432         vector<string *> *plugin_objects;
 433         vector<string *>::iterator x;
 434         int ret = 0;
 435
 436         info << "detecting VST plugins along " << path << endmsg;
 437
 438         plugin_objects = scanner (vst_path, vst_filter, 0, true, true);
 439
 440         if (plugin_objects) {
 441                 for (x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
 442                         vst_discover (**x);
 443                 }
 444         }
 445
 446         vector_delete (plugin_objects);
 447         return ret;
 448 }
 449
 450 int
 451 PluginManager::vst_discover (string path)
 452 {
 453         FSTInfo* finfo;
 454         PluginInfo* info;
 455
 456         if ((finfo = fst_get_info (const_cast<char *> (path.c_str()))) == 0) {
 457                 return -1;
 458         }
 459
 460         if (!finfo->canProcessReplacing) {
 461                 warning << string_compose (_("VST plugin %1 does not support processReplacing, and so cannot be used in ardour at this time"),
 462                                     finfo->name)
 463                         << endl;
 464         }
 465
 466         info = new PluginInfo;
 467
 468         /* what a goddam joke freeware VST is */
 469
 470         if (!strcasecmp ("The Unnamed plugin", finfo->name)) {
 471                 info->name = PBD::basename_nosuffix (path);
 472         } else {
 473                 info->name = finfo->name;
 474         }
 475
 476         info->category = "VST";
 477         info->path = path;
 478         info->index = 0;
 479         info->n_inputs = finfo->numInputs;
 480         info->n_outputs = finfo->numOutputs;
 481         info->type = PluginInfo::VST;
 482
 483         _vst_plugin_info.push_back (info);
 484         fst_free_info (finfo);
 485
 486         return 0;
 487 }
 488
 489 #endif