libs/ardour/processor.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/enumwriter.h"
  29 #include "pbd/xml++.h"
  30
  31 #include "ardour/processor.h"
  32 #include "ardour/plugin.h"
  33 #include "ardour/port.h"
  34 #include "ardour/route.h"
  35 #include "ardour/ladspa_plugin.h"
  36 #include "ardour/buffer_set.h"
  37 #include "ardour/send.h"
  38 #include "ardour/port_insert.h"
  39 #include "ardour/plugin_insert.h"
  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 // Always saved as Processor, but may be IOProcessor or Send in legacy sessions
  60 const string Processor::state_node_name = "Processor";
  61
  62 Processor::Processor(Session& session, const string& name)
  63         : SessionObject(session, name)
  64         , Automatable (session)
  65         , _pending_active(false)
  66         , _active(false)
  67         , _next_ab_is_active(false)
  68         , _configured(false)
  69         , _display_to_user (true)
  70         , _pre_fader (false)
  71 {
  72 }
  73
  74 XMLNode&
  75 Processor::get_state (void)
  76 {
  77         return state (true);
  78 }
  79
  80 /* NODE STRUCTURE
  81
  82     <Automation [optionally with visible="...." ]>
  83        <parameter-N>
  84          <AutomationList id=N>
  85            <events>
  86            X1 Y1
  87            X2 Y2
  88            ....
  89            </events>
  90        </parameter-N>
  91     <Automation>
  92 */
  93
  94 XMLNode&
  95 Processor::state (bool full_state)
  96 {
  97         XMLNode* node = new XMLNode (state_node_name);
  98         char buf[64];
  99
 100         id().print (buf, sizeof (buf));
 101         node->add_property("id", buf);
 102         node->add_property("name", _name);
 103         node->add_property("active", active() ? "yes" : "no");
 104
 105         if (_extra_xml){
 106                 node->add_child_copy (*_extra_xml);
 107         }
 108
 109         if (full_state) {
 110                 XMLNode& automation = Automatable::get_automation_state();
 111                 if (!automation.children().empty()
 112                                 || !automation.properties().empty()
 113                                 || !_visible_controls.empty()) {
 114
 115                         stringstream sstr;
 116                         for (set<Evoral::Parameter>::iterator x = _visible_controls.begin();
 117                                         x != _visible_controls.end(); ++x) {
 118                                 if (x != _visible_controls.begin()) {
 119                                         sstr << ' ';
 120                                 }
 121                                 sstr << *x;
 122                         }
 123
 124                         automation.add_property ("visible", sstr.str());
 125                         node->add_child_nocopy (automation);
 126                 }
 127         }
 128
 129         return *node;
 130 }
 131
 132 int
 133 Processor::set_state_2X (const XMLNode & node, int /*version*/)
 134 {
 135         XMLProperty const * prop;
 136
 137         XMLNodeList children = node.children ();
 138
 139         for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
 140
 141                 if ((*i)->name() == X_("IO")) {
 142
 143                         if ((prop = (*i)->property ("name")) != 0) {
 144                                 set_name (prop->value ());
 145                         }
 146
 147                         if ((prop = (*i)->property ("id")) != 0) {
 148                                 _id = prop->value ();
 149                         }
 150
 151                         if ((prop = (*i)->property ("active")) != 0) {
 152                                 bool const a = string_is_affirmative (prop->value ());
 153                                 if (_active != a) {
 154                                         if (a) {
 155                                                 activate ();
 156                                         } else {
 157                                                 deactivate ();
 158                                         }
 159                                 }
 160                         }
 161                 }
 162         }
 163
 164         return 0;
 165 }
 166
 167 int
 168 Processor::set_state (const XMLNode& node, int version)
 169 {
 170         if (version < 3000) {
 171                 return set_state_2X (node, version);
 172         }
 173
 174         const XMLProperty *prop;
 175         const XMLProperty *legacy_active = 0;
 176
 177         // may not exist for legacy 3.0 sessions
 178         if ((prop = node.property ("name")) != 0) {
 179                 set_name(prop->value());
 180         }
 181
 182         // may not exist for legacy 3.0 sessions
 183         if ((prop = node.property ("id")) != 0) {
 184                 _id = prop->value();
 185         }
 186
 187         XMLNodeList nlist = node.children();
 188         XMLNodeIterator niter;
 189
 190         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 191
 192                 if ((*niter)->name() == X_("Automation")) {
 193
 194                         XMLProperty *prop;
 195
 196                         if ((prop = (*niter)->property ("path")) != 0) {
 197                                 old_set_automation_state (*(*niter));
 198                         } else {
 199                                 set_automation_state (*(*niter), Evoral::Parameter(PluginAutomation));
 200                         }
 201
 202                         if ((prop = (*niter)->property ("visible")) != 0) {
 203                                 uint32_t what;
 204                                 stringstream sstr;
 205
 206                                 _visible_controls.clear ();
 207
 208                                 sstr << prop->value();
 209                                 while (1) {
 210                                         sstr >> what;
 211                                         if (sstr.fail()) {
 212                                                 break;
 213                                         }
 214                                         // FIXME: other automation types?
 215                                         mark_automation_visible (Evoral::Parameter(PluginAutomation, 0, what), true);
 216                                 }
 217                         }
 218
 219                 } else if ((*niter)->name() == "Extra") {
 220                         _extra_xml = new XMLNode (*(*niter));
 221                 } else if ((*niter)->name() == "Redirect") {
 222                         if ( !(legacy_active = (*niter)->property("active"))) {
 223                                 error << string_compose(_("No %1 property flag in element %2"), "active", (*niter)->name()) << endl;
 224                         }
 225                 }
 226         }
 227
 228         if ((prop = node.property ("active")) == 0) {
 229                 if (legacy_active) {
 230                         prop = legacy_active;
 231                 } else {
 232                         error << _("No child node with active property") << endmsg;
 233                         return -1;
 234                 }
 235         }
 236
 237         bool const a = string_is_affirmative (prop->value ());
 238         if (_active != a) {
 239                 if (a) {
 240                         activate ();
 241                 } else {
 242                         deactivate ();
 243                 }
 244         }
 245
 246         return 0;
 247 }
 248
 249 bool
 250 Processor::configure_io (ChanCount in, ChanCount out)
 251 {
 252         /* This class assumes 1:1 input:output.static output stream count.
 253            Derived classes must override and set _configured_output appropriately
 254            if this is not the case
 255         */
 256
 257         _configured_input = in;
 258         _configured_output = out;
 259         _configured = true;
 260
 261         ConfigurationChanged (in, out); /* EMIT SIGNAL */
 262
 263         return true;
 264 }
 265
 266 void
 267 Processor::set_display_to_user (bool yn)
 268 {
 269         _display_to_user = yn;
 270 }
 271
 272 void
 273 Processor::set_pre_fader (bool p)
 274 {
 275         _pre_fader = p;
 276 }