libs/ardour/plugin_insert.cc

   1 /*
   2     Copyright (C) 2000 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 <string>
  25
  26
  27 #include "pbd/failed_constructor.h"
  28 #include "pbd/xml++.h"
  29
  30 #include "ardour/audio_buffer.h"
  31 #include "ardour/automation_list.h"
  32 #include "ardour/buffer_set.h"
  33 #include "ardour/event_type_map.h"
  34 #include "ardour/ladspa_plugin.h"
  35 #include "ardour/plugin.h"
  36 #include "ardour/plugin_insert.h"
  37 #include "ardour/port.h"
  38 #include "ardour/route.h"
  39
  40 #ifdef HAVE_SLV2
  41 #include "ardour/lv2_plugin.h"
  42 #endif
  43
  44 #ifdef VST_SUPPORT
  45 #include "ardour/vst_plugin.h"
  46 #endif
  47
  48 #ifdef HAVE_AUDIOUNITS
  49 #include "ardour/audio_unit.h"
  50 #endif
  51
  52 #include "ardour/audioengine.h"
  53 #include "ardour/session.h"
  54 #include "ardour/types.h"
  55
  56 #include "i18n.h"
  57
  58 using namespace std;
  59 using namespace ARDOUR;
  60 using namespace PBD;
  61
  62 const string PluginInsert::port_automation_node_name = "PortAutomation";
  63
  64 PluginInsert::PluginInsert (Session& s, boost::shared_ptr<Plugin> plug)
  65         : Processor (s, (plug ? plug->name() : string ("toBeRenamed")))
  66         , _signal_analysis_collected_nframes(0)
  67         , _signal_analysis_collect_nframes_max(0)
  68 {
  69         /* the first is the master */
  70
  71         if (plug) {
  72                 _plugins.push_back (plug);
  73                 set_automatable ();
  74
  75                 Glib::Mutex::Lock em (_session.engine().process_lock());
  76                 IO::PortCountChanged (max(input_streams(), output_streams()));
  77         }
  78 }
  79
  80 bool
  81 PluginInsert::set_count (uint32_t num)
  82 {
  83         bool require_state = !_plugins.empty();
  84
  85         /* this is a bad idea.... we shouldn't do this while active.
  86            only a route holding their redirect_lock should be calling this
  87         */
  88
  89         if (num == 0) {
  90                 return false;
  91         } else if (num > _plugins.size()) {
  92                 uint32_t diff = num - _plugins.size();
  93
  94                 for (uint32_t n = 0; n < diff; ++n) {
  95                         _plugins.push_back (plugin_factory (_plugins[0]));
  96
  97                         if (require_state) {
  98                                 /* XXX do something */
  99                         }
 100                 }
 101
 102         } else if (num < _plugins.size()) {
 103                 uint32_t diff = _plugins.size() - num;
 104                 for (uint32_t n= 0; n < diff; ++n) {
 105                         _plugins.pop_back();
 106                 }
 107         }
 108
 109         return true;
 110 }
 111
 112 PluginInsert::~PluginInsert ()
 113 {
 114 }
 115
 116 void
 117 PluginInsert::control_list_automation_state_changed (Evoral::Parameter which, AutoState s)
 118 {
 119         if (which.type() != PluginAutomation)
 120                 return;
 121
 122         boost::shared_ptr<AutomationControl> c
 123                         = boost::dynamic_pointer_cast<AutomationControl>(control (which));
 124
 125         if (c && s != Off) {
 126                 _plugins[0]->set_parameter (which.id(), c->list()->eval (_session.transport_frame()));
 127         }
 128 }
 129
 130 ChanCount
 131 PluginInsert::output_streams() const
 132 {
 133         ChanCount out = _plugins.front()->get_info()->n_outputs;
 134
 135         if (out == ChanCount::INFINITE) {
 136                 return _plugins.front()->output_streams ();
 137         } else {
 138                 out.set_audio (out.n_audio() * _plugins.size());
 139                 out.set_midi (out.n_midi() * _plugins.size());
 140                 return out;
 141         }
 142 }
 143
 144 ChanCount
 145 PluginInsert::input_streams() const
 146 {
 147         ChanCount in = _plugins[0]->get_info()->n_inputs;
 148
 149         if (in == ChanCount::INFINITE) {
 150                 return _plugins[0]->input_streams ();
 151         } else {
 152                 in.set_audio (in.n_audio() * _plugins.size());
 153                 in.set_midi (in.n_midi() * _plugins.size());
 154                 return in;
 155         }
 156 }
 157
 158 ChanCount
 159 PluginInsert::natural_output_streams() const
 160 {
 161         return _plugins[0]->get_info()->n_outputs;
 162 }
 163
 164 ChanCount
 165 PluginInsert::natural_input_streams() const
 166 {
 167         return _plugins[0]->get_info()->n_inputs;
 168 }
 169
 170 bool
 171 PluginInsert::is_generator() const
 172 {
 173         /* XXX more finesse is possible here. VST plugins have a
 174            a specific "instrument" flag, for example.
 175          */
 176
 177         return _plugins[0]->get_info()->n_inputs.n_audio() == 0;
 178 }
 179
 180 void
 181 PluginInsert::set_automatable ()
 182 {
 183         set<Evoral::Parameter> a = _plugins.front()->automatable ();
 184
 185         Plugin::ParameterDescriptor desc;
 186
 187         for (set<Evoral::Parameter>::iterator i = a.begin(); i != a.end(); ++i) {
 188                 if (i->type() == PluginAutomation) {
 189
 190                         Evoral::Parameter param(*i);
 191
 192                         _plugins.front()->get_parameter_descriptor(i->id(), desc);
 193
 194                         /* the Parameter belonging to the actual plugin doesn't have its range set
 195                            but we want the Controllable related to this Parameter to have those limits.
 196                         */
 197
 198                         param.set_range (desc.lower, desc.upper, _plugins.front()->default_value(i->id()), desc.toggled);
 199                         can_automate (param);
 200                         boost::shared_ptr<AutomationList> list(new AutomationList(param));
 201                         add_control (boost::shared_ptr<AutomationControl>(new PluginControl(this, param, list)));
 202                 }
 203         }
 204 }
 205
 206 void
 207 PluginInsert::parameter_changed (Evoral::Parameter which, float val)
 208 {
 209         if (which.type() != PluginAutomation)
 210                 return;
 211
 212         Plugins::iterator i = _plugins.begin();
 213
 214         /* don't set the first plugin, just all the slaves */
 215
 216         if (i != _plugins.end()) {
 217                 ++i;
 218                 for (; i != _plugins.end(); ++i) {
 219                         (*i)->set_parameter (which, val);
 220                 }
 221         }
 222 }
 223
 224 int
 225 PluginInsert::set_block_size (nframes_t nframes)
 226 {
 227         int ret = 0;
 228         for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
 229                 if ((*i)->set_block_size (nframes) != 0) {
 230                         ret = -1;
 231                 }
 232         }
 233         return ret;
 234 }
 235
 236 void
 237 PluginInsert::activate ()
 238 {
 239         for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
 240                 (*i)->activate ();
 241         }
 242
 243         Processor::activate ();
 244 }
 245
 246 void
 247 PluginInsert::deactivate ()
 248 {
 249         Processor::deactivate ();
 250
 251         for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
 252                 (*i)->deactivate ();
 253         }
 254 }
 255
 256 void
 257 PluginInsert::flush ()
 258 {
 259         for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
 260                 (*i)->flush ();
 261         }
 262 }
 263
 264 void
 265 PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now)
 266 {
 267         // Calculate if, and how many frames we need to collect for analysis
 268         nframes_t collect_signal_nframes = (_signal_analysis_collect_nframes_max -
 269                                             _signal_analysis_collected_nframes);
 270         if (nframes < collect_signal_nframes) { // we might not get all frames now
 271                 collect_signal_nframes = nframes;
 272         }
 273
 274         ChanMapping in_map(input_streams());
 275         ChanMapping out_map(output_streams());
 276
 277         /* Note that we've already required that plugins
 278            be able to handle in-place processing.
 279         */
 280
 281         if (with_auto) {
 282
 283                 uint32_t n = 0;
 284
 285                 for (Controls::iterator li = controls().begin(); li != controls().end(); ++li, ++n) {
 286
 287                         boost::shared_ptr<AutomationControl> c
 288                                 = boost::dynamic_pointer_cast<AutomationControl>(li->second);
 289
 290                         if (c->parameter().type() == PluginAutomation && c->automation_playback()) {
 291                                 bool valid;
 292
 293                                 const float val = c->list()->rt_safe_eval (now, valid);
 294
 295                                 if (valid) {
 296                                         c->set_value(val);
 297                                 }
 298
 299                         }
 300                 }
 301         }
 302
 303         if (collect_signal_nframes > 0) {
 304                 // collect input
 305                 //std::cerr << "collect input, bufs " << bufs.count().n_audio() << " count,  " << bufs.available().n_audio() << " available" << std::endl;
 306                 //std::cerr << "               streams " << input_streams().n_audio() << std::endl;
 307                 //std::cerr << "filling buffer with " << collect_signal_nframes << " frames at " << _signal_analysis_collected_nframes << std::endl;
 308
 309                 _signal_analysis_inputs.set_count(input_streams());
 310
 311                 for (uint32_t i = 0; i < input_streams().n_audio(); ++i) {
 312                         _signal_analysis_inputs.get_audio(i).read_from(
 313                                 bufs.get_audio(i),
 314                                 collect_signal_nframes,
 315                                 _signal_analysis_collected_nframes); // offset is for target buffer
 316                 }
 317
 318         }
 319
 320         for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
 321                 (*i)->connect_and_run(bufs, in_map, out_map, nframes, offset);
 322                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 323                         in_map.offset_to(*t, natural_input_streams().get(*t));
 324                         out_map.offset_to(*t, natural_output_streams().get(*t));
 325                 }
 326         }
 327
 328         if (collect_signal_nframes > 0) {
 329                 // collect output
 330                 //std::cerr << "       output, bufs " << bufs.count().n_audio() << " count,  " << bufs.available().n_audio() << " available" << std::endl;
 331                 //std::cerr << "               streams " << output_streams().n_audio() << std::endl;
 332
 333                 _signal_analysis_outputs.set_count(output_streams());
 334
 335                 for (uint32_t i = 0; i < output_streams().n_audio(); ++i) {
 336                         _signal_analysis_outputs.get_audio(i).read_from(
 337                                 bufs.get_audio(i),
 338                                 collect_signal_nframes,
 339                                 _signal_analysis_collected_nframes); // offset is for target buffer
 340                 }
 341
 342                 _signal_analysis_collected_nframes += collect_signal_nframes;
 343                 assert(_signal_analysis_collected_nframes <= _signal_analysis_collect_nframes_max);
 344
 345                 if (_signal_analysis_collected_nframes == _signal_analysis_collect_nframes_max) {
 346                         _signal_analysis_collect_nframes_max = 0;
 347                         _signal_analysis_collected_nframes   = 0;
 348
 349                         AnalysisDataGathered(&_signal_analysis_inputs,
 350                                              &_signal_analysis_outputs);
 351                 }
 352         }
 353         /* leave remaining channel buffers alone */
 354 }
 355
 356 void
 357 PluginInsert::silence (nframes_t nframes)
 358 {
 359         ChanMapping in_map(input_streams());
 360         ChanMapping out_map(output_streams());
 361
 362         if (active()) {
 363                 for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
 364                         (*i)->connect_and_run (_session.get_silent_buffers ((*i)->get_info()->n_inputs), in_map, out_map, nframes, 0);
 365                 }
 366         }
 367 }
 368
 369 void
 370 PluginInsert::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, nframes_t nframes, bool)
 371 {
 372         if (_active || _pending_active) {
 373
 374                 if (_session.transport_rolling()) {
 375                         automation_run (bufs, nframes);
 376                 } else {
 377                         connect_and_run (bufs, nframes, 0, false);
 378                 }
 379
 380         } else {
 381
 382                 /* FIXME: type, audio only */
 383
 384                 uint32_t in = _plugins[0]->get_info()->n_inputs.n_audio();
 385                 uint32_t out = _plugins[0]->get_info()->n_outputs.n_audio();
 386
 387                 if (out > in) {
 388
 389                         /* not active, but something has make up for any channel count increase */
 390
 391                         for (uint32_t n = out - in; n < out; ++n) {
 392                                 memcpy (bufs.get_audio(n).data(), bufs.get_audio(in - 1).data(), sizeof (Sample) * nframes);
 393                         }
 394                 }
 395
 396                 bufs.count().set_audio(out);
 397         }
 398
 399         _active = _pending_active;
 400 }
 401
 402 void
 403 PluginInsert::set_parameter (Evoral::Parameter param, float val)
 404 {
 405         if (param.type() != PluginAutomation) {
 406                 return;
 407         }
 408
 409         /* the others will be set from the event triggered by this */
 410
 411         _plugins[0]->set_parameter (param.id(), val);
 412
 413         boost::shared_ptr<AutomationControl> ac
 414                         = boost::dynamic_pointer_cast<AutomationControl>(control(param));
 415
 416         if (ac) {
 417                 ac->set_value(val);
 418         } else {
 419                 warning << "set_parameter called for nonexistant parameter "
 420                         << EventTypeMap::instance().to_symbol(param) << endmsg;
 421         }
 422
 423         _session.set_dirty();
 424 }
 425
 426 float
 427 PluginInsert::get_parameter (Evoral::Parameter param)
 428 {
 429         if (param.type() != PluginAutomation) {
 430                 return 0.0;
 431         } else {
 432                 assert (!_plugins.empty ());
 433                 return _plugins[0]->get_parameter (param.id());
 434         }
 435 }
 436
 437 void
 438 PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes)
 439 {
 440         Evoral::ControlEvent next_event (0, 0.0f);
 441         nframes_t now = _session.transport_frame ();
 442         nframes_t end = now + nframes;
 443         nframes_t offset = 0;
 444
 445         Glib::Mutex::Lock lm (control_lock(), Glib::TRY_LOCK);
 446
 447         if (!lm.locked()) {
 448                 connect_and_run (bufs, nframes, offset, false);
 449                 return;
 450         }
 451
 452         if (!find_next_event (now, end, next_event) || requires_fixed_sized_buffers()) {
 453
 454                 /* no events have a time within the relevant range */
 455
 456                 connect_and_run (bufs, nframes, offset, true, now);
 457                 return;
 458         }
 459
 460         while (nframes) {
 461
 462                 nframes_t cnt = min (((nframes_t) ceil (next_event.when) - now), nframes);
 463
 464                 connect_and_run (bufs, cnt, offset, true, now);
 465
 466                 nframes -= cnt;
 467                 offset += cnt;
 468                 now += cnt;
 469
 470                 if (!find_next_event (now, end, next_event)) {
 471                         break;
 472                 }
 473         }
 474
 475         /* cleanup anything that is left to do */
 476
 477         if (nframes) {
 478                 connect_and_run (bufs, nframes, offset, true, now);
 479         }
 480 }
 481
 482 float
 483 PluginInsert::default_parameter_value (const Evoral::Parameter& param)
 484 {
 485         if (param.type() != PluginAutomation)
 486                 return 1.0;
 487
 488         if (_plugins.empty()) {
 489                 fatal << _("programming error: ") << X_("PluginInsert::default_parameter_value() called with no plugin")
 490                       << endmsg;
 491                 /*NOTREACHED*/
 492         }
 493
 494         return _plugins[0]->default_value (param.id());
 495 }
 496
 497 boost::shared_ptr<Plugin>
 498 PluginInsert::plugin_factory (boost::shared_ptr<Plugin> other)
 499 {
 500         boost::shared_ptr<LadspaPlugin> lp;
 501 #ifdef HAVE_SLV2
 502         boost::shared_ptr<LV2Plugin> lv2p;
 503 #endif
 504 #ifdef VST_SUPPORT
 505         boost::shared_ptr<VSTPlugin> vp;
 506 #endif
 507 #ifdef HAVE_AUDIOUNITS
 508         boost::shared_ptr<AUPlugin> ap;
 509 #endif
 510
 511         if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
 512                 return boost::shared_ptr<Plugin> (new LadspaPlugin (*lp));
 513 #ifdef HAVE_SLV2
 514         } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin> (other)) != 0) {
 515                 return boost::shared_ptr<Plugin> (new LV2Plugin (*lv2p));
 516 #endif
 517 #ifdef VST_SUPPORT
 518         } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
 519                 return boost::shared_ptr<Plugin> (new VSTPlugin (*vp));
 520 #endif
 521 #ifdef HAVE_AUDIOUNITS
 522         } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
 523                 return boost::shared_ptr<Plugin> (new AUPlugin (*ap));
 524 #endif
 525         }
 526
 527         fatal << string_compose (_("programming error: %1"),
 528                           X_("unknown plugin type in PluginInsert::plugin_factory"))
 529               << endmsg;
 530         /*NOTREACHED*/
 531         return boost::shared_ptr<Plugin> ((Plugin*) 0);
 532 }
 533
 534 bool
 535 PluginInsert::configure_io (ChanCount in, ChanCount out)
 536 {
 537         if (set_count (count_for_configuration (in, out)) < 0) {
 538                 return false;
 539         }
 540
 541         /* if we're running replicated plugins, each plugin has
 542            the same i/o configuration and we may need to announce how many
 543            output streams there are.
 544
 545            if we running a single plugin, we need to configure it.
 546         */
 547
 548         if (_plugins.front()->configure_io (in, out) < 0) {
 549                 return false;
 550         }
 551
 552         // we don't know the analysis window size, so we must work with the
 553         // current buffer size here. each request for data fills in these
 554         // buffers and the analyser makes sure it gets enough data for the
 555         // analysis window
 556         session().ensure_buffer_set (_signal_analysis_inputs, in);
 557         //_signal_analysis_inputs.set_count (in);
 558
 559         session().ensure_buffer_set (_signal_analysis_outputs, out);
 560         //_signal_analysis_outputs.set_count (out);
 561
 562         // std::cerr << "set counts to i" << in.n_audio() << "/o" << out.n_audio() << std::endl;
 563
 564         return Processor::configure_io (in, out);
 565 }
 566
 567 bool
 568 PluginInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 569 {
 570         // Plugin has flexible I/O, so delegate to it
 571         if (_plugins.front()->reconfigurable_io()) {
 572                 return _plugins.front()->can_support_io_configuration (in, out);
 573         }
 574
 575         ChanCount inputs  = _plugins[0]->get_info()->n_inputs;
 576         ChanCount outputs = _plugins[0]->get_info()->n_outputs;
 577
 578         // Plugin inputs match requested inputs exactly
 579         if (inputs == in) {
 580                 out = outputs;
 581                 return true;
 582         }
 583
 584         // See if replication is possible
 585         // We can replicate if there exists a single factor f such that, for every type,
 586         // the number of plugin inputs * f = the requested number of inputs
 587         uint32_t f             = 0;
 588         bool     can_replicate = true;
 589         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 590                 // No inputs of this type
 591                 if (inputs.get(*t) == 0 && in.get(*t) == 0) {
 592                         continue;
 593
 594                 // Plugin has more inputs than requested, can not replicate
 595                 } else if (inputs.get(*t) >= in.get(*t)) {
 596                         can_replicate = false;
 597                         break;
 598
 599                 // Plugin inputs is not a factor of requested inputs, can not replicate
 600                 } else if (inputs.get(*t) == 0 || in.get(*t) % inputs.get(*t) != 0) {
 601                         can_replicate = false;
 602                         break;
 603
 604                 // Potential factor not set yet
 605                 } else if (f == 0) {
 606                         f = in.get(*t) / inputs.get(*t);;
 607                 }
 608
 609                 // Factor for this type does not match another type, can not replicate
 610                 if (f != (in.get(*t) / inputs.get(*t))) {
 611                         can_replicate = false;
 612                         break;
 613                 }
 614         }
 615
 616         if (can_replicate) {
 617                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 618                         out.set (*t, outputs.get(*t) * f);
 619                 }
 620                 return true;
 621         } else {
 622                 return false;
 623         }
 624 }
 625
 626 /* Number of plugin instances required to support a given channel configuration.
 627  * (private helper)
 628  */
 629 int32_t
 630 PluginInsert::count_for_configuration (ChanCount in, ChanCount /*out*/) const
 631 {
 632         if (_plugins.front()->reconfigurable_io()) {
 633                 /* plugin has flexible I/O, so the answer is always 1 */
 634                 /* this could change if we ever decide to replicate AU's */
 635                 return 1;
 636         }
 637
 638         // FIXME: take 'out' into consideration
 639
 640         ChanCount outputs = _plugins[0]->get_info()->n_outputs;
 641         ChanCount inputs = _plugins[0]->get_info()->n_inputs;
 642
 643         if (inputs.n_total() == 0) {
 644                 /* instrument plugin, always legal, but throws away any existing streams */
 645                 return 1;
 646         }
 647
 648         if (inputs.n_total() == 1 && outputs == inputs
 649                         && ((inputs.n_audio() == 0 && in.n_audio() == 0)
 650                                 || (inputs.n_midi() == 0 && in.n_midi() == 0))) {
 651                 /* mono plugin, replicate as needed to match in */
 652                 return in.n_total();
 653         }
 654
 655         if (inputs == in) {
 656                 /* exact match */
 657                 return 1;
 658         }
 659
 660         // assumes in is valid, so we must be replicating
 661         if (inputs.n_total() < in.n_total()
 662                         && (in.n_total() % inputs.n_total() == 0)) {
 663
 664                 return in.n_total() / inputs.n_total();
 665         }
 666
 667         /* err... */
 668         return 0;
 669 }
 670
 671 XMLNode&
 672 PluginInsert::get_state(void)
 673 {
 674         return state (true);
 675 }
 676
 677 XMLNode&
 678 PluginInsert::state (bool full)
 679 {
 680         XMLNode& node = Processor::state (full);
 681
 682         node.add_property("type", _plugins[0]->state_node_name());
 683         node.add_property("unique-id", _plugins[0]->unique_id());
 684         node.add_property("count", string_compose("%1", _plugins.size()));
 685         node.add_child_nocopy (_plugins[0]->get_state());
 686
 687         return node;
 688 }
 689
 690 int
 691 PluginInsert::set_state(const XMLNode& node, int version)
 692 {
 693         XMLNodeList nlist = node.children();
 694         XMLNodeIterator niter;
 695         XMLPropertyList plist;
 696         const XMLProperty *prop;
 697         ARDOUR::PluginType type;
 698
 699         if ((prop = node.property ("type")) == 0) {
 700                 error << _("XML node describing plugin is missing the `type' field") << endmsg;
 701                 return -1;
 702         }
 703
 704         if (prop->value() == X_("ladspa") || prop->value() == X_("Ladspa")) { /* handle old school sessions */
 705                 type = ARDOUR::LADSPA;
 706         } else if (prop->value() == X_("lv2")) {
 707                 type = ARDOUR::LV2;
 708         } else if (prop->value() == X_("vst")) {
 709                 type = ARDOUR::VST;
 710         } else if (prop->value() == X_("audiounit")) {
 711                 type = ARDOUR::AudioUnit;
 712         } else {
 713                 error << string_compose (_("unknown plugin type %1 in plugin insert state"),
 714                                   prop->value())
 715                       << endmsg;
 716                 return -1;
 717         }
 718
 719         prop = node.property ("unique-id");
 720
 721         if (prop == 0) {
 722 #ifdef VST_SUPPORT
 723                 /* older sessions contain VST plugins with only an "id" field.
 724                  */
 725
 726                 if (type == ARDOUR::VST) {
 727                         prop = node.property ("id");
 728                 }
 729 #endif
 730                 /* recheck  */
 731
 732                 if (prop == 0) {
 733                         error << _("Plugin has no unique ID field") << endmsg;
 734                         return -1;
 735                 }
 736         }
 737
 738         boost::shared_ptr<Plugin> plugin;
 739
 740         plugin = find_plugin (_session, prop->value(), type);
 741
 742         if (plugin == 0) {
 743                 error << string_compose(_("Found a reference to a plugin (\"%1\") that is unknown.\n"
 744                                    "Perhaps it was removed or moved since it was last used."), prop->value())
 745                       << endmsg;
 746                 return -1;
 747         }
 748
 749         uint32_t count = 1;
 750         bool need_automatables = true;
 751
 752         if (_plugins.empty()) {
 753                 /* if we are adding the first plugin, we will need to set
 754                    up automatable controls.
 755                 */
 756                 need_automatables = true;
 757         }
 758
 759         if ((prop = node.property ("count")) != 0) {
 760                 sscanf (prop->value().c_str(), "%u", &count);
 761         }
 762
 763         if (_plugins.size() != count) {
 764
 765                 _plugins.push_back (plugin);
 766
 767                 for (uint32_t n = 1; n < count; ++n) {
 768                         _plugins.push_back (plugin_factory (plugin));
 769                 }
 770         }
 771
 772         if (need_automatables) {
 773                 set_automatable ();
 774         }
 775
 776         /* Handle the node list for this Processor (or Insert if an A2 session) */
 777         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 778
 779                 if ((*niter)->name() == plugin->state_node_name()) {
 780
 781                         for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
 782                                 (*i)->set_state (**niter, version);
 783                         }
 784                         break;
 785                 }
 786         }
 787
 788         Processor::set_state (node, version);
 789
 790         if (version < 3000) {
 791
 792                 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 793                         if ((*niter)->name() == "Redirect") {
 794                                 /* XXX do we need to tackle placement? i think not (pd; oct 16 2009) */
 795                                 Processor::set_state (**niter, version);
 796                                 break;
 797                         }
 798                 }
 799
 800                 // set_parameter_state_2X (node, version);
 801
 802         } else {
 803
 804                 // set_parameter_state (node, version);
 805         }
 806
 807         // The name of the PluginInsert comes from the plugin, nothing else
 808         _name = plugin->get_info()->name;
 809
 810         /* catch up on I/O */
 811
 812         {
 813                 Glib::Mutex::Lock em (_session.engine().process_lock());
 814                 IO::PortCountChanged (max(input_streams(), output_streams()));
 815         }
 816
 817         return 0;
 818 }
 819
 820 void
 821 PluginInsert::set_parameter_state (const XMLNode& node, int version)
 822 {
 823         XMLNodeList nlist = node.children();
 824         XMLNodeIterator niter;
 825
 826         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 827
 828                 if ((*niter)->name() != port_automation_node_name) {
 829                         continue;
 830                 }
 831
 832                 XMLNodeList cnodes;
 833                 XMLProperty *cprop;
 834                 XMLNodeConstIterator iter;
 835                 XMLNode *child;
 836                 const char *port;
 837                 uint32_t port_id;
 838
 839                 cnodes = (*niter)->children ("AutomationList");
 840
 841                 for (iter = cnodes.begin(); iter != cnodes.end(); ++iter) {
 842
 843                         child = *iter;
 844
 845                         /* XXX this code knows way too much about the internal details of an AutomationList state node */
 846
 847                         if ((cprop = child->property("automation-id")) != 0) {
 848                                 port = cprop->value().c_str();
 849                         } else {
 850                                 warning << _("PluginInsert: Auto: no plugin parameter number seen") << endmsg;
 851                                 continue;
 852                         }
 853
 854                         if (sscanf (port, "parameter-%" PRIu32, &port_id) != 1) {
 855                                 warning << _("PluginInsert: Auto: no parameter number found") << endmsg;
 856                                 continue;
 857                         }
 858
 859                         if (port_id >= _plugins[0]->parameter_count()) {
 860                                 warning << _("PluginInsert: Auto: plugin parameter out of range") << endmsg;
 861                                 continue;
 862                         }
 863
 864                         boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(
 865                                         control(Evoral::Parameter(PluginAutomation, 0, port_id), true));
 866
 867                         if (c) {
 868                                 c->alist()->set_state (*child, version);
 869                         } else {
 870                                 error << string_compose (_("PluginInsert: automatable control %1 not found - ignored"), port_id) << endmsg;
 871                         }
 872                 }
 873
 874                 /* done */
 875
 876                 break;
 877         }
 878 }
 879
 880 void
 881 PluginInsert::set_parameter_state_2X (const XMLNode& node, int version)
 882 {
 883         XMLNodeList nlist = node.children();
 884         XMLNodeIterator niter;
 885
 886         /* look for port automation node */
 887
 888         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 889
 890                 if ((*niter)->name() != port_automation_node_name) {
 891                         continue;
 892                 }
 893
 894                 XMLNodeList cnodes;
 895                 XMLProperty *cprop;
 896                 XMLNodeConstIterator iter;
 897                 XMLNode *child;
 898                 const char *port;
 899                 uint32_t port_id;
 900
 901                 cnodes = (*niter)->children ("port");
 902
 903                 for (iter = cnodes.begin(); iter != cnodes.end(); ++iter){
 904
 905                         child = *iter;
 906
 907                         if ((cprop = child->property("number")) != 0) {
 908                                 port = cprop->value().c_str();
 909                         } else {
 910                                 warning << _("PluginInsert: Auto: no ladspa port number") << endmsg;
 911                                 continue;
 912                         }
 913
 914                         sscanf (port, "%" PRIu32, &port_id);
 915
 916                         if (port_id >= _plugins[0]->parameter_count()) {
 917                                 warning << _("PluginInsert: Auto: port id out of range") << endmsg;
 918                                 continue;
 919                         }
 920
 921                         boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(
 922                                         control(Evoral::Parameter(PluginAutomation, 0, port_id), true));
 923
 924                         if (c) {
 925                                 if (!child->children().empty()) {
 926                                         c->alist()->set_state (*child->children().front(), version);
 927                                 }
 928                         } else {
 929                                 error << string_compose (_("PluginInsert: automatable control %1 not found - ignored"), port_id) << endmsg;
 930                         }
 931                 }
 932
 933                 /* done */
 934
 935                 break;
 936         }
 937 }
 938
 939
 940 string
 941 PluginInsert::describe_parameter (Evoral::Parameter param)
 942 {
 943         if (param.type() != PluginAutomation)
 944                 return Automatable::describe_parameter(param);
 945
 946         return _plugins[0]->describe_parameter (param);
 947 }
 948
 949 ARDOUR::nframes_t
 950 PluginInsert::signal_latency() const
 951 {
 952         if (_user_latency) {
 953                 return _user_latency;
 954         }
 955
 956         return _plugins[0]->signal_latency ();
 957 }
 958
 959 ARDOUR::PluginType
 960 PluginInsert::type ()
 961 {
 962        return plugin()->get_info()->type;
 963 }
 964
 965 PluginInsert::PluginControl::PluginControl (PluginInsert* p, const Evoral::Parameter &param, boost::shared_ptr<AutomationList> list)
 966         : AutomationControl (p->session(), param, list, p->describe_parameter(param))
 967         , _plugin (p)
 968 {
 969         Plugin::ParameterDescriptor desc;
 970         p->plugin(0)->get_parameter_descriptor (param.id(), desc);
 971         _logarithmic = desc.logarithmic;
 972         _toggled = desc.toggled;
 973 }
 974
 975 void
 976 PluginInsert::PluginControl::set_value (double val)
 977 {
 978         /* FIXME: probably should be taking out some lock here.. */
 979
 980         if (_toggled) {
 981                 if (val > 0.5) {
 982                         val = 1.0;
 983                 } else {
 984                         val = 0.0;
 985                 }
 986         } else {
 987
 988                 /*const float range = _list->get_max_y() - _list->get_min_y();
 989                 const float lower = _list->get_min_y();
 990
 991                 if (!_logarithmic) {
 992                         val = lower + (range * val);
 993                 } else {
 994                         float log_lower = 0.0f;
 995                         if (lower > 0.0f) {
 996                                 log_lower = log(lower);
 997                         }
 998
 999                         val = exp(log_lower + log(range) * val);
1000                 }*/
1001
1002         }
1003
1004         for (Plugins::iterator i = _plugin->_plugins.begin();
1005                         i != _plugin->_plugins.end(); ++i) {
1006                 (*i)->set_parameter (_list->parameter().id(), val);
1007         }
1008
1009         boost::shared_ptr<Plugin> iasp = _plugin->_impulseAnalysisPlugin.lock();
1010         if (iasp) {
1011                 iasp->set_parameter (_list->parameter().id(), val);
1012         }
1013
1014         AutomationControl::set_value(val);
1015 }
1016
1017 double
1018 PluginInsert::PluginControl::get_value (void) const
1019 {
1020         /* FIXME: probably should be taking out some lock here.. */
1021
1022         double val = _plugin->get_parameter (_list->parameter());
1023
1024         return val;
1025
1026         /*if (_toggled) {
1027
1028                 return val;
1029
1030         } else {
1031
1032                 if (_logarithmic) {
1033                         val = log(val);
1034                 }
1035
1036                 return ((val - lower) / range);
1037         }*/
1038 }
1039
1040 boost::shared_ptr<Plugin>
1041 PluginInsert::get_impulse_analysis_plugin()
1042 {
1043         boost::shared_ptr<Plugin> ret;
1044         if (_impulseAnalysisPlugin.expired()) {
1045                 ret = plugin_factory(_plugins[0]);
1046                 _impulseAnalysisPlugin = ret;
1047         } else {
1048                 ret = _impulseAnalysisPlugin.lock();
1049         }
1050
1051         return ret;
1052 }
1053
1054 void
1055 PluginInsert::collect_signal_for_analysis(nframes_t nframes)
1056 {
1057         // called from outside the audio thread, so this should be safe
1058         // only do audio as analysis is (currently) only for audio plugins
1059         _signal_analysis_inputs.ensure_buffers(  DataType::AUDIO, input_streams().n_audio(),  nframes);
1060         _signal_analysis_outputs.ensure_buffers( DataType::AUDIO, output_streams().n_audio(), nframes);
1061
1062         _signal_analysis_collected_nframes   = 0;
1063         _signal_analysis_collect_nframes_max = nframes;
1064 }
1065