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