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 <algorithm>
  21
  22 #include <pbd/xml++.h>
  23
  24 #include <ardour/send.h>
  25 #include <ardour/session.h>
  26 #include <ardour/port.h>
  27 #include <ardour/audio_port.h>
  28 #include <ardour/buffer_set.h>
  29 #include <ardour/meter.h>
  30 #include "i18n.h"
  31
  32 using namespace ARDOUR;
  33 using namespace PBD;
  34
  35 Send::Send (Session& s, Placement p)
  36         : Redirect (s, string_compose (_("send %1"), (bitslot = s.next_send_id()) + 1), p)
  37 {
  38         _metering = false;
  39         RedirectCreated (this); /* EMIT SIGNAL */
  40 }
  41
  42 Send::Send (Session& s, const XMLNode& node)
  43         : Redirect (s,  "send", PreFader)
  44 {
  45         _metering = false;
  46
  47         if (set_state (node)) {
  48                 throw failed_constructor();
  49         }
  50
  51         RedirectCreated (this); /* EMIT SIGNAL */
  52 }
  53
  54 Send::Send (const Send& other)
  55         : Redirect (other._session, string_compose (_("send %1"), (bitslot = other._session.next_send_id()) + 1), other.placement())
  56 {
  57         _metering = false;
  58         RedirectCreated (this); /* EMIT SIGNAL */
  59 }
  60
  61 Send::~Send ()
  62 {
  63         GoingAway ();
  64 }
  65
  66 XMLNode&
  67 Send::get_state(void)
  68 {
  69         return state (true);
  70 }
  71
  72 XMLNode&
  73 Send::state(bool full)
  74 {
  75         XMLNode *node = new XMLNode("Send");
  76         char buf[32];
  77         node->add_child_nocopy (Redirect::state (full));
  78         snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
  79         node->add_property ("bitslot", buf);
  80         return *node;
  81 }
  82
  83 int
  84 Send::set_state(const XMLNode& node)
  85 {
  86         XMLNodeList nlist = node.children();
  87         XMLNodeIterator niter;
  88         const XMLProperty* prop;
  89
  90         if ((prop = node.property ("bitslot")) == 0) {
  91                 bitslot = _session.next_send_id();
  92         } else {
  93                 sscanf (prop->value().c_str(), "%" PRIu32, &bitslot);
  94                 _session.mark_send_id (bitslot);
  95         }
  96
  97         /* Send has regular IO automation (gain, pan) */
  98
  99         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 100                 if ((*niter)->name() == Redirect::state_node_name) {
 101                         Redirect::set_state (**niter);
 102                         break;
 103                 } else if ((*niter)->name() == X_("Automation")) {
 104                         IO::set_automation_state (*(*niter));
 105                 }
 106         }
 107
 108         if (niter == nlist.end()) {
 109                 error << _("XML node describing a send is missing a Redirect node") << endmsg;
 110                 return -1;
 111         }
 112
 113         return 0;
 114 }
 115
 116 void
 117 Send::run (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset)
 118 {
 119         if (active()) {
 120
 121                 // we have to copy the input, because IO::deliver_output may alter the buffers
 122                 // in-place, which a send must never do.
 123
 124                 BufferSet& sendbufs = _session.get_send_buffers(bufs.count());
 125
 126                 sendbufs.read_from(bufs, nframes);
 127                 assert(sendbufs.count() == bufs.count());
 128
 129                 IO::deliver_output (sendbufs, start_frame, end_frame, nframes, offset);
 130
 131                 if (_metering) {
 132                         if (_gain == 0) {
 133                                 _meter->reset();
 134                         } else {
 135                                 _meter->run(output_buffers(), nframes, offset);
 136                         }
 137                 }
 138
 139         } else {
 140                 silence (nframes, offset);
 141
 142                 if (_metering) {
 143                         _meter->reset();
 144                 }
 145         }
 146 }
 147
 148 void
 149 Send::set_metering (bool yn)
 150 {
 151         _metering = yn;
 152
 153         if (!_metering) {
 154                 /* XXX possible thread hazard here */
 155                 peak_meter().reset();
 156         }
 157 }
 158
 159 void
 160 Send::expect_inputs (const ChanCount& expected)
 161 {
 162         if (expected != _expected_inputs) {
 163                 _expected_inputs = expected;
 164                 reset_panner ();
 165         }
 166 }