libs/ardour/plugin_manager.cc

   1 /*
   2     Copyright (C) 2000-2006 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 #define __STDC_FORMAT_MACROS 1
  22 #include <stdint.h>
  23
  24 #include <sys/types.h>
  25 #include <cstdio>
  26 #include <lrdf.h>
  27 #include <dlfcn.h>
  28
  29 #ifdef VST_SUPPORT
  30 #include <fst.h>
  31 #include <pbd/basename.h>
  32 #include <string.h>
  33 #endif // VST_SUPPORT
  34
  35 #include <pbd/pathscanner.h>
  36
  37 #include <ardour/ladspa.h>
  38 #include <ardour/session.h>
  39 #include <ardour/plugin_manager.h>
  40 #include <ardour/plugin.h>
  41 #include <ardour/ladspa_plugin.h>
  42
  43 #ifdef VST_SUPPORT
  44 #include <ardour/vst_plugin.h>
  45 #endif
  46
  47 #include <pbd/error.h>
  48 #include <pbd/stl_delete.h>
  49
  50 #include "i18n.h"
  51
  52 using namespace ARDOUR;
  53 using namespace PBD;
  54
  55 PluginManager* PluginManager::_manager = 0;
  56
  57 PluginManager::PluginManager ()
  58 {
  59         char* s;
  60         string lrdf_path;
  61
  62         if ((s = getenv ("LADSPA_RDF_PATH"))){
  63                 lrdf_path = s;
  64         }
  65
  66         if (lrdf_path.length() == 0) {
  67                 lrdf_path = "/usr/local/share/ladspa/rdf:/usr/share/ladspa/rdf";
  68         }
  69
  70         add_lrdf_data(lrdf_path);
  71         add_ladspa_presets();
  72 #ifdef VST_SUPPORT
  73         if (Config->get_use_vst()) {
  74                 add_vst_presets();
  75         }
  76 #endif /* VST_SUPPORT */
  77
  78         if ((s = getenv ("LADSPA_PATH"))) {
  79                 ladspa_path = s;
  80         }
  81
  82         if ((s = getenv ("VST_PATH"))) {
  83                 vst_path = s;
  84         } else if ((s = getenv ("VST_PLUGINS"))) {
  85                 vst_path = s;
  86         }
  87
  88         refresh ();
  89
  90         if (_manager == 0) {
  91                 _manager = this;
  92         }
  93 }
  94
  95 void
  96 PluginManager::refresh ()
  97 {
  98         ladspa_refresh ();
  99 #ifdef VST_SUPPORT
 100         if (Config->get_use_vst()) {
 101                 vst_refresh ();
 102         }
 103 #endif // VST_SUPPORT
 104 }
 105
 106 void
 107 PluginManager::ladspa_refresh ()
 108 {
 109         _ladspa_plugin_info.clear ();
 110
 111         if (ladspa_path.length() == 0) {
 112                 ladspa_path = "/usr/local/lib/ladspa:/usr/lib/ladspa";
 113         }
 114
 115         ladspa_discover_from_path (ladspa_path);
 116 }
 117
 118 int
 119 PluginManager::add_ladspa_directory (string path)
 120 {
 121         if (ladspa_discover_from_path (path) == 0) {
 122                 ladspa_path += ':';
 123                 ladspa_path += path;
 124                 return 0;
 125         }
 126         return -1;
 127 }
 128
 129 static bool ladspa_filter (const string& str, void *arg)
 130 {
 131         /* Not a dotfile, has a prefix before a period, suffix is "so" */
 132
 133         return str[0] != '.' && (str.length() > 3 && str.find (".so") == (str.length() - 3));
 134 }
 135
 136 int
 137 PluginManager::ladspa_discover_from_path (string path)
 138 {
 139         PathScanner scanner;
 140         vector<string *> *plugin_objects;
 141         vector<string *>::iterator x;
 142         int ret = 0;
 143
 144         plugin_objects = scanner (ladspa_path, ladspa_filter, 0, true, true);
 145
 146         if (plugin_objects) {
 147                 for (x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
 148                         ladspa_discover (**x);
 149                 }
 150         }
 151
 152         vector_delete (plugin_objects);
 153         return ret;
 154 }
 155
 156 static bool rdf_filter (const string &str, void *arg)
 157 {
 158         return str[0] != '.' &&
 159                    ((str.find(".rdf")  == (str.length() - 4)) ||
 160             (str.find(".rdfs") == (str.length() - 5)) ||
 161                     (str.find(".n3")   == (str.length() - 3)));
 162 }
 163
 164 void
 165 PluginManager::add_ladspa_presets()
 166 {
 167         add_presets ("ladspa");
 168 }
 169
 170 void
 171 PluginManager::add_vst_presets()
 172 {
 173         add_presets ("vst");
 174 }
 175 void
 176 PluginManager::add_presets(string domain)
 177 {
 178
 179         PathScanner scanner;
 180         vector<string *> *presets;
 181         vector<string *>::iterator x;
 182
 183         char* envvar;
 184         if ((envvar = getenv ("HOME")) == 0) {
 185                 return;
 186         }
 187
 188         string path = string_compose("%1/.%2/rdf", envvar, domain);
 189         presets = scanner (path, rdf_filter, 0, true, true);
 190
 191         if (presets) {
 192                 for (x = presets->begin(); x != presets->end (); ++x) {
 193                         string file = "file:" + **x;
 194                         if (lrdf_read_file(file.c_str())) {
 195                                 warning << string_compose(_("Could not parse rdf file: %1"), *x) << endmsg;
 196                         }
 197                 }
 198         }
 199
 200         vector_delete (presets);
 201 }
 202
 203 void
 204 PluginManager::add_lrdf_data (const string &path)
 205 {
 206         PathScanner scanner;
 207         vector<string *>* rdf_files;
 208         vector<string *>::iterator x;
 209         string uri;
 210
 211         rdf_files = scanner (path, rdf_filter, 0, true, true);
 212
 213         if (rdf_files) {
 214                 for (x = rdf_files->begin(); x != rdf_files->end (); ++x) {
 215                         uri = "file://" + **x;
 216
 217                         if (lrdf_read_file(uri.c_str())) {
 218                                 warning << "Could not parse rdf file: " << uri << endmsg;
 219                         }
 220                 }
 221         }
 222
 223         vector_delete (rdf_files);
 224 }
 225
 226 int
 227 PluginManager::ladspa_discover (string path)
 228 {
 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                 PluginInfoPtr info(new LadspaPluginInfo);
 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 = ARDOUR::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 string
 284 PluginManager::get_ladspa_category (uint32_t plugin_id)
 285 {
 286         char buf[256];
 287         lrdf_statement pattern;
 288
 289         snprintf(buf, sizeof(buf), "%s%" PRIu32, LADSPA_BASE, plugin_id);
 290         pattern.subject = buf;
 291         pattern.predicate = RDF_TYPE;
 292         pattern.object = 0;
 293         pattern.object_type = lrdf_uri;
 294
 295         lrdf_statement* matches1 = lrdf_matches (&pattern);
 296
 297         if (!matches1) {
 298                 return _("Unknown");
 299         }
 300
 301         pattern.subject = matches1->object;
 302         pattern.predicate = LADSPA_BASE "hasLabel";
 303         pattern.object = 0;
 304         pattern.object_type = lrdf_literal;
 305
 306         lrdf_statement* matches2 = lrdf_matches (&pattern);
 307         lrdf_free_statements(matches1);
 308
 309         if (!matches2) {
 310                 return _("Unknown");
 311         }
 312
 313         string label = matches2->object;
 314         lrdf_free_statements(matches2);
 315
 316         return label;
 317 }
 318
 319 #ifdef VST_SUPPORT
 320
 321 void
 322 PluginManager::vst_refresh ()
 323 {
 324         _vst_plugin_info.clear ();
 325
 326         if (vst_path.length() == 0) {
 327                 vst_path = "/usr/local/lib/vst:/usr/lib/vst";
 328         }
 329
 330         vst_discover_from_path (vst_path);
 331 }
 332
 333 int
 334 PluginManager::add_vst_directory (string path)
 335 {
 336         if (vst_discover_from_path (path) == 0) {
 337                 vst_path += ':';
 338                 vst_path += path;
 339                 return 0;
 340         }
 341         return -1;
 342 }
 343
 344 static bool vst_filter (const string& str, void *arg)
 345 {
 346         /* Not a dotfile, has a prefix before a period, suffix is "dll" */
 347
 348         return str[0] != '.' && (str.length() > 4 && str.find (".dll") == (str.length() - 4));
 349 }
 350
 351 int
 352 PluginManager::vst_discover_from_path (string path)
 353 {
 354         PathScanner scanner;
 355         vector<string *> *plugin_objects;
 356         vector<string *>::iterator x;
 357         int ret = 0;
 358
 359         info << "detecting VST plugins along " << path << endmsg;
 360
 361         plugin_objects = scanner (vst_path, vst_filter, 0, true, true);
 362
 363         if (plugin_objects) {
 364                 for (x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
 365                         vst_discover (**x);
 366                 }
 367         }
 368
 369         vector_delete (plugin_objects);
 370         return ret;
 371 }
 372
 373 int
 374 PluginManager::vst_discover (string path)
 375 {
 376         FSTInfo* finfo;
 377
 378         if ((finfo = fst_get_info (const_cast<char *> (path.c_str()))) == 0) {
 379                 return -1;
 380         }
 381
 382         if (!finfo->canProcessReplacing) {
 383                 warning << string_compose (_("VST plugin %1 does not support processReplacing, and so cannot be used in ardour at this time"),
 384                                     finfo->name)
 385                         << endl;
 386         }
 387
 388         PluginInfoPtr info(new VSTPluginInfo);
 389
 390         /* what a goddam joke freeware VST is */
 391
 392         if (!strcasecmp ("The Unnamed plugin", finfo->name)) {
 393                 info->name = PBD::basename_nosuffix (path);
 394         } else {
 395                 info->name = finfo->name;
 396         }
 397
 398         info->category = "VST";
 399         info->path = path;
 400         info->index = 0;
 401         info->n_inputs = finfo->numInputs;
 402         info->n_outputs = finfo->numOutputs;
 403         info->type = ARDOUR::VST;
 404
 405         _vst_plugin_info.push_back (info);
 406         fst_free_info (finfo);
 407
 408         return 0;
 409 }
 410
 411 #endif // VST_SUPPORT