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