libs/ardour/plugin.cc

   1 /*
   2     Copyright (C) 2000-2002 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 */
  19
  20 #ifdef WAF_BUILD
  21 #include "libardour-config.h"
  22 #endif
  23
  24 #include <vector>
  25 #include <string>
  26
  27 #include <cstdlib>
  28 #include <cstdio> // so libraptor doesn't complain
  29 #include <cmath>
  30 #include <dirent.h>
  31 #include <sys/stat.h>
  32 #include <cerrno>
  33 #include <utility>
  34
  35 #include <lrdf.h>
  36
  37 #include "pbd/compose.h"
  38 #include "pbd/error.h"
  39 #include "pbd/xml++.h"
  40
  41 #include "ardour/ardour.h"
  42 #include "ardour/session.h"
  43 #include "ardour/audioengine.h"
  44 #include "ardour/plugin.h"
  45 #include "ardour/ladspa_plugin.h"
  46 #include "ardour/plugin_manager.h"
  47
  48 #ifdef HAVE_AUDIOUNITS
  49 #include "ardour/audio_unit.h"
  50 #endif
  51
  52 #ifdef HAVE_SLV2
  53 #include "ardour/lv2_plugin.h"
  54 #endif
  55
  56 #include "pbd/stl_delete.h"
  57
  58 #include "i18n.h"
  59 #include <locale.h>
  60
  61 using namespace std;
  62 using namespace ARDOUR;
  63 using namespace PBD;
  64
  65 PBD::Signal0<bool> Plugin::PresetFileExists;
  66
  67 Plugin::Plugin (AudioEngine& e, Session& s)
  68         : _engine (e)
  69         , _session (s)
  70         , _cycles (0)
  71 {
  72 }
  73
  74 Plugin::Plugin (const Plugin& other)
  75         : StatefulDestructible()
  76         , Latent()
  77         , _engine (other._engine)
  78         , _session (other._session)
  79         , _info (other._info)
  80         , _cycles (0)
  81         , presets (other.presets)
  82 {
  83 }
  84
  85 Plugin::~Plugin ()
  86 {
  87 }
  88
  89 const Plugin::PresetRecord*
  90 Plugin::preset_by_label(const string& label)
  91 {
  92         // FIXME: O(n)
  93         for (map<string,PresetRecord>::const_iterator i = presets.begin(); i != presets.end(); ++i) {
  94                 if (i->second.label == label) {
  95                         return &i->second;
  96                 }
  97         }
  98         return NULL;
  99 }
 100
 101 const Plugin::PresetRecord*
 102 Plugin::preset_by_uri(const string& uri)
 103 {
 104         map<string,PresetRecord>::const_iterator pr = presets.find(uri);
 105         if (pr != presets.end()) {
 106                 return &pr->second;
 107         } else {
 108                 return NULL;
 109         }
 110 }
 111
 112 vector<Plugin::PresetRecord>
 113 Plugin::get_presets()
 114 {
 115         vector<PresetRecord> result;
 116         uint32_t id;
 117         std::string unique (unique_id());
 118
 119         /* XXX problem: AU plugins don't have numeric ID's.
 120            Solution: they have a different method of providing presets.
 121            XXX sub-problem: implement it.
 122         */
 123
 124         if (!isdigit (unique[0])) {
 125                 return result;
 126         }
 127
 128         id = atol (unique.c_str());
 129
 130         lrdf_uris* set_uris = lrdf_get_setting_uris(id);
 131
 132         if (set_uris) {
 133                 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
 134                         if (char* label = lrdf_get_label(set_uris->items[i])) {
 135                                 PresetRecord rec(set_uris->items[i], label);
 136                                 result.push_back(rec);
 137                                 presets.insert(std::make_pair(set_uris->items[i], rec));
 138                         }
 139                 }
 140                 lrdf_free_uris(set_uris);
 141         }
 142
 143         return result;
 144 }
 145
 146 bool
 147 Plugin::load_preset(const string& preset_uri)
 148 {
 149         lrdf_defaults* defs = lrdf_get_setting_values(preset_uri.c_str());
 150
 151         if (defs) {
 152                 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
 153                         // The defs->items[i].pid < defs->count check is to work around
 154                         // a bug in liblrdf that saves invalid values into the presets file.
 155                         if (((uint32_t) defs->items[i].pid < (uint32_t) defs->count) && parameter_is_input (defs->items[i].pid)) {
 156                                 set_parameter(defs->items[i].pid, defs->items[i].value);
 157                         }
 158                 }
 159                 lrdf_free_setting_values(defs);
 160         }
 161
 162         return true;
 163 }
 164
 165 bool
 166 Plugin::save_preset (string name, string domain)
 167 {
 168         lrdf_portvalue portvalues[parameter_count()];
 169         lrdf_defaults defaults;
 170         uint32_t id;
 171         std::string unique (unique_id());
 172
 173         /* XXX problem: AU plugins don't have numeric ID's.
 174            Solution: they have a different method of providing/saving presets.
 175            XXX sub-problem: implement it.
 176         */
 177
 178         if (!isdigit (unique[0])) {
 179                 return false;
 180         }
 181
 182         id = atol (unique.c_str());
 183
 184         defaults.count = parameter_count();
 185         defaults.items = portvalues;
 186
 187         for (uint32_t i = 0; i < parameter_count(); ++i) {
 188                 if (parameter_is_input (i)) {
 189                         portvalues[i].pid = i;
 190                         portvalues[i].value = get_parameter(i);
 191                 }
 192         }
 193
 194         char* envvar;
 195         if ((envvar = getenv ("HOME")) == 0) {
 196                 warning << _("Could not locate HOME.  Preset not saved.") << endmsg;
 197                 return false;
 198         }
 199
 200         string source(string_compose("file:%1/.%2/rdf/ardour-presets.n3", envvar, domain));
 201
 202         char* uri = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
 203
 204         /* XXX: why is the uri apparently kept as the key in the `presets' map and also in the PresetRecord? */
 205
 206         presets.insert (make_pair (uri, PresetRecord (uri, name)));
 207         free (uri);
 208
 209         string path = string_compose("%1/.%2", envvar, domain);
 210         if (g_mkdir_with_parents (path.c_str(), 0775)) {
 211                 warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
 212                 return false;
 213         }
 214
 215         path += "/rdf";
 216         if (g_mkdir_with_parents (path.c_str(), 0775)) {
 217                 warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
 218                 return false;
 219         }
 220
 221         if (lrdf_export_by_source(source.c_str(), source.substr(5).c_str())) {
 222                 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
 223                 return false;
 224         }
 225
 226         return true;
 227 }
 228
 229 PluginPtr
 230 ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
 231 {
 232         PluginManager *mgr = PluginManager::the_manager();
 233         PluginInfoList plugs;
 234
 235         switch (type) {
 236         case ARDOUR::LADSPA:
 237                 plugs = mgr->ladspa_plugin_info();
 238                 break;
 239
 240 #ifdef HAVE_SLV2
 241         case ARDOUR::LV2:
 242                 plugs = mgr->lv2_plugin_info();
 243                 break;
 244 #endif
 245
 246 #ifdef VST_SUPPORT
 247         case ARDOUR::VST:
 248                 plugs = mgr->vst_plugin_info();
 249                 break;
 250 #endif
 251
 252 #ifdef HAVE_AUDIOUNITS
 253         case ARDOUR::AudioUnit:
 254                 plugs = mgr->au_plugin_info();
 255                 break;
 256 #endif
 257
 258         default:
 259                 return PluginPtr ((Plugin *) 0);
 260         }
 261
 262         PluginInfoList::iterator i;
 263
 264         for (i = plugs.begin(); i != plugs.end(); ++i) {
 265                 if (identifier == (*i)->unique_id){
 266                         return (*i)->load (session);
 267                 }
 268         }
 269
 270 #ifdef VST_SUPPORT
 271         /* hmm, we didn't find it. could be because in older versions of Ardour.
 272            we used to store the name of a VST plugin, not its unique ID. so try
 273            again.
 274         */
 275
 276         for (i = plugs.begin(); i != plugs.end(); ++i) {
 277                 if (identifier == (*i)->name){
 278                         return (*i)->load (session);
 279                 }
 280         }
 281 #endif
 282
 283         return PluginPtr ((Plugin*) 0);
 284 }
 285
 286 ChanCount
 287 Plugin::output_streams () const
 288 {
 289         /* LADSPA & VST should not get here because they do not
 290            return "infinite" i/o counts.
 291         */
 292         return ChanCount::ZERO;
 293 }
 294
 295 ChanCount
 296 Plugin::input_streams () const
 297 {
 298         /* LADSPA & VST should not get here because they do not
 299            return "infinite" i/o counts.
 300         */
 301         return ChanCount::ZERO;
 302 }
 303
 304