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