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