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