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 #include <string>
  21
  22 #include <sigc++/bind.h>
  23
  24 #include <pbd/failed_constructor.h>
  25 #include <pbd/enumwriter.h>
  26 #include <pbd/xml++.h>
  27
  28 #include <ardour/processor.h>
  29 #include <ardour/plugin.h>
  30 #include <ardour/port.h>
  31 #include <ardour/route.h>
  32 #include <ardour/ladspa_plugin.h>
  33 #include <ardour/buffer_set.h>
  34 #include <ardour/send.h>
  35 #include <ardour/port_insert.h>
  36 #include <ardour/plugin_insert.h>
  37
  38 #ifdef VST_SUPPORT
  39 #include <ardour/vst_plugin.h>
  40 #endif
  41
  42 #ifdef HAVE_AUDIOUNITS
  43 #include <ardour/audio_unit.h>
  44 #endif
  45
  46 #include <ardour/audioengine.h>
  47 #include <ardour/session.h>
  48 #include <ardour/types.h>
  49
  50 #include "i18n.h"
  51
  52 using namespace std;
  53 using namespace ARDOUR;
  54 using namespace PBD;
  55
  56 sigc::signal<void,Processor*> Processor::ProcessorCreated;
  57
  58 // Always saved as Processor, but may be IOProcessor or Send in legacy sessions
  59 const string Processor::state_node_name = "Processor";
  60
  61 Processor::Processor(Session& session, const string& name, Placement p)
  62         : SessionObject(session, name)
  63         , AutomatableControls(session)
  64         , _active(false)
  65         , _next_ab_is_active(false)
  66         , _configured(false)
  67         , _placement(p)
  68         , _gui(0)
  69 {
  70 }
  71
  72 boost::shared_ptr<Processor>
  73 Processor::clone (boost::shared_ptr<const Processor> other)
  74 {
  75         boost::shared_ptr<const Send> send;
  76         boost::shared_ptr<const PortInsert> port_insert;
  77         boost::shared_ptr<const PluginInsert> plugin_insert;
  78
  79         if ((send = boost::dynamic_pointer_cast<const Send>(other)) != 0) {
  80                 return boost::shared_ptr<Processor> (new Send (*send));
  81         } else if ((port_insert = boost::dynamic_pointer_cast<const PortInsert>(other)) != 0) {
  82                 return boost::shared_ptr<Processor> (new PortInsert (*port_insert));
  83         } else if ((plugin_insert = boost::dynamic_pointer_cast<const PluginInsert>(other)) != 0) {
  84                 return boost::shared_ptr<Processor> (new PluginInsert (*plugin_insert));
  85         } else {
  86                 fatal << _("programming error: unknown Processor type in Processor::Clone!\n")
  87                       << endmsg;
  88                 /*NOTREACHED*/
  89         }
  90         return boost::shared_ptr<Processor>();
  91 }
  92
  93 void
  94 Processor::set_sort_key (uint32_t key)
  95 {
  96         _sort_key = key;
  97 }
  98
  99 void
 100 Processor::set_placement (Placement p)
 101 {
 102         if (_placement != p) {
 103                 _placement = p;
 104                  PlacementChanged (); /* EMIT SIGNAL */
 105         }
 106 }
 107
 108 XMLNode&
 109 Processor::get_state (void)
 110 {
 111         return state (true);
 112 }
 113
 114 /* NODE STRUCTURE
 115
 116     <Automation [optionally with visible="...." ]>
 117        <parameter-N>
 118          <AutomationList id=N>
 119            <events>
 120            X1 Y1
 121            X2 Y2
 122            ....
 123            </events>
 124        </parameter-N>
 125     <Automation>
 126 */
 127
 128 XMLNode&
 129 Processor::state (bool full_state)
 130 {
 131         XMLNode* node = new XMLNode (state_node_name);
 132         stringstream sstr;
 133
 134         // FIXME: This conflicts with "id" used by plugin for name in legacy sessions (ugh).
 135         // Do we need to serialize this?
 136         /*
 137         char buf[64];
 138         id().print (buf, sizeof (buf));
 139         node->add_property("id", buf);
 140         */
 141
 142         node->add_property("name", _name);
 143         node->add_property("active", active() ? "yes" : "no");
 144         node->add_property("placement", enum_2_string (_placement));
 145
 146         if (_extra_xml){
 147                 node->add_child_copy (*_extra_xml);
 148         }
 149
 150         if (full_state) {
 151
 152                 XMLNode& automation = Automatable::get_automation_state();
 153
 154                 for (set<Evoral::Parameter>::iterator x = _visible_controls.begin(); x != _visible_controls.end(); ++x) {
 155                         if (x != _visible_controls.begin()) {
 156                                 sstr << ' ';
 157                         }
 158                         sstr << *x;
 159                 }
 160
 161                 automation.add_property ("visible", sstr.str());
 162
 163                 node->add_child_nocopy (automation);
 164         }
 165
 166         return *node;
 167 }
 168
 169 int
 170 Processor::set_state (const XMLNode& node)
 171 {
 172         const XMLProperty *prop;
 173         const XMLProperty *legacy_active = 0;
 174         const XMLProperty *legacy_placement = 0;
 175
 176         // may not exist for legacy sessions
 177         if ((prop = node.property ("name")) != 0) {
 178                 set_name(prop->value());
 179         }
 180
 181         XMLNodeList nlist = node.children();
 182         XMLNodeIterator niter;
 183
 184         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 185
 186                 if ((*niter)->name() == X_("Automation")) {
 187
 188
 189                         XMLProperty *prop;
 190
 191                         if ((prop = (*niter)->property ("path")) != 0) {
 192                                 old_set_automation_state (*(*niter));
 193                         } else {
 194                                 set_automation_state (*(*niter), Evoral::Parameter(PluginAutomation));
 195                         }
 196
 197                         if ((prop = (*niter)->property ("visible")) != 0) {
 198                                 uint32_t what;
 199                                 stringstream sstr;
 200
 201                                 _visible_controls.clear ();
 202
 203                                 sstr << prop->value();
 204                                 while (1) {
 205                                         sstr >> what;
 206                                         if (sstr.fail()) {
 207                                                 break;
 208                                         }
 209                                         // FIXME: other automation types?
 210                                         mark_automation_visible (Evoral::Parameter(PluginAutomation, 0, what), true);
 211                                 }
 212                         }
 213
 214                 } else if ((*niter)->name() == "extra") {
 215                         _extra_xml = new XMLNode (*(*niter));
 216                 } else if ((*niter)->name() == "Redirect") {
 217                         if ( !(legacy_active = (*niter)->property("active"))) {
 218                                 error << string_compose(_("No %1 property flag in element %2"), "active", (*niter)->name()) << endl;
 219                         }
 220                         if ( !(legacy_placement = (*niter)->property("placement"))) {
 221                                 error << string_compose(_("No %1 property flag in element %2"), "placement", (*niter)->name()) << endl;
 222                         }
 223                 }
 224         }
 225
 226         if ((prop = node.property ("active")) == 0) {
 227                 warning << _("XML node describing a processor is missing the `active' field, trying legacy active flag from child node") << endmsg;
 228                 if (legacy_active) {
 229                         prop = legacy_active;
 230                 } else {
 231                         error << _("No child node with active property") << endmsg;
 232                         return -1;
 233                 }
 234         }
 235
 236         if (_active != (prop->value() == "yes")) {
 237                 _active = !_active;
 238                 ActiveChanged (); /* EMIT_SIGNAL */
 239         }
 240
 241         if ((prop = node.property ("placement")) == 0) {
 242                 warning << _("XML node describing a processor is missing the `placement' field, trying legacy placement flag from child node") << endmsg;
 243                 if (legacy_placement) {
 244                         prop = legacy_placement;
 245                 } else {
 246                         error << _("No child node with placement property") << endmsg;
 247                         return -1;
 248                 }
 249         }
 250
 251         /* hack to handle older sessions before we only used EnumWriter */
 252
 253         string pstr;
 254
 255         if (prop->value() == "pre") {
 256                 pstr = "PreFader";
 257         } else if (prop->value() == "post") {
 258                 pstr = "PostFader";
 259         } else {
 260                 pstr = prop->value();
 261         }
 262
 263         Placement p = Placement (string_2_enum (pstr, p));
 264         set_placement (p);
 265
 266         return 0;
 267 }
 268
 269 bool
 270 Processor::configure_io (ChanCount in, ChanCount out)
 271 {
 272         /* this class assumes static output stream count.
 273            Derived classes must override, and must set "out"
 274            to reflect "in" before calling this.
 275         */
 276
 277         _configured_input = in;
 278         _configured = true;
 279
 280         return true;
 281 }