libs/ardour/send.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 <iostream>
  21 #include <algorithm>
  22
  23 #include "pbd/xml++.h"
  24 #include "pbd/boost_debug.h"
  25
  26 #include "ardour/amp.h"
  27 #include "ardour/send.h"
  28 #include "ardour/session.h"
  29 #include "ardour/buffer_set.h"
  30 #include "ardour/meter.h"
  31 #include "ardour/io.h"
  32
  33 #include "i18n.h"
  34
  35 namespace ARDOUR {
  36 class AutomationControl;
  37 class MuteMaster;
  38 class Pannable;
  39 }
  40
  41 using namespace ARDOUR;
  42 using namespace PBD;
  43 using namespace std;
  44
  45 string
  46 Send::name_and_id_new_send (Session& s, Role r, uint32_t& bitslot)
  47 {
  48         if (r == Role (0)) {
  49                 /* this happens during initial construction of sends from XML,
  50                    before they get ::set_state() called. lets not worry about
  51                    it.
  52                 */
  53                 bitslot = 0;
  54                 return string ();
  55         }
  56
  57         switch (r) {
  58         case Delivery::Aux:
  59                 return string_compose (_("aux %1"), (bitslot = s.next_aux_send_id ()) + 1);
  60         case Delivery::Listen:
  61                 return _("listen"); // no ports, no need for numbering
  62         case Delivery::Send:
  63                 return string_compose (_("send %1"), (bitslot = s.next_send_id ()) + 1);
  64         default:
  65                 fatal << string_compose (_("programming error: send created using role %1"), enum_2_string (r)) << endmsg;
  66                 /*NOTREACHED*/
  67                 return string();
  68         }
  69
  70 }
  71
  72 Send::Send (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r)
  73         : Delivery (s, p, mm, name_and_id_new_send (s, r, _bitslot), r)
  74         , _metering (false)
  75 {
  76         if (_role == Listen) {
  77                 /* we don't need to do this but it keeps things looking clean
  78                    in a debugger. _bitslot is not used by listen sends.
  79                 */
  80                 _bitslot = 0;
  81         }
  82
  83         boost_debug_shared_ptr_mark_interesting (this, "send");
  84
  85         _amp.reset (new Amp (_session));
  86         _meter.reset (new PeakMeter (_session));
  87
  88         add_control (_amp->gain_control ());
  89 }
  90
  91 Send::~Send ()
  92 {
  93         _session.unmark_send_id (_bitslot);
  94 }
  95
  96 void
  97 Send::activate ()
  98 {
  99         _amp->activate ();
 100         _meter->activate ();
 101
 102         Processor::activate ();
 103 }
 104
 105 void
 106 Send::deactivate ()
 107 {
 108         _amp->deactivate ();
 109         _meter->deactivate ();
 110         _meter->reset ();
 111
 112         Processor::deactivate ();
 113 }
 114
 115 void
 116 Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
 117 {
 118         if (_output->n_ports() == ChanCount::ZERO) {
 119                 _meter->reset ();
 120                 _active = _pending_active;
 121                 return;
 122         }
 123
 124         if (!_active && !_pending_active) {
 125                 _meter->reset ();
 126                 _output->silence (nframes);
 127                 _active = _pending_active;
 128                 return;
 129         }
 130
 131         // we have to copy the input, because deliver_output() may alter the buffers
 132         // in-place, which a send must never do.
 133
 134         BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
 135         sendbufs.read_from (bufs, nframes);
 136         assert(sendbufs.count() == bufs.count());
 137
 138         /* gain control */
 139
 140         // Can't automate gain for sends or returns yet because we need different buffers
 141         // so that we don't overwrite the main automation data for the route amp
 142         // _amp->setup_gain_automation (start_frame, end_frame, nframes);
 143         _amp->run (sendbufs, start_frame, end_frame, nframes, true);
 144
 145         /* deliver to outputs */
 146
 147         Delivery::run (sendbufs, start_frame, end_frame, nframes, true);
 148
 149         /* consider metering */
 150
 151         if (_metering) {
 152                 if (_amp->gain_control()->get_value() == 0) {
 153                         _meter->reset();
 154                 } else {
 155                         _meter->run (*_output_buffers, start_frame, end_frame, nframes, true);
 156                 }
 157         }
 158
 159         /* _active was set to _pending_active by Delivery::run() */
 160 }
 161
 162 XMLNode&
 163 Send::get_state(void)
 164 {
 165         return state (true);
 166 }
 167
 168 XMLNode&
 169 Send::state (bool full)
 170 {
 171         XMLNode& node = Delivery::state(full);
 172         char buf[32];
 173
 174         node.add_property ("type", "send");
 175         snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
 176
 177         if (_role != Listen) {
 178                 node.add_property ("bitslot", buf);
 179         }
 180
 181         node.add_child_nocopy (_amp->state (full));
 182
 183         return node;
 184 }
 185
 186 int
 187 Send::set_state (const XMLNode& node, int version)
 188 {
 189         if (version < 3000) {
 190                 return set_state_2X (node, version);
 191         }
 192
 193         const XMLProperty* prop;
 194
 195         Delivery::set_state (node, version);
 196
 197         if (node.property ("ignore-bitslot") == 0) {
 198
 199                 /* don't try to reset bitslot if there is a node for it already: this can cause
 200                    issues with the session's accounting of send ID's
 201                 */
 202
 203                 if ((prop = node.property ("bitslot")) == 0) {
 204                         if (_role == Delivery::Aux) {
 205                                 _bitslot = _session.next_aux_send_id ();
 206                         } else if (_role == Delivery::Send) {
 207                                 _bitslot = _session.next_send_id ();
 208                         } else {
 209                                 // bitslot doesn't matter but make it zero anyway
 210                                 _bitslot = 0;
 211                         }
 212                 } else {
 213                         if (_role == Delivery::Aux) {
 214                                 _session.unmark_aux_send_id (_bitslot);
 215                                 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
 216                                 _session.mark_aux_send_id (_bitslot);
 217                         } else if (_role == Delivery::Send) {
 218                                 _session.unmark_send_id (_bitslot);
 219                                 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
 220                                 _session.mark_send_id (_bitslot);
 221                         } else {
 222                                 // bitslot doesn't matter but make it zero anyway
 223                                 _bitslot = 0;
 224                         }
 225                 }
 226         }
 227
 228         XMLNodeList nlist = node.children();
 229         for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
 230                 if ((*i)->name() == X_("Processor")) {
 231                         _amp->set_state (**i, version);
 232                 }
 233         }
 234
 235         return 0;
 236 }
 237
 238 int
 239 Send::set_state_2X (const XMLNode& node, int /* version */)
 240 {
 241         /* use the IO's name for the name of the send */
 242         XMLNodeList const & children = node.children ();
 243
 244         XMLNodeList::const_iterator i = children.begin();
 245         while (i != children.end() && (*i)->name() != X_("Redirect")) {
 246                 ++i;
 247         }
 248
 249         if (i == children.end()) {
 250                 return -1;
 251         }
 252
 253         XMLNodeList const & grand_children = (*i)->children ();
 254         XMLNodeList::const_iterator j = grand_children.begin ();
 255         while (j != grand_children.end() && (*j)->name() != X_("IO")) {
 256                 ++j;
 257         }
 258
 259         if (j == grand_children.end()) {
 260                 return -1;
 261         }
 262
 263         XMLProperty const * prop = (*j)->property (X_("name"));
 264         if (!prop) {
 265                 return -1;
 266         }
 267
 268         set_name (prop->value ());
 269
 270         return 0;
 271 }
 272
 273 bool
 274 Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 275 {
 276         /* sends have no impact at all on the channel configuration of the
 277            streams passing through the route. so, out == in.
 278         */
 279
 280         out = in;
 281         return true;
 282 }
 283
 284 /** Caller must hold process lock */
 285 bool
 286 Send::configure_io (ChanCount in, ChanCount out)
 287 {
 288         if (!_amp->configure_io (in, out) || !_meter->configure_io (in, out)) {
 289                 return false;
 290         }
 291
 292         if (!Processor::configure_io (in, out)) {
 293                 return false;
 294         }
 295
 296         reset_panner ();
 297
 298         return true;
 299 }
 300
 301 bool
 302 Send::set_name (const string& new_name)
 303 {
 304         string unique_name;
 305
 306         if (_role == Delivery::Send) {
 307                 char buf[32];
 308
 309                 /* rip any existing numeric part of the name, and append the bitslot
 310                  */
 311
 312                 string::size_type last_letter = new_name.find_last_not_of ("0123456789");
 313
 314                 if (last_letter != string::npos) {
 315                         unique_name = new_name.substr (0, last_letter + 1);
 316                 } else {
 317                         unique_name = new_name;
 318                 }
 319
 320                 snprintf (buf, sizeof (buf), "%u", (_bitslot + 1));
 321                 unique_name += buf;
 322
 323         } else {
 324                 unique_name = new_name;
 325         }
 326
 327         return Delivery::set_name (unique_name);
 328 }
 329
 330 bool
 331 Send::display_to_user () const
 332 {
 333         /* we ignore Deliver::_display_to_user */
 334
 335         if (_role == Listen) {
 336                 /* don't make the monitor/control/listen send visible */
 337                 return false;
 338         }
 339
 340         return true;
 341 }
 342
 343 string
 344 Send::value_as_string (boost::shared_ptr<AutomationControl> ac) const
 345 {
 346         return _amp->value_as_string (ac);
 347 }
 348
 349