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