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 #ifndef COMPILER_MSVC
  31 #include <dirent.h>
  32 #endif
  33 #include <sys/stat.h>
  34 #include <cerrno>
  35 #include <utility>
  36
  37 #ifdef HAVE_LRDF
  38 #include <lrdf.h>
  39 #endif
  40
  41 #include "pbd/compose.h"
  42 #include "pbd/error.h"
  43 #include "pbd/xml++.h"
  44
  45 #include "ardour/buffer_set.h"
  46 #include "ardour/chan_count.h"
  47 #include "ardour/chan_mapping.h"
  48 #include "ardour/data_type.h"
  49 #include "ardour/luaproc.h"
  50 #include "ardour/midi_buffer.h"
  51 #include "ardour/midi_state_tracker.h"
  52 #include "ardour/plugin.h"
  53 #include "ardour/plugin_manager.h"
  54 #include "ardour/port.h"
  55 #include "ardour/session.h"
  56 #include "ardour/types.h"
  57
  58 #ifdef AUDIOUNIT_SUPPORT
  59 #include "ardour/audio_unit.h"
  60 #endif
  61
  62 #ifdef LV2_SUPPORT
  63 #include "ardour/lv2_plugin.h"
  64 #endif
  65
  66 #include "pbd/stl_delete.h"
  67
  68 #include "i18n.h"
  69 #include <locale.h>
  70
  71 using namespace std;
  72 using namespace ARDOUR;
  73 using namespace PBD;
  74
  75 namespace ARDOUR { class AudioEngine; }
  76
  77 #ifdef NO_PLUGIN_STATE
  78 static bool seen_get_state_message = false;
  79 static bool seen_set_state_message = false;
  80 #endif
  81
  82 PBD::Signal2<void, std::string, Plugin*> Plugin::PresetsChanged;
  83
  84 bool
  85 PluginInfo::is_instrument () const
  86 {
  87         return (n_inputs.n_midi() != 0) && (n_outputs.n_audio() > 0);
  88 }
  89
  90 Plugin::Plugin (AudioEngine& e, Session& s)
  91         : _engine (e)
  92         , _session (s)
  93         , _cycles (0)
  94         , _have_presets (false)
  95         , _have_pending_stop_events (false)
  96         , _parameter_changed_since_last_preset (false)
  97 {
  98         _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
  99         PresetsChanged.connect_same_thread (_preset_connection, boost::bind (&Plugin::update_presets, this, _1 ,_2));
 100 }
 101
 102 Plugin::Plugin (const Plugin& other)
 103         : StatefulDestructible()
 104         , Latent()
 105         , _engine (other._engine)
 106         , _session (other._session)
 107         , _info (other._info)
 108         , _cycles (0)
 109         , _have_presets (false)
 110         , _have_pending_stop_events (false)
 111         , _parameter_changed_since_last_preset (false)
 112 {
 113         _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
 114         PresetsChanged.connect_same_thread (_preset_connection, boost::bind (&Plugin::update_presets, this, _1 ,_2));
 115 }
 116
 117 Plugin::~Plugin ()
 118 {
 119 }
 120
 121 void
 122 Plugin::remove_preset (string name)
 123 {
 124         Plugin::PresetRecord const * p = preset_by_label (name);
 125         if (!p->user) {
 126                 PBD::error << _("Cannot remove plugin factory preset.") << endmsg;
 127                 return;
 128         }
 129
 130         do_remove_preset (name);
 131         _presets.erase (preset_by_label (name)->uri);
 132
 133         _last_preset.uri = "";
 134         _parameter_changed_since_last_preset = false;
 135         PresetRemoved (); /* EMIT SIGNAL */
 136         PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
 137 }
 138
 139 /** @return PresetRecord with empty URI on failure */
 140 Plugin::PresetRecord
 141 Plugin::save_preset (string name)
 142 {
 143         if (preset_by_label (name)) {
 144                 PBD::error << _("Preset with given name already exists.") << endmsg;
 145                 return Plugin::PresetRecord ();
 146         }
 147
 148         string const uri = do_save_preset (name);
 149
 150         if (!uri.empty()) {
 151                 _presets.insert (make_pair (uri, PresetRecord (uri, name)));
 152                 PresetAdded (); /* EMIT SIGNAL */
 153                 PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
 154         }
 155
 156         return PresetRecord (uri, name);
 157 }
 158
 159 PluginPtr
 160 ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
 161 {
 162         PluginManager& mgr (PluginManager::instance());
 163         PluginInfoList plugs;
 164
 165         switch (type) {
 166         case ARDOUR::Lua:
 167                 plugs = mgr.lua_plugin_info();
 168                 break;
 169
 170         case ARDOUR::LADSPA:
 171                 plugs = mgr.ladspa_plugin_info();
 172                 break;
 173
 174 #ifdef LV2_SUPPORT
 175         case ARDOUR::LV2:
 176                 plugs = mgr.lv2_plugin_info();
 177                 break;
 178 #endif
 179
 180 #ifdef WINDOWS_VST_SUPPORT
 181         case ARDOUR::Windows_VST:
 182                 plugs = mgr.windows_vst_plugin_info();
 183                 break;
 184 #endif
 185
 186 #ifdef LXVST_SUPPORT
 187         case ARDOUR::LXVST:
 188                 plugs = mgr.lxvst_plugin_info();
 189                 break;
 190 #endif
 191
 192 #ifdef AUDIOUNIT_SUPPORT
 193         case ARDOUR::AudioUnit:
 194                 plugs = mgr.au_plugin_info();
 195                 break;
 196 #endif
 197
 198         default:
 199                 return PluginPtr ((Plugin *) 0);
 200         }
 201
 202         PluginInfoList::iterator i;
 203
 204         for (i = plugs.begin(); i != plugs.end(); ++i) {
 205                 if (identifier == (*i)->unique_id){
 206                         return (*i)->load (session);
 207                 }
 208         }
 209
 210 #ifdef WINDOWS_VST_SUPPORT
 211         /* hmm, we didn't find it. could be because in older versions of Ardour.
 212            we used to store the name of a VST plugin, not its unique ID. so try
 213            again.
 214         */
 215
 216         for (i = plugs.begin(); i != plugs.end(); ++i) {
 217                 if (identifier == (*i)->name){
 218                         return (*i)->load (session);
 219                 }
 220         }
 221 #endif
 222
 223 #ifdef LXVST_SUPPORT
 224         /* hmm, we didn't find it. could be because in older versions of Ardour.
 225            we used to store the name of a VST plugin, not its unique ID. so try
 226            again.
 227         */
 228
 229         for (i = plugs.begin(); i != plugs.end(); ++i) {
 230                 if (identifier == (*i)->name){
 231                         return (*i)->load (session);
 232                 }
 233         }
 234 #endif
 235
 236         return PluginPtr ((Plugin*) 0);
 237 }
 238
 239 ChanCount
 240 Plugin::output_streams () const
 241 {
 242         /* LADSPA & VST should not get here because they do not
 243            return "infinite" i/o counts.
 244         */
 245         return ChanCount::ZERO;
 246 }
 247
 248 ChanCount
 249 Plugin::input_streams () const
 250 {
 251         /* LADSPA & VST should not get here because they do not
 252            return "infinite" i/o counts.
 253         */
 254         return ChanCount::ZERO;
 255 }
 256
 257 Plugin::IOPortDescription
 258 Plugin::describe_io_port (ARDOUR::DataType dt, bool input, uint32_t id) const
 259 {
 260         std::stringstream ss;
 261         switch (dt) {
 262                 case DataType::AUDIO:
 263                         ss << _("Audio") << " ";
 264                         break;
 265                 case DataType::MIDI:
 266                         ss << _("Midi") << " ";
 267                         break;
 268                 default:
 269                         ss << _("?") << " ";
 270                         break;
 271         }
 272         if (input) {
 273                 ss << _("In") << " ";
 274         } else {
 275                 ss << _("Out") << " ";
 276         }
 277
 278         ss << (id + 1);
 279
 280         Plugin::IOPortDescription iod (ss.str());
 281         return iod;
 282 }
 283
 284 PluginOutputConfiguration
 285 Plugin::possible_output () const
 286 {
 287         PluginOutputConfiguration oc;
 288         if (_info) {
 289                 oc.insert (_info->n_outputs.n_audio ());
 290         }
 291         return oc;
 292 }
 293
 294 const Plugin::PresetRecord *
 295 Plugin::preset_by_label (const string& label)
 296 {
 297 #ifndef NO_PLUGIN_STATE
 298         if (!_have_presets) {
 299                 find_presets ();
 300                 _have_presets = true;
 301         }
 302 #endif
 303         // FIXME: O(n)
 304         for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
 305                 if (i->second.label == label) {
 306                         return &i->second;
 307                 }
 308         }
 309
 310         return 0;
 311 }
 312
 313 const Plugin::PresetRecord *
 314 Plugin::preset_by_uri (const string& uri)
 315 {
 316 #ifndef NO_PLUGIN_STATE
 317         if (!_have_presets) {
 318                 find_presets ();
 319                 _have_presets = true;
 320         }
 321 #endif
 322         map<string, PresetRecord>::const_iterator pr = _presets.find (uri);
 323         if (pr != _presets.end()) {
 324                 return &pr->second;
 325         } else {
 326                 return 0;
 327         }
 328 }
 329
 330 int
 331 Plugin::connect_and_run (BufferSet& bufs,
 332                          ChanMapping /*in_map*/, ChanMapping /*out_map*/,
 333                          pframes_t /* nframes */, framecnt_t /*offset*/)
 334 {
 335         if (bufs.count().n_midi() > 0) {
 336
 337                 /* Track notes that we are sending to the plugin */
 338
 339                 const MidiBuffer& b = bufs.get_midi (0);
 340
 341                 _tracker.track (b.begin(), b.end());
 342
 343                 if (_have_pending_stop_events) {
 344                         /* Transmit note-offs that are pending from the last transport stop */
 345                         bufs.merge_from (_pending_stop_events, 0);
 346                         _have_pending_stop_events = false;
 347                 }
 348         }
 349
 350         return 0;
 351 }
 352
 353 void
 354 Plugin::realtime_handle_transport_stopped ()
 355 {
 356         resolve_midi ();
 357 }
 358
 359 void
 360 Plugin::realtime_locate ()
 361 {
 362         resolve_midi ();
 363 }
 364
 365 void
 366 Plugin::monitoring_changed ()
 367 {
 368         resolve_midi ();
 369 }
 370
 371 void
 372 Plugin::resolve_midi ()
 373 {
 374         /* Create note-offs for any active notes and put them in _pending_stop_events, to be picked
 375            up on the next call to connect_and_run ().
 376         */
 377
 378         _pending_stop_events.get_midi(0).clear ();
 379         _tracker.resolve_notes (_pending_stop_events.get_midi (0), /* split cycle offset*/ Port::port_offset());
 380         _have_pending_stop_events = true;
 381 }
 382
 383 void
 384 Plugin::update_presets (std::string src_unique_id, Plugin* src )
 385 {
 386         if (src == this || unique_id() != src_unique_id) {
 387                 return;
 388         }
 389         _have_presets = false;
 390         // TODO check if a preset was added/removed and emit the proper signal
 391         // so far no subscriber distinguishes between PresetAdded and PresetRemoved
 392         PresetAdded();
 393 }
 394
 395 vector<Plugin::PresetRecord>
 396 Plugin::get_presets ()
 397 {
 398         vector<PresetRecord> p;
 399
 400 #ifndef NO_PLUGIN_STATE
 401         if (!_have_presets) {
 402                 find_presets ();
 403                 _have_presets = true;
 404         }
 405
 406         for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
 407                 p.push_back (i->second);
 408         }
 409 #else
 410         if (!seen_set_state_message) {
 411                 info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a full version"),
 412                                         PROGRAM_NAME)
 413                      << endmsg;
 414                 seen_set_state_message = true;
 415         }
 416 #endif
 417
 418         return p;
 419 }
 420
 421 /** Set parameters using a preset */
 422 bool
 423 Plugin::load_preset (PresetRecord r)
 424 {
 425         _last_preset = r;
 426         _parameter_changed_since_last_preset = false;
 427
 428         PresetLoaded (); /* EMIT SIGNAL */
 429         return true;
 430 }
 431
 432 void
 433 Plugin::clear_preset ()
 434 {
 435         _last_preset.uri = "";
 436         _last_preset.label = "";
 437         _parameter_changed_since_last_preset = false;
 438
 439         PresetLoaded (); /* EMIT SIGNAL */
 440 }
 441
 442 void
 443 Plugin::set_parameter (uint32_t /* which */, float /* value */)
 444 {
 445         _parameter_changed_since_last_preset = true;
 446         _session.set_dirty ();
 447         PresetDirty (); /* EMIT SIGNAL */
 448 }
 449
 450 void
 451 Plugin::parameter_changed_externally (uint32_t which, float /* value */)
 452 {
 453         _parameter_changed_since_last_preset = true;
 454         _session.set_dirty ();
 455         ParameterChangedExternally (which, get_parameter (which)); /* EMIT SIGNAL */
 456         PresetDirty (); /* EMIT SIGNAL */
 457 }
 458
 459 int
 460 Plugin::set_state (const XMLNode& node, int /*version*/)
 461 {
 462         XMLProperty const * p = node.property (X_("last-preset-uri"));
 463         if (p) {
 464                 _last_preset.uri = p->value ();
 465         }
 466
 467         p = node.property (X_("last-preset-label"));
 468         if (p) {
 469                 _last_preset.label = p->value ();
 470         }
 471
 472         p = node.property (X_("parameter-changed-since-last-preset"));
 473         if (p) {
 474                 _parameter_changed_since_last_preset = string_is_affirmative (p->value ());
 475         }
 476
 477         return 0;
 478 }
 479
 480 XMLNode &
 481 Plugin::get_state ()
 482 {
 483         XMLNode* root = new XMLNode (state_node_name ());
 484         LocaleGuard lg ();
 485
 486         root->add_property (X_("last-preset-uri"), _last_preset.uri);
 487         root->add_property (X_("last-preset-label"), _last_preset.label);
 488         root->add_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset ? X_("yes") : X_("no"));
 489
 490 #ifndef NO_PLUGIN_STATE
 491         add_state (root);
 492 #else
 493         if (!seen_get_state_message) {
 494                 info << string_compose (_("Saving plugin settings is not supported in this build of %1. Consider paying for the full version"),
 495                                         PROGRAM_NAME)
 496                      << endmsg;
 497                 seen_get_state_message = true;
 498         }
 499 #endif
 500
 501         return *root;
 502 }
 503
 504 void
 505 Plugin::set_info (PluginInfoPtr info)
 506 {
 507         _info = info;
 508 }
 509
 510