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         , _owner (0)
 101         , _have_presets (false)
 102         , _have_pending_stop_events (false)
 103         , _parameter_changed_since_last_preset (false)
 104 {
 105         _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
 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         , _owner (other._owner)
 116         , _have_presets (false)
 117         , _have_pending_stop_events (false)
 118         , _parameter_changed_since_last_preset (false)
 119 {
 120         _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
 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) {
 132                 PBD::error << _("Trying to remove nonexistent preset.") << endmsg;
 133                 return;
 134         }
 135         if (!p->user) {
 136                 PBD::error << _("Cannot remove plugin factory preset.") << endmsg;
 137                 return;
 138         }
 139
 140         do_remove_preset (name);
 141         _presets.erase (p->uri);
 142
 143         _last_preset.uri = "";
 144         _parameter_changed_since_last_preset = false;
 145         _have_presets = false;
 146         PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
 147         PresetRemoved (); /* EMIT SIGNAL */
 148 }
 149
 150 /** @return PresetRecord with empty URI on failure */
 151 Plugin::PresetRecord
 152 Plugin::save_preset (string name)
 153 {
 154         if (preset_by_label (name)) {
 155                 PBD::error << _("Preset with given name already exists.") << endmsg;
 156                 return Plugin::PresetRecord ();
 157         }
 158
 159         string const uri = do_save_preset (name);
 160
 161         if (!uri.empty()) {
 162                 _presets.insert (make_pair (uri, PresetRecord (uri, name)));
 163                 _have_presets = false;
 164                 PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
 165                 PresetAdded (); /* EMIT SIGNAL */
 166         }
 167
 168         return PresetRecord (uri, name);
 169 }
 170
 171 PluginPtr
 172 ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
 173 {
 174         PluginManager& mgr (PluginManager::instance());
 175         PluginInfoList plugs;
 176
 177         switch (type) {
 178         case ARDOUR::Lua:
 179                 plugs = mgr.lua_plugin_info();
 180                 break;
 181
 182         case ARDOUR::LADSPA:
 183                 plugs = mgr.ladspa_plugin_info();
 184                 break;
 185
 186 #ifdef LV2_SUPPORT
 187         case ARDOUR::LV2:
 188                 plugs = mgr.lv2_plugin_info();
 189                 break;
 190 #endif
 191
 192 #ifdef WINDOWS_VST_SUPPORT
 193         case ARDOUR::Windows_VST:
 194                 plugs = mgr.windows_vst_plugin_info();
 195                 break;
 196 #endif
 197
 198 #ifdef LXVST_SUPPORT
 199         case ARDOUR::LXVST:
 200                 plugs = mgr.lxvst_plugin_info();
 201                 break;
 202 #endif
 203
 204 #ifdef MACVST_SUPPORT
 205         case ARDOUR::MacVST:
 206                 plugs = mgr.mac_vst_plugin_info();
 207                 break;
 208 #endif
 209
 210 #ifdef AUDIOUNIT_SUPPORT
 211         case ARDOUR::AudioUnit:
 212                 plugs = mgr.au_plugin_info();
 213                 break;
 214 #endif
 215
 216         default:
 217                 return PluginPtr ((Plugin *) 0);
 218         }
 219
 220         PluginInfoList::iterator i;
 221
 222         for (i = plugs.begin(); i != plugs.end(); ++i) {
 223                 if (identifier == (*i)->unique_id){
 224                         return (*i)->load (session);
 225                 }
 226         }
 227
 228 #ifdef WINDOWS_VST_SUPPORT
 229         /* hmm, we didn't find it. could be because in older versions of Ardour.
 230            we used to store the name of a VST plugin, not its unique ID. so try
 231            again.
 232         */
 233
 234         for (i = plugs.begin(); i != plugs.end(); ++i) {
 235                 if (identifier == (*i)->name){
 236                         return (*i)->load (session);
 237                 }
 238         }
 239 #endif
 240
 241 #ifdef LXVST_SUPPORT
 242         /* hmm, we didn't find it. could be because in older versions of Ardour.
 243            we used to store the name of a VST plugin, not its unique ID. so try
 244            again.
 245         */
 246
 247         for (i = plugs.begin(); i != plugs.end(); ++i) {
 248                 if (identifier == (*i)->name){
 249                         return (*i)->load (session);
 250                 }
 251         }
 252 #endif
 253
 254         return PluginPtr ((Plugin*) 0);
 255 }
 256
 257 ChanCount
 258 Plugin::output_streams () const
 259 {
 260         /* LADSPA & VST should not get here because they do not
 261            return "infinite" i/o counts.
 262         */
 263         return ChanCount::ZERO;
 264 }
 265
 266 ChanCount
 267 Plugin::input_streams () const
 268 {
 269         /* LADSPA & VST should not get here because they do not
 270            return "infinite" i/o counts.
 271         */
 272         return ChanCount::ZERO;
 273 }
 274
 275 Plugin::IOPortDescription
 276 Plugin::describe_io_port (ARDOUR::DataType dt, bool input, uint32_t id) const
 277 {
 278         std::stringstream ss;
 279         switch (dt) {
 280                 case DataType::AUDIO:
 281                         ss << _("Audio") << " ";
 282                         break;
 283                 case DataType::MIDI:
 284                         ss << _("Midi") << " ";
 285                         break;
 286                 default:
 287                         ss << _("?") << " ";
 288                         break;
 289         }
 290         if (input) {
 291                 ss << _("In") << " ";
 292         } else {
 293                 ss << _("Out") << " ";
 294         }
 295
 296         ss << (id + 1);
 297
 298         Plugin::IOPortDescription iod (ss.str());
 299         return iod;
 300 }
 301
 302 PluginOutputConfiguration
 303 Plugin::possible_output () const
 304 {
 305         PluginOutputConfiguration oc;
 306         if (_info) {
 307                 oc.insert (_info->n_outputs.n_audio ());
 308         }
 309         return oc;
 310 }
 311
 312 const Plugin::PresetRecord *
 313 Plugin::preset_by_label (const string& label)
 314 {
 315 #ifndef NO_PLUGIN_STATE
 316         if (!_have_presets) {
 317                 find_presets ();
 318                 _have_presets = true;
 319         }
 320 #endif
 321         // FIXME: O(n)
 322         for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
 323                 if (i->second.label == label) {
 324                         return &i->second;
 325                 }
 326         }
 327
 328         return 0;
 329 }
 330
 331 const Plugin::PresetRecord *
 332 Plugin::preset_by_uri (const string& uri)
 333 {
 334 #ifndef NO_PLUGIN_STATE
 335         if (!_have_presets) {
 336                 find_presets ();
 337                 _have_presets = true;
 338         }
 339 #endif
 340         map<string, PresetRecord>::const_iterator pr = _presets.find (uri);
 341         if (pr != _presets.end()) {
 342                 return &pr->second;
 343         } else {
 344                 return 0;
 345         }
 346 }
 347
 348 int
 349 Plugin::connect_and_run (BufferSet& bufs,
 350                 framepos_t /*start*/, framepos_t /*end*/, double /*speed*/,
 351                 ChanMapping /*in_map*/, ChanMapping /*out_map*/,
 352                 pframes_t /* nframes */, framecnt_t /*offset*/)
 353 {
 354         if (bufs.count().n_midi() > 0) {
 355
 356                 /* Track notes that we are sending to the plugin */
 357
 358                 const MidiBuffer& b = bufs.get_midi (0);
 359
 360                 _tracker.track (b.begin(), b.end());
 361
 362                 if (_have_pending_stop_events) {
 363                         /* Transmit note-offs that are pending from the last transport stop */
 364                         bufs.merge_from (_pending_stop_events, 0);
 365                         _have_pending_stop_events = false;
 366                 }
 367         }
 368
 369         return 0;
 370 }
 371
 372 void
 373 Plugin::realtime_handle_transport_stopped ()
 374 {
 375         resolve_midi ();
 376 }
 377
 378 void
 379 Plugin::realtime_locate ()
 380 {
 381         resolve_midi ();
 382 }
 383
 384 void
 385 Plugin::monitoring_changed ()
 386 {
 387         resolve_midi ();
 388 }
 389
 390 void
 391 Plugin::resolve_midi ()
 392 {
 393         /* Create note-offs for any active notes and put them in _pending_stop_events, to be picked
 394            up on the next call to connect_and_run ().
 395         */
 396
 397         _pending_stop_events.get_midi(0).clear ();
 398         _tracker.resolve_notes (_pending_stop_events.get_midi (0), 0);
 399         _have_pending_stop_events = true;
 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         PresetDirty (); /* EMIT SIGNAL */
 456 }
 457
 458 void
 459 Plugin::parameter_changed_externally (uint32_t which, float /* value */)
 460 {
 461         _parameter_changed_since_last_preset = true;
 462         _session.set_dirty ();
 463         ParameterChangedExternally (which, get_parameter (which)); /* EMIT SIGNAL */
 464         PresetDirty (); /* EMIT SIGNAL */
 465 }
 466
 467 int
 468 Plugin::set_state (const XMLNode& node, int /*version*/)
 469 {
 470         node.get_property (X_("last-preset-uri"), _last_preset.uri);
 471         node.get_property (X_("last-preset-label"), _last_preset.label);
 472         node.get_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset);
 473         return 0;
 474 }
 475
 476 XMLNode &
 477 Plugin::get_state ()
 478 {
 479         XMLNode* root = new XMLNode (state_node_name ());
 480
 481         root->set_property (X_("last-preset-uri"), _last_preset.uri);
 482         root->set_property (X_("last-preset-label"), _last_preset.label);
 483         root->set_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset);
 484
 485 #ifndef NO_PLUGIN_STATE
 486         add_state (root);
 487 #else
 488         if (!seen_get_state_message) {
 489                 info << string_compose (_("Saving plugin settings is not supported in this build of %1. Consider paying for the full version"),
 490                                         PROGRAM_NAME)
 491                      << endmsg;
 492                 seen_get_state_message = true;
 493         }
 494 #endif
 495
 496         return *root;
 497 }
 498
 499 void
 500 Plugin::set_info (PluginInfoPtr info)
 501 {
 502         _info = info;
 503 }
 504
 505 std::string
 506 Plugin::parameter_label (uint32_t which) const
 507 {
 508         if (which >= parameter_count ()) {
 509                 return "";
 510         }
 511         ParameterDescriptor pd;
 512         get_parameter_descriptor (which, pd);
 513         return pd.label;
 514 }