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