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 #include "pbd/xml++.h"
  27 #include "pbd/types_convert.h"
  28
  29 #include "ardour/automatable.h"
  30 #include "ardour/chan_count.h"
  31 #include "ardour/debug.h"
  32 #include "ardour/processor.h"
  33 #include "ardour/types.h"
  34
  35 #ifdef WINDOWS_VST_SUPPORT
  36 #include "ardour/windows_vst_plugin.h"
  37 #endif
  38
  39 #ifdef AUDIOUNIT_SUPPORT
  40 #include "ardour/audio_unit.h"
  41 #endif
  42
  43 #include "ardour/audioengine.h"
  44 #include "ardour/session.h"
  45 #include "ardour/types.h"
  46
  47 #include "pbd/i18n.h"
  48
  49 using namespace std;
  50 using namespace ARDOUR;
  51 using namespace PBD;
  52
  53 namespace ARDOUR { class Session; }
  54
  55 // Always saved as Processor, but may be IOProcessor or Send in legacy sessions
  56 const string Processor::state_node_name = "Processor";
  57
  58 Processor::Processor(Session& session, const string& name)
  59         : SessionObject(session, name)
  60         , Automatable (session)
  61         , _pending_active(false)
  62         , _active(false)
  63         , _next_ab_is_active(false)
  64         , _configured(false)
  65         , _display_to_user (true)
  66         , _pre_fader (false)
  67         , _ui_pointer (0)
  68         , _window_proxy (0)
  69         , _pinmgr_proxy (0)
  70         , _owner (0)
  71         , _input_latency (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         , Latent (other)
  80         , _pending_active(other._pending_active)
  81         , _active(other._active)
  82         , _next_ab_is_active(false)
  83         , _configured(false)
  84         , _display_to_user (true)
  85         , _pre_fader (false)
  86         , _ui_pointer (0)
  87         , _window_proxy (0)
  88         , _pinmgr_proxy (0)
  89         , _owner (0)
  90         , _input_latency (0)
  91 {
  92 }
  93
  94 Processor::~Processor ()
  95 {
  96         DEBUG_TRACE (DEBUG::Destruction, string_compose ("processor %1 destructor\n", _name));
  97 }
  98
  99 XMLNode&
 100 Processor::get_state (void)
 101 {
 102         return state (true);
 103 }
 104
 105 /* NODE STRUCTURE
 106
 107     <Automation [optionally with visible="...." ]>
 108        <parameter-N>
 109          <AutomationList id=N>
 110            <events>
 111            X1 Y1
 112            X2 Y2
 113            ....
 114            </events>
 115        </parameter-N>
 116     <Automation>
 117 */
 118
 119 XMLNode&
 120 Processor::state (bool full_state)
 121 {
 122         XMLNode* node = new XMLNode (state_node_name);
 123
 124         node->set_property("id", id());
 125         node->set_property("name", name());
 126         node->set_property("active", active());
 127
 128         if (_extra_xml){
 129                 node->add_child_copy (*_extra_xml);
 130         }
 131
 132         if (full_state) {
 133                 XMLNode& automation = Automatable::get_automation_xml_state();
 134                 if (!automation.children().empty() || !automation.properties().empty()) {
 135                         node->add_child_nocopy (automation);
 136                 } else {
 137                         delete &automation;
 138                 }
 139         }
 140
 141         node->set_property("user-latency", _user_latency);
 142
 143         return *node;
 144 }
 145
 146 int
 147 Processor::set_state_2X (const XMLNode & node, int /*version*/)
 148 {
 149         XMLProperty const * prop;
 150
 151         XMLNodeList children = node.children ();
 152
 153         for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
 154
 155                 if ((*i)->name() == X_("IO")) {
 156
 157                         if ((prop = (*i)->property ("name")) != 0) {
 158                                 set_name (prop->value ());
 159                         }
 160
 161                         set_id (**i);
 162
 163                         //note:  in A2, active state was stored in the Redirect node, not the child IO node
 164                         /*
 165                          * if ((prop = (*i)->property ("active")) != 0) {
 166                                 bool const a = string_is_affirmative (prop->value ());
 167                                 if (_active != a) {
 168                                         if (a) {
 169                                                 activate ();
 170                                         } else {
 171                                                 deactivate ();
 172                                         }
 173                                 }
 174                         }*/
 175
 176                 }
 177         }
 178
 179         return 0;
 180 }
 181
 182 int
 183 Processor::set_state (const XMLNode& node, int version)
 184 {
 185         if (version < 3000) {
 186                 return set_state_2X (node, version);
 187         }
 188
 189         bool ignore_name;
 190         // Only testing for the presence of the property not value
 191         if (!node.get_property("ignore-name", ignore_name)) {
 192                 string name;
 193                 // may not exist for legacy 3.0 sessions
 194                 if (node.get_property ("name", name)) {
 195                         /* don't let derived classes have a crack at set_name,
 196                            as some (like Send) will screw with the one we suggest.
 197                         */
 198                         Processor::set_name (name);
 199                 }
 200
 201                 set_id (node);
 202         }
 203
 204         XMLNodeList nlist = node.children();
 205         XMLNodeIterator niter;
 206
 207         Stateful::save_extra_xml (node);
 208
 209         XMLProperty const * prop = 0;
 210         XMLProperty const * legacy_active = 0;
 211
 212         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 213
 214                 if ((*niter)->name() == X_("Automation")) {
 215
 216                         if ((prop = (*niter)->property ("path")) != 0) {
 217                                 old_set_automation_state (*(*niter));
 218                         } else {
 219                                 set_automation_xml_state (*(*niter), Evoral::Parameter(PluginAutomation));
 220                         }
 221
 222                 } else if ((*niter)->name() == "Redirect") {
 223                         if ( !(legacy_active = (*niter)->property("active"))) {
 224                                 error << string_compose(_("No %1 property flag in element %2"), "active", (*niter)->name()) << endl;
 225                         }
 226                 }
 227         }
 228
 229         if ((prop = node.property ("active")) == 0) {
 230                 if (legacy_active) {
 231                         prop = legacy_active;
 232                 } else {
 233                         error << _("No child node with active property") << endmsg;
 234                         return -1;
 235                 }
 236         }
 237
 238         bool const a = string_to<bool> (prop->value ()) && !_session.get_bypass_all_loaded_plugins();
 239         if (_active != a) {
 240                 if (a) {
 241                         activate ();
 242                 } else {
 243                         deactivate ();
 244                 }
 245         }
 246
 247         node.get_property ("user-latency", _user_latency);
 248
 249         return 0;
 250 }
 251
 252 /** @pre Caller must hold process lock */
 253 bool
 254 Processor::configure_io (ChanCount in, ChanCount out)
 255 {
 256         /* This class assumes 1:1 input:output.static output stream count.
 257            Derived classes must override and set _configured_output appropriately
 258            if this is not the case
 259         */
 260
 261         _configured_input = in;
 262         _configured_output = out;
 263         _configured = true;
 264
 265         ConfigurationChanged (in, out); /* EMIT SIGNAL */
 266
 267         return true;
 268 }
 269
 270 void
 271 Processor::set_display_to_user (bool yn)
 272 {
 273         _display_to_user = yn;
 274 }
 275
 276 void
 277 Processor::set_pre_fader (bool p)
 278 {
 279         _pre_fader = p;
 280 }
 281
 282 void
 283 Processor::set_owner (SessionObject* o)
 284 {
 285         _owner = o;
 286 }
 287
 288 SessionObject*
 289 Processor::owner() const
 290 {
 291         return _owner;
 292 }
 293
 294 void
 295 Processor::set_input_latency (framecnt_t cnt)
 296 {
 297         _input_latency = cnt;
 298 }
 299