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         , _ui_pointer (0)
  72 {
  73 }
  74
  75 Processor::Processor (const Processor& other)
  76         : Evoral::ControlSet (other)
  77         , SessionObject (other.session(), other.name())
  78         , Automatable (other.session())
  79         , _pending_active(other._pending_active)
  80         , _active(other._active)
  81         , _next_ab_is_active(false)
  82         , _configured(false)
  83         , _display_to_user (true)
  84         , _pre_fader (false)
  85         , _ui_pointer (0)
  86 {
  87 }
  88
  89 XMLNode&
  90 Processor::get_state (void)
  91 {
  92         return state (true);
  93 }
  94
  95 /* NODE STRUCTURE
  96
  97     <Automation [optionally with visible="...." ]>
  98        <parameter-N>
  99          <AutomationList id=N>
 100            <events>
 101            X1 Y1
 102            X2 Y2
 103            ....
 104            </events>
 105        </parameter-N>
 106     <Automation>
 107 */
 108
 109 XMLNode&
 110 Processor::state (bool full_state)
 111 {
 112         XMLNode* node = new XMLNode (state_node_name);
 113         char buf[64];
 114
 115         id().print (buf, sizeof (buf));
 116         node->add_property("id", buf);
 117         node->add_property("name", _name);
 118         node->add_property("active", active() ? "yes" : "no");
 119
 120         if (_extra_xml){
 121                 node->add_child_copy (*_extra_xml);
 122         }
 123
 124         if (full_state) {
 125                 XMLNode& automation = Automatable::get_automation_xml_state();
 126                 if (!automation.children().empty() || !automation.properties().empty()) {
 127                         node->add_child_nocopy (automation);
 128                 }
 129         }
 130
 131         snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
 132         node->add_property("user-latency", buf);
 133
 134         return *node;
 135 }
 136
 137 int
 138 Processor::set_state_2X (const XMLNode & node, int /*version*/)
 139 {
 140         XMLProperty const * prop;
 141
 142         XMLNodeList children = node.children ();
 143
 144         for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
 145
 146                 if ((*i)->name() == X_("IO")) {
 147
 148                         if ((prop = (*i)->property ("name")) != 0) {
 149                                 set_name (prop->value ());
 150                         }
 151
 152                         if ((prop = (*i)->property ("id")) != 0) {
 153                                 _id = prop->value ();
 154                         }
 155
 156                         if ((prop = (*i)->property ("active")) != 0) {
 157                                 bool const a = string_is_affirmative (prop->value ());
 158                                 if (_active != a) {
 159                                         if (a) {
 160                                                 activate ();
 161                                         } else {
 162                                                 deactivate ();
 163                                         }
 164                                 }
 165                         }
 166                 }
 167         }
 168
 169         return 0;
 170 }
 171
 172 int
 173 Processor::set_state (const XMLNode& node, int version)
 174 {
 175         if (version < 3000) {
 176                 return set_state_2X (node, version);
 177         }
 178
 179         const XMLProperty *prop;
 180         const XMLProperty *legacy_active = 0;
 181
 182         // may not exist for legacy 3.0 sessions
 183         if ((prop = node.property ("name")) != 0) {
 184                 /* don't let derived classes have a crack at set_name,
 185                    as some (like Send) will screw with the one we suggest.
 186                 */
 187                 Processor::set_name (prop->value());
 188         }
 189
 190         // may not exist for legacy 3.0 sessions
 191         if ((prop = node.property ("id")) != 0) {
 192                 _id = prop->value();
 193         }
 194
 195         XMLNodeList nlist = node.children();
 196         XMLNodeIterator niter;
 197
 198         Stateful::save_extra_xml (node);
 199
 200         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 201
 202                 if ((*niter)->name() == X_("Automation")) {
 203
 204                         XMLProperty *prop;
 205
 206                         if ((prop = (*niter)->property ("path")) != 0) {
 207                                 old_set_automation_state (*(*niter));
 208                         } else {
 209                                 set_automation_xml_state (*(*niter), Evoral::Parameter(PluginAutomation));
 210                         }
 211
 212                 } else if ((*niter)->name() == "Redirect") {
 213                         if ( !(legacy_active = (*niter)->property("active"))) {
 214                                 error << string_compose(_("No %1 property flag in element %2"), "active", (*niter)->name()) << endl;
 215                         }
 216                 }
 217         }
 218
 219         if ((prop = node.property ("active")) == 0) {
 220                 if (legacy_active) {
 221                         prop = legacy_active;
 222                 } else {
 223                         error << _("No child node with active property") << endmsg;
 224                         return -1;
 225                 }
 226         }
 227
 228         bool const a = string_is_affirmative (prop->value ());
 229         if (_active != a) {
 230                 if (a) {
 231                         activate ();
 232                 } else {
 233                         deactivate ();
 234                 }
 235         }
 236
 237         if ((prop = node.property ("user-latency")) != 0) {
 238                 _user_latency = atoi (prop->value ());
 239         }
 240
 241         return 0;
 242 }
 243
 244 /** @pre Caller must hold process lock */
 245 bool
 246 Processor::configure_io (ChanCount in, ChanCount out)
 247 {
 248         /* This class assumes 1:1 input:output.static output stream count.
 249            Derived classes must override and set _configured_output appropriately
 250            if this is not the case
 251         */
 252
 253         _configured_input = in;
 254         _configured_output = out;
 255         _configured = true;
 256
 257         ConfigurationChanged (in, out); /* EMIT SIGNAL */
 258
 259         return true;
 260 }
 261
 262 void
 263 Processor::set_display_to_user (bool yn)
 264 {
 265         _display_to_user = yn;
 266 }
 267
 268 void
 269 Processor::set_pre_fader (bool p)
 270 {
 271         _pre_fader = p;
 272 }
 273
 274 void
 275 Processor::set_ui (void* p)
 276 {
 277         _ui_pointer = p;
 278 }